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

    Definition Classes
    HasGroupCol
  75. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  76. def getInitScoreCol: String

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

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

    Definition Classes
    HasWeightCol
  141. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  142. def getZeroAsMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  143. val groupCol: Param[String]

    The name of the group column

    The name of the group column

    Definition Classes
    HasGroupCol
  144. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  145. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  146. val improvementTolerance: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  147. val initScoreCol: Param[String]

    The name of the initial score column

    The name of the initial score column

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

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

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

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

    Definition Classes
    HasWeightCol
  297. def setXGBoostDartMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  298. def setZeroAsMissing(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDatasetParams
  299. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  300. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  301. def stringFromTrainedModel(model: LightGBMRankerModel): String
    Definition Classes
    LightGBMRankerLightGBMBase
  302. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  303. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  304. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  305. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  306. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  307. val uid: String
    Definition Classes
    LightGBMRankerBasicLogging → Identifiable
  308. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  309. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  310. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  311. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  312. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  313. val ver: String
    Definition Classes
    BasicLogging
  314. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  315. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  316. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable
  317. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  318. val zeroAsMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams