trait LightGBMBase[TrainedModel <: Model[TrainedModel] with LightGBMModelParams] extends Estimator[TrainedModel] with LightGBMParams with ComplexParamsWritable with HasFeaturesCol with HasLabelCol with LightGBMPerformance with SynapseMLLogging

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMBase
  2. SynapseMLLogging
  3. LightGBMPerformance
  4. HasLabelCol
  5. HasFeaturesCol
  6. ComplexParamsWritable
  7. LightGBMParams
  8. LightGBMCategoricalParams
  9. LightGBMSeedParams
  10. LightGBMObjectiveParams
  11. LightGBMPredictionParams
  12. LightGBMDartParams
  13. LightGBMDatasetParams
  14. LightGBMLearnerParams
  15. LightGBMBinParams
  16. LightGBMFractionParams
  17. LightGBMSlotParams
  18. LightGBMExecutionParams
  19. HasInitScoreCol
  20. HasValidationIndicatorCol
  21. HasWeightCol
  22. DefaultParamsWritable
  23. MLWritable
  24. Wrappable
  25. RWrappable
  26. PythonWrappable
  27. BaseWrappable
  28. Estimator
  29. PipelineStage
  30. Logging
  31. Params
  32. Serializable
  33. Serializable
  34. Identifiable
  35. AnyRef
  36. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Estimator[TrainedModel]
    Definition Classes
    Estimator → PipelineStage → Params
  2. abstract def fit(dataset: Dataset[_]): TrainedModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  3. abstract def getModel(trainParams: BaseTrainParams, lightGBMBooster: LightGBMBooster): TrainedModel

    Gets the trained model given the train parameters and booster.

    Gets the trained model given the train parameters and booster.

    returns

    trained model.

    Attributes
    protected
  4. abstract 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.

    Attributes
    protected
  5. abstract def stringFromTrainedModel(model: TrainedModel): String
    Attributes
    protected
  6. abstract def transformSchema(schema: StructType): StructType
    Definition Classes
    PipelineStage
  7. abstract val uid: String
    Definition Classes
    SynapseMLLogging

