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. DotnetWrappable
  26. RWrappable
  27. PythonWrappable
  28. BaseWrappable
  29. Estimator
  30. PipelineStage
  31. Logging
  32. Params
  33. Serializable
  34. Serializable
  35. Identifiable
  36. AnyRef
  37. 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. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  34. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  35. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  36. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  37. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  38. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  39. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  40. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  41. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  42. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  43. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  44. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  45. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  46. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  47. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  48. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  49. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  50. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  51. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  52. val dropSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  53. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  54. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  56. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  57. def explainParams(): String
    Definition Classes
    Params
  58. val extraSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  59. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  60. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  61. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  62. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  63. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  64. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  65. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  66. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  67. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[TrainedModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  68. def fit(dataset: Dataset[_], paramMap: ParamMap): TrainedModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  69. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): TrainedModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  70. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  71. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  72. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  73. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  74. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  75. def getBaggingSeed: Int
    Definition Classes
    LightGBMSeedParams
  76. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  77. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  78. def getBoostingType: String
    Definition Classes
    LightGBMParams
  79. def getCatSmooth: Double
    Definition Classes
    LightGBMCategoricalParams
  80. 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
  81. def getCategoricalParams: CategoricalParams

    Constructs the CategoricalParams.

    Constructs the CategoricalParams.

    returns

    CategoricalParams object containing the parameters related to LightGBM categorical features.

    Attributes
    protected
  82. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  83. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  84. def getCatl2: Double
    Definition Classes
    LightGBMCategoricalParams
  85. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  86. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  87. def getColumnParams: ColumnParams

    Constructs the ColumnParams.

    Constructs the ColumnParams.

    returns

    ColumnParams object containing the parameters related to LightGBM columns.

    Attributes
    protected
  88. def getDartParams: DartModeParams

    Constructs the DartModeParams

    Constructs the DartModeParams

    returns

    DartModeParams object containing parameters related to dart mode.

    Attributes
    protected
  89. def getDataRandomSeed: Int
    Definition Classes
    LightGBMSeedParams
  90. def getDataTransferMode: String
    Definition Classes
    LightGBMExecutionParams
  91. def getDatasetCreationParams(categoricalIndexes: Array[Int], numThreads: Int): String
    Attributes
    protected
  92. def getDatasetParams: DatasetParams

    Constructs the DatasetParams.

    Constructs the DatasetParams.

    returns

    DatasetParams object containing parameters related to LightGBM Dataset parameters.

    Attributes
    protected
  93. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  94. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  95. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  96. def getDeterministic: Boolean
    Definition Classes
    LightGBMSeedParams
  97. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  98. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  99. def getDropSeed: Int
    Definition Classes
    LightGBMSeedParams
  100. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  101. def getExecutionParams(numTasksPerExec: Int): ExecutionParams

    Constructs the ExecutionParams.

    Constructs the ExecutionParams.

    returns

    ExecutionParams object containing parameters related to LightGBM execution.

    Attributes
    protected
  102. def getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  103. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  104. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  105. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  106. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  107. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  108. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  109. 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
  110. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  111. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  112. def getIsEnableSparse: Boolean
    Definition Classes
    LightGBMDatasetParams
  113. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  114. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  115. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  116. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  117. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  118. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  119. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  120. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  121. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  122. def getMaxCatThreshold: Int
    Definition Classes
    LightGBMCategoricalParams
  123. def getMaxCatToOnehot: Int
    Definition Classes
    LightGBMCategoricalParams
  124. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  125. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  126. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  127. def getMaxNumClasses: Int
    Definition Classes
    LightGBMParams
  128. def getMaxStreamingOMPThreads: Int
    Definition Classes
    LightGBMExecutionParams
  129. def getMetric: String
    Definition Classes
    LightGBMParams
  130. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  131. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  132. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  133. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  134. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  135. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  136. def getModelString: String
    Definition Classes
    LightGBMParams
  137. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  138. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  139. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  140. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  141. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  142. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  143. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  144. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  145. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  146. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  147. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
  148. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  149. 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
  150. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  151. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  152. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  153. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  154. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  155. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  156. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  157. 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
  158. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  159. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  160. def getReferenceDataset: Array[Byte]
    Definition Classes
    LightGBMExecutionParams
  161. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  162. def getSamplingMode: String
    Definition Classes
    LightGBMExecutionParams
  163. def getSamplingSubsetSize: Int
    Definition Classes
    LightGBMExecutionParams
  164. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  165. def getSeedParams: SeedParams

    Constructs the SeedParams.

    Constructs the SeedParams.

    returns

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

    Attributes
    protected
  166. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  167. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  168. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  169. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  170. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  171. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
  172. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  173. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  174. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  175. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  176. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  177. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  178. def getWeightCol: String

    Definition Classes
    HasWeightCol
  179. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  180. def getZeroAsMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  181. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  182. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  183. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  184. val improvementTolerance: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  185. def initPerformanceMeasures(batchCount: Int): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  186. val initScoreCol: Param[String]

    The name of the initial score column

    The name of the initial score column

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

    Definition Classes
    HasInitScoreCol
  331. def setIsEnableSparse(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDatasetParams
  332. def setIsProvideTrainingMetric(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  333. def setLambdaL1(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  334. def setLambdaL2(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  335. def setLeafPredictionCol(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMPredictionParams
  336. def setLearningRate(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  337. def setMatrixType(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  338. def setMaxBin(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMBinParams
  339. def setMaxBinByFeature(value: Array[Int]): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  340. def setMaxCatThreshold(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMCategoricalParams
  341. def setMaxCatToOnehot(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMCategoricalParams
  342. def setMaxDeltaStep(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  343. def setMaxDepth(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  344. def setMaxDrop(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  345. def setMaxNumClasses(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  346. def setMaxStreamingOMPThreads(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  347. def setMetric(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  348. def setMicroBatchSize(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  349. def setMinDataInLeaf(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  350. def setMinDataPerBin(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  351. def setMinDataPerGroup(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMCategoricalParams
  352. def setMinGainToSplit(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  353. def setMinSumHessianInLeaf(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  354. def setModelString(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  355. def setMonotoneConstraints(value: Array[Int]): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  356. def setMonotoneConstraintsMethod(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  357. def setMonotonePenalty(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  358. def setNegBaggingFraction(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMFractionParams
  359. def setNumBatches(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  360. def setNumIterations(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  361. def setNumLeaves(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMParams
  362. def setNumTasks(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  363. def setNumThreads(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  364. def setObjective(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMObjectiveParams
  365. def setObjectiveSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  366. def setOtherRate(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  367. def setParallelism(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  368. def setPassThroughArgs(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  369. def setPosBaggingFraction(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMFractionParams
  370. def setPredictDisableShapeCheck(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMPredictionParams
  371. def setReferenceDataset(value: Array[Byte]): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  372. def setRepartitionByGroupingColumn(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  373. def setSamplingMode(value: String): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  374. def setSamplingSubsetSize(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  375. def setSeed(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMSeedParams
  376. def setSkipDrop(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  377. def setSlotNames(value: Array[String]): LightGBMBase.this.type
    Definition Classes
    LightGBMSlotParams
  378. def setTimeout(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  379. def setTopK(value: Int): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  380. def setTopRate(value: Double): LightGBMBase.this.type
    Definition Classes
    LightGBMLearnerParams
  381. def setUniformDrop(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  382. def setUseBarrierExecutionMode(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  383. def setUseMissing(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDatasetParams
  384. def setUseSingleDatasetMode(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMExecutionParams
  385. def setValidationIndicatorCol(value: String): LightGBMBase.this.type

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

    Definition Classes
    HasWeightCol
  388. def setXGBoostDartMode(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDartParams
  389. def setZeroAsMissing(value: Boolean): LightGBMBase.this.type
    Definition Classes
    LightGBMDatasetParams
  390. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  391. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  392. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  393. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  394. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  395. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  396. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  397. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  398. 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
  399. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  400. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  401. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  402. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  403. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  404. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  405. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  406. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  407. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  408. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  409. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  410. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable
  411. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  412. 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 DotnetWrappable

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