Class/Object

com.microsoft.ml.spark.lightgbm

LightGBMRegressor

Related Docs: object LightGBMRegressor | package lightgbm

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, LightGBMExecutionParams, HasInitScoreCol, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, BaseRegressor[Vector, LightGBMRegressor, LightGBMRegressionModel], Regressor[Vector, LightGBMRegressor, LightGBMRegressionModel], Predictor[Vector, LightGBMRegressor, LightGBMRegressionModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Estimator[LightGBMRegressionModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMRegressor
  2. LightGBMBase
  3. LightGBMParams
  4. LightGBMExecutionParams
  5. HasInitScoreCol
  6. HasValidationIndicatorCol
  7. HasWeightCol
  8. DefaultParamsWritable
  9. MLWritable
  10. Wrappable
  11. BaseRegressor
  12. Regressor
  13. Predictor
  14. PredictorParams
  15. HasPredictionCol
  16. HasFeaturesCol
  17. HasLabelCol
  18. Estimator
  19. PipelineStage
  20. Logging
  21. Params
  22. Serializable
  23. Serializable
  24. Identifiable
  25. AnyRef
  26. 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
    LightGBMExecutionParams
  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
    LightGBMExecutionParams
  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. def getInitScoreCol: String

    Permalink

    Definition Classes
    HasInitScoreCol
  51. def getIsProvideTrainingMetric: Boolean

    Permalink
    Definition Classes
    LightGBMParams
  52. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  53. def getLambdaL1: Double

    Permalink
    Definition Classes
    LightGBMParams
  54. def getLambdaL2: Double

    Permalink
    Definition Classes
    LightGBMParams
  55. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams
  56. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams
  57. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  58. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  59. def getModel(trainParams: TrainParams, lightGBMBooster: LightGBMBooster): LightGBMRegressionModel

    Permalink

    Gets the trained model given the train parameters and booster.

    Gets the trained model given the train parameters and booster.

    returns

    trained model.

    Definition Classes
    LightGBMRegressorLightGBMBase
  60. def getModelString: String

    Permalink
    Definition Classes
    LightGBMParams
  61. def getNumBatches: Int

    Permalink
    Definition Classes
    LightGBMParams
  62. def getNumIterations: Int

    Permalink
    Definition Classes
    LightGBMParams
  63. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  64. def getObjective: String

    Permalink
    Definition Classes
    LightGBMParams
  65. def getOptGroupCol: Option[String]

    Permalink

    Optional group column for Ranking, set to None by default.

    Optional group column for Ranking, set to None by default.

    returns

    None

    Attributes
    protected
    Definition Classes
    LightGBMBase
  66. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  67. def getParallelism: String

    Permalink
    Definition Classes
    LightGBMExecutionParams
  68. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  69. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  70. def getTimeout: Double

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

    Permalink

    Gets the training parameters.

    Gets the training parameters.

    returns

    train parameters.

    Definition Classes
    LightGBMRegressorLightGBMBase
  72. def getTweedieVariancePower: Double

    Permalink
  73. def getUseBarrierExecutionMode: Boolean

    Permalink
    Definition Classes
    LightGBMExecutionParams
  74. def getValidationIndicatorCol: String

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  75. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  76. def getWeightCol: String

    Permalink

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  80. val initScoreCol: Param[String]

    Permalink

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  81. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

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

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

    Permalink
    Definition Classes
    Any
  86. val isProvideTrainingMetric: BooleanParam

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

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

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

    Permalink
    Definition Classes
    HasLabelCol
  90. val lambdaL1: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  91. val lambdaL2: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  92. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  93. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  106. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  107. val minSumHessianInLeaf: DoubleParam

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  112. val numBatches: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  113. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  114. val numLeaves: IntParam

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

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

    Permalink
    Definition Classes
    LightGBMExecutionParams
  117. lazy val params: Array[Param[_]]

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

    Permalink
    Definition Classes
    HasPredictionCol
  119. def preprocessData(dataset: DataFrame): DataFrame

    Permalink

    Allow algorithm specific preprocessing of dataset.

    Allow algorithm specific preprocessing of dataset.

    dataset

    The dataset to preprocess prior to training.

    returns

    The preprocessed data.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  120. def save(path: String): Unit

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMExecutionParams
  135. def setEarlyStoppingRound(value: Int): LightGBMRegressor.this.type

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

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

    Permalink
    Definition Classes
    Predictor
  138. def setInitScoreCol(value: String): LightGBMRegressor.this.type

    Permalink

    Definition Classes
    HasInitScoreCol
  139. def setLabelCol(value: String): LightGBMRegressor

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMExecutionParams
  152. def setPredictionCol(value: String): LightGBMRegressor

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

    Permalink
    Definition Classes
    LightGBMExecutionParams
  154. def setTweedieVariancePower(value: Double): LightGBMRegressor.this.type

    Permalink
  155. def setUseBarrierExecutionMode(value: Boolean): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  156. def setValidationIndicatorCol(value: String): LightGBMRegressor.this.type

    Permalink

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

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

    Permalink

    Definition Classes
    HasWeightCol
  159. def setisProvideTrainingMetric(value: Boolean): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams
  160. def stringFromTrainedModel(model: LightGBMRegressionModel): String

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

    Permalink
    Definition Classes
    AnyRef
  162. val timeout: DoubleParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  163. def toString(): String

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

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

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

    Permalink
  168. val uid: String

    Permalink

    The unique ID.

    The unique ID.

    Definition Classes
    LightGBMRegressor → Identifiable
  169. val useBarrierExecutionMode: BooleanParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  170. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

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

    Permalink

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  172. val verbosity: IntParam

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

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  177. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from LightGBMParams

Inherited from LightGBMExecutionParams

Inherited from HasInitScoreCol

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 HasFeaturesCol

Inherited from HasLabelCol

Inherited from Estimator[LightGBMRegressionModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped