Packages

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

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:

  • regression_l2, L2 loss, alias=regression, mean_squared_error, mse, l2_root, root_mean_squared_error, rmse
  • regression_l1, L1 loss, alias=mean_absolute_error, mae
  • huber, Huber loss
  • fair, Fair loss
  • poisson, Poisson regression
  • quantile, Quantile regression
  • mape, MAPE loss, alias=mean_absolute_percentage_error
  • gamma, Gamma regression with log-link. It might be useful, e.g., for modeling insurance claims severity, or for any target that might be gamma-distributed
  • tweedie, Tweedie regression with log-link. It might be useful, e.g., for modeling total loss in insurance, or for any target that might be tweedie-distributed
Linear Supertypes
LightGBMBase[LightGBMRegressionModel], BasicLogging, LightGBMParams, LightGBMObjectiveParams, LightGBMPredictionParams, LightGBMDartParams, LightGBMLearnerParams, LightGBMBinParams, LightGBMFractionParams, LightGBMSlotParams, LightGBMExecutionParams, HasInitScoreCol, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, RWrappable, PythonWrappable, BaseWrappable, 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. BasicLogging
  4. LightGBMParams
  5. LightGBMObjectiveParams
  6. LightGBMPredictionParams
  7. LightGBMDartParams
  8. LightGBMLearnerParams
  9. LightGBMBinParams
  10. LightGBMFractionParams
  11. LightGBMSlotParams
  12. LightGBMExecutionParams
  13. HasInitScoreCol
  14. HasValidationIndicatorCol
  15. HasWeightCol
  16. DefaultParamsWritable
  17. MLWritable
  18. Wrappable
  19. RWrappable
  20. PythonWrappable
  21. BaseWrappable
  22. BaseRegressor
  23. Regressor
  24. Predictor
  25. PredictorParams
  26. HasPredictionCol
  27. HasFeaturesCol
  28. HasLabelCol
  29. Estimator
  30. PipelineStage
  31. Logging
  32. Params
  33. Serializable
  34. Serializable
  35. Identifiable
  36. AnyRef
  37. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LightGBMRegressor()
  2. new LightGBMRegressor(uid: String)

    uid

    The unique ID.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMRegressionModel): Unit
    Definition Classes
    LightGBMBase
  6. val alpha: DoubleParam
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val baggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  9. val baggingFreq: IntParam
    Definition Classes
    LightGBMParams
  10. val baggingSeed: IntParam
    Definition Classes
    LightGBMParams
  11. def beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMRegressionModel]): Unit
    Definition Classes
    LightGBMBase
  12. val binSampleCount: IntParam
    Definition Classes
    LightGBMBinParams
  13. val boostFromAverage: BooleanParam
    Definition Classes
    LightGBMParams
  14. val boostingType: Param[String]
    Definition Classes
    LightGBMParams
  15. def castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  16. val categoricalSlotIndexes: IntArrayParam
    Definition Classes
    LightGBMSlotParams
  17. val categoricalSlotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  18. val chunkSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  19. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  20. final def clear(param: Param[_]): LightGBMRegressor.this.type
    Definition Classes
    Params
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  23. def copy(extra: ParamMap): LightGBMRegressor
    Definition Classes
    LightGBMRegressor → Predictor → Estimator → PipelineStage → Params
  24. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  25. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  26. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  27. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  28. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  29. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  30. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  31. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  34. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  35. def explainParams(): String
    Definition Classes
    Params
  36. def extractInstances(dataset: Dataset[_], validateInstance: (Instance) ⇒ Unit): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  37. def extractInstances(dataset: Dataset[_]): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  38. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]
    Attributes
    protected
    Definition Classes
    Predictor
  39. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  40. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  41. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  42. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  43. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  44. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  45. def fit(dataset: Dataset[_]): LightGBMRegressionModel
    Definition Classes
    Predictor → Estimator
  46. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMRegressionModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  47. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMRegressionModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  48. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMRegressionModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  49. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  50. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  51. def getAlpha: Double
  52. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  53. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  54. def getBaggingSeed: Int
    Definition Classes
    LightGBMParams
  55. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  56. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  57. def getBoostingType: String
    Definition Classes
    LightGBMParams
  58. def getCategoricalIndexes(featuresSchema: StructField): Array[Int]

    Retrieves the categorical indexes in the features column.

    Retrieves the categorical indexes in the features column.

    featuresSchema

    The schema of the features column

    returns

    the categorical indexes in the features column.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  59. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  60. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  61. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  62. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  63. def getColumnParams: ColumnParams
    Attributes
    protected
    Definition Classes
    LightGBMBase
  64. def getDartParams: DartModeParams

    Constructs the DartModeParams

    Constructs the DartModeParams

    returns

    DartModeParams object containing parameters related to dart mode.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  65. def getDatasetParams(categoricalIndexes: Array[Int], numThreads: Int): String
    Definition Classes
    LightGBMBase
  66. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  67. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  68. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  69. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  70. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  71. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  72. def getExecutionParams: ExecutionParams

    Constructs the ExecutionParams.

    Constructs the ExecutionParams.

    returns

    ExecutionParams object containing parameters related to LightGBM execution.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  73. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  74. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  75. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  76. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  77. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  78. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  79. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  80. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  81. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  82. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  83. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  84. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  85. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  86. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  87. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  88. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  89. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  90. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  91. def getMetric: String
    Definition Classes
    LightGBMParams
  92. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  93. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  94. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  95. def getModel(trainParams: TrainParams, lightGBMBooster: LightGBMBooster): LightGBMRegressionModel

    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
    LightGBMRegressor → LightGBMBase
  96. def getModelString: String
    Definition Classes
    LightGBMParams
  97. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  98. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  99. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  100. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  101. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  102. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  103. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  104. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  105. def getOptGroupCol: Option[String]

    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
  106. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  107. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  108. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  109. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  110. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  111. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  112. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  113. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  114. def getSlotNamesWithMetadata(featuresSchema: StructField): Option[Array[String]]
    Definition Classes
    LightGBMBase
  115. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  116. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  117. def getTrainParams(numTasks: Int, dataset: Dataset[_], numTasksPerExec: Int): TrainParams

    Gets the training parameters.

    Gets the training parameters.

    numTasks

    The total number of tasks.

    dataset

    The training dataset.

    numTasksPerExec

    The number of tasks per executor.

    returns

    train parameters.

    Definition Classes
    LightGBMRegressor → LightGBMBase
  118. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
    Definition Classes
    LightGBMBase
  119. def getTweedieVariancePower: Double
  120. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  121. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  122. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  123. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  124. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  125. def getWeightCol: String

    Definition Classes
    HasWeightCol
  126. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  127. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  128. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  129. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  130. val improvementTolerance: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  131. val initScoreCol: Param[String]

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  132. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  133. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  134. def innerTrain(dataset: Dataset[_], batchIndex: Int): LightGBMRegressionModel

    Inner train method for LightGBM learners.

    Inner train method for LightGBM learners. Calculates the number of workers, creates a driver thread, and runs mapPartitions on the dataset.

    dataset

    The dataset to train on.

    batchIndex

    In running in batch training mode, gets the batch number.

    returns

    The LightGBM Model from the trained LightGBM Booster.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  135. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  136. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  137. val isProvideTrainingMetric: BooleanParam
    Definition Classes
    LightGBMParams
  138. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  139. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  140. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  141. val lambdaL1: DoubleParam
    Definition Classes
    LightGBMParams
  142. val lambdaL2: DoubleParam
    Definition Classes
    LightGBMParams
  143. val leafPredictionCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  144. val learningRate: DoubleParam
    Definition Classes
    LightGBMParams
  145. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  146. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  147. def logClass(): Unit
    Definition Classes
    BasicLogging
  148. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  149. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  150. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  151. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  152. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  153. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  154. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  155. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  156. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  157. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  158. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  159. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  160. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  161. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  162. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  163. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  164. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  165. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  166. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  167. val matrixType: Param[String]
    Definition Classes
    LightGBMExecutionParams
  168. val maxBin: IntParam
    Definition Classes
    LightGBMBinParams
  169. val maxBinByFeature: IntArrayParam
    Definition Classes
    LightGBMParams
  170. val maxDeltaStep: DoubleParam
    Definition Classes
    LightGBMParams
  171. val maxDepth: IntParam
    Definition Classes
    LightGBMParams
  172. val maxDrop: IntParam
    Definition Classes
    LightGBMDartParams
  173. val metric: Param[String]
    Definition Classes
    LightGBMParams
  174. val minDataInLeaf: IntParam
    Definition Classes
    LightGBMParams
  175. val minGainToSplit: DoubleParam
    Definition Classes
    LightGBMParams
  176. val minSumHessianInLeaf: DoubleParam
    Definition Classes
    LightGBMParams
  177. val modelString: Param[String]
    Definition Classes
    LightGBMParams
  178. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  179. val negBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  180. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  181. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  182. val numBatches: IntParam
    Definition Classes
    LightGBMExecutionParams
  183. val numIterations: IntParam
    Definition Classes
    LightGBMParams
  184. val numLeaves: IntParam
    Definition Classes
    LightGBMParams
  185. val numTasks: IntParam
    Definition Classes
    LightGBMExecutionParams
  186. val numThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  187. val objective: Param[String]
    Definition Classes
    LightGBMObjectiveParams
  188. val parallelism: Param[String]
    Definition Classes
    LightGBMExecutionParams
  189. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  190. val posBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  191. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  192. def prepareDataframe(dataset: Dataset[_], numTasks: Int): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  193. def preprocessData(dataset: DataFrame): DataFrame

    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
  194. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  195. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  196. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  197. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  198. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  199. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  200. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  201. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  202. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  203. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  204. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  205. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  206. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  207. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  208. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  209. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  210. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  211. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  212. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  213. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  214. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  215. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  216. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  217. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  218. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  219. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  220. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  221. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  222. val repartitionByGroupingColumn: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  223. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  224. final def set(paramPair: ParamPair[_]): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  225. final def set(param: String, value: Any): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  226. final def set[T](param: Param[T], value: T): LightGBMRegressor.this.type
    Definition Classes
    Params
  227. def setAlpha(value: Double): LightGBMRegressor.this.type
  228. def setBaggingFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  229. def setBaggingFreq(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  230. def setBaggingSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  231. def setBinSampleCount(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMBinParams
  232. def setBoostFromAverage(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  233. def setBoostingType(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  234. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSlotParams
  235. def setCategoricalSlotNames(value: Array[String]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSlotParams
  236. def setChunkSize(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  237. final def setDefault(paramPairs: ParamPair[_]*): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  238. final def setDefault[T](param: Param[T], value: T): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  239. def setDefaultListenPort(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  240. def setDelegate(delegate: LightGBMDelegate): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  241. def setDriverListenPort(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  242. def setDropRate(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  243. def setEarlyStoppingRound(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  244. def setFObj(value: FObjTrait): LightGBMRegressor.this.type
    Definition Classes
    LightGBMObjectiveParams
  245. def setFeatureFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  246. def setFeaturesCol(value: String): LightGBMRegressor
    Definition Classes
    Predictor
  247. def setFeaturesShapCol(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMPredictionParams
  248. def setImprovementTolerance(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  249. def setInitScoreCol(value: String): LightGBMRegressor.this.type

    Definition Classes
    HasInitScoreCol
  250. def setIsProvideTrainingMetric(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  251. def setLabelCol(value: String): LightGBMRegressor
    Definition Classes
    Predictor
  252. def setLambdaL1(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  253. def setLambdaL2(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  254. def setLeafPredictionCol(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMPredictionParams
  255. def setLearningRate(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  256. def setMatrixType(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  257. def setMaxBin(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMBinParams
  258. def setMaxBinByFeature(value: Array[Int]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  259. def setMaxDeltaStep(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  260. def setMaxDepth(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  261. def setMaxDrop(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  262. def setMetric(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  263. def setMinDataInLeaf(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  264. def setMinGainToSplit(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  265. def setMinSumHessianInLeaf(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  266. def setModelString(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  267. def setNegBaggingFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  268. def setNumBatches(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  269. def setNumIterations(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  270. def setNumLeaves(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  271. def setNumTasks(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  272. def setNumThreads(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  273. def setObjective(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMObjectiveParams
  274. def setParallelism(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  275. def setPosBaggingFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  276. def setPredictionCol(value: String): LightGBMRegressor
    Definition Classes
    Predictor
  277. def setRepartitionByGroupingColumn(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  278. def setSkipDrop(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  279. def setSlotNames(value: Array[String]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSlotParams
  280. def setTimeout(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  281. def setTopK(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  282. def setTweedieVariancePower(value: Double): LightGBMRegressor.this.type
  283. def setUniformDrop(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  284. def setUseBarrierExecutionMode(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  285. def setUseSingleDatasetMode(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  286. def setValidationIndicatorCol(value: String): LightGBMRegressor.this.type

    Definition Classes
    HasValidationIndicatorCol
  287. def setVerbosity(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  288. def setWeightCol(value: String): LightGBMRegressor.this.type

    Definition Classes
    HasWeightCol
  289. def setXGBoostDartMode(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  290. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  291. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  292. def stringFromTrainedModel(model: LightGBMRegressionModel): String
    Definition Classes
    LightGBMRegressor → LightGBMBase
  293. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  294. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  295. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  296. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  297. def train(dataset: Dataset[_]): LightGBMRegressionModel

    Trains the LightGBM model.

    Trains the LightGBM model. If batches are specified, breaks training dataset into batches for training.

    dataset

    The input dataset to train.

    returns

    The trained model.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  298. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  299. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  300. val tweedieVariancePower: DoubleParam
  301. val uid: String
    Definition Classes
    LightGBMRegressor → BasicLogging → Identifiable
  302. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  303. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  304. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  305. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
    Attributes
    protected
    Definition Classes
    PredictorParams
  306. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  307. val ver: String
    Definition Classes
    BasicLogging
  308. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  309. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  310. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  311. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  312. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  313. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable
  314. val xgboostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams

Inherited from LightGBMBase[LightGBMRegressionModel]

Inherited from BasicLogging

Inherited from LightGBMParams

Inherited from LightGBMObjectiveParams

Inherited from LightGBMPredictionParams

Inherited from LightGBMDartParams

Inherited from LightGBMLearnerParams

Inherited from LightGBMBinParams

Inherited from LightGBMFractionParams

Inherited from LightGBMSlotParams

Inherited from LightGBMExecutionParams

Inherited from HasInitScoreCol

Inherited from HasValidationIndicatorCol

Inherited from HasWeightCol

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

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