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

    Permalink
    Definition Classes
    LightGBMParams
  52. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams
  53. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  54. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  55. def getModelString: String

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

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

    Permalink
    Definition Classes
    LightGBMParams
  58. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  59. def getObjective: String

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

    Permalink
    Definition Classes
    Params
  61. def getParallelism: String

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

    Permalink
    Definition Classes
    Params
  63. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  64. final def getProbabilityCol: String

    Permalink
    Definition Classes
    HasProbabilityCol
  65. final def getRawPredictionCol: String

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

    Permalink
    Definition Classes
    HasThresholds
  67. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams
  68. def getValidationIndicatorCol: String

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  69. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  70. def getWeightCol: String

    Permalink

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

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

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

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

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

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

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

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

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

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

    Permalink
  81. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol
  82. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  83. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  96. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  97. val minSumHessianInLeaf: DoubleParam

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  102. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  103. val numLeaves: IntParam

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

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

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  147. final val thresholds: DoubleArrayParam

    Permalink
    Definition Classes
    HasThresholds
  148. val timeout: DoubleParam

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

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

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

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

    Permalink

    The unique ID.

    The unique ID.

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

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

    Permalink

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  156. val verbosity: IntParam

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

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  161. 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