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:

Linear Supertypes
LightGBMParams, MMLParams, 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. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMRegressor
  2. LightGBMParams
  3. MMLParams
  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. 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. val alpha: DoubleParam

    Permalink

  19. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  20. val baggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams

  21. val baggingFreq: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  22. val baggingSeed: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  23. def chainedUid(origin: String): String

    Permalink
    Definition Classes
    Wrappable

  24. final def clear(param: Param[_]): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    Params

  25. def clone(): AnyRef

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

  26. def copy(extra: ParamMap): LightGBMRegressor

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  29. val defaultListenPort: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  30. val earlyStoppingRound: IntParam

    Permalink
    Definition Classes
    LightGBMParams

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

    Permalink
    Definition Classes
    AnyRef

  32. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Params

  34. def explainParams(): String

    Permalink
    Definition Classes
    Params

  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[_]): LightGBMRegressionModel

    Permalink
    Definition Classes
    Predictor → Estimator

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

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

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

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

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

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

    Permalink

  47. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMParams

  48. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams

  49. def getBaggingSeed: Int

    Permalink
    Definition Classes
    LightGBMParams

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

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Params

  52. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMParams

  53. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMParams

  54. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMParams

  55. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol

  56. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol

  57. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams

  58. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMParams

  59. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams

  60. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams

  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. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMParams

  69. def getTweedieVariancePower: Double

    Permalink

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

    Permalink
    Definition Classes
    Params

  71. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  72. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  74. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Definition Classes
    Params

  76. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Params

  78. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  79. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol

  80. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams

  81. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  82. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  83. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  84. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  85. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  86. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  87. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  88. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  89. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  90. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  91. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  92. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  93. val maxBin: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  94. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  95. val minSumHessianInLeaf: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams

  96. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  97. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  98. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  99. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  100. val numLeaves: IntParam

    Permalink
    Definition Classes
    LightGBMParams

  101. val objective: Param[String]

    Permalink
    Definition Classes
    LightGBMParams

  102. val parallelism: Param[String]

    Permalink
    Definition Classes
    LightGBMParams

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

    Permalink
    Definition Classes
    Wrappable

  104. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  105. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol

  106. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  107. final def set(paramPair: ParamPair[_]): LightGBMRegressor.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  108. final def set(param: String, value: Any): LightGBMRegressor.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  109. final def set[T](param: Param[T], value: T): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    Params

  110. def setAlpha(value: Double): LightGBMRegressor.this.type

    Permalink

  111. def setBaggingFraction(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  112. def setBaggingFreq(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  113. def setBaggingSeed(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  114. final def setDefault(paramPairs: ParamPair[_]*): LightGBMRegressor.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  116. def setDefaultListenPort(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  117. def setEarlyStoppingRound(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  118. def setFeatureFraction(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  119. def setFeaturesCol(value: String): LightGBMRegressor

    Permalink
    Definition Classes
    Predictor

  120. def setLabelCol(value: String): LightGBMRegressor

    Permalink
    Definition Classes
    Predictor

  121. def setLearningRate(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  122. def setMaxBin(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  123. def setMaxDepth(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  124. def setMinSumHessianInLeaf(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  125. def setNumIterations(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  126. def setNumLeaves(value: Int): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  127. def setObjective(value: String): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  128. def setParallelism(value: String): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  129. def setPredictionCol(value: String): LightGBMRegressor

    Permalink
    Definition Classes
    Predictor

  130. def setTimeout(value: Double): LightGBMRegressor.this.type

    Permalink
    Definition Classes
    LightGBMParams

  131. def setTweedieVariancePower(value: Double): LightGBMRegressor.this.type

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  133. val timeout: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams

  134. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

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

  136. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    Predictor → PipelineStage

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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  138. val tweedieVariancePower: DoubleParam

    Permalink

  139. val uid: String

    Permalink

    The unique ID.

    The unique ID.

    Definition Classes
    LightGBMRegressor → Identifiable

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

    Permalink
    Attributes
    protected
    Definition Classes
    PredictorParams

  141. final def wait(): Unit

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

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

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

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

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

  144. 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 BaseRegressor[Vector, LightGBMRegressor, LightGBMRegressionModel]

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

Members