Class/Object

com.microsoft.ml.spark

LightGBMClassifier

Related Docs: object LightGBMClassifier | package spark

Permalink

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

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
LightGBMBase[LightGBMClassificationModel], LightGBMParams, HasValidationIndicatorCol, HasWeightCol, 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. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. LightGBMClassifier
  2. LightGBMBase
  3. LightGBMParams
  4. HasValidationIndicatorCol
  5. HasWeightCol
  6. DefaultParamsWritable
  7. MLWritable
  8. Wrappable
  9. ProbabilisticClassifier
  10. ProbabilisticClassifierParams
  11. HasThresholds
  12. HasProbabilityCol
  13. Classifier
  14. ClassifierParams
  15. HasRawPredictionCol
  16. Predictor
  17. PredictorParams
  18. HasPredictionCol
  19. HasFeaturesCol
  20. HasLabelCol
  21. Estimator
  22. PipelineStage
  23. Logging
  24. Params
  25. Serializable
  26. Serializable
  27. Identifiable
  28. AnyRef
  29. 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. val boostFromAverage: BooleanParam

    Permalink
    Definition Classes
    LightGBMParams
  10. val boostingType: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  11. val categoricalSlotIndexes: IntArrayParam

    Permalink
    Definition Classes
    LightGBMParams
  12. val categoricalSlotNames: StringArrayParam

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  19. val earlyStoppingRound: IntParam

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  28. val featureFraction: DoubleParam

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  36. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  37. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams
  38. def getBaggingSeed: Int

    Permalink
    Definition Classes
    LightGBMParams
  39. def getBoostFromAverage: Boolean

    Permalink
    Definition Classes
    LightGBMParams
  40. def getBoostingType: String

    Permalink
    Definition Classes
    LightGBMParams
  41. def getCategoricalSlotIndexes: Array[Int]

    Permalink
    Definition Classes
    LightGBMParams
  42. def getCategoricalSlotNames: Array[String]

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

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

    Permalink
    Definition Classes
    Params
  45. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMParams
  46. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMParams
  47. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  48. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  49. def getIsUnbalance: Boolean

    Permalink
  50. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  51. def getLambdaL1: Double

    Permalink
    Definition Classes
    LightGBMParams
  52. def getLambdaL2: Double

    Permalink
    Definition Classes
    LightGBMParams
  53. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams
  54. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams
  55. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  56. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  57. def getModel(trainParams: TrainParams, lightGBMBooster: LightGBMBooster): LightGBMClassificationModel

    Permalink
    Definition Classes
    LightGBMClassifierLightGBMBase
  58. def getModelString: String

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

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

    Permalink
    Definition Classes
    LightGBMParams
  61. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  62. def getObjective: String

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

    Permalink
    Definition Classes
    Params
  64. def getParallelism: String

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

    Permalink
    Definition Classes
    Params
  66. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  67. final def getProbabilityCol: String

    Permalink
    Definition Classes
    HasProbabilityCol
  68. final def getRawPredictionCol: String

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

    Permalink
    Definition Classes
    HasThresholds
  70. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams
  71. def getTrainParams(numWorkers: Int, categoricalIndexes: Array[Int], dataset: Dataset[_]): TrainParams

    Permalink
    Definition Classes
    LightGBMClassifierLightGBMBase
  72. def getValidationIndicatorCol: String

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  73. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  74. def getWeightCol: String

    Permalink

    Definition Classes
    HasWeightCol
  75. final def hasDefault[T](param: Param[T]): Boolean

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  84. val isUnbalance: BooleanParam

    Permalink
  85. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol
  86. val lambdaL1: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  87. val lambdaL2: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  88. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  89. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  102. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  103. val minSumHessianInLeaf: DoubleParam

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  108. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  109. val numLeaves: IntParam

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  123. def setBoostFromAverage(value: Boolean): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  124. def setBoostingType(value: String): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  125. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  126. def setCategoricalSlotNames(value: Array[String]): LightGBMClassifier.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    Predictor
  133. def setIsUnbalance(value: Boolean): LightGBMClassifier.this.type

    Permalink
  134. def setLabelCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Predictor
  135. def setLambdaL1(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  136. def setLambdaL2(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  137. def setLearningRate(value: Double): LightGBMClassifier.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  151. def setValidationIndicatorCol(value: String): LightGBMClassifier.this.type

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  152. def setVerbosity(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams
  153. def setWeightCol(value: String): LightGBMClassifier.this.type

    Permalink

    Definition Classes
    HasWeightCol
  154. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  155. final val thresholds: DoubleArrayParam

    Permalink
    Definition Classes
    HasThresholds
  156. val timeout: DoubleParam

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

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

    Permalink

    Trains the LightGBM model.

    Trains the LightGBM model.

    dataset

    The input dataset to train.

    returns

    The trained model.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  159. def transformSchema(schema: StructType): StructType

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

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

    Permalink

    The unique ID.

    The unique ID.

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

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams
  163. val validationIndicatorCol: Param[String]

    Permalink

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  164. val verbosity: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  165. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  168. val weightCol: Param[String]

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  169. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from LightGBMParams

Inherited from HasValidationIndicatorCol

Inherited from HasWeightCol

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

Parameters

A list of parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters

Parameter setters

Parameter getters

Members