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
- Alphabetic
- By Inheritance
- LightGBMClassifier
- LightGBMBase
- SynapseMLLogging
- LightGBMPerformance
- ComplexParamsWritable
- LightGBMParams
- LightGBMCategoricalParams
- LightGBMSeedParams
- LightGBMObjectiveParams
- LightGBMPredictionParams
- LightGBMDartParams
- LightGBMDatasetParams
- LightGBMLearnerParams
- LightGBMBinParams
- LightGBMFractionParams
- LightGBMSlotParams
- LightGBMExecutionParams
- HasInitScoreCol
- HasValidationIndicatorCol
- HasWeightCol
- DefaultParamsWritable
- MLWritable
- Wrappable
- RWrappable
- PythonWrappable
- BaseWrappable
- ProbabilisticClassifier
- ProbabilisticClassifierParams
- HasThresholds
- HasProbabilityCol
- Classifier
- ClassifierParams
- HasRawPredictionCol
- Predictor
- PredictorParams
- HasPredictionCol
- HasFeaturesCol
- HasLabelCol
- Estimator
- PipelineStage
- Logging
- Params
- Serializable
- Serializable
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
$[T](param: Param[T]): T
- Attributes
- protected
- Definition Classes
- Params
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addCustomTrainParams(params: BaseTrainParams, dataset: Dataset[_]): BaseTrainParams
- Attributes
- protected
- Definition Classes
- LightGBMClassifier → LightGBMBase
-
def
afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMClassificationModel): Unit
- Definition Classes
- LightGBMBase
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
baggingFraction: DoubleParam
- Definition Classes
- LightGBMFractionParams
-
val
baggingFreq: IntParam
- Definition Classes
- LightGBMParams
-
val
baggingSeed: IntParam
- Definition Classes
- LightGBMSeedParams
-
def
beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMClassificationModel]): Unit
- Definition Classes
- LightGBMBase
-
val
binSampleCount: IntParam
- Definition Classes
- LightGBMBinParams
-
val
boostFromAverage: BooleanParam
- Definition Classes
- LightGBMParams
-
val
boostingType: Param[String]
- Definition Classes
- LightGBMParams
-
def
castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame
- Attributes
- protected
- Definition Classes
- LightGBMBase
-
val
catSmooth: DoubleParam
- Definition Classes
- LightGBMCategoricalParams
-
val
categoricalSlotIndexes: IntArrayParam
- Definition Classes
- LightGBMSlotParams
-
val
categoricalSlotNames: StringArrayParam
- Definition Classes
- LightGBMSlotParams
-
val
catl2: DoubleParam
- Definition Classes
- LightGBMCategoricalParams
-
val
chunkSize: IntParam
- Definition Classes
- LightGBMExecutionParams
-
lazy val
classNameHelper: String
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
final
def
clear(param: Param[_]): LightGBMClassifier.this.type
- Definition Classes
- Params
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
companionModelClassName: String
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
def
copy(extra: ParamMap): LightGBMClassifier
- Definition Classes
- LightGBMClassifier → Predictor → Estimator → PipelineStage → Params
-
def
copyValues[T <: Params](to: T, extra: ParamMap): T
- Attributes
- protected
- Definition Classes
- Params
-
lazy val
copyrightLines: String
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
val
dataRandomSeed: IntParam
- Definition Classes
- LightGBMSeedParams
-
val
dataTransferMode: Param[String]
- Definition Classes
- LightGBMExecutionParams
-
final
def
defaultCopy[T <: Params](extra: ParamMap): T
- Attributes
- protected
- Definition Classes
- Params
-
val
defaultListenPort: IntParam
- Definition Classes
- LightGBMExecutionParams
-
val
delegate: Option[LightGBMDelegate]
- Definition Classes
- LightGBMParams
-
val
deterministic: BooleanParam
- Definition Classes
- LightGBMSeedParams
-
val
driverListenPort: IntParam
- Definition Classes
- LightGBMExecutionParams
-
val
dropRate: DoubleParam
- Definition Classes
- LightGBMDartParams
-
val
dropSeed: IntParam
- Definition Classes
- LightGBMSeedParams
-
val
earlyStoppingRound: IntParam
- Definition Classes
- LightGBMLearnerParams
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
explainParam(param: Param[_]): String
- Definition Classes
- Params
-
def
explainParams(): String
- Definition Classes
- Params
-
val
extraSeed: IntParam
- Definition Classes
- LightGBMSeedParams
-
final
def
extractParamMap(): ParamMap
- Definition Classes
- Params
-
final
def
extractParamMap(extra: ParamMap): ParamMap
- Definition Classes
- Params
-
val
featureFraction: DoubleParam
- Definition Classes
- LightGBMFractionParams
-
val
featureFractionByNode: DoubleParam
- Definition Classes
- LightGBMFractionParams
-
val
featureFractionSeed: IntParam
- Definition Classes
- LightGBMSeedParams
-
final
val
featuresCol: Param[String]
- Definition Classes
- HasFeaturesCol
-
val
featuresShapCol: Param[String]
- Definition Classes
- LightGBMPredictionParams
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fit(dataset: Dataset[_]): LightGBMClassificationModel
- Definition Classes
- Predictor → Estimator
-
def
fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMClassificationModel]
- Definition Classes
- Estimator
- Annotations
- @Since( "2.0.0" )
-
def
fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMClassificationModel
- Definition Classes
- Estimator
- Annotations
- @Since( "2.0.0" )
-
def
fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMClassificationModel
- Definition Classes
- Estimator
- Annotations
- @Since( "2.0.0" ) @varargs()
-
val
fobj: FObjParam
- Definition Classes
- LightGBMObjectiveParams
-
final
def
get[T](param: Param[T]): Option[T]
- Definition Classes
- Params
-
def
getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
- Definition Classes
- LightGBMPerformance
-
def
getBaggingFraction: Double
- Definition Classes
- LightGBMFractionParams
-
def
getBaggingFreq: Int
- Definition Classes
- LightGBMParams
-
def
getBaggingSeed: Int
- Definition Classes
- LightGBMSeedParams
-
def
getBinSampleCount: Int
- Definition Classes
- LightGBMBinParams
-
def
getBoostFromAverage: Boolean
- Definition Classes
- LightGBMParams
-
def
getBoostingType: String
- Definition Classes
- LightGBMParams
-
def
getCatSmooth: Double
- Definition Classes
- LightGBMCategoricalParams
-
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
-
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
-
def
getCategoricalSlotIndexes: Array[Int]
- Definition Classes
- LightGBMSlotParams
-
def
getCategoricalSlotNames: Array[String]
- Definition Classes
- LightGBMSlotParams
-
def
getCatl2: Double
- Definition Classes
- LightGBMCategoricalParams
-
def
getChunkSize: Int
- Definition Classes
- LightGBMExecutionParams
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getColumnParams: ColumnParams
Constructs the ColumnParams.
Constructs the ColumnParams.
- returns
ColumnParams object containing the parameters related to LightGBM columns.
- Attributes
- protected
- Definition Classes
- LightGBMBase
-
def
getDartParams: DartModeParams
Constructs the DartModeParams
Constructs the DartModeParams
- returns
DartModeParams object containing parameters related to dart mode.
- Attributes
- protected
- Definition Classes
- LightGBMBase
-
def
getDataRandomSeed: Int
- Definition Classes
- LightGBMSeedParams
-
def
getDataTransferMode: String
- Definition Classes
- LightGBMExecutionParams
-
def
getDatasetCreationParams(categoricalIndexes: Array[Int], numThreads: Int): String
- Attributes
- protected
- Definition Classes
- LightGBMBase
-
def
getDatasetParams: DatasetParams
Constructs the DatasetParams.
Constructs the DatasetParams.
- returns
DatasetParams object containing parameters related to LightGBM Dataset parameters.
- Attributes
- protected
- Definition Classes
- LightGBMBase
-
final
def
getDefault[T](param: Param[T]): Option[T]
- Definition Classes
- Params
-
def
getDefaultListenPort: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getDelegate: Option[LightGBMDelegate]
- Definition Classes
- LightGBMParams
-
def
getDeterministic: Boolean
- Definition Classes
- LightGBMSeedParams
-
def
getDriverListenPort: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getDropRate: Double
- Definition Classes
- LightGBMDartParams
-
def
getDropSeed: Int
- Definition Classes
- LightGBMSeedParams
-
def
getEarlyStoppingRound: Int
- Definition Classes
- LightGBMLearnerParams
-
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
-
def
getExtraSeed: Int
- Definition Classes
- LightGBMSeedParams
-
def
getFObj: FObjTrait
- Definition Classes
- LightGBMObjectiveParams
-
def
getFeatureFraction: Double
- Definition Classes
- LightGBMFractionParams
-
def
getFeatureFractionByNode: Double
- Definition Classes
- LightGBMFractionParams
-
def
getFeatureFractionSeed: Int
- Definition Classes
- LightGBMSeedParams
-
final
def
getFeaturesCol: String
- Definition Classes
- HasFeaturesCol
-
def
getFeaturesShapCol: String
- Definition Classes
- LightGBMPredictionParams
-
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
-
def
getImprovementTolerance: Double
- Definition Classes
- LightGBMLearnerParams
-
def
getInitScoreCol: String
- Definition Classes
- HasInitScoreCol
-
def
getIsEnableSparse: Boolean
- Definition Classes
- LightGBMDatasetParams
-
def
getIsProvideTrainingMetric: Boolean
- Definition Classes
- LightGBMParams
- def getIsUnbalance: Boolean
-
final
def
getLabelCol: String
- Definition Classes
- HasLabelCol
-
def
getLambdaL1: Double
- Definition Classes
- LightGBMParams
-
def
getLambdaL2: Double
- Definition Classes
- LightGBMParams
-
def
getLeafPredictionCol: String
- Definition Classes
- LightGBMPredictionParams
-
def
getLearningRate: Double
- Definition Classes
- LightGBMParams
-
def
getMatrixType: String
- Definition Classes
- LightGBMExecutionParams
-
def
getMaxBin: Int
- Definition Classes
- LightGBMBinParams
-
def
getMaxBinByFeature: Array[Int]
- Definition Classes
- LightGBMParams
-
def
getMaxCatThreshold: Int
- Definition Classes
- LightGBMCategoricalParams
-
def
getMaxCatToOnehot: Int
- Definition Classes
- LightGBMCategoricalParams
-
def
getMaxDeltaStep: Double
- Definition Classes
- LightGBMParams
-
def
getMaxDepth: Int
- Definition Classes
- LightGBMParams
-
def
getMaxDrop: Int
- Definition Classes
- LightGBMDartParams
-
def
getMaxNumClasses: Int
- Definition Classes
- LightGBMParams
-
def
getMaxStreamingOMPThreads: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getMetric: String
- Definition Classes
- LightGBMParams
-
def
getMicroBatchSize: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getMinDataInLeaf: Int
- Definition Classes
- LightGBMParams
-
def
getMinDataPerBin: Int
- Definition Classes
- LightGBMParams
-
def
getMinDataPerGroup: Int
- Definition Classes
- LightGBMCategoricalParams
-
def
getMinGainToSplit: Double
- Definition Classes
- LightGBMParams
-
def
getMinSumHessianInLeaf: Double
- Definition Classes
- LightGBMParams
-
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
-
def
getModelString: String
- Definition Classes
- LightGBMParams
-
def
getMonotoneConstraints: Array[Int]
- Definition Classes
- LightGBMLearnerParams
-
def
getMonotoneConstraintsMethod: String
- Definition Classes
- LightGBMLearnerParams
-
def
getMonotonePenalty: Double
- Definition Classes
- LightGBMLearnerParams
-
def
getNegBaggingFraction: Double
- Definition Classes
- LightGBMFractionParams
-
def
getNumBatches: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getNumClasses(dataset: Dataset[_], maxNumClasses: Int): Int
- Attributes
- protected
- Definition Classes
- Classifier
-
def
getNumIterations: Int
- Definition Classes
- LightGBMParams
-
def
getNumLeaves: Int
- Definition Classes
- LightGBMParams
-
def
getNumTasks: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getNumThreads: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getObjective: String
- Definition Classes
- LightGBMObjectiveParams
-
def
getObjectiveParams: ObjectiveParams
Constructs the ObjectiveParams.
Constructs the ObjectiveParams.
- returns
ObjectiveParams object containing parameters related to the objective function.
- Attributes
- protected
- Definition Classes
- LightGBMBase
-
def
getObjectiveSeed: Int
- Definition Classes
- LightGBMSeedParams
-
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
-
final
def
getOrDefault[T](param: Param[T]): T
- Definition Classes
- Params
-
def
getOtherRate: Double
- Definition Classes
- LightGBMLearnerParams
-
def
getParallelism: String
- Definition Classes
- LightGBMExecutionParams
-
def
getParam(paramName: String): Param[Any]
- Definition Classes
- Params
-
def
getParamInfo(p: Param[_]): ParamInfo[_]
- Definition Classes
- BaseWrappable
-
def
getPassThroughArgs: String
- Definition Classes
- LightGBMExecutionParams
-
def
getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
- Attributes
- protected
- Definition Classes
- SynapseMLLogging
-
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
-
def
getPosBaggingFraction: Double
- Definition Classes
- LightGBMFractionParams
-
def
getPredictDisableShapeCheck: Boolean
- Definition Classes
- LightGBMPredictionParams
-
final
def
getPredictionCol: String
- Definition Classes
- HasPredictionCol
-
final
def
getProbabilityCol: String
- Definition Classes
- HasProbabilityCol
-
final
def
getRawPredictionCol: String
- Definition Classes
- HasRawPredictionCol
-
def
getReferenceDataset: Array[Byte]
- Definition Classes
- LightGBMExecutionParams
-
def
getRepartitionByGroupingColumn: Boolean
- Definition Classes
- LightGBMExecutionParams
-
def
getSamplingMode: String
- Definition Classes
- LightGBMExecutionParams
-
def
getSamplingSubsetSize: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getSeed: Int
- Definition Classes
- LightGBMSeedParams
-
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
-
def
getSkipDrop: Double
- Definition Classes
- LightGBMDartParams
-
def
getSlotNames: Array[String]
- Definition Classes
- LightGBMSlotParams
-
def
getThresholds: Array[Double]
- Definition Classes
- HasThresholds
-
def
getTimeout: Double
- Definition Classes
- LightGBMExecutionParams
-
def
getTopK: Int
- Definition Classes
- LightGBMExecutionParams
-
def
getTopRate: Double
- Definition Classes
- LightGBMLearnerParams
-
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
-
def
getTrainingCols: Array[(String, Seq[DataType])]
- Attributes
- protected
- Definition Classes
- LightGBMBase
-
def
getUniformDrop: Boolean
- Definition Classes
- LightGBMDartParams
-
def
getUseBarrierExecutionMode: Boolean
- Definition Classes
- LightGBMExecutionParams
-
def
getUseMissing: Boolean
- Definition Classes
- LightGBMDatasetParams
-
def
getUseSingleDatasetMode: Boolean
- Definition Classes
- LightGBMExecutionParams
-
def
getValidationIndicatorCol: String
- Definition Classes
- HasValidationIndicatorCol
-
def
getVerbosity: Int
- Definition Classes
- LightGBMParams
-
def
getWeightCol: String
- Definition Classes
- HasWeightCol
-
def
getXGBoostDartMode: Boolean
- Definition Classes
- LightGBMDartParams
-
def
getZeroAsMissing: Boolean
- Definition Classes
- LightGBMDatasetParams
-
final
def
hasDefault[T](param: Param[T]): Boolean
- Definition Classes
- Params
-
def
hasParam(paramName: String): Boolean
- Definition Classes
- Params
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
val
improvementTolerance: DoubleParam
- Definition Classes
- LightGBMLearnerParams
-
def
initPerformanceMeasures(batchCount: Int): Unit
- Attributes
- protected
- Definition Classes
- LightGBMPerformance
-
val
initScoreCol: Param[String]
The name of the initial score column
The name of the initial score column
- Definition Classes
- HasInitScoreCol
-
def
initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
- Attributes
- protected
- Definition Classes
- Logging
-
def
initializeLogIfNecessary(isInterpreter: Boolean): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
final
def
isDefined(param: Param[_]): Boolean
- Definition Classes
- Params
-
val
isEnableSparse: BooleanParam
- Definition Classes
- LightGBMDatasetParams
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
isProvideTrainingMetric: BooleanParam
- Definition Classes
- LightGBMParams
-
final
def
isSet(param: Param[_]): Boolean
- Definition Classes
- Params
-
def
isTraceEnabled(): Boolean
- Attributes
- protected
- Definition Classes
- Logging
- val isUnbalance: BooleanParam
-
final
val
labelCol: Param[String]
- Definition Classes
- HasLabelCol
-
val
lambdaL1: DoubleParam
- Definition Classes
- LightGBMParams
-
val
lambdaL2: DoubleParam
- Definition Classes
- LightGBMParams
-
val
leafPredictionCol: Param[String]
- Definition Classes
- LightGBMPredictionParams
-
val
learningRate: DoubleParam
- Definition Classes
- LightGBMParams
-
def
log: Logger
- Attributes
- protected
- Definition Classes
- Logging
-
def
logBase(info: Map[String, String], featureName: Option[String]): Unit
- Attributes
- protected
- Definition Classes
- SynapseMLLogging
-
def
logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit
- Attributes
- protected
- Definition Classes
- SynapseMLLogging
-
def
logClass(featureName: String): Unit
- Definition Classes
- SynapseMLLogging
-
def
logDebug(msg: ⇒ String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logDebug(msg: ⇒ String): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logError(msg: ⇒ String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logError(msg: ⇒ String): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logErrorBase(methodName: String, e: Exception): Unit
- Attributes
- protected
- Definition Classes
- SynapseMLLogging
-
def
logFit[T](f: ⇒ T, columns: Int): T
- Definition Classes
- SynapseMLLogging
-
def
logInfo(msg: ⇒ String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logInfo(msg: ⇒ String): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logName: String
- Attributes
- protected
- Definition Classes
- Logging
-
def
logTrace(msg: ⇒ String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logTrace(msg: ⇒ String): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logTransform[T](f: ⇒ T, columns: Int): T
- Definition Classes
- SynapseMLLogging
-
def
logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
- Definition Classes
- SynapseMLLogging
-
def
logWarning(msg: ⇒ String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logWarning(msg: ⇒ String): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
makePyFile(conf: CodegenConfig): Unit
- Definition Classes
- PythonWrappable
-
def
makeRFile(conf: CodegenConfig): Unit
- Definition Classes
- RWrappable
-
val
matrixType: Param[String]
- Definition Classes
- LightGBMExecutionParams
-
val
maxBin: IntParam
- Definition Classes
- LightGBMBinParams
-
val
maxBinByFeature: IntArrayParam
- Definition Classes
- LightGBMParams
-
val
maxCatThreshold: IntParam
- Definition Classes
- LightGBMCategoricalParams
-
val
maxCatToOnehot: IntParam
- Definition Classes
- LightGBMCategoricalParams
-
val
maxDeltaStep: DoubleParam
- Definition Classes
- LightGBMParams
-
val
maxDepth: IntParam
- Definition Classes
- LightGBMParams
-
val
maxDrop: IntParam
- Definition Classes
- LightGBMDartParams
-
val
maxNumClasses: IntParam
- Definition Classes
- LightGBMParams
-
val
maxStreamingOMPThreads: IntParam
- Definition Classes
- LightGBMExecutionParams
-
val
metric: Param[String]
- Definition Classes
- LightGBMParams
-
val
microBatchSize: IntParam
- Definition Classes
- LightGBMExecutionParams
-
val
minDataInLeaf: IntParam
- Definition Classes
- LightGBMParams
-
val
minDataPerBin: IntParam
- Definition Classes
- LightGBMParams
-
val
minDataPerGroup: IntParam
- Definition Classes
- LightGBMCategoricalParams
-
val
minGainToSplit: DoubleParam
- Definition Classes
- LightGBMParams
-
val
minSumHessianInLeaf: DoubleParam
- Definition Classes
- LightGBMParams
-
val
modelString: Param[String]
- Definition Classes
- LightGBMParams
-
val
monotoneConstraints: IntArrayParam
- Definition Classes
- LightGBMLearnerParams
-
val
monotoneConstraintsMethod: Param[String]
- Definition Classes
- LightGBMLearnerParams
-
val
monotonePenalty: DoubleParam
- Definition Classes
- LightGBMLearnerParams
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
val
negBaggingFraction: DoubleParam
- Definition Classes
- LightGBMFractionParams
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
numBatches: IntParam
- Definition Classes
- LightGBMExecutionParams
-
val
numIterations: IntParam
- Definition Classes
- LightGBMParams
-
val
numLeaves: IntParam
- Definition Classes
- LightGBMParams
-
val
numTasks: IntParam
- Definition Classes
- LightGBMExecutionParams
-
val
numThreads: IntParam
- Definition Classes
- LightGBMExecutionParams
-
val
objective: Param[String]
- Definition Classes
- LightGBMObjectiveParams
-
val
objectiveSeed: IntParam
- Definition Classes
- LightGBMSeedParams
-
val
otherRate: DoubleParam
- Definition Classes
- LightGBMLearnerParams
-
val
parallelism: Param[String]
- Definition Classes
- LightGBMExecutionParams
-
lazy val
params: Array[Param[_]]
- Definition Classes
- Params
-
val
passThroughArgs: Param[String]
- Definition Classes
- LightGBMExecutionParams
-
val
posBaggingFraction: DoubleParam
- Definition Classes
- LightGBMFractionParams
-
val
predictDisableShapeCheck: BooleanParam
- Definition Classes
- LightGBMPredictionParams
-
final
val
predictionCol: Param[String]
- Definition Classes
- HasPredictionCol
-
def
prepareDataframe(dataset: Dataset[_], numTasks: Int): DataFrame
- Attributes
- protected
- Definition Classes
- LightGBMBase
-
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
-
final
val
probabilityCol: Param[String]
- Definition Classes
- HasProbabilityCol
-
def
pyAdditionalMethods: String
- Definition Classes
- PythonWrappable
-
lazy val
pyClassDoc: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
lazy val
pyClassName: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyExtraEstimatorImports: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyExtraEstimatorMethods: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
lazy val
pyInheritedClasses: Seq[String]
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyInitFunc(): String
- Definition Classes
- PythonWrappable
-
lazy val
pyInternalWrapper: Boolean
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
lazy val
pyObjectBaseClass: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamArg[T](p: Param[T]): String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamDefault[T](p: Param[T]): Option[String]
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamGetter(p: Param[_]): String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamSetter(p: Param[_]): String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamsArgs: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamsDefaults: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
lazy val
pyParamsDefinitions: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamsGetters: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamsSetters: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pythonClass(): String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
rClass(): String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rDocString: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rExtraBodyLines: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rExtraInitLines: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
lazy val
rFuncName: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
lazy val
rInternalWrapper: Boolean
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rParamArg[T](p: Param[T]): String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rParamsArgs: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rSetterLines: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
final
val
rawPredictionCol: Param[String]
- Definition Classes
- HasRawPredictionCol
-
val
referenceDataset: ByteArrayParam
- Definition Classes
- LightGBMExecutionParams
-
val
repartitionByGroupingColumn: BooleanParam
- Definition Classes
- LightGBMExecutionParams
-
val
samplingMode: Param[String]
- Definition Classes
- LightGBMExecutionParams
-
val
samplingSubsetSize: IntParam
- Definition Classes
- LightGBMExecutionParams
-
def
save(path: String): Unit
- Definition Classes
- MLWritable
- Annotations
- @Since( "1.6.0" ) @throws( ... )
-
val
seed: IntParam
- Definition Classes
- LightGBMSeedParams
-
final
def
set(paramPair: ParamPair[_]): LightGBMClassifier.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
set(param: String, value: Any): LightGBMClassifier.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
set[T](param: Param[T], value: T): LightGBMClassifier.this.type
- Definition Classes
- Params
-
def
setBaggingFraction(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMFractionParams
-
def
setBaggingFreq(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setBaggingSeed(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSeedParams
-
def
setBatchPerformanceMeasure(index: Int, measures: InstrumentationMeasures): Unit
- Attributes
- protected
- Definition Classes
- LightGBMPerformance
-
def
setBatchPerformanceMeasures(measures: Array[Option[InstrumentationMeasures]]): LightGBMClassifier.this.type
- Attributes
- protected
- Definition Classes
- LightGBMPerformance
-
def
setBinSampleCount(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMBinParams
-
def
setBoostFromAverage(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setBoostingType(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setCatSmooth(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMCategoricalParams
-
def
setCategoricalSlotIndexes(value: Array[Int]): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSlotParams
-
def
setCategoricalSlotNames(value: Array[String]): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSlotParams
-
def
setCatl2(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMCategoricalParams
-
def
setChunkSize(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setDataRandomSeed(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSeedParams
-
def
setDataTransferMode(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
final
def
setDefault(paramPairs: ParamPair[_]*): LightGBMClassifier.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
setDefault[T](param: Param[T], value: T): LightGBMClassifier.this.type
- Attributes
- protected[org.apache.spark.ml]
- Definition Classes
- Params
-
def
setDefaultListenPort(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setDelegate(delegate: LightGBMDelegate): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setDeterministic(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSeedParams
-
def
setDriverListenPort(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setDropRate(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMDartParams
-
def
setDropSeed(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSeedParams
-
def
setEarlyStoppingRound(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMLearnerParams
-
def
setExtraSeed(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSeedParams
-
def
setFObj(value: FObjTrait): LightGBMClassifier.this.type
- Definition Classes
- LightGBMObjectiveParams
-
def
setFeatureFraction(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMFractionParams
-
def
setFeatureFractionByNode(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMFractionParams
-
def
setFeatureFractionSeed(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSeedParams
-
def
setFeaturesCol(value: String): LightGBMClassifier
- Definition Classes
- Predictor
-
def
setFeaturesShapCol(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMPredictionParams
-
def
setImprovementTolerance(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMLearnerParams
-
def
setInitScoreCol(value: String): LightGBMClassifier.this.type
- Definition Classes
- HasInitScoreCol
-
def
setIsEnableSparse(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMDatasetParams
-
def
setIsProvideTrainingMetric(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
- def setIsUnbalance(value: Boolean): LightGBMClassifier.this.type
-
def
setLabelCol(value: String): LightGBMClassifier
- Definition Classes
- Predictor
-
def
setLambdaL1(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setLambdaL2(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setLeafPredictionCol(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMPredictionParams
-
def
setLearningRate(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMatrixType(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setMaxBin(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMBinParams
-
def
setMaxBinByFeature(value: Array[Int]): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMaxCatThreshold(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMCategoricalParams
-
def
setMaxCatToOnehot(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMCategoricalParams
-
def
setMaxDeltaStep(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMaxDepth(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMaxDrop(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMDartParams
-
def
setMaxNumClasses(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMaxStreamingOMPThreads(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setMetric(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMicroBatchSize(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setMinDataInLeaf(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMinDataPerBin(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMinDataPerGroup(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMCategoricalParams
-
def
setMinGainToSplit(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMinSumHessianInLeaf(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setModelString(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setMonotoneConstraints(value: Array[Int]): LightGBMClassifier.this.type
- Definition Classes
- LightGBMLearnerParams
-
def
setMonotoneConstraintsMethod(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMLearnerParams
-
def
setMonotonePenalty(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMLearnerParams
-
def
setNegBaggingFraction(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMFractionParams
-
def
setNumBatches(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setNumIterations(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setNumLeaves(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setNumTasks(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setNumThreads(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setObjective(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMObjectiveParams
-
def
setObjectiveSeed(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSeedParams
-
def
setOtherRate(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMLearnerParams
-
def
setParallelism(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setPassThroughArgs(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setPosBaggingFraction(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMFractionParams
-
def
setPredictDisableShapeCheck(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMPredictionParams
-
def
setPredictionCol(value: String): LightGBMClassifier
- Definition Classes
- Predictor
-
def
setProbabilityCol(value: String): LightGBMClassifier
- Definition Classes
- ProbabilisticClassifier
-
def
setRawPredictionCol(value: String): LightGBMClassifier
- Definition Classes
- Classifier
-
def
setReferenceDataset(value: Array[Byte]): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setRepartitionByGroupingColumn(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setSamplingMode(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setSamplingSubsetSize(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setSeed(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSeedParams
-
def
setSkipDrop(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMDartParams
-
def
setSlotNames(value: Array[String]): LightGBMClassifier.this.type
- Definition Classes
- LightGBMSlotParams
-
def
setThresholds(value: Array[Double]): LightGBMClassifier
- Definition Classes
- ProbabilisticClassifier
-
def
setTimeout(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setTopK(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setTopRate(value: Double): LightGBMClassifier.this.type
- Definition Classes
- LightGBMLearnerParams
-
def
setUniformDrop(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMDartParams
-
def
setUseBarrierExecutionMode(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setUseMissing(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMDatasetParams
-
def
setUseSingleDatasetMode(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
-
def
setValidationIndicatorCol(value: String): LightGBMClassifier.this.type
- Definition Classes
- HasValidationIndicatorCol
-
def
setVerbosity(value: Int): LightGBMClassifier.this.type
- Definition Classes
- LightGBMParams
-
def
setWeightCol(value: String): LightGBMClassifier.this.type
- Definition Classes
- HasWeightCol
-
def
setXGBoostDartMode(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMDartParams
-
def
setZeroAsMissing(value: Boolean): LightGBMClassifier.this.type
- Definition Classes
- LightGBMDatasetParams
-
val
skipDrop: DoubleParam
- Definition Classes
- LightGBMDartParams
-
val
slotNames: StringArrayParam
- Definition Classes
- LightGBMSlotParams
-
def
stringFromTrainedModel(model: LightGBMClassificationModel): String
- Definition Classes
- LightGBMClassifier → LightGBMBase
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
thisStage: Params
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
val
thresholds: DoubleArrayParam
- Definition Classes
- HasThresholds
-
val
timeout: DoubleParam
- Definition Classes
- LightGBMExecutionParams
-
def
toString(): String
- Definition Classes
- Identifiable → AnyRef → Any
-
val
topK: IntParam
- Definition Classes
- LightGBMExecutionParams
-
val
topRate: DoubleParam
- Definition Classes
- LightGBMLearnerParams
-
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
-
def
transformSchema(schema: StructType): StructType
- Definition Classes
- Predictor → PipelineStage
-
def
transformSchema(schema: StructType, logging: Boolean): StructType
- Attributes
- protected
- Definition Classes
- PipelineStage
- Annotations
- @DeveloperApi()
-
val
uid: String
- Definition Classes
- LightGBMClassifier → SynapseMLLogging → Identifiable
-
val
uniformDrop: BooleanParam
- Definition Classes
- LightGBMDartParams
-
val
useBarrierExecutionMode: BooleanParam
- Definition Classes
- LightGBMExecutionParams
-
val
useMissing: BooleanParam
- Definition Classes
- LightGBMDatasetParams
-
val
useSingleDatasetMode: BooleanParam
- Definition Classes
- LightGBMExecutionParams
-
def
validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
- Attributes
- protected
- Definition Classes
- ProbabilisticClassifierParams → ClassifierParams → PredictorParams
-
val
validationIndicatorCol: Param[String]
The name of the validation indicator column
The name of the validation indicator column
- Definition Classes
- HasValidationIndicatorCol
-
val
verbosity: IntParam
- Definition Classes
- LightGBMParams
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
val
weightCol: Param[String]
The name of the weight column
The name of the weight column
- Definition Classes
- HasWeightCol
-
def
write: MLWriter
- Definition Classes
- ComplexParamsWritable → MLWritable
-
val
xGBoostDartMode: BooleanParam
- Definition Classes
- LightGBMDartParams
-
val
zeroAsMissing: BooleanParam
- Definition Classes
- LightGBMDatasetParams
Deprecated Value Members
-
val
executionMode: Param[String]
- Definition Classes
- LightGBMExecutionParams
- Annotations
- @deprecated
- Deprecated
(Since version 0.11.1) Please use 'dataTransferMode'
-
def
setExecutionMode(value: String): LightGBMClassifier.this.type
- Definition Classes
- LightGBMExecutionParams
- Annotations
- @deprecated
- Deprecated
(Since version 0.11.1) Please use 'setDataTransferMode'