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, 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. LightGBMParams
  3. HasWeightCol
  4. DefaultParamsWritable
  5. MLWritable
  6. Wrappable
  7. ProbabilisticClassifier
  8. ProbabilisticClassifierParams
  9. HasThresholds
  10. HasProbabilityCol
  11. Classifier
  12. ClassifierParams
  13. HasRawPredictionCol
  14. Predictor
  15. PredictorParams
  16. HasPredictionCol
  17. HasFeaturesCol
  18. HasLabelCol
  19. Estimator
  20. PipelineStage
  21. Logging
  22. Params
  23. Serializable
  24. Serializable
  25. Identifiable
  26. AnyRef
  27. 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 categoricalSlotIndexes: IntArrayParam

    Permalink
    Definition Classes
    LightGBMParams
  10. val categoricalSlotNames: StringArrayParam

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  17. val earlyStoppingRound: IntParam

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  26. val featureFraction: DoubleParam

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  34. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  35. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams
  36. def getBaggingSeed: Int

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

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

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

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

    Permalink
    Definition Classes
    Params
  41. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMParams
  42. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMParams
  43. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  44. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  45. def getIsUnbalance: Boolean

    Permalink
  46. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  47. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams
  48. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams
  49. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  50. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  51. def getModelString: String

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

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

    Permalink
    Definition Classes
    LightGBMParams
  54. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  55. def getObjective: String

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

    Permalink
    Definition Classes
    Params
  57. def getParallelism: String

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

    Permalink
    Definition Classes
    Params
  59. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  60. final def getProbabilityCol: String

    Permalink
    Definition Classes
    HasProbabilityCol
  61. final def getRawPredictionCol: String

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

    Permalink
    Definition Classes
    HasThresholds
  63. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams
  64. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  65. def getWeightCol: String

    Permalink

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

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

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

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

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

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

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

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

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

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

    Permalink
  76. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol
  77. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  78. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  91. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  92. val minSumHessianInLeaf: DoubleParam

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  97. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  98. val numLeaves: IntParam

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  136. def setVerbosity(value: Int): LightGBMClassifier.this.type

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  139. final val thresholds: DoubleArrayParam

    Permalink
    Definition Classes
    HasThresholds
  140. val timeout: DoubleParam

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  142. 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
  143. def transformSchema(schema: StructType): StructType

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

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

    Permalink

    The unique ID.

    The unique ID.

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

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams
  147. val verbosity: IntParam

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

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  152. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from LightGBMParams

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