Class/Object

com.microsoft.ml.spark

LightGBMClassifier

Related Docs: object LightGBMClassifier | package spark

Permalink

class LightGBMClassifier extends ProbabilisticClassifier[Vector, LightGBMClassifier, LightGBMClassificationModel] with LightGBMParams

Trains a LightGBM Binary Classification model, a fast, distributed, high performance gradient boosting framework based on decision tree algorithms. For more information please see here: https://github.com/Microsoft/LightGBM. For parameter information see here: https://github.com/Microsoft/LightGBM/blob/master/docs/Parameters.rst

Annotations
@InternalWrapper()
Linear Supertypes
LightGBMParams, DefaultParamsWritable, MLWritable, Wrappable, ProbabilisticClassifier[Vector, LightGBMClassifier, LightGBMClassificationModel], ProbabilisticClassifierParams, HasThresholds, HasProbabilityCol, Classifier[Vector, LightGBMClassifier, LightGBMClassificationModel], ClassifierParams, HasRawPredictionCol, Predictor[Vector, LightGBMClassifier, LightGBMClassificationModel], PredictorParams, HasPredictionCol, org.apache.spark.ml.param.shared.HasFeaturesCol, org.apache.spark.ml.param.shared.HasLabelCol, Estimator[LightGBMClassificationModel], PipelineStage, org.apache.spark.internal.Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMClassifier
  2. LightGBMParams
  3. DefaultParamsWritable
  4. MLWritable
  5. Wrappable
  6. ProbabilisticClassifier
  7. ProbabilisticClassifierParams
  8. HasThresholds
  9. HasProbabilityCol
  10. Classifier
  11. ClassifierParams
  12. HasRawPredictionCol
  13. Predictor
  14. PredictorParams
  15. HasPredictionCol
  16. HasFeaturesCol
  17. HasLabelCol
  18. Estimator
  19. PipelineStage
  20. Logging
  21. Params
  22. Serializable
  23. Serializable
  24. Identifiable
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LightGBMClassifier()

    Permalink
  2. new LightGBMClassifier(uid: String)

    Permalink

    uid

    The unique ID.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val baggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  7. val baggingFreq: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  8. val baggingSeed: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  9. final def clear(param: Param[_]): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    Params
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def copy(extra: ParamMap): LightGBMClassifier

    Permalink
    Definition Classes
    LightGBMClassifier → Predictor → Estimator → PipelineStage → Params
  12. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. val defaultListenPort: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  15. val earlyStoppingRound: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  19. def explainParams(): String

    Permalink
    Definition Classes
    Params
  20. def extractLabeledPoints(dataset: Dataset[_], numClasses: Int): RDD[LabeledPoint]

    Permalink
    Attributes
    protected
    Definition Classes
    Classifier
  21. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]

    Permalink
    Attributes
    protected
    Definition Classes
    Predictor
  22. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  23. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  24. val featureFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  25. final val featuresCol: Param[String]

    Permalink
    Definition Classes
    HasFeaturesCol
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def fit(dataset: Dataset[_]): LightGBMClassificationModel

    Permalink
    Definition Classes
    Predictor → Estimator
  28. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[LightGBMClassificationModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  29. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMClassificationModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  30. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMClassificationModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  31. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  32. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  33. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams
  34. def getBaggingSeed: Int

    Permalink
    Definition Classes
    LightGBMParams
  35. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  36. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  37. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMParams
  38. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMParams
  39. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  40. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  41. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  42. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams
  43. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams
  44. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  45. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  46. def getModelString: String

    Permalink
    Definition Classes
    LightGBMParams
  47. def getNumClasses(dataset: Dataset[_], maxNumClasses: Int): Int

    Permalink
    Attributes
    protected
    Definition Classes
    Classifier
  48. def getNumIterations: Int

    Permalink
    Definition Classes
    LightGBMParams
  49. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  50. def getObjective: String

    Permalink
    Definition Classes
    LightGBMParams
  51. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  52. def getParallelism: String

    Permalink
    Definition Classes
    LightGBMParams
  53. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  54. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  55. final def getProbabilityCol: String

    Permalink
    Definition Classes
    HasProbabilityCol
  56. final def getRawPredictionCol: String

    Permalink
    Definition Classes
    HasRawPredictionCol
  57. def getThresholds: Array[Double]

    Permalink
    Definition Classes
    HasThresholds
  58. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams
  59. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  60. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  61. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  62. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  65. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  66. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  67. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol
  69. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  70. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  75. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  77. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  79. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  81. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  82. val maxBin: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  83. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  84. val minSumHessianInLeaf: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  85. val modelString: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  86. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  87. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  88. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  89. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  90. val numLeaves: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  91. val objective: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  92. val parallelism: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  93. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  94. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol
  95. final val probabilityCol: Param[String]

    Permalink
    Definition Classes
    HasProbabilityCol
  96. final val rawPredictionCol: Param[String]

    Permalink
    Definition Classes
    HasRawPredictionCol
  97. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  98. final def set(paramPair: ParamPair[_]): LightGBMClassifier.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  99. final def set(param: String, value: Any): LightGBMClassifier.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  100. final def set[T](param: Param[T], value: T): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    Params
  101. def setBaggingFraction(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  102. def setBaggingFreq(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  103. def setBaggingSeed(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  104. final def setDefault(paramPairs: ParamPair[_]*): LightGBMClassifier.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  105. final def setDefault[T](param: Param[T], value: T): LightGBMClassifier.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  106. def setDefaultListenPort(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  107. def setEarlyStoppingRound(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  108. def setFeatureFraction(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  109. def setFeaturesCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Predictor
  110. def setLabelCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Predictor
  111. def setLearningRate(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  112. def setMaxBin(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  113. def setMaxDepth(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  114. def setMinSumHessianInLeaf(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  115. def setModelString(value: String): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  116. def setNumIterations(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  117. def setNumLeaves(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  118. def setObjective(value: String): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  119. def setParallelism(value: String): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  120. def setPredictionCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Predictor
  121. def setProbabilityCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    ProbabilisticClassifier
  122. def setRawPredictionCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Classifier
  123. def setThresholds(value: Array[Double]): LightGBMClassifier

    Permalink
    Definition Classes
    ProbabilisticClassifier
  124. def setTimeout(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  125. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  126. final val thresholds: DoubleArrayParam

    Permalink
    Definition Classes
    HasThresholds
  127. val timeout: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  128. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  129. def train(dataset: Dataset[_]): LightGBMClassificationModel

    Permalink

    Trains the LightGBM Classification model.

    Trains the LightGBM Classification model.

    dataset

    The input dataset to train.

    returns

    The trained model.

    Attributes
    protected
    Definition Classes
    LightGBMClassifier → Predictor
  130. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    Predictor → PipelineStage
  131. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  132. val uid: String

    Permalink

    The unique ID.

    The unique ID.

    Definition Classes
    LightGBMClassifier → Identifiable
  133. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams
  134. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from LightGBMParams

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from ProbabilisticClassifier[Vector, LightGBMClassifier, LightGBMClassificationModel]

Inherited from ProbabilisticClassifierParams

Inherited from HasThresholds

Inherited from HasProbabilityCol

Inherited from Classifier[Vector, LightGBMClassifier, LightGBMClassificationModel]

Inherited from ClassifierParams

Inherited from HasRawPredictionCol

Inherited from Predictor[Vector, LightGBMClassifier, LightGBMClassificationModel]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from org.apache.spark.ml.param.shared.HasFeaturesCol

Inherited from org.apache.spark.ml.param.shared.HasLabelCol

Inherited from Estimator[LightGBMClassificationModel]

Inherited from PipelineStage

Inherited from org.apache.spark.internal.Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Members