class LightGBMClassifier extends ProbabilisticClassifier[Vector, LightGBMClassifier, LightGBMClassificationModel] with LightGBMBase[LightGBMClassificationModel] with SynapseMLLogging

Trains a LightGBM Classification 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

Linear Supertypes
LightGBMBase[LightGBMClassificationModel], SynapseMLLogging, LightGBMPerformance, LightGBMParams, LightGBMCategoricalParams, LightGBMSeedParams, LightGBMObjectiveParams, LightGBMPredictionParams, LightGBMDartParams, LightGBMDatasetParams, LightGBMLearnerParams, LightGBMBinParams, LightGBMFractionParams, LightGBMSlotParams, LightGBMExecutionParams, HasInitScoreCol, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, DotnetWrappable, RWrappable, PythonWrappable, BaseWrappable, ProbabilisticClassifier[Vector, LightGBMClassifier, LightGBMClassificationModel], ProbabilisticClassifierParams, HasThresholds, HasProbabilityCol, Classifier[Vector, LightGBMClassifier, LightGBMClassificationModel], ClassifierParams, HasRawPredictionCol, Predictor[Vector, LightGBMClassifier, LightGBMClassificationModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Estimator[LightGBMClassificationModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMClassifier
  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. ProbabilisticClassifier
  28. ProbabilisticClassifierParams
  29. HasThresholds
  30. HasProbabilityCol
  31. Classifier
  32. ClassifierParams
  33. HasRawPredictionCol
  34. Predictor
  35. PredictorParams
  36. HasPredictionCol
  37. HasFeaturesCol
  38. HasLabelCol
  39. Estimator
  40. PipelineStage
  41. Logging
  42. Params
  43. Serializable
  44. Serializable
  45. Identifiable
  46. AnyRef
  47. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LightGBMClassifier()
  2. new LightGBMClassifier(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
    LightGBMClassifier → LightGBMBase
  6. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMClassificationModel): Unit
    Definition Classes
    LightGBMBase
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val baggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  9. val baggingFreq: IntParam
    Definition Classes
    LightGBMParams
  10. val baggingSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  11. def beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMClassificationModel]): Unit
    Definition Classes
    LightGBMBase
  12. val binSampleCount: IntParam
    Definition Classes
    LightGBMBinParams
  13. val boostFromAverage: BooleanParam
    Definition Classes
    LightGBMParams
  14. val boostingType: Param[String]
    Definition Classes
    LightGBMParams
  15. def 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
  16. 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
  17. def castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  18. val catSmooth: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  19. val categoricalSlotIndexes: IntArrayParam
    Definition Classes
    LightGBMSlotParams
  20. val categoricalSlotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  21. val catl2: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  22. val chunkSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  23. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  24. final def clear(param: Param[_]): LightGBMClassifier.this.type
    Definition Classes
    Params
  25. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  27. def copy(extra: ParamMap): LightGBMClassifier
    Definition Classes
    LightGBMClassifier → Predictor → Estimator → PipelineStage → Params
  28. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  29. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  30. val dataRandomSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  31. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  32. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  33. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  34. val deterministic: BooleanParam
    Definition Classes
    LightGBMSeedParams
  35. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  36. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  37. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  38. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  39. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  40. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  41. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  42. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  43. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  44. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  45. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  46. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  47. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  48. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  49. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  50. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  51. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  52. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  53. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  54. val dropSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  55. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  56. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  58. def executePartitionTasks(ctx: TrainingContext, dataframe: DataFrame, measures: InstrumentationMeasures): LightGBMBooster
    Attributes
    protected
    Definition Classes
    LightGBMBase
  59. 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): LightGBMClassificationModel

    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
  60. val executionMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  61. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  62. def explainParams(): String
    Definition Classes
    Params
  63. val extraSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  64. def extractInstances(dataset: Dataset[_], numClasses: Int): RDD[Instance]
    Attributes
    protected
    Definition Classes
    ClassifierParams
  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[_], numClasses: Int): RDD[LabeledPoint]
    Attributes
    protected
    Definition Classes
    Classifier
  68. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]
    Attributes
    protected
    Definition Classes
    Predictor
  69. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  70. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  71. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  72. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  73. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  74. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  75. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  76. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  77. def fit(dataset: Dataset[_]): LightGBMClassificationModel
    Definition Classes
    Predictor → Estimator
  78. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMClassificationModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  79. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMClassificationModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  80. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMClassificationModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  81. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  82. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  83. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  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. def getIsUnbalance: Boolean
  126. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  127. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  128. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  129. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  130. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  131. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  132. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  133. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  134. def getMaxCatThreshold: Int
    Definition Classes
    LightGBMCategoricalParams
  135. def getMaxCatToOnehot: Int
    Definition Classes
    LightGBMCategoricalParams
  136. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  137. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  138. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  139. def getMaxNumClasses: Int
    Definition Classes
    LightGBMParams
  140. def getMaxStreamingOMPThreads: Int
    Definition Classes
    LightGBMExecutionParams
  141. def getMetric: String
    Definition Classes
    LightGBMParams
  142. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  143. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  144. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  145. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  146. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  147. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  148. def getModel(trainParams: BaseTrainParams, lightGBMBooster: LightGBMBooster): LightGBMClassificationModel

    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
    LightGBMClassifier → LightGBMBase
  149. def getModelString: String
    Definition Classes
    LightGBMParams
  150. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  151. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  152. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  153. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  154. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  155. def getNumClasses(dataset: Dataset[_], maxNumClasses: Int): Int
    Attributes
    protected
    Definition Classes
    Classifier
  156. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  157. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  158. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  159. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  160. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  161. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

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

    Definition Classes
    HasValidationIndicatorCol
  194. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  195. def getWeightCol: String

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

    The name of the initial score column

    The name of the initial score column

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

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

    Definition Classes
    HasValidationIndicatorCol
  409. def setVerbosity(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  410. def setWeightCol(value: String): LightGBMClassifier.this.type

    Definition Classes
    HasWeightCol
  411. def setXGBoostDartMode(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDartParams
  412. def setZeroAsMissing(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDatasetParams
  413. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  414. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  415. def stringFromTrainedModel(model: LightGBMClassificationModel): String
    Definition Classes
    LightGBMClassifier → LightGBMBase
  416. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  417. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  418. val thresholds: DoubleArrayParam
    Definition Classes
    HasThresholds
  419. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  420. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  421. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  422. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  423. def train(dataset: Dataset[_]): LightGBMClassificationModel

    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
  424. def trainOneDataBatch(dataset: Dataset[_], batchIndex: Int, batchCount: Int): LightGBMClassificationModel

    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
  425. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  426. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  427. val uid: String
    Definition Classes
    LightGBMClassifier → SynapseMLLogging → Identifiable
  428. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  429. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  430. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  431. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  432. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
    Attributes
    protected
    Definition Classes
    ProbabilisticClassifierParams → ClassifierParams → PredictorParams
  433. def validateLabel(label: Double, numClasses: Int): Unit
    Attributes
    protected
    Definition Classes
    Classifier
  434. def validateNumClasses(numClasses: Int): Unit
    Attributes
    protected
    Definition Classes
    Classifier
  435. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  436. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  437. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  438. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  439. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  440. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  441. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable
  442. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  443. val zeroAsMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams

Inherited from LightGBMBase[LightGBMClassificationModel]

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 ProbabilisticClassifier[Vector, LightGBMClassifier, LightGBMClassificationModel]

Inherited from ProbabilisticClassifierParams

Inherited from HasThresholds

Inherited from HasProbabilityCol

Inherited from Classifier[Vector, LightGBMClassifier, LightGBMClassificationModel]

Inherited from ClassifierParams

Inherited from HasRawPredictionCol

Inherited from Predictor[Vector, LightGBMClassifier, LightGBMClassificationModel]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Estimator[LightGBMClassificationModel]

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