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

Linear Supertypes
LightGBMBase[LightGBMRankerModel], SynapseMLLogging, LightGBMPerformance, ComplexParamsWritable, LightGBMParams, LightGBMCategoricalParams, LightGBMSeedParams, LightGBMObjectiveParams, LightGBMPredictionParams, LightGBMDartParams, LightGBMDatasetParams, LightGBMLearnerParams, LightGBMBinParams, LightGBMFractionParams, LightGBMSlotParams, LightGBMExecutionParams, HasInitScoreCol, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, RWrappable, PythonWrappable, BaseWrappable, Ranker[Vector, LightGBMRanker, LightGBMRankerModel], HasGroupCol, Predictor[Vector, LightGBMRanker, LightGBMRankerModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Estimator[LightGBMRankerModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LightGBMRanker
  2. LightGBMBase
  3. SynapseMLLogging
  4. LightGBMPerformance
  5. ComplexParamsWritable
  6. LightGBMParams
  7. LightGBMCategoricalParams
  8. LightGBMSeedParams
  9. LightGBMObjectiveParams
  10. LightGBMPredictionParams
  11. LightGBMDartParams
  12. LightGBMDatasetParams
  13. LightGBMLearnerParams
  14. LightGBMBinParams
  15. LightGBMFractionParams
  16. LightGBMSlotParams
  17. LightGBMExecutionParams
  18. HasInitScoreCol
  19. HasValidationIndicatorCol
  20. HasWeightCol
  21. DefaultParamsWritable
  22. MLWritable
  23. Wrappable
  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 dataTransferMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  18. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  19. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  20. val deterministic: BooleanParam
    Definition Classes
    LightGBMSeedParams
  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. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  27. def explainParams(): String
    Definition Classes
    Params
  28. val extraSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  29. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  30. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  31. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  32. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  33. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  34. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  35. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  36. def fit(dataset: Dataset[_]): LightGBMRankerModel
    Definition Classes
    Predictor → Estimator
  37. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMRankerModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  38. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  39. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  40. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  41. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  43. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  44. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  45. def getBaggingSeed: Int
    Definition Classes
    LightGBMSeedParams
  46. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  47. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  48. def getBoostingType: String
    Definition Classes
    LightGBMParams
  49. def getCatSmooth: Double
    Definition Classes
    LightGBMCategoricalParams
  50. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  51. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  52. def getCatl2: Double
    Definition Classes
    LightGBMCategoricalParams
  53. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  54. def getDataRandomSeed: Int
    Definition Classes
    LightGBMSeedParams
  55. def getDataTransferMode: String
    Definition Classes
    LightGBMExecutionParams
  56. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  57. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  58. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  59. def getDeterministic: Boolean
    Definition Classes
    LightGBMSeedParams
  60. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  61. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  62. def getDropSeed: Int
    Definition Classes
    LightGBMSeedParams
  63. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  64. def getEvalAt: Array[Int]
  65. def getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  66. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  67. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  68. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  69. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  70. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  71. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  72. def getGroupCol: String

    Definition Classes
    HasGroupCol
  73. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  74. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  75. def getIsEnableSparse: Boolean
    Definition Classes
    LightGBMDatasetParams
  76. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  77. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  78. def getLabelGain: Array[Double]
  79. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  80. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  81. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  82. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  83. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  84. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  85. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  86. def getMaxCatThreshold: Int
    Definition Classes
    LightGBMCategoricalParams
  87. def getMaxCatToOnehot: Int
    Definition Classes
    LightGBMCategoricalParams
  88. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  89. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  90. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  91. def getMaxNumClasses: Int
    Definition Classes
    LightGBMParams
  92. def getMaxPosition: Int
  93. def getMaxStreamingOMPThreads: Int
    Definition Classes
    LightGBMExecutionParams
  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
    LightGBMRanker → LightGBMBase
  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
    LightGBMRanker → LightGBMBase
  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 getReferenceDataset: Array[Byte]
    Definition Classes
    LightGBMExecutionParams
  126. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  127. def getSamplingMode: String
    Definition Classes
    LightGBMExecutionParams
  128. def getSamplingSubsetSize: Int
    Definition Classes
    LightGBMExecutionParams
  129. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  130. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  131. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  132. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  133. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  134. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  135. 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
    LightGBMRanker → LightGBMBase
  136. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  137. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  138. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  139. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  140. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  141. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  142. def getWeightCol: String

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

    The name of the group column

    The name of the group column

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

    The name of the initial score column

    The name of the initial score column

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

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

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

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

    Definition Classes
    HasWeightCol
  306. def setXGBoostDartMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  307. def setZeroAsMissing(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDatasetParams
  308. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  309. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  310. def stringFromTrainedModel(model: LightGBMRankerModel): String
    Definition Classes
    LightGBMRanker → LightGBMBase
  311. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  312. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  313. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  314. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  315. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  316. val uid: String
    Definition Classes
    LightGBMRanker → SynapseMLLogging → Identifiable
  317. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  318. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  319. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  320. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  321. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  322. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  323. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  324. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable
  325. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  326. val zeroAsMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams

Deprecated Value Members

  1. val executionMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.1) Please use 'dataTransferMode'

  2. def setExecutionMode(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
    Annotations
    @deprecated
    Deprecated

    (Since version 0.11.1) Please use 'setDataTransferMode'