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. 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 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 getNumIterations: Int

    Permalink
    Definition Classes
    LightGBMParams
  57. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  58. def getObjective: String

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

    Permalink
    Definition Classes
    Params
  60. def getParallelism: String

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

    Permalink
    Definition Classes
    Params
  62. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  63. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams
  64. def getTweedieVariancePower: Double

    Permalink
  65. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  66. def getWeightCol: String

    Permalink

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasLabelCol
  77. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  78. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    LightGBMParams
  91. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  92. val minSumHessianInLeaf: DoubleParam

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  97. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  98. val numLeaves: IntParam

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  137. val timeout: DoubleParam

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

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

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

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

    Permalink
  143. val uid: String

    Permalink

    The unique ID.

    The unique ID.

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

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

    Permalink
    Definition Classes
    LightGBMParams
  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. val weightCol: Param[String]

    Permalink

    The name of the weight column

    The name of the weight column

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