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, DotnetWrappable, 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. DotnetWrappable
  25. RWrappable
  26. PythonWrappable
  27. BaseWrappable
  28. Ranker
  29. HasGroupCol
  30. Predictor
  31. PredictorParams
  32. HasPredictionCol
  33. HasFeaturesCol
  34. HasLabelCol
  35. Estimator
  36. PipelineStage
  37. Logging
  38. Params
  39. Serializable
  40. Serializable
  41. Identifiable
  42. AnyRef
  43. 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. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  22. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  23. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  24. val dropSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  25. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  26. val evalAt: IntArrayParam
  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 getDataTransferMode: String
    Definition Classes
    LightGBMExecutionParams
  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 getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  67. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  68. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  69. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  70. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  71. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  72. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  73. def getGroupCol: String

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

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

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

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

    The name of the group column

    The name of the group column

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

    The name of the initial score column

    The name of the initial score column

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

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

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

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

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

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  324. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  325. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  326. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable
  327. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  328. 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'