Concrete 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
  6. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: TrainedModel): Unit
  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[TrainedModel]): Unit
  12. val binSampleCount: IntParam
    Definition Classes
    LightGBMBinParams
  13. val boostFromAverage: BooleanParam
    Definition Classes
    LightGBMParams
  14. val boostingType: Param[String]
    Definition Classes
    LightGBMParams
  15. def castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame
    Attributes
    protected
  16. val catSmooth: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  17. val categoricalSlotIndexes: IntArrayParam
    Definition Classes
    LightGBMSlotParams
  18. val categoricalSlotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  19. val catl2: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  20. val chunkSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  21. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  22. final def clear(param: Param[_]): LightGBMBase.this.type
    Definition Classes
    Params
  23. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  25. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  26. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  27. val dataRandomSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  28. val dataTransferMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  29. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  30. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  31. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  32. val deterministic: BooleanParam
    Definition Classes
    LightGBMSeedParams
  33. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  34. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  35. val dropSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  36. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  39. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  40. def explainParams(): String
    Definition Classes
    Params
  41. val extraSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  42. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  43. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  44. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  45. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  46. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  47. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  48. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  49. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  50. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[TrainedModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  51. def fit(dataset: Dataset[_], paramMap: ParamMap): TrainedModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  52. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): TrainedModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  53. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  54. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  55. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  56. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  57. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  58. def getBaggingSeed: Int
    Definition Classes
    LightGBMSeedParams
  59. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  60. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  61. def getBoostingType: String
    Definition Classes
    LightGBMParams
  62. def getCatSmooth: Double
    Definition Classes
    LightGBMCategoricalParams
  63. 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
  64. def getCategoricalParams: CategoricalParams

    Constructs the CategoricalParams.

    Constructs the CategoricalParams.

    returns

    CategoricalParams object containing the parameters related to LightGBM categorical features.

    Attributes
    protected
  65. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  66. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  67. def getCatl2: Double
    Definition Classes
    LightGBMCategoricalParams
  68. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  69. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  70. def getColumnParams: ColumnParams

    Constructs the ColumnParams.

    Constructs the ColumnParams.

    returns

    ColumnParams object containing the parameters related to LightGBM columns.

    Attributes
    protected
  71. def getDartParams: DartModeParams

    Constructs the DartModeParams

    Constructs the DartModeParams

    returns

    DartModeParams object containing parameters related to dart mode.

    Attributes
    protected
  72. def getDataRandomSeed: Int
    Definition Classes
    LightGBMSeedParams
  73. def getDataTransferMode: String
    Definition Classes
    LightGBMExecutionParams
  74. def getDatasetCreationParams(categoricalIndexes: Array[Int], numThreads: Int): String
    Attributes
    protected
  75. def getDatasetParams: DatasetParams

    Constructs the DatasetParams.

    Constructs the DatasetParams.

    returns

    DatasetParams object containing parameters related to LightGBM Dataset parameters.

    Attributes
    protected
  76. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  77. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  78. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  79. def getDeterministic: Boolean
    Definition Classes
    LightGBMSeedParams
  80. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  81. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  82. def getDropSeed: Int
    Definition Classes
    LightGBMSeedParams
  83. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  84. def getExecutionParams(numTasksPerExec: Int): ExecutionParams

    Constructs the ExecutionParams.

    Constructs the ExecutionParams.

    returns

    ExecutionParams object containing parameters related to LightGBM execution.

    Attributes
    protected
  85. def getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  86. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  87. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  88. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  89. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  90. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  91. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  92. 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
  93. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  94. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  95. def getIsEnableSparse: Boolean
    Definition Classes
    LightGBMDatasetParams
  96. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  97. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  98. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  99. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  100. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  101. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  102. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  103. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  104. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  105. def getMaxCatThreshold: Int
    Definition Classes
    LightGBMCategoricalParams
  106. def getMaxCatToOnehot: Int
    Definition Classes
    LightGBMCategoricalParams
  107. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  108. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  109. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  110. def getMaxNumClasses: Int
    Definition Classes
    LightGBMParams
  111. def getMaxStreamingOMPThreads: Int
    Definition Classes
    LightGBMExecutionParams
  112. def getMetric: String
    Definition Classes
    LightGBMParams
  113. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  114. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  115. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  116. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  117. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  118. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  119. def getModelString: String
    Definition Classes
    LightGBMParams
  120. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  121. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  122. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  123. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  124. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  125. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  126. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  127. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  128. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  129. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  130. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
  131. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  132. 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
  133. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  134. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  135. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  136. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  137. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  138. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  139. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  140. 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
  141. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  142. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  143. def getReferenceDataset: Array[Byte]
    Definition Classes
    LightGBMExecutionParams
  144. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  145. def getSamplingMode: String
    Definition Classes
    LightGBMExecutionParams
  146. def getSamplingSubsetSize: Int
    Definition Classes
    LightGBMExecutionParams
  147. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  148. def getSeedParams: SeedParams

    Constructs the SeedParams.

    Constructs the SeedParams.

    returns

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

    Attributes
    protected
  149. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  150. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  151. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  152. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  153. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  154. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
  155. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  156. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  157. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  158. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  159. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  160. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  161. def getWeightCol: String

    Definition Classes
    HasWeightCol
  162. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  163. def getZeroAsMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  164. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  165. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  166. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  167. val improvementTolerance: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  168. def initPerformanceMeasures(batchCount: Int): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  169. val initScoreCol: Param[String]

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  170. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  171. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  172. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  173. val isEnableSparse: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  174. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  175. val isProvideTrainingMetric: BooleanParam
    Definition Classes
    LightGBMParams
  176. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  177. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  178. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  179. val lambdaL1: DoubleParam
    Definition Classes
    LightGBMParams
  180. val lambdaL2: DoubleParam
    Definition Classes
    LightGBMParams
  181. val leafPredictionCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  182. val learningRate: DoubleParam
    Definition Classes
    LightGBMParams
  183. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  184. def logBase(info: Map[String, String], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  185. def logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  186. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  187. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  188. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  189. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  190. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  191. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  192. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  193. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  194. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  195. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  196. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  197. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  198. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  199. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  200. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  201. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  202. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  203. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  204. val matrixType: Param[String]
    Definition Classes
    LightGBMExecutionParams
  205. val maxBin: IntParam
    Definition Classes
    LightGBMBinParams
  206. val maxBinByFeature: IntArrayParam
    Definition Classes
    LightGBMParams
  207. val maxCatThreshold: IntParam
    Definition Classes
    LightGBMCategoricalParams
  208. val maxCatToOnehot: IntParam
    Definition Classes
    LightGBMCategoricalParams
  209. val maxDeltaStep: DoubleParam
    Definition Classes
    LightGBMParams
  210. val maxDepth: IntParam
    Definition Classes
    LightGBMParams
  211. val maxDrop: IntParam
    Definition Classes
    LightGBMDartParams
  212. val maxNumClasses: IntParam
    Definition Classes
    LightGBMParams
  213. val maxStreamingOMPThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  214. val metric: Param[String]
    Definition Classes
    LightGBMParams
  215. val microBatchSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  216. val minDataInLeaf: IntParam
    Definition Classes
    LightGBMParams
  217. val minDataPerBin: IntParam
    Definition Classes
    LightGBMParams
  218. val minDataPerGroup: IntParam
    Definition Classes
    LightGBMCategoricalParams
  219. val minGainToSplit: DoubleParam
    Definition Classes
    LightGBMParams
  220. val minSumHessianInLeaf: DoubleParam
    Definition Classes
    LightGBMParams
  221. val modelString: Param[String]
    Definition Classes
    LightGBMParams
  222. val monotoneConstraints: IntArrayParam
    Definition Classes
    LightGBMLearnerParams
  223. val monotoneConstraintsMethod: Param[String]
    Definition Classes
    LightGBMLearnerParams
  224. val monotonePenalty: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  225. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  226. val negBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  227. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  228. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  229. val numBatches: IntParam
    Definition Classes
    LightGBMExecutionParams
  230. val numIterations: IntParam
    Definition Classes
    LightGBMParams
  231. val numLeaves: IntParam
    Definition Classes
    LightGBMParams
  232. val numTasks: IntParam
    Definition Classes
    LightGBMExecutionParams
  233. val numThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  234. val objective: Param[String]
    Definition Classes
    LightGBMObjectiveParams
  235. val objectiveSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  236. val otherRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  237. val parallelism: Param[String]
    Definition Classes
    LightGBMExecutionParams
  238. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  239. val passThroughArgs: Param[String]
    Definition Classes
    LightGBMExecutionParams
  240. val posBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  241. val predictDisableShapeCheck: BooleanParam
    Definition Classes
    LightGBMPredictionParams
  242. def prepareDataframe(dataset: Dataset[_], numTasks: Int): DataFrame
    Attributes
    protected
  243. 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
  244. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  245. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  246. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  247. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  248. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  249. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  250. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  251. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  252. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  253. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  254. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  255. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  256. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  257. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  258. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  259. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  260. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  261. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  262. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  263. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  264. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  265. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  266. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  267. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  268. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  269. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  270. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  271. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  272. val referenceDataset: ByteArrayParam
    Definition Classes
    LightGBMExecutionParams
  273. val repartitionByGroupingColumn: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  274. val samplingMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  275. val samplingSubsetSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  276. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  277. val seed: IntParam
    Definition Classes
    LightGBMSeedParams
  278. final def set(paramPair: ParamPair[_]): LightGBMBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  279. final def set(param: String, value: Any): LightGBMBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  280. final def set[T](param: Param[T], value: T): LightGBMBase.this.type
    Definition Classes
    Params
  281. def setBaggingFraction(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMFractionParams
  282. def setBaggingFreq(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  283. def setBaggingSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  284. def setBatchPerformanceMeasure(index: Int, measures: InstrumentationMeasures): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  285. def setBatchPerformanceMeasures(measures: Array[Option[InstrumentationMeasures]]): LightGBMBase.this.type
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  286. def setBinSampleCount(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMBinParams
  287. def setBoostFromAverage(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  288. def setBoostingType(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  289. def setCatSmooth(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMCategoricalParams
  290. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMBase.this.type
    Definition Classes
    LightGBMSlotParams
  291. def setCategoricalSlotNames(value: Array[String]): LightGBMBase.this.type
    Definition Classes
    LightGBMSlotParams
  292. def setCatl2(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMCategoricalParams
  293. def setChunkSize(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  294. def setDataRandomSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  295. def setDataTransferMode(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  296. final def setDefault(paramPairs: ParamPair[_]*): LightGBMBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  297. final def setDefault[T](param: Param[T], value: T): LightGBMBase.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  298. def setDefaultListenPort(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  299. def setDelegate(delegate: LightGBMDelegate): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  300. def setDeterministic(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  301. def setDriverListenPort(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  302. def setDropRate(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  303. def setDropSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  304. def setEarlyStoppingRound(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  305. def setExtraSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  306. def setFObj(value: FObjTrait): LightGBMBase.this.type
    Definition Classes
    LightGBMObjectiveParams
  307. def setFeatureFraction(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMFractionParams
  308. def setFeatureFractionByNode(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMFractionParams
  309. def setFeatureFractionSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  310. def setFeaturesShapCol(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMPredictionParams
  311. def setImprovementTolerance(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  312. def setInitScoreCol(value: String): LightGBMBase.this.type

    Definition Classes
    HasInitScoreCol
  313. def setIsEnableSparse(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDatasetParams
  314. def setIsProvideTrainingMetric(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  315. def setLambdaL1(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  316. def setLambdaL2(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  317. def setLeafPredictionCol(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMPredictionParams
  318. def setLearningRate(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  319. def setMatrixType(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  320. def setMaxBin(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMBinParams
  321. def setMaxBinByFeature(value: Array[Int]): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  322. def setMaxCatThreshold(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMCategoricalParams
  323. def setMaxCatToOnehot(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMCategoricalParams
  324. def setMaxDeltaStep(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  325. def setMaxDepth(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  326. def setMaxDrop(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  327. def setMaxNumClasses(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  328. def setMaxStreamingOMPThreads(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  329. def setMetric(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  330. def setMicroBatchSize(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  331. def setMinDataInLeaf(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  332. def setMinDataPerBin(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  333. def setMinDataPerGroup(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMCategoricalParams
  334. def setMinGainToSplit(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  335. def setMinSumHessianInLeaf(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  336. def setModelString(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  337. def setMonotoneConstraints(value: Array[Int]): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  338. def setMonotoneConstraintsMethod(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  339. def setMonotonePenalty(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  340. def setNegBaggingFraction(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMFractionParams
  341. def setNumBatches(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  342. def setNumIterations(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  343. def setNumLeaves(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  344. def setNumTasks(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  345. def setNumThreads(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  346. def setObjective(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMObjectiveParams
  347. def setObjectiveSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  348. def setOtherRate(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  349. def setParallelism(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  350. def setPassThroughArgs(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  351. def setPosBaggingFraction(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMFractionParams
  352. def setPredictDisableShapeCheck(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMPredictionParams
  353. def setReferenceDataset(value: Array[Byte]): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  354. def setRepartitionByGroupingColumn(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  355. def setSamplingMode(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  356. def setSamplingSubsetSize(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  357. def setSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  358. def setSkipDrop(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  359. def setSlotNames(value: Array[String]): LightGBMBase.this.type
    Definition Classes
    LightGBMSlotParams
  360. def setTimeout(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  361. def setTopK(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  362. def setTopRate(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  363. def setUniformDrop(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  364. def setUseBarrierExecutionMode(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  365. def setUseMissing(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDatasetParams
  366. def setUseSingleDatasetMode(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  367. def setValidationIndicatorCol(value: String): LightGBMBase.this.type

    Definition Classes
    HasValidationIndicatorCol
  368. def setVerbosity(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  369. def setWeightCol(value: String): LightGBMBase.this.type

    Definition Classes
    HasWeightCol
  370. def setXGBoostDartMode(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  371. def setZeroAsMissing(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDatasetParams
  372. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  373. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  374. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  375. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  376. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  377. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  378. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  379. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  380. def train(dataset: Dataset[_]): TrainedModel

    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
  381. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  382. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  383. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  384. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  385. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  386. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  387. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  388. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  389. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  390. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  391. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  392. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable
  393. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  394. 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): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.1) Please use 'setDataTransferMode'

Inherited from SynapseMLLogging

Inherited from LightGBMPerformance

Inherited from HasLabelCol

Inherited from HasFeaturesCol

Inherited from ComplexParamsWritable

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 RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Estimator[TrainedModel]

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