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, LightGBMPerformance, LightGBMParams, LightGBMCategoricalParams, LightGBMSeedParams, LightGBMObjectiveParams, LightGBMPredictionParams, LightGBMDartParams, LightGBMDatasetParams, LightGBMLearnerParams, LightGBMBinParams, LightGBMFractionParams, LightGBMSlotParams, LightGBMExecutionParams, HasInitScoreCol, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, DotnetWrappable, 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. LightGBMPerformance
  5. LightGBMParams
  6. LightGBMCategoricalParams
  7. LightGBMSeedParams
  8. LightGBMObjectiveParams
  9. LightGBMPredictionParams
  10. LightGBMDartParams
  11. LightGBMDatasetParams
  12. LightGBMLearnerParams
  13. LightGBMBinParams
  14. LightGBMFractionParams
  15. LightGBMSlotParams
  16. LightGBMExecutionParams
  17. HasInitScoreCol
  18. HasValidationIndicatorCol
  19. HasWeightCol
  20. DefaultParamsWritable
  21. MLWritable
  22. Wrappable
  23. DotnetWrappable
  24. RWrappable
  25. PythonWrappable
  26. BaseWrappable
  27. BaseRegressor
  28. Regressor
  29. Predictor
  30. PredictorParams
  31. HasPredictionCol
  32. HasFeaturesCol
  33. HasLabelCol
  34. Estimator
  35. PipelineStage
  36. Logging
  37. Params
  38. Serializable
  39. Serializable
  40. Identifiable
  41. AnyRef
  42. 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 addCustomTrainParams(params: BaseTrainParams, dataset: Dataset[_]): BaseTrainParams
    Attributes
    protected
    Definition Classes
    LightGBMBase
  6. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMRegressionModel): Unit
    Definition Classes
    LightGBMBase
  7. val alpha: DoubleParam
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val baggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  10. val baggingFreq: IntParam
    Definition Classes
    LightGBMParams
  11. val baggingSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  12. def beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMRegressionModel]): Unit
    Definition Classes
    LightGBMBase
  13. val binSampleCount: IntParam
    Definition Classes
    LightGBMBinParams
  14. val boostFromAverage: BooleanParam
    Definition Classes
    LightGBMParams
  15. val boostingType: Param[String]
    Definition Classes
    LightGBMParams
  16. def calculateColumnStatistics(dataframe: DataFrame, measures: InstrumentationMeasures): (Int, Int)

    Extract column counts from the dataset.

    Extract column counts from the dataset.

    dataframe

    The dataset to train on.

    returns

    The number of feature columns and initial score classes

    Attributes
    protected
    Definition Classes
    LightGBMBase
  17. def calculateRowStatistics(dataframe: DataFrame, trainingParams: BaseTrainParams, numCols: Int, measures: InstrumentationMeasures): (Array[Row], Array[Long])

    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.

    dataframe

    The dataset to train on.

    trainingParams

    The training parameters.

    numCols

    The number of feature columns.

    returns

    The serialized Dataset reference and an array of partition counts.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  18. def castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  19. val catSmooth: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  20. val categoricalSlotIndexes: IntArrayParam
    Definition Classes
    LightGBMSlotParams
  21. val categoricalSlotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  22. val catl2: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  23. val chunkSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  24. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  25. final def clear(param: Param[_]): LightGBMRegressor.this.type
    Definition Classes
    Params
  26. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  28. def copy(extra: ParamMap): LightGBMRegressor
    Definition Classes
    LightGBMRegressor → Predictor → Estimator → PipelineStage → Params
  29. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  30. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  31. val dataRandomSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  32. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  33. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  34. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  35. val deterministic: BooleanParam
    Definition Classes
    LightGBMSeedParams
  36. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  37. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  38. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  39. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  40. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  41. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  42. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  43. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  44. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  45. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  46. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  47. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  48. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  49. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  50. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  51. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  52. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  53. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  54. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  55. val dropSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  56. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  57. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  59. def executePartitionTasks(ctx: TrainingContext, dataframe: DataFrame, measures: InstrumentationMeasures): LightGBMBooster
    Attributes
    protected
    Definition Classes
    LightGBMBase
  60. def executeTraining(dataframe: DataFrame, validationData: Option[Broadcast[Array[Row]]], broadcastedSampleData: Option[Broadcast[Array[Row]]], partitionCounts: Option[Array[Long]], trainParams: BaseTrainParams, numCols: Int, numInitValueClasses: Int, batchIndex: Int, numTasks: Int, numTasksPerExecutor: Int, measures: InstrumentationMeasures): LightGBMRegressionModel

    Run a parallel job via map partitions to initialize the native library and network, translate the data to the LightGBM in-memory representation and train the models.

    Run a parallel job via map partitions to initialize the native library and network, translate the data to the LightGBM in-memory representation and train the models.

    dataframe

    The dataset to train on.

    validationData

    The dataset to use as validation. (optional)

    broadcastedSampleData

    Sample data to use for streaming mode Dataset creation (optional).

    partitionCounts

    The count per partition for streaming mode (optional).

    trainParams

    Training parameters.

    numCols

    Number of columns.

    numInitValueClasses

    Number of classes for initial values (used only for multiclass).

    batchIndex

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

    numTasks

    Number of tasks/partitions.

    numTasksPerExecutor

    Number of tasks per executor.

    measures

    Instrumentation measures to populate.

    returns

    The LightGBM Model from the trained LightGBM Booster.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  61. val executionMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  62. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  63. def explainParams(): String
    Definition Classes
    Params
  64. val extraSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  65. def extractInstances(dataset: Dataset[_], validateInstance: (Instance) ⇒ Unit): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  66. def extractInstances(dataset: Dataset[_]): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  67. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]
    Attributes
    protected
    Definition Classes
    Predictor
  68. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  69. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  70. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  71. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  72. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  73. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  74. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  75. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  76. def fit(dataset: Dataset[_]): LightGBMRegressionModel
    Definition Classes
    Predictor → Estimator
  77. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMRegressionModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  78. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMRegressionModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  79. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMRegressionModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  80. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  81. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  82. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  83. def getAlpha: Double
  84. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  85. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  86. def getBaggingSeed: Int
    Definition Classes
    LightGBMSeedParams
  87. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  88. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  89. def getBoostingType: String
    Definition Classes
    LightGBMParams
  90. def getCatSmooth: Double
    Definition Classes
    LightGBMCategoricalParams
  91. 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
  92. def getCategoricalParams: CategoricalParams

    Constructs the CategoricalParams.

    Constructs the CategoricalParams.

    returns

    CategoricalParams object containing the parameters related to LightGBM categorical features.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  93. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  94. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  95. def getCatl2: Double
    Definition Classes
    LightGBMCategoricalParams
  96. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  97. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  98. def getColumnParams: ColumnParams

    Constructs the ColumnParams.

    Constructs the ColumnParams.

    returns

    ColumnParams object containing the parameters related to LightGBM columns.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  99. def getDartParams: DartModeParams

    Constructs the DartModeParams

    Constructs the DartModeParams

    returns

    DartModeParams object containing parameters related to dart mode.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  100. def getDataRandomSeed: Int
    Definition Classes
    LightGBMSeedParams
  101. def getDatasetCreationParams(categoricalIndexes: Array[Int], numThreads: Int): String
    Definition Classes
    LightGBMBase
  102. def getDatasetParams: DatasetParams

    Constructs the DatasetParams.

    Constructs the DatasetParams.

    returns

    DatasetParams object containing parameters related to LightGBM Dataset parameters.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  103. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  104. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  105. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  106. def getDeterministic: Boolean
    Definition Classes
    LightGBMSeedParams
  107. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  108. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  109. def getDropSeed: Int
    Definition Classes
    LightGBMSeedParams
  110. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  111. def getExecutionMode: String
    Definition Classes
    LightGBMExecutionParams
  112. def getExecutionParams(numTasksPerExec: Int): ExecutionParams

    Constructs the ExecutionParams.

    Constructs the ExecutionParams.

    returns

    ExecutionParams object containing parameters related to LightGBM execution.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  113. def getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  114. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  115. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  116. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  117. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  118. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  119. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  120. def getGeneralParams(numTasks: Int, featuresSchema: StructField): GeneralParams

    Constructs the GeneralParams.

    Constructs the GeneralParams.

    returns

    GeneralParams object containing parameters related to general LightGBM parameters.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  121. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  122. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  123. def getIsEnableSparse: Boolean
    Definition Classes
    LightGBMDatasetParams
  124. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  125. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  126. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  127. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  128. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  129. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  130. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  131. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  132. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  133. def getMaxCatThreshold: Int
    Definition Classes
    LightGBMCategoricalParams
  134. def getMaxCatToOnehot: Int
    Definition Classes
    LightGBMCategoricalParams
  135. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  136. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  137. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  138. def getMetric: String
    Definition Classes
    LightGBMParams
  139. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  140. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  141. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  142. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  143. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  144. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  145. def getModel(trainParams: BaseTrainParams, 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
  146. def getModelString: String
    Definition Classes
    LightGBMParams
  147. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  148. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  149. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  150. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  151. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  152. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  153. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  154. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  155. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  156. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  157. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  158. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  159. 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
  160. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  161. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  162. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  163. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  164. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  165. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  166. def getPerformanceMeasures: Option[InstrumentationMeasures]

    In the common case of 1 batch, there is only 1 measure, so this is a convenience method.

    In the common case of 1 batch, there is only 1 measure, so this is a convenience method.

    Definition Classes
    LightGBMPerformance
  167. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  168. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  169. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  170. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  171. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  172. def getSeedParams: SeedParams

    Constructs the SeedParams.

    Constructs the SeedParams.

    returns

    SeedParams object containing the parameters related to LightGBM seeds and determinism.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  173. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  174. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  175. def getSlotNamesWithMetadata(featuresSchema: StructField): Option[Array[String]]
    Definition Classes
    LightGBMBase
  176. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  177. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  178. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  179. def getTrainParams(numTasks: Int, featuresSchema: StructField, numTasksPerExec: Int): BaseTrainParams

    Gets the training parameters.

    Gets the training parameters.

    numTasks

    The total number of tasks.

    featuresSchema

    The features column schema.

    numTasksPerExec

    The number of tasks per executor.

    returns

    train parameters.

    Definition Classes
    LightGBMRegressor → LightGBMBase
  180. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
    Definition Classes
    LightGBMBase
  181. def getTrainingContext(dataframe: DataFrame, validationData: Option[Broadcast[Array[Row]]], broadcastedSampleData: Option[Broadcast[Array[Row]]], partitionCounts: Option[Array[Long]], trainParams: BaseTrainParams, numCols: Int, numInitValueClasses: Int, batchIndex: Int, numTasksPerExecutor: Int, networkManager: NetworkManager): TrainingContext

    Get the object that holds all relevant context information for the training session.

    Get the object that holds all relevant context information for the training session.

    dataframe

    The dataset to train on.

    validationData

    The dataset to use as validation. (optional)

    broadcastedSampleData

    Sample data to use for streaming mode Dataset creation (optional).

    partitionCounts

    The count per partition for streaming mode (optional).

    trainParams

    Training parameters.

    numCols

    Number of columns.

    numInitValueClasses

    Number of classes for initial values (used only for multiclass).

    batchIndex

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

    numTasksPerExecutor

    Number of tasks per executor.

    networkManager

    The network manager.

    returns

    The context of the training session.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  182. def getTweedieVariancePower: Double
  183. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  184. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  185. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  186. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  187. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  188. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  189. def getWeightCol: String

    Definition Classes
    HasWeightCol
  190. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  191. def getZeroAsMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  192. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  193. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  194. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  195. val improvementTolerance: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  196. def initPerformanceMeasures(batchCount: Int): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  197. val initScoreCol: Param[String]

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  198. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  199. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  200. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  201. val isEnableSparse: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  202. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  203. val isProvideTrainingMetric: BooleanParam
    Definition Classes
    LightGBMParams
  204. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  205. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  206. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  207. val lambdaL1: DoubleParam
    Definition Classes
    LightGBMParams
  208. val lambdaL2: DoubleParam
    Definition Classes
    LightGBMParams
  209. val leafPredictionCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  210. val learningRate: DoubleParam
    Definition Classes
    LightGBMParams
  211. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  212. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  213. def logClass(): Unit
    Definition Classes
    BasicLogging
  214. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  215. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  216. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  217. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  218. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  219. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  220. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  221. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  222. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  223. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  224. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  225. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  226. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  227. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  228. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  229. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  230. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  231. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  232. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  233. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  234. val matrixType: Param[String]
    Definition Classes
    LightGBMExecutionParams
  235. val maxBin: IntParam
    Definition Classes
    LightGBMBinParams
  236. val maxBinByFeature: IntArrayParam
    Definition Classes
    LightGBMParams
  237. val maxCatThreshold: IntParam
    Definition Classes
    LightGBMCategoricalParams
  238. val maxCatToOnehot: IntParam
    Definition Classes
    LightGBMCategoricalParams
  239. val maxDeltaStep: DoubleParam
    Definition Classes
    LightGBMParams
  240. val maxDepth: IntParam
    Definition Classes
    LightGBMParams
  241. val maxDrop: IntParam
    Definition Classes
    LightGBMDartParams
  242. val metric: Param[String]
    Definition Classes
    LightGBMParams
  243. val microBatchSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  244. val minDataInLeaf: IntParam
    Definition Classes
    LightGBMParams
  245. val minDataPerBin: IntParam
    Definition Classes
    LightGBMParams
  246. val minDataPerGroup: IntParam
    Definition Classes
    LightGBMCategoricalParams
  247. val minGainToSplit: DoubleParam
    Definition Classes
    LightGBMParams
  248. val minSumHessianInLeaf: DoubleParam
    Definition Classes
    LightGBMParams
  249. val modelString: Param[String]
    Definition Classes
    LightGBMParams
  250. val monotoneConstraints: IntArrayParam
    Definition Classes
    LightGBMLearnerParams
  251. val monotoneConstraintsMethod: Param[String]
    Definition Classes
    LightGBMLearnerParams
  252. val monotonePenalty: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  253. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  254. val negBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  255. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  256. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  257. val numBatches: IntParam
    Definition Classes
    LightGBMExecutionParams
  258. val numIterations: IntParam
    Definition Classes
    LightGBMParams
  259. val numLeaves: IntParam
    Definition Classes
    LightGBMParams
  260. val numTasks: IntParam
    Definition Classes
    LightGBMExecutionParams
  261. val numThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  262. val objective: Param[String]
    Definition Classes
    LightGBMObjectiveParams
  263. val objectiveSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  264. val otherRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  265. val parallelism: Param[String]
    Definition Classes
    LightGBMExecutionParams
  266. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  267. val passThroughArgs: Param[String]
    Definition Classes
    LightGBMExecutionParams
  268. val posBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  269. val predictDisableShapeCheck: BooleanParam
    Definition Classes
    LightGBMPredictionParams
  270. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  271. def prepareDataframe(dataset: Dataset[_], numTasks: Int): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  272. def preprocessData(df: DataFrame): DataFrame

    Allow algorithm specific preprocessing of dataset.

    Allow algorithm specific preprocessing of dataset.

    df

    The dataframe to preprocess prior to training.

    returns

    The preprocessed data.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  273. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  274. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  275. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  276. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  277. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  278. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  279. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  280. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  281. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  282. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  283. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  284. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  285. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  286. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  287. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  288. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  289. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  290. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  291. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  292. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  293. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  294. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  295. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  296. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  297. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  298. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  299. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  300. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  301. val repartitionByGroupingColumn: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  302. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  303. val seed: IntParam
    Definition Classes
    LightGBMSeedParams
  304. final def set(paramPair: ParamPair[_]): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  305. final def set(param: String, value: Any): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  306. final def set[T](param: Param[T], value: T): LightGBMRegressor.this.type
    Definition Classes
    Params
  307. def setAlpha(value: Double): LightGBMRegressor.this.type
  308. def setBaggingFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  309. def setBaggingFreq(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  310. def setBaggingSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  311. def setBatchPerformanceMeasure(index: Int, measures: InstrumentationMeasures): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  312. def setBatchPerformanceMeasures(measures: Array[Option[InstrumentationMeasures]]): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  313. def setBinSampleCount(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMBinParams
  314. def setBoostFromAverage(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  315. def setBoostingType(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  316. def setCatSmooth(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMCategoricalParams
  317. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSlotParams
  318. def setCategoricalSlotNames(value: Array[String]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSlotParams
  319. def setCatl2(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMCategoricalParams
  320. def setChunkSize(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  321. def setDataRandomSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  322. final def setDefault(paramPairs: ParamPair[_]*): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  323. final def setDefault[T](param: Param[T], value: T): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  324. def setDefaultListenPort(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  325. def setDelegate(delegate: LightGBMDelegate): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  326. def setDeterministic(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  327. def setDriverListenPort(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  328. def setDropRate(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  329. def setDropSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  330. def setEarlyStoppingRound(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  331. def setExecutionMode(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  332. def setExtraSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  333. def setFObj(value: FObjTrait): LightGBMRegressor.this.type
    Definition Classes
    LightGBMObjectiveParams
  334. def setFeatureFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  335. def setFeatureFractionByNode(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  336. def setFeatureFractionSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  337. def setFeaturesCol(value: String): LightGBMRegressor
    Definition Classes
    Predictor
  338. def setFeaturesShapCol(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMPredictionParams
  339. def setImprovementTolerance(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  340. def setInitScoreCol(value: String): LightGBMRegressor.this.type

    Definition Classes
    HasInitScoreCol
  341. def setIsEnableSparse(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDatasetParams
  342. def setIsProvideTrainingMetric(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  343. def setLabelCol(value: String): LightGBMRegressor
    Definition Classes
    Predictor
  344. def setLambdaL1(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  345. def setLambdaL2(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  346. def setLeafPredictionCol(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMPredictionParams
  347. def setLearningRate(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  348. def setMatrixType(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  349. def setMaxBin(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMBinParams
  350. def setMaxBinByFeature(value: Array[Int]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  351. def setMaxCatThreshold(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMCategoricalParams
  352. def setMaxCatToOnehot(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMCategoricalParams
  353. def setMaxDeltaStep(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  354. def setMaxDepth(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  355. def setMaxDrop(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  356. def setMetric(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  357. def setMicroBatchSize(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  358. def setMinDataInLeaf(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  359. def setMinDataPerBin(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  360. def setMinDataPerGroup(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMCategoricalParams
  361. def setMinGainToSplit(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  362. def setMinSumHessianInLeaf(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  363. def setModelString(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  364. def setMonotoneConstraints(value: Array[Int]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  365. def setMonotoneConstraintsMethod(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  366. def setMonotonePenalty(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  367. def setNegBaggingFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  368. def setNumBatches(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  369. def setNumIterations(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  370. def setNumLeaves(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  371. def setNumTasks(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  372. def setNumThreads(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  373. def setObjective(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMObjectiveParams
  374. def setObjectiveSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  375. def setOtherRate(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  376. def setParallelism(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  377. def setPassThroughArgs(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  378. def setPosBaggingFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  379. def setPredictDisableShapeCheck(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMPredictionParams
  380. def setPredictionCol(value: String): LightGBMRegressor
    Definition Classes
    Predictor
  381. def setRepartitionByGroupingColumn(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  382. def setSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  383. def setSkipDrop(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  384. def setSlotNames(value: Array[String]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSlotParams
  385. def setTimeout(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  386. def setTopK(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  387. def setTopRate(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  388. def setTweedieVariancePower(value: Double): LightGBMRegressor.this.type
  389. def setUniformDrop(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  390. def setUseBarrierExecutionMode(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  391. def setUseMissing(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDatasetParams
  392. def setUseSingleDatasetMode(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  393. def setValidationIndicatorCol(value: String): LightGBMRegressor.this.type

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

    Definition Classes
    HasWeightCol
  396. def setXGBoostDartMode(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  397. def setZeroAsMissing(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDatasetParams
  398. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  399. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  400. def stringFromTrainedModel(model: LightGBMRegressionModel): String
    Definition Classes
    LightGBMRegressor → LightGBMBase
  401. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  402. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  403. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  404. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  405. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  406. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  407. 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
  408. def trainOneDataBatch(dataset: Dataset[_], batchIndex: Int, batchCount: 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
  409. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  410. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  411. val tweedieVariancePower: DoubleParam
  412. val uid: String
    Definition Classes
    LightGBMRegressor → BasicLogging → Identifiable
  413. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  414. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  415. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  416. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  417. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
    Attributes
    protected
    Definition Classes
    PredictorParams
  418. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  419. val ver: String
    Definition Classes
    BasicLogging
  420. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  421. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  422. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  423. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  424. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  425. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable
  426. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  427. val zeroAsMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams

Inherited from LightGBMBase[LightGBMRegressionModel]

Inherited from BasicLogging

Inherited from LightGBMPerformance

Inherited from LightGBMParams

Inherited from LightGBMCategoricalParams

Inherited from LightGBMSeedParams

Inherited from LightGBMObjectiveParams

Inherited from LightGBMPredictionParams

Inherited from LightGBMDartParams

Inherited from LightGBMDatasetParams

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 DotnetWrappable

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