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, ComplexParamsWritable, 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. ComplexParamsWritable
  6. LightGBMParams
  7. LightGBMCategoricalParams
  8. LightGBMSeedParams
  9. LightGBMObjectiveParams
  10. LightGBMPredictionParams
  11. LightGBMDartParams
  12. LightGBMDatasetParams
  13. LightGBMLearnerParams
  14. LightGBMBinParams
  15. LightGBMFractionParams
  16. LightGBMSlotParams
  17. LightGBMExecutionParams
  18. HasInitScoreCol
  19. HasValidationIndicatorCol
  20. HasWeightCol
  21. DefaultParamsWritable
  22. MLWritable
  23. Wrappable
  24. DotnetWrappable
  25. RWrappable
  26. PythonWrappable
  27. BaseWrappable
  28. ProbabilisticClassifier
  29. ProbabilisticClassifierParams
  30. HasThresholds
  31. HasProbabilityCol
  32. Classifier
  33. ClassifierParams
  34. HasRawPredictionCol
  35. Predictor
  36. PredictorParams
  37. HasPredictionCol
  38. HasFeaturesCol
  39. HasLabelCol
  40. Estimator
  41. PipelineStage
  42. Logging
  43. Params
  44. Serializable
  45. Serializable
  46. Identifiable
  47. AnyRef
  48. 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. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMClassificationModel): Unit
    Definition Classes
    LightGBMBase
  2. val baggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  3. val baggingFreq: IntParam
    Definition Classes
    LightGBMParams
  4. val baggingSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  5. def beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMClassificationModel]): Unit
    Definition Classes
    LightGBMBase
  6. val binSampleCount: IntParam
    Definition Classes
    LightGBMBinParams
  7. val boostFromAverage: BooleanParam
    Definition Classes
    LightGBMParams
  8. val boostingType: Param[String]
    Definition Classes
    LightGBMParams
  9. val catSmooth: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  10. val categoricalSlotIndexes: IntArrayParam
    Definition Classes
    LightGBMSlotParams
  11. val categoricalSlotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  12. val catl2: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  13. val chunkSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  14. final def clear(param: Param[_]): LightGBMClassifier.this.type
    Definition Classes
    Params
  15. def copy(extra: ParamMap): LightGBMClassifier
    Definition Classes
    LightGBMClassifier → Predictor → Estimator → PipelineStage → Params
  16. val dataRandomSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  17. val dataTransferMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  18. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  19. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  20. val deterministic: BooleanParam
    Definition Classes
    LightGBMSeedParams
  21. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  22. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  23. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  24. val dropSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  25. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  26. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  27. def explainParams(): String
    Definition Classes
    Params
  28. val extraSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  29. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  30. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  31. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  32. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  33. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  34. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  35. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  36. def fit(dataset: Dataset[_]): LightGBMClassificationModel
    Definition Classes
    Predictor → Estimator
  37. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMClassificationModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  38. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMClassificationModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  39. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMClassificationModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  40. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  41. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  43. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  44. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  45. def getBaggingSeed: Int
    Definition Classes
    LightGBMSeedParams
  46. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  47. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  48. def getBoostingType: String
    Definition Classes
    LightGBMParams
  49. def getCatSmooth: Double
    Definition Classes
    LightGBMCategoricalParams
  50. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  51. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  52. def getCatl2: Double
    Definition Classes
    LightGBMCategoricalParams
  53. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  54. def getDataRandomSeed: Int
    Definition Classes
    LightGBMSeedParams
  55. def getDataTransferMode: String
    Definition Classes
    LightGBMExecutionParams
  56. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  57. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  58. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  59. def getDeterministic: Boolean
    Definition Classes
    LightGBMSeedParams
  60. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  61. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  62. def getDropSeed: Int
    Definition Classes
    LightGBMSeedParams
  63. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  64. def getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  65. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  66. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  67. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  68. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  69. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  70. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  71. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  72. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  73. def getIsEnableSparse: Boolean
    Definition Classes
    LightGBMDatasetParams
  74. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  75. def getIsUnbalance: Boolean
  76. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  77. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  78. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  79. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  80. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  81. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  82. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  83. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  84. def getMaxCatThreshold: Int
    Definition Classes
    LightGBMCategoricalParams
  85. def getMaxCatToOnehot: Int
    Definition Classes
    LightGBMCategoricalParams
  86. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  87. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  88. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  89. def getMaxNumClasses: Int
    Definition Classes
    LightGBMParams
  90. def getMaxStreamingOMPThreads: Int
    Definition Classes
    LightGBMExecutionParams
  91. def getMetric: String
    Definition Classes
    LightGBMParams
  92. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  93. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  94. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  95. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  96. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  97. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  98. 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
  99. def getModelString: String
    Definition Classes
    LightGBMParams
  100. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  101. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  102. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  103. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  104. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  105. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  106. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  107. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  108. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  109. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  110. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  111. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  112. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  113. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  114. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  115. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  116. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  117. 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
  118. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  119. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  120. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  121. final def getProbabilityCol: String
    Definition Classes
    HasProbabilityCol
  122. final def getRawPredictionCol: String
    Definition Classes
    HasRawPredictionCol
  123. def getReferenceDataset: Array[Byte]
    Definition Classes
    LightGBMExecutionParams
  124. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  125. def getSamplingMode: String
    Definition Classes
    LightGBMExecutionParams
  126. def getSamplingSubsetSize: Int
    Definition Classes
    LightGBMExecutionParams
  127. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  128. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  129. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  130. def getThresholds: Array[Double]
    Definition Classes
    HasThresholds
  131. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  132. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  133. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  134. 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
  135. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  136. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  137. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  138. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  139. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  140. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  141. def getWeightCol: String

    Definition Classes
    HasWeightCol
  142. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  143. def getZeroAsMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  144. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  145. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  146. val improvementTolerance: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  147. val initScoreCol: Param[String]

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  148. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  149. val isEnableSparse: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  150. val isProvideTrainingMetric: BooleanParam
    Definition Classes
    LightGBMParams
  151. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  152. val isUnbalance: BooleanParam
  153. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  154. val lambdaL1: DoubleParam
    Definition Classes
    LightGBMParams
  155. val lambdaL2: DoubleParam
    Definition Classes
    LightGBMParams
  156. val leafPredictionCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  157. val learningRate: DoubleParam
    Definition Classes
    LightGBMParams
  158. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  159. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  160. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  161. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  162. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  163. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  164. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  165. val matrixType: Param[String]
    Definition Classes
    LightGBMExecutionParams
  166. val maxBin: IntParam
    Definition Classes
    LightGBMBinParams
  167. val maxBinByFeature: IntArrayParam
    Definition Classes
    LightGBMParams
  168. val maxCatThreshold: IntParam
    Definition Classes
    LightGBMCategoricalParams
  169. val maxCatToOnehot: IntParam
    Definition Classes
    LightGBMCategoricalParams
  170. val maxDeltaStep: DoubleParam
    Definition Classes
    LightGBMParams
  171. val maxDepth: IntParam
    Definition Classes
    LightGBMParams
  172. val maxDrop: IntParam
    Definition Classes
    LightGBMDartParams
  173. val maxNumClasses: IntParam
    Definition Classes
    LightGBMParams
  174. val maxStreamingOMPThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  175. val metric: Param[String]
    Definition Classes
    LightGBMParams
  176. val microBatchSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  177. val minDataInLeaf: IntParam
    Definition Classes
    LightGBMParams
  178. val minDataPerBin: IntParam
    Definition Classes
    LightGBMParams
  179. val minDataPerGroup: IntParam
    Definition Classes
    LightGBMCategoricalParams
  180. val minGainToSplit: DoubleParam
    Definition Classes
    LightGBMParams
  181. val minSumHessianInLeaf: DoubleParam
    Definition Classes
    LightGBMParams
  182. val modelString: Param[String]
    Definition Classes
    LightGBMParams
  183. val monotoneConstraints: IntArrayParam
    Definition Classes
    LightGBMLearnerParams
  184. val monotoneConstraintsMethod: Param[String]
    Definition Classes
    LightGBMLearnerParams
  185. val monotonePenalty: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  186. val negBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  187. val numBatches: IntParam
    Definition Classes
    LightGBMExecutionParams
  188. val numIterations: IntParam
    Definition Classes
    LightGBMParams
  189. val numLeaves: IntParam
    Definition Classes
    LightGBMParams
  190. val numTasks: IntParam
    Definition Classes
    LightGBMExecutionParams
  191. val numThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  192. val objective: Param[String]
    Definition Classes
    LightGBMObjectiveParams
  193. val objectiveSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  194. val otherRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  195. val parallelism: Param[String]
    Definition Classes
    LightGBMExecutionParams
  196. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  197. val passThroughArgs: Param[String]
    Definition Classes
    LightGBMExecutionParams
  198. val posBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  199. val predictDisableShapeCheck: BooleanParam
    Definition Classes
    LightGBMPredictionParams
  200. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  201. final val probabilityCol: Param[String]
    Definition Classes
    HasProbabilityCol
  202. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  203. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  204. final val rawPredictionCol: Param[String]
    Definition Classes
    HasRawPredictionCol
  205. val referenceDataset: ByteArrayParam
    Definition Classes
    LightGBMExecutionParams
  206. val repartitionByGroupingColumn: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  207. val samplingMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  208. val samplingSubsetSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  209. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  210. val seed: IntParam
    Definition Classes
    LightGBMSeedParams
  211. final def set[T](param: Param[T], value: T): LightGBMClassifier.this.type
    Definition Classes
    Params
  212. def setBaggingFraction(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMFractionParams
  213. def setBaggingFreq(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  214. def setBaggingSeed(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSeedParams
  215. def setBinSampleCount(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMBinParams
  216. def setBoostFromAverage(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  217. def setBoostingType(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  218. def setCatSmooth(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMCategoricalParams
  219. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSlotParams
  220. def setCategoricalSlotNames(value: Array[String]): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSlotParams
  221. def setCatl2(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMCategoricalParams
  222. def setChunkSize(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  223. def setDataRandomSeed(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSeedParams
  224. def setDataTransferMode(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  225. def setDefaultListenPort(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  226. def setDelegate(delegate: LightGBMDelegate): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  227. def setDeterministic(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSeedParams
  228. def setDriverListenPort(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  229. def setDropRate(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDartParams
  230. def setDropSeed(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSeedParams
  231. def setEarlyStoppingRound(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMLearnerParams
  232. def setExtraSeed(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSeedParams
  233. def setFObj(value: FObjTrait): LightGBMClassifier.this.type
    Definition Classes
    LightGBMObjectiveParams
  234. def setFeatureFraction(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMFractionParams
  235. def setFeatureFractionByNode(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMFractionParams
  236. def setFeatureFractionSeed(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSeedParams
  237. def setFeaturesCol(value: String): LightGBMClassifier
    Definition Classes
    Predictor
  238. def setFeaturesShapCol(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMPredictionParams
  239. def setImprovementTolerance(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMLearnerParams
  240. def setInitScoreCol(value: String): LightGBMClassifier.this.type

    Definition Classes
    HasInitScoreCol
  241. def setIsEnableSparse(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDatasetParams
  242. def setIsProvideTrainingMetric(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  243. def setIsUnbalance(value: Boolean): LightGBMClassifier.this.type
  244. def setLabelCol(value: String): LightGBMClassifier
    Definition Classes
    Predictor
  245. def setLambdaL1(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  246. def setLambdaL2(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  247. def setLeafPredictionCol(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMPredictionParams
  248. def setLearningRate(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  249. def setMatrixType(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  250. def setMaxBin(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMBinParams
  251. def setMaxBinByFeature(value: Array[Int]): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  252. def setMaxCatThreshold(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMCategoricalParams
  253. def setMaxCatToOnehot(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMCategoricalParams
  254. def setMaxDeltaStep(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  255. def setMaxDepth(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  256. def setMaxDrop(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDartParams
  257. def setMaxNumClasses(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  258. def setMaxStreamingOMPThreads(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  259. def setMetric(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  260. def setMicroBatchSize(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  261. def setMinDataInLeaf(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  262. def setMinDataPerBin(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  263. def setMinDataPerGroup(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMCategoricalParams
  264. def setMinGainToSplit(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  265. def setMinSumHessianInLeaf(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  266. def setModelString(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  267. def setMonotoneConstraints(value: Array[Int]): LightGBMClassifier.this.type
    Definition Classes
    LightGBMLearnerParams
  268. def setMonotoneConstraintsMethod(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMLearnerParams
  269. def setMonotonePenalty(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMLearnerParams
  270. def setNegBaggingFraction(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMFractionParams
  271. def setNumBatches(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  272. def setNumIterations(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  273. def setNumLeaves(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMParams
  274. def setNumTasks(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  275. def setNumThreads(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  276. def setObjective(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMObjectiveParams
  277. def setObjectiveSeed(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSeedParams
  278. def setOtherRate(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMLearnerParams
  279. def setParallelism(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  280. def setPassThroughArgs(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  281. def setPosBaggingFraction(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMFractionParams
  282. def setPredictDisableShapeCheck(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMPredictionParams
  283. def setPredictionCol(value: String): LightGBMClassifier
    Definition Classes
    Predictor
  284. def setProbabilityCol(value: String): LightGBMClassifier
    Definition Classes
    ProbabilisticClassifier
  285. def setRawPredictionCol(value: String): LightGBMClassifier
    Definition Classes
    Classifier
  286. def setReferenceDataset(value: Array[Byte]): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  287. def setRepartitionByGroupingColumn(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  288. def setSamplingMode(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  289. def setSamplingSubsetSize(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  290. def setSeed(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSeedParams
  291. def setSkipDrop(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDartParams
  292. def setSlotNames(value: Array[String]): LightGBMClassifier.this.type
    Definition Classes
    LightGBMSlotParams
  293. def setThresholds(value: Array[Double]): LightGBMClassifier
    Definition Classes
    ProbabilisticClassifier
  294. def setTimeout(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  295. def setTopK(value: Int): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  296. def setTopRate(value: Double): LightGBMClassifier.this.type
    Definition Classes
    LightGBMLearnerParams
  297. def setUniformDrop(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDartParams
  298. def setUseBarrierExecutionMode(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  299. def setUseMissing(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDatasetParams
  300. def setUseSingleDatasetMode(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
  301. def setValidationIndicatorCol(value: String): LightGBMClassifier.this.type

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

    Definition Classes
    HasWeightCol
  304. def setXGBoostDartMode(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDartParams
  305. def setZeroAsMissing(value: Boolean): LightGBMClassifier.this.type
    Definition Classes
    LightGBMDatasetParams
  306. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  307. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  308. def stringFromTrainedModel(model: LightGBMClassificationModel): String
    Definition Classes
    LightGBMClassifier → LightGBMBase
  309. val thresholds: DoubleArrayParam
    Definition Classes
    HasThresholds
  310. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  311. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  312. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  313. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  314. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  315. val uid: String
    Definition Classes
    LightGBMClassifier → SynapseMLLogging → Identifiable
  316. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  317. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  318. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  319. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  320. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  321. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  322. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  323. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable
  324. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  325. val zeroAsMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams

Deprecated Value Members

  1. val executionMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.1) Please use 'dataTransferMode'

  2. def setExecutionMode(value: String): LightGBMClassifier.this.type
    Definition Classes
    LightGBMExecutionParams
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.1) Please use 'setDataTransferMode'