class LightGBMRanker extends Ranker[Vector, LightGBMRanker, LightGBMRankerModel] with LightGBMBase[LightGBMRankerModel] with SynapseMLLogging

Trains a LightGBMRanker model, a fast, distributed, high performance gradient boosting framework based on decision tree algorithms. For more information please see here: https://github.com/Microsoft/LightGBM. For parameter information see here: https://github.com/Microsoft/LightGBM/blob/master/docs/Parameters.rst

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

Instance Constructors

  1. new LightGBMRanker()
  2. new LightGBMRanker(uid: String)

    uid

    The unique ID.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def addCustomTrainParams(params: BaseTrainParams, dataset: Dataset[_]): BaseTrainParams
    Attributes
    protected
    Definition Classes
    LightGBMBase
  6. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMRankerModel): Unit
    Definition Classes
    LightGBMBase
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val baggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  9. val baggingFreq: IntParam
    Definition Classes
    LightGBMParams
  10. val baggingSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  11. def beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMRankerModel]): Unit
    Definition Classes
    LightGBMBase
  12. val binSampleCount: IntParam
    Definition Classes
    LightGBMBinParams
  13. val boostFromAverage: BooleanParam
    Definition Classes
    LightGBMParams
  14. val boostingType: Param[String]
    Definition Classes
    LightGBMParams
  15. def calculateColumnStatistics(dataframe: DataFrame, measures: InstrumentationMeasures): (Int, Int)

    Extract column counts from the dataset.

    Extract column counts from the dataset.

    dataframe

    The dataset to train on.

    returns

    The number of feature columns and initial score classes

    Attributes
    protected
    Definition Classes
    LightGBMBase
  16. def calculateRowStatistics(dataframe: DataFrame, trainingParams: BaseTrainParams, numCols: Int, measures: InstrumentationMeasures): (Array[Row], Array[Long])

    Inner train method for LightGBM learners.

    Inner train method for LightGBM learners. Calculates the number of workers, creates a driver thread, and runs mapPartitions on the dataset.

    dataframe

    The dataset to train on.

    trainingParams

    The training parameters.

    numCols

    The number of feature columns.

    returns

    The serialized Dataset reference and an array of partition counts.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  17. def castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  18. val catSmooth: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  19. val categoricalSlotIndexes: IntArrayParam
    Definition Classes
    LightGBMSlotParams
  20. val categoricalSlotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  21. val catl2: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  22. val chunkSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  23. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  24. final def clear(param: Param[_]): LightGBMRanker.this.type
    Definition Classes
    Params
  25. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  27. def copy(extra: ParamMap): LightGBMRanker
    Definition Classes
    LightGBMRanker → Predictor → Estimator → PipelineStage → Params
  28. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  29. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  30. val dataRandomSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  31. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  32. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  33. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  34. val deterministic: BooleanParam
    Definition Classes
    LightGBMSeedParams
  35. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  36. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  37. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  38. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  39. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  40. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  41. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  42. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  43. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  44. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  45. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  46. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  47. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  48. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  49. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  50. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  51. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  52. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  53. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  54. val dropSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  55. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  56. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  58. val evalAt: IntArrayParam
  59. def executePartitionTasks(ctx: TrainingContext, dataframe: DataFrame, measures: InstrumentationMeasures): LightGBMBooster
    Attributes
    protected
    Definition Classes
    LightGBMBase
  60. def executeTraining(dataframe: DataFrame, validationData: Option[Broadcast[Array[Row]]], broadcastedSampleData: Option[Broadcast[Array[Row]]], partitionCounts: Option[Array[Long]], trainParams: BaseTrainParams, numCols: Int, numInitValueClasses: Int, batchIndex: Int, numTasks: Int, numTasksPerExecutor: Int, measures: InstrumentationMeasures): LightGBMRankerModel

    Run a parallel job via map partitions to initialize the native library and network, translate the data to the LightGBM in-memory representation and train the models.

    Run a parallel job via map partitions to initialize the native library and network, translate the data to the LightGBM in-memory representation and train the models.

    dataframe

    The dataset to train on.

    validationData

    The dataset to use as validation. (optional)

    broadcastedSampleData

    Sample data to use for streaming mode Dataset creation (optional).

    partitionCounts

    The count per partition for streaming mode (optional).

    trainParams

    Training parameters.

    numCols

    Number of columns.

    numInitValueClasses

    Number of classes for initial values (used only for multiclass).

    batchIndex

    In running in batch training mode, gets the batch number.

    numTasks

    Number of tasks/partitions.

    numTasksPerExecutor

    Number of tasks per executor.

    measures

    Instrumentation measures to populate.

    returns

    The LightGBM Model from the trained LightGBM Booster.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  61. val executionMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  62. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  63. def explainParams(): String
    Definition Classes
    Params
  64. val extraSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  65. def extractInstances(dataset: Dataset[_], validateInstance: (Instance) ⇒ Unit): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  66. def extractInstances(dataset: Dataset[_]): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  67. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]
    Attributes
    protected
    Definition Classes
    Predictor
  68. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  69. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  70. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  71. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  72. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  73. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  74. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  75. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  76. def fit(dataset: Dataset[_]): LightGBMRankerModel
    Definition Classes
    Predictor → Estimator
  77. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMRankerModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  78. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  79. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  80. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  81. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  82. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  83. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  84. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  85. def getBaggingSeed: Int
    Definition Classes
    LightGBMSeedParams
  86. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  87. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  88. def getBoostingType: String
    Definition Classes
    LightGBMParams
  89. def getCatSmooth: Double
    Definition Classes
    LightGBMCategoricalParams
  90. def getCategoricalIndexes(featuresSchema: StructField): Array[Int]

    Retrieves the categorical indexes in the features column.

    Retrieves the categorical indexes in the features column.

    featuresSchema

    The schema of the features column

    returns

    the categorical indexes in the features column.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  91. def getCategoricalParams: CategoricalParams

    Constructs the CategoricalParams.

    Constructs the CategoricalParams.

    returns

    CategoricalParams object containing the parameters related to LightGBM categorical features.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  92. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  93. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  94. def getCatl2: Double
    Definition Classes
    LightGBMCategoricalParams
  95. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  96. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  97. def getColumnParams: ColumnParams

    Constructs the ColumnParams.

    Constructs the ColumnParams.

    returns

    ColumnParams object containing the parameters related to LightGBM columns.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  98. def getDartParams: DartModeParams

    Constructs the DartModeParams

    Constructs the DartModeParams

    returns

    DartModeParams object containing parameters related to dart mode.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  99. def getDataRandomSeed: Int
    Definition Classes
    LightGBMSeedParams
  100. def getDatasetCreationParams(categoricalIndexes: Array[Int], numThreads: Int): String
    Definition Classes
    LightGBMBase
  101. def getDatasetParams: DatasetParams

    Constructs the DatasetParams.

    Constructs the DatasetParams.

    returns

    DatasetParams object containing parameters related to LightGBM Dataset parameters.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  102. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  103. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  104. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  105. def getDeterministic: Boolean
    Definition Classes
    LightGBMSeedParams
  106. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  107. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  108. def getDropSeed: Int
    Definition Classes
    LightGBMSeedParams
  109. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  110. def getEvalAt: Array[Int]
  111. def getExecutionMode: String
    Definition Classes
    LightGBMExecutionParams
  112. def getExecutionParams(numTasksPerExec: Int): ExecutionParams

    Constructs the ExecutionParams.

    Constructs the ExecutionParams.

    returns

    ExecutionParams object containing parameters related to LightGBM execution.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  113. def getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  114. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  115. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  116. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  117. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  118. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  119. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  120. def getGeneralParams(numTasks: Int, featuresSchema: StructField): GeneralParams

    Constructs the GeneralParams.

    Constructs the GeneralParams.

    returns

    GeneralParams object containing parameters related to general LightGBM parameters.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  121. def getGroupCol: String

    Definition Classes
    HasGroupCol
  122. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  123. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  124. def getIsEnableSparse: Boolean
    Definition Classes
    LightGBMDatasetParams
  125. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  126. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  127. def getLabelGain: Array[Double]
  128. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  129. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  130. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  131. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  132. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  133. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  134. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  135. def getMaxCatThreshold: Int
    Definition Classes
    LightGBMCategoricalParams
  136. def getMaxCatToOnehot: Int
    Definition Classes
    LightGBMCategoricalParams
  137. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  138. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  139. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  140. def getMaxNumClasses: Int
    Definition Classes
    LightGBMParams
  141. def getMaxPosition: Int
  142. def getMaxStreamingOMPThreads: Int
    Definition Classes
    LightGBMExecutionParams
  143. def getMetric: String
    Definition Classes
    LightGBMParams
  144. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  145. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  146. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  147. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  148. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  149. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  150. def getModel(trainParams: BaseTrainParams, lightGBMBooster: LightGBMBooster): LightGBMRankerModel

    Gets the trained model given the train parameters and booster.

    Gets the trained model given the train parameters and booster.

    returns

    trained model.

    Definition Classes
    LightGBMRankerLightGBMBase
  151. def getModelString: String
    Definition Classes
    LightGBMParams
  152. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  153. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  154. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  155. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  156. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  157. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  158. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  159. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  160. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  161. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  162. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  163. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  164. 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

    Definition Classes
    LightGBMRankerLightGBMBase
  165. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  166. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  167. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  168. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  169. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  170. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  171. 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
  172. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  173. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  174. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  175. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  176. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  177. def getSeedParams: SeedParams

    Constructs the SeedParams.

    Constructs the SeedParams.

    returns

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

    Attributes
    protected
    Definition Classes
    LightGBMBase
  178. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  179. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  180. def getSlotNamesWithMetadata(featuresSchema: StructField): Option[Array[String]]
    Definition Classes
    LightGBMBase
  181. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  182. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  183. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  184. def getTrainParams(numTasks: Int, featuresSchema: StructField, numTasksPerExec: Int): BaseTrainParams

    Gets the training parameters.

    Gets the training parameters.

    numTasks

    The total number of tasks.

    featuresSchema

    The features column schema.

    numTasksPerExec

    The number of tasks per executor.

    returns

    train parameters.

    Definition Classes
    LightGBMRankerLightGBMBase
  185. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
    Definition Classes
    LightGBMBase
  186. def getTrainingContext(dataframe: DataFrame, validationData: Option[Broadcast[Array[Row]]], broadcastedSampleData: Option[Broadcast[Array[Row]]], partitionCounts: Option[Array[Long]], trainParams: BaseTrainParams, numCols: Int, numInitValueClasses: Int, batchIndex: Int, numTasksPerExecutor: Int, networkManager: NetworkManager): TrainingContext

    Get the object that holds all relevant context information for the training session.

    Get the object that holds all relevant context information for the training session.

    dataframe

    The dataset to train on.

    validationData

    The dataset to use as validation. (optional)

    broadcastedSampleData

    Sample data to use for streaming mode Dataset creation (optional).

    partitionCounts

    The count per partition for streaming mode (optional).

    trainParams

    Training parameters.

    numCols

    Number of columns.

    numInitValueClasses

    Number of classes for initial values (used only for multiclass).

    batchIndex

    In running in batch training mode, gets the batch number.

    numTasksPerExecutor

    Number of tasks per executor.

    networkManager

    The network manager.

    returns

    The context of the training session.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  187. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  188. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  189. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  190. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  191. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  192. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  193. def getWeightCol: String

    Definition Classes
    HasWeightCol
  194. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  195. def getZeroAsMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  196. val groupCol: Param[String]

    The name of the group column

    The name of the group column

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

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  203. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  204. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  205. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  206. val isEnableSparse: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  207. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  208. val isProvideTrainingMetric: BooleanParam
    Definition Classes
    LightGBMParams
  209. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  210. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  211. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  212. val labelGain: DoubleArrayParam
  213. val lambdaL1: DoubleParam
    Definition Classes
    LightGBMParams
  214. val lambdaL2: DoubleParam
    Definition Classes
    LightGBMParams
  215. val leafPredictionCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  216. val learningRate: DoubleParam
    Definition Classes
    LightGBMParams
  217. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  218. def logBase(info: SynapseMLLogInfo): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  219. def logBase(methodName: String, columns: Option[Int]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  220. def logClass(): Unit
    Definition Classes
    SynapseMLLogging
  221. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  222. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  223. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  224. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  225. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  226. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  227. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  228. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  229. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  230. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  231. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  232. def logTrain[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  233. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  234. def logVerb[T](verb: String, f: ⇒ T, columns: Int = -1): T
    Definition Classes
    SynapseMLLogging
  235. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  236. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  237. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  238. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  239. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  240. val matrixType: Param[String]
    Definition Classes
    LightGBMExecutionParams
  241. val maxBin: IntParam
    Definition Classes
    LightGBMBinParams
  242. val maxBinByFeature: IntArrayParam
    Definition Classes
    LightGBMParams
  243. val maxCatThreshold: IntParam
    Definition Classes
    LightGBMCategoricalParams
  244. val maxCatToOnehot: IntParam
    Definition Classes
    LightGBMCategoricalParams
  245. val maxDeltaStep: DoubleParam
    Definition Classes
    LightGBMParams
  246. val maxDepth: IntParam
    Definition Classes
    LightGBMParams
  247. val maxDrop: IntParam
    Definition Classes
    LightGBMDartParams
  248. val maxNumClasses: IntParam
    Definition Classes
    LightGBMParams
  249. val maxPosition: IntParam
  250. val maxStreamingOMPThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  251. val metric: Param[String]
    Definition Classes
    LightGBMParams
  252. val microBatchSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  253. val minDataInLeaf: IntParam
    Definition Classes
    LightGBMParams
  254. val minDataPerBin: IntParam
    Definition Classes
    LightGBMParams
  255. val minDataPerGroup: IntParam
    Definition Classes
    LightGBMCategoricalParams
  256. val minGainToSplit: DoubleParam
    Definition Classes
    LightGBMParams
  257. val minSumHessianInLeaf: DoubleParam
    Definition Classes
    LightGBMParams
  258. val modelString: Param[String]
    Definition Classes
    LightGBMParams
  259. val monotoneConstraints: IntArrayParam
    Definition Classes
    LightGBMLearnerParams
  260. val monotoneConstraintsMethod: Param[String]
    Definition Classes
    LightGBMLearnerParams
  261. val monotonePenalty: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  262. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  263. val negBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  264. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  265. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  266. val numBatches: IntParam
    Definition Classes
    LightGBMExecutionParams
  267. val numIterations: IntParam
    Definition Classes
    LightGBMParams
  268. val numLeaves: IntParam
    Definition Classes
    LightGBMParams
  269. val numTasks: IntParam
    Definition Classes
    LightGBMExecutionParams
  270. val numThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  271. val objective: Param[String]
    Definition Classes
    LightGBMObjectiveParams
  272. val objectiveSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  273. val otherRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  274. val parallelism: Param[String]
    Definition Classes
    LightGBMExecutionParams
  275. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  276. val passThroughArgs: Param[String]
    Definition Classes
    LightGBMExecutionParams
  277. val posBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  278. val predictDisableShapeCheck: BooleanParam
    Definition Classes
    LightGBMPredictionParams
  279. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  280. def prepareDataframe(dataset: Dataset[_], numTasks: Int): DataFrame
    Definition Classes
    LightGBMRankerLightGBMBase
  281. def preprocessData(df: DataFrame): DataFrame

    For Ranking, we need to sort the data within partitions by group prior to training to ensure training succeeds.

    For Ranking, we need to sort the data within partitions by group prior to training to ensure training succeeds.

    df

    The data frame to preprocess prior to training.

    returns

    The preprocessed data, sorted within partition by group.

    Definition Classes
    LightGBMRankerLightGBMBase
  282. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  283. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  284. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  285. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  286. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  287. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  288. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  289. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  290. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  291. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  292. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  293. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  294. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  295. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  296. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  297. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  298. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  299. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  300. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  301. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  302. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  303. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  304. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  305. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  306. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  307. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  308. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  309. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  310. val repartitionByGroupingColumn: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  311. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  312. val seed: IntParam
    Definition Classes
    LightGBMSeedParams
  313. final def set(paramPair: ParamPair[_]): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  314. final def set(param: String, value: Any): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  315. final def set[T](param: Param[T], value: T): LightGBMRanker.this.type
    Definition Classes
    Params
  316. def setBaggingFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  317. def setBaggingFreq(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  318. def setBaggingSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  319. def setBatchPerformanceMeasure(index: Int, measures: InstrumentationMeasures): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  320. def setBatchPerformanceMeasures(measures: Array[Option[InstrumentationMeasures]]): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  321. def setBinSampleCount(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMBinParams
  322. def setBoostFromAverage(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  323. def setBoostingType(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  324. def setCatSmooth(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMCategoricalParams
  325. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMRanker.this.type
    Definition Classes
    LightGBMSlotParams
  326. def setCategoricalSlotNames(value: Array[String]): LightGBMRanker.this.type
    Definition Classes
    LightGBMSlotParams
  327. def setCatl2(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMCategoricalParams
  328. def setChunkSize(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  329. def setDataRandomSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  330. final def setDefault(paramPairs: ParamPair[_]*): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  331. final def setDefault[T](param: Param[T], value: T): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  332. def setDefaultListenPort(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  333. def setDelegate(delegate: LightGBMDelegate): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  334. def setDeterministic(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  335. def setDriverListenPort(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  336. def setDropRate(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  337. def setDropSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  338. def setEarlyStoppingRound(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  339. def setEvalAt(value: Array[Int]): LightGBMRanker.this.type
  340. def setExecutionMode(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  341. def setExtraSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  342. def setFObj(value: FObjTrait): LightGBMRanker.this.type
    Definition Classes
    LightGBMObjectiveParams
  343. def setFeatureFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  344. def setFeatureFractionByNode(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  345. def setFeatureFractionSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  346. def setFeaturesCol(value: String): LightGBMRanker
    Definition Classes
    Predictor
  347. def setFeaturesShapCol(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMPredictionParams
  348. def setGroupCol(value: String): LightGBMRanker.this.type

    Definition Classes
    HasGroupCol
  349. def setImprovementTolerance(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  350. def setInitScoreCol(value: String): LightGBMRanker.this.type

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

    Definition Classes
    HasValidationIndicatorCol
  407. def setVerbosity(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  408. def setWeightCol(value: String): LightGBMRanker.this.type

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

    Trains the LightGBM model.

    Trains the LightGBM model. If batches are specified, breaks training dataset into batches for training.

    dataset

    The input dataset to train.

    returns

    The trained model.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  421. def trainOneDataBatch(dataset: Dataset[_], batchIndex: Int, batchCount: Int): LightGBMRankerModel

    Inner train method for LightGBM learners.

    Inner train method for LightGBM learners. Calculates the number of workers, creates a driver thread, and runs mapPartitions on the dataset.

    dataset

    The dataset to train on.

    batchIndex

    In running in batch training mode, gets the batch number.

    returns

    The LightGBM Model from the trained LightGBM Booster.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  422. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  423. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  424. val uid: String
    Definition Classes
    LightGBMRankerSynapseMLLogging → Identifiable
  425. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  426. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  427. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  428. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  429. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
    Attributes
    protected
    Definition Classes
    PredictorParams
  430. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  431. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  432. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  433. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  434. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  435. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  436. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable
  437. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  438. val zeroAsMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams

Inherited from SynapseMLLogging

Inherited from LightGBMPerformance

Inherited from LightGBMParams

Inherited from LightGBMCategoricalParams

Inherited from LightGBMSeedParams

Inherited from LightGBMObjectiveParams

Inherited from LightGBMPredictionParams

Inherited from LightGBMDartParams

Inherited from LightGBMDatasetParams

Inherited from LightGBMLearnerParams

Inherited from LightGBMBinParams

Inherited from LightGBMFractionParams

Inherited from LightGBMSlotParams

Inherited from LightGBMExecutionParams

Inherited from HasInitScoreCol

Inherited from HasValidationIndicatorCol

Inherited from HasWeightCol

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from DotnetWrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Ranker[Vector, LightGBMRanker, LightGBMRankerModel]

Inherited from HasGroupCol

Inherited from Predictor[Vector, LightGBMRanker, LightGBMRankerModel]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Estimator[LightGBMRankerModel]

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