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

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. BasicLogging
  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 getMaxPosition: Int
  141. def getMetric: String
    Definition Classes
    LightGBMParams
  142. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  143. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  144. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  145. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  146. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  147. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  148. 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
  149. def getModelString: String
    Definition Classes
    LightGBMParams
  150. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  151. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  152. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  153. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  154. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  155. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  156. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  157. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  158. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  159. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  160. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  161. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  162. 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
  163. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  164. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  165. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  166. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  167. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  168. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  169. 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
  170. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  171. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  172. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  173. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  174. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  175. 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
  176. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  177. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  178. def getSlotNamesWithMetadata(featuresSchema: StructField): Option[Array[String]]
    Definition Classes
    LightGBMBase
  179. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  180. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  181. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  182. 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
  183. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
    Definition Classes
    LightGBMBase
  184. 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
  185. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  186. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  187. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  188. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  189. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  190. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  191. def getWeightCol: String

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

    The name of the group column

    The name of the group column

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

    The name of the initial score column

    The name of the initial score column

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

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

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

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

    Definition Classes
    HasWeightCol
  403. def setXGBoostDartMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  404. def setZeroAsMissing(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDatasetParams
  405. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  406. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  407. def stringFromTrainedModel(model: LightGBMRankerModel): String
    Definition Classes
    LightGBMRankerLightGBMBase
  408. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  409. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  410. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  411. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  412. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  413. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  414. 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
  415. 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
  416. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  417. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  418. val uid: String
    Definition Classes
    LightGBMRankerBasicLogging → Identifiable
  419. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  420. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  421. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  422. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  423. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
    Attributes
    protected
    Definition Classes
    PredictorParams
  424. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  425. val ver: String
    Definition Classes
    BasicLogging
  426. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  427. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  428. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  429. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  430. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  431. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable
  432. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  433. val zeroAsMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams

Inherited from BasicLogging

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