Class/Object

com.microsoft.ml.spark

LightGBMRegressor

Related Docs: object LightGBMRegressor | package spark

Permalink

class LightGBMRegressor extends BaseRegressor[Vector, LightGBMRegressor, LightGBMRegressionModel] with LightGBMBase[LightGBMRegressionModel]

Trains a LightGBM Regression 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 Note: The application parameter supports the following values:

Annotations
@InternalWrapper()
Linear Supertypes
LightGBMBase[LightGBMRegressionModel], LightGBMParams, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, BaseRegressor[Vector, LightGBMRegressor, LightGBMRegressionModel], Regressor[Vector, LightGBMRegressor, LightGBMRegressionModel], Predictor[Vector, LightGBMRegressor, LightGBMRegressionModel], PredictorParams, HasPredictionCol, org.apache.spark.ml.param.shared.HasFeaturesCol, org.apache.spark.ml.param.shared.HasLabelCol, Estimator[LightGBMRegressionModel], PipelineStage, org.apache.spark.internal.Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. LightGBMRegressor
  2. LightGBMBase
  3. LightGBMParams
  4. HasValidationIndicatorCol
  5. HasWeightCol
  6. DefaultParamsWritable
  7. MLWritable
  8. Wrappable
  9. BaseRegressor
  10. Regressor
  11. Predictor
  12. PredictorParams
  13. HasPredictionCol
  14. HasFeaturesCol
  15. HasLabelCol
  16. Estimator
  17. PipelineStage
  18. Logging
  19. Params
  20. Serializable
  21. Serializable
  22. Identifiable
  23. AnyRef
  24. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LightGBMRegressor()

    Permalink
  2. new LightGBMRegressor(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. val alpha: DoubleParam

    Permalink
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val baggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  8. val baggingFreq: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  9. val baggingSeed: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  10. val boostFromAverage: BooleanParam

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

    Permalink
    Definition Classes
    LightGBMParams
  12. val categoricalSlotIndexes: IntArrayParam

    Permalink
    Definition Classes
    LightGBMParams
  13. val categoricalSlotNames: StringArrayParam

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  20. val earlyStoppingRound: IntParam

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

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

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

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

    Permalink
    Definition Classes
    Params
  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[_]): LightGBMRegressionModel

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

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

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

    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 getAlpha: Double

    Permalink
  37. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  38. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams
  39. def getBaggingSeed: Int

    Permalink
    Definition Classes
    LightGBMParams
  40. def getBoostFromAverage: Boolean

    Permalink
    Definition Classes
    LightGBMParams
  41. def getBoostingType: String

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

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

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

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

    Permalink
    Definition Classes
    Params
  46. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMParams
  47. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMParams
  48. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  49. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  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): LightGBMRegressionModel

    Permalink
    Definition Classes
    LightGBMRegressorLightGBMBase
  58. def getModelString: String

    Permalink
    Definition Classes
    LightGBMParams
  59. def getNumBatches: Int

    Permalink
    Definition Classes
    LightGBMParams
  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. def getTimeout: Double

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

    Permalink
    Definition Classes
    LightGBMRegressorLightGBMBase
  69. def getTweedieVariancePower: Double

    Permalink
  70. def getValidationIndicatorCol: String

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  71. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  72. def getWeightCol: String

    Permalink

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  78. def innerTrain(dataset: Dataset[_]): LightGBMRegressionModel

    Permalink
    Definition Classes
    LightGBMBase
  79. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    HasLabelCol
  84. val lambdaL1: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  85. val lambdaL2: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  86. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  87. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  100. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  101. val minSumHessianInLeaf: DoubleParam

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  106. val numBatches: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  107. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  108. val numLeaves: IntParam

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

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

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

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

    Permalink
    Definition Classes
    HasPredictionCol
  113. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  117. def setAlpha(value: Double): LightGBMRegressor.this.type

    Permalink
  118. def setBaggingFraction(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  119. def setBaggingFreq(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  120. def setBaggingSeed(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  121. def setBoostFromAverage(value: Boolean): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  122. def setBoostingType(value: String): LightGBMRegressor.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  128. def setEarlyStoppingRound(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  129. def setFeatureFraction(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  130. def setFeaturesCol(value: String): LightGBMRegressor

    Permalink
    Definition Classes
    Predictor
  131. def setLabelCol(value: String): LightGBMRegressor

    Permalink
    Definition Classes
    Predictor
  132. def setLambdaL1(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  133. def setLambdaL2(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  134. def setLearningRate(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  135. def setMaxBin(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  136. def setMaxDepth(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  137. def setMinSumHessianInLeaf(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  138. def setModelString(value: String): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  139. def setNumBatches(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  140. def setNumIterations(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  141. def setNumLeaves(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  142. def setObjective(value: String): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  143. def setParallelism(value: String): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  144. def setPredictionCol(value: String): LightGBMRegressor

    Permalink
    Definition Classes
    Predictor
  145. def setTimeout(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  146. def setTweedieVariancePower(value: Double): LightGBMRegressor.this.type

    Permalink
  147. def setValidationIndicatorCol(value: String): LightGBMRegressor.this.type

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  148. def setVerbosity(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  149. def setWeightCol(value: String): LightGBMRegressor.this.type

    Permalink

    Definition Classes
    HasWeightCol
  150. def stringFromTrainedModel(model: LightGBMRegressionModel): String

    Permalink
    Definition Classes
    LightGBMRegressorLightGBMBase
  151. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  152. val timeout: DoubleParam

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

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

    Permalink

    Trains the LightGBM model.

    Trains the LightGBM model.

    dataset

    The input dataset to train.

    returns

    The trained model.

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  157. val tweedieVariancePower: DoubleParam

    Permalink
  158. val uid: String

    Permalink

    The unique ID.

    The unique ID.

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

    Permalink
    Attributes
    protected
    Definition Classes
    PredictorParams
  160. val validationIndicatorCol: Param[String]

    Permalink

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  161. val verbosity: IntParam

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

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  166. 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 Regressor[Vector, LightGBMRegressor, LightGBMRegressionModel]

Inherited from Predictor[Vector, LightGBMRegressor, LightGBMRegressionModel]

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[LightGBMRegressionModel]

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