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

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], SynapseMLLogging, 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. SynapseMLLogging
  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 getMaxNumClasses: Int
    Definition Classes
    LightGBMParams
  139. def getMaxStreamingOMPThreads: Int
    Definition Classes
    LightGBMExecutionParams
  140. def getMetric: String
    Definition Classes
    LightGBMParams
  141. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  142. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  143. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  144. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  145. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  146. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  147. 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
  148. def getModelString: String
    Definition Classes
    LightGBMParams
  149. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  150. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  151. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  152. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  153. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  154. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  155. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  156. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  157. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  158. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  159. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  160. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  161. 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
  162. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  163. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  164. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  165. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  166. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  167. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  168. 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
  169. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  170. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  171. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  172. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  173. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  174. 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
  175. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  176. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  177. def getSlotNamesWithMetadata(featuresSchema: StructField): Option[Array[String]]
    Definition Classes
    LightGBMBase
  178. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  179. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  180. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  181. 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
  182. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
    Definition Classes
    LightGBMBase
  183. 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
  184. def getTweedieVariancePower: Double
  185. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  186. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  187. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  188. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  189. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  190. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  191. def getWeightCol: String

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

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  200. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  201. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  202. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  203. val isEnableSparse: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  204. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  205. val isProvideTrainingMetric: BooleanParam
    Definition Classes
    LightGBMParams
  206. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  207. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  208. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  209. val lambdaL1: DoubleParam
    Definition Classes
    LightGBMParams
  210. val lambdaL2: DoubleParam
    Definition Classes
    LightGBMParams
  211. val leafPredictionCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  212. val learningRate: DoubleParam
    Definition Classes
    LightGBMParams
  213. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  214. def logBase(info: SynapseMLLogInfo): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  215. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  216. def logClass(): Unit
    Definition Classes
    SynapseMLLogging
  217. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  218. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  219. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  220. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  221. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  222. def logFit[T](f: ⇒ T): T
    Definition Classes
    SynapseMLLogging
  223. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  224. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  225. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  226. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  227. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  228. def logTrain[T](f: ⇒ T): T
    Definition Classes
    SynapseMLLogging
  229. def logTransform[T](f: ⇒ T): T
    Definition Classes
    SynapseMLLogging
  230. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    SynapseMLLogging
  231. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  232. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  233. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  234. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  235. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  236. val matrixType: Param[String]
    Definition Classes
    LightGBMExecutionParams
  237. val maxBin: IntParam
    Definition Classes
    LightGBMBinParams
  238. val maxBinByFeature: IntArrayParam
    Definition Classes
    LightGBMParams
  239. val maxCatThreshold: IntParam
    Definition Classes
    LightGBMCategoricalParams
  240. val maxCatToOnehot: IntParam
    Definition Classes
    LightGBMCategoricalParams
  241. val maxDeltaStep: DoubleParam
    Definition Classes
    LightGBMParams
  242. val maxDepth: IntParam
    Definition Classes
    LightGBMParams
  243. val maxDrop: IntParam
    Definition Classes
    LightGBMDartParams
  244. val maxNumClasses: IntParam
    Definition Classes
    LightGBMParams
  245. val maxStreamingOMPThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  246. val metric: Param[String]
    Definition Classes
    LightGBMParams
  247. val microBatchSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  248. val minDataInLeaf: IntParam
    Definition Classes
    LightGBMParams
  249. val minDataPerBin: IntParam
    Definition Classes
    LightGBMParams
  250. val minDataPerGroup: IntParam
    Definition Classes
    LightGBMCategoricalParams
  251. val minGainToSplit: DoubleParam
    Definition Classes
    LightGBMParams
  252. val minSumHessianInLeaf: DoubleParam
    Definition Classes
    LightGBMParams
  253. val modelString: Param[String]
    Definition Classes
    LightGBMParams
  254. val monotoneConstraints: IntArrayParam
    Definition Classes
    LightGBMLearnerParams
  255. val monotoneConstraintsMethod: Param[String]
    Definition Classes
    LightGBMLearnerParams
  256. val monotonePenalty: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  257. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  258. val negBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  259. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  260. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  261. val numBatches: IntParam
    Definition Classes
    LightGBMExecutionParams
  262. val numIterations: IntParam
    Definition Classes
    LightGBMParams
  263. val numLeaves: IntParam
    Definition Classes
    LightGBMParams
  264. val numTasks: IntParam
    Definition Classes
    LightGBMExecutionParams
  265. val numThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  266. val objective: Param[String]
    Definition Classes
    LightGBMObjectiveParams
  267. val objectiveSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  268. val otherRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  269. val parallelism: Param[String]
    Definition Classes
    LightGBMExecutionParams
  270. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  271. val passThroughArgs: Param[String]
    Definition Classes
    LightGBMExecutionParams
  272. val posBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  273. val predictDisableShapeCheck: BooleanParam
    Definition Classes
    LightGBMPredictionParams
  274. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  275. def prepareDataframe(dataset: Dataset[_], numTasks: Int): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  276. 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
  277. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  278. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  279. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  280. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  281. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  282. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  283. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  284. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  285. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  286. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  287. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  288. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  289. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  290. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  291. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  292. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  293. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  294. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  295. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  296. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  297. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  298. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  299. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  300. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  301. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  302. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  303. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  304. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  305. val repartitionByGroupingColumn: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  306. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  307. val seed: IntParam
    Definition Classes
    LightGBMSeedParams
  308. final def set(paramPair: ParamPair[_]): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  309. final def set(param: String, value: Any): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  310. final def set[T](param: Param[T], value: T): LightGBMRegressor.this.type
    Definition Classes
    Params
  311. def setAlpha(value: Double): LightGBMRegressor.this.type
  312. def setBaggingFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  313. def setBaggingFreq(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  314. def setBaggingSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  315. def setBatchPerformanceMeasure(index: Int, measures: InstrumentationMeasures): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  316. def setBatchPerformanceMeasures(measures: Array[Option[InstrumentationMeasures]]): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  317. def setBinSampleCount(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMBinParams
  318. def setBoostFromAverage(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  319. def setBoostingType(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  320. def setCatSmooth(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMCategoricalParams
  321. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSlotParams
  322. def setCategoricalSlotNames(value: Array[String]): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSlotParams
  323. def setCatl2(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMCategoricalParams
  324. def setChunkSize(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  325. def setDataRandomSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  326. final def setDefault(paramPairs: ParamPair[_]*): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  327. final def setDefault[T](param: Param[T], value: T): LightGBMRegressor.this.type
    Attributes
    protected
    Definition Classes
    Params
  328. def setDefaultListenPort(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  329. def setDelegate(delegate: LightGBMDelegate): LightGBMRegressor.this.type
    Definition Classes
    LightGBMParams
  330. def setDeterministic(value: Boolean): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  331. def setDriverListenPort(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  332. def setDropRate(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMDartParams
  333. def setDropSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  334. def setEarlyStoppingRound(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  335. def setExecutionMode(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMExecutionParams
  336. def setExtraSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  337. def setFObj(value: FObjTrait): LightGBMRegressor.this.type
    Definition Classes
    LightGBMObjectiveParams
  338. def setFeatureFraction(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  339. def setFeatureFractionByNode(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMFractionParams
  340. def setFeatureFractionSeed(value: Int): LightGBMRegressor.this.type
    Definition Classes
    LightGBMSeedParams
  341. def setFeaturesCol(value: String): LightGBMRegressor
    Definition Classes
    Predictor
  342. def setFeaturesShapCol(value: String): LightGBMRegressor.this.type
    Definition Classes
    LightGBMPredictionParams
  343. def setImprovementTolerance(value: Double): LightGBMRegressor.this.type
    Definition Classes
    LightGBMLearnerParams
  344. def setInitScoreCol(value: String): LightGBMRegressor.this.type

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

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

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

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  425. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  426. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  427. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  428. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  429. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  430. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable
  431. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  432. val zeroAsMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams

Inherited from LightGBMBase[LightGBMRegressionModel]

Inherited from SynapseMLLogging

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