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, MMLParams, 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. MMLParams
  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. def BooleanParam(i: Identifiable, name: String, description: String, default: Boolean): BooleanParam

    Permalink
    Definition Classes
    Wrappable

  6. def BooleanParam(i: Identifiable, name: String, description: String): BooleanParam

    Permalink
    Definition Classes
    Wrappable

  7. def DoubleParam(i: Identifiable, name: String, description: String, default: Double): DoubleParam

    Permalink
    Definition Classes
    Wrappable

  8. def DoubleParam(i: Identifiable, name: String, description: String): DoubleParam

    Permalink
    Definition Classes
    Wrappable

  9. def IntParam(i: Identifiable, name: String, description: String, validation: (Int) ⇒ Boolean): IntParam

    Permalink
    Definition Classes
    Wrappable

  10. def IntParam(i: Identifiable, name: String, description: String, default: Int): IntParam

    Permalink
    Definition Classes
    Wrappable

  11. def IntParam(i: Identifiable, name: String, description: String): IntParam

    Permalink
    Definition Classes
    Wrappable

  12. def LongParam(i: Identifiable, name: String, description: String, default: Long): LongParam

    Permalink
    Definition Classes
    Wrappable

  13. def LongParam(i: Identifiable, name: String, description: String): LongParam

    Permalink
    Definition Classes
    Wrappable

  14. def StringParam(i: Identifiable, name: String, description: String, default: String, domain: Seq[String]): Param[String]

    Permalink
    Definition Classes
    Wrappable

  15. def StringParam(i: Identifiable, name: String, description: String, default: String): Param[String]

    Permalink
    Definition Classes
    Wrappable

  16. def StringParam(i: Identifiable, name: String, description: String, validation: (String) ⇒ Boolean): Param[String]

    Permalink
    Definition Classes
    Wrappable

  17. def StringParam(i: Identifiable, name: String, description: String): Param[String]

    Permalink
    Definition Classes
    Wrappable

  18. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  19. val baggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams

  20. val baggingFreq: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  21. val baggingSeed: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  22. def chainedUid(origin: String): String

    Permalink
    Definition Classes
    Wrappable

  23. final def clear(param: Param[_]): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    Params

  24. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. def copy(extra: ParamMap): LightGBMClassifier

    Permalink
    Definition Classes
    LightGBMClassifier → Predictor → Estimator → PipelineStage → Params

  26. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  27. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  28. val defaultListenPort: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  29. val earlyStoppingRound: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  30. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  31. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  32. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  33. def explainParams(): String

    Permalink
    Definition Classes
    Params

  34. def extractLabeledPoints(dataset: Dataset[_], numClasses: Int): RDD[LabeledPoint]

    Permalink
    Attributes
    protected
    Definition Classes
    Classifier

  35. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]

    Permalink
    Attributes
    protected
    Definition Classes
    Predictor

  36. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  37. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  38. val featureFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams

  39. final val featuresCol: Param[String]

    Permalink
    Definition Classes
    HasFeaturesCol

  40. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  41. def fit(dataset: Dataset[_]): LightGBMClassificationModel

    Permalink
    Definition Classes
    Predictor → Estimator

  42. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[LightGBMClassificationModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  43. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMClassificationModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )

  44. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMClassificationModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()

  45. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  46. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMParams

  47. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams

  48. def getBaggingSeed: Int

    Permalink
    Definition Classes
    LightGBMParams

  49. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  50. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  51. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMParams

  52. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMParams

  53. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMParams

  54. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol

  55. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol

  56. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams

  57. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams

  58. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams

  59. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams

  60. def getNumClasses(dataset: Dataset[_], maxNumClasses: Int): Int

    Permalink
    Attributes
    protected
    Definition Classes
    Classifier

  61. def getNumIterations: Int

    Permalink
    Definition Classes
    LightGBMParams

  62. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams

  63. def getObjective: String

    Permalink
    Definition Classes
    LightGBMParams

  64. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params

  65. def getParallelism: String

    Permalink
    Definition Classes
    LightGBMParams

  66. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

  67. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol

  68. final def getProbabilityCol: String

    Permalink
    Definition Classes
    HasProbabilityCol

  69. final def getRawPredictionCol: String

    Permalink
    Definition Classes
    HasRawPredictionCol

  70. def getThresholds: Array[Double]

    Permalink
    Definition Classes
    HasThresholds

  71. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams

  72. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  73. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  74. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  75. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  76. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  77. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  78. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  79. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  80. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  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. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  99. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  100. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  101. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  102. val numLeaves: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  103. val objective: Param[String]

    Permalink
    Definition Classes
    LightGBMParams

  104. val parallelism: Param[String]

    Permalink
    Definition Classes
    LightGBMParams

  105. val paramDomains: Map[String, Seq[String]]

    Permalink
    Definition Classes
    Wrappable

  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. final def setDefault(paramPairs: ParamPair[_]*): LightGBMClassifier.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  118. final def setDefault[T](param: Param[T], value: T): LightGBMClassifier.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  119. def setDefaultListenPort(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  120. def setEarlyStoppingRound(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  121. def setFeatureFraction(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  122. def setFeaturesCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Predictor

  123. def setLabelCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Predictor

  124. def setLearningRate(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  125. def setMaxBin(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  126. def setMaxDepth(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  127. def setMinSumHessianInLeaf(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  128. def setNumIterations(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  129. def setNumLeaves(value: Int): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  130. def setObjective(value: String): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  131. def setParallelism(value: String): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  132. def setPredictionCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Predictor

  133. def setProbabilityCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    ProbabilisticClassifier

  134. def setRawPredictionCol(value: String): LightGBMClassifier

    Permalink
    Definition Classes
    Classifier

  135. def setThresholds(value: Array[Double]): LightGBMClassifier

    Permalink
    Definition Classes
    ProbabilisticClassifier

  136. def setTimeout(value: Double): LightGBMClassifier.this.type

    Permalink
    Definition Classes
    LightGBMParams

  137. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  138. final val thresholds: DoubleArrayParam

    Permalink
    Definition Classes
    HasThresholds

  139. val timeout: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams

  140. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  141. 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

  142. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    Predictor → PipelineStage

  143. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  144. val uid: String

    Permalink

    The unique ID.

    The unique ID.

    Definition Classes
    LightGBMClassifier → Identifiable

  145. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams

  146. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  147. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  148. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  149. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from LightGBMParams

Inherited from MMLParams

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