Class/Object

com.microsoft.ml.spark

LightGBMRegressor

Related Docs: object LightGBMRegressor | package spark

Permalink

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

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
LightGBMParams, 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. LightGBMParams
  3. HasWeightCol
  4. DefaultParamsWritable
  5. MLWritable
  6. Wrappable
  7. BaseRegressor
  8. Regressor
  9. Predictor
  10. PredictorParams
  11. HasPredictionCol
  12. HasFeaturesCol
  13. HasLabelCol
  14. Estimator
  15. PipelineStage
  16. Logging
  17. Params
  18. Serializable
  19. Serializable
  20. Identifiable
  21. AnyRef
  22. 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. final def clear(param: Param[_]): LightGBMRegressor.this.type

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  16. val earlyStoppingRound: IntParam

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

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

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

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

    Permalink
    Definition Classes
    Params
  21. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]

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

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

    Permalink
    Definition Classes
    Params
  24. val featureFraction: DoubleParam

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  32. def getAlpha: Double

    Permalink
  33. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  34. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams
  35. def getBaggingSeed: Int

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

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

    Permalink
    Definition Classes
    Params
  38. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMParams
  39. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMParams
  40. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMParams
  41. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  42. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  43. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams
  44. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams
  45. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  46. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  47. def getModelString: String

    Permalink
    Definition Classes
    LightGBMParams
  48. def getNumIterations: Int

    Permalink
    Definition Classes
    LightGBMParams
  49. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  50. def getObjective: String

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

    Permalink
    Definition Classes
    Params
  52. def getParallelism: String

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

    Permalink
    Definition Classes
    Params
  54. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  55. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams
  56. def getTweedieVariancePower: Double

    Permalink
  57. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  58. def getWeightCol: String

    Permalink

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasLabelCol
  69. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  70. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  83. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  84. val minSumHessianInLeaf: DoubleParam

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  89. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  90. val numLeaves: IntParam

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Predictor
  110. def setLearningRate(value: Double): LightGBMRegressor.this.type

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  122. def setVerbosity(value: Int): LightGBMRegressor.this.type

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  125. val timeout: DoubleParam

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

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

    Permalink

    Trains the LightGBM Regression model.

    Trains the LightGBM Regression model.

    dataset

    The input dataset to train.

    returns

    The trained model.

    Attributes
    protected
    Definition Classes
    LightGBMRegressor → Predictor
  128. def transformSchema(schema: StructType): StructType

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

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

    Permalink
  131. val uid: String

    Permalink

    The unique ID.

    The unique ID.

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

    Permalink
    Attributes
    protected
    Definition Classes
    PredictorParams
  133. val verbosity: IntParam

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

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

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