Class/Object

com.microsoft.ml.spark.lightgbm

LightGBMRanker

Related Docs: object LightGBMRanker | package lightgbm

Permalink

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

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

Annotations
@InternalWrapper()
Linear Supertypes
LightGBMBase[LightGBMRankerModel], LightGBMParams, LightGBMPredictionParams, LightGBMLearnerParams, LightGBMBinParams, LightGBMFractionParams, LightGBMSlotParams, LightGBMExecutionParams, HasInitScoreCol, HasValidationIndicatorCol, HasWeightCol, DefaultParamsWritable, MLWritable, Wrappable, HasAdditionalPythonMethods, 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. LightGBMParams
  4. LightGBMPredictionParams
  5. LightGBMLearnerParams
  6. LightGBMBinParams
  7. LightGBMFractionParams
  8. LightGBMSlotParams
  9. LightGBMExecutionParams
  10. HasInitScoreCol
  11. HasValidationIndicatorCol
  12. HasWeightCol
  13. DefaultParamsWritable
  14. MLWritable
  15. Wrappable
  16. HasAdditionalPythonMethods
  17. Ranker
  18. HasGroupCol
  19. Predictor
  20. PredictorParams
  21. HasPredictionCol
  22. HasFeaturesCol
  23. HasLabelCol
  24. Estimator
  25. PipelineStage
  26. Logging
  27. Params
  28. Serializable
  29. Serializable
  30. Identifiable
  31. AnyRef
  32. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LightGBMRanker()

    Permalink
  2. new LightGBMRanker(uid: String)

    Permalink

    uid

    The unique ID.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    HasAdditionalPythonMethods
  6. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMRankerModel): Unit

    Permalink
    Definition Classes
    LightGBMBase
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val baggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMFractionParams
  9. val baggingFreq: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  10. val baggingSeed: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  11. def beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMRankerModel]): Unit

    Permalink
    Definition Classes
    LightGBMBase
  12. val binSampleCount: IntParam

    Permalink
    Definition Classes
    LightGBMBinParams
  13. val boostFromAverage: BooleanParam

    Permalink
    Definition Classes
    LightGBMParams
  14. val boostingType: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  15. def castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    LightGBMBase
  16. val categoricalSlotIndexes: IntArrayParam

    Permalink
    Definition Classes
    LightGBMSlotParams
  17. val categoricalSlotNames: StringArrayParam

    Permalink
    Definition Classes
    LightGBMSlotParams
  18. final def clear(param: Param[_]): LightGBMRanker.this.type

    Permalink
    Definition Classes
    Params
  19. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def copy(extra: ParamMap): LightGBMRanker

    Permalink
    Definition Classes
    LightGBMRanker → Predictor → Estimator → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  23. val defaultListenPort: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  24. var delegate: Option[LightGBMDelegate]

    Permalink
    Definition Classes
    LightGBMParams
  25. val driverListenPort: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  26. val earlyStoppingRound: IntParam

    Permalink
    Definition Classes
    LightGBMLearnerParams
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  29. val evalAt: IntArrayParam

    Permalink
  30. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  31. def explainParams(): String

    Permalink
    Definition Classes
    Params
  32. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]

    Permalink
    Attributes
    protected
    Definition Classes
    Predictor
  33. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  34. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  35. val featureFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMFractionParams
  36. final val featuresCol: Param[String]

    Permalink
    Definition Classes
    HasFeaturesCol
  37. val featuresShapCol: Param[String]

    Permalink
    Definition Classes
    LightGBMPredictionParams
  38. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def fit(dataset: Dataset[_]): LightGBMRankerModel

    Permalink
    Definition Classes
    Predictor → Estimator
  40. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[LightGBMRankerModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  41. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMRankerModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  42. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMRankerModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  43. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  44. def getBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMFractionParams
  45. def getBaggingFreq: Int

    Permalink
    Definition Classes
    LightGBMParams
  46. def getBaggingSeed: Int

    Permalink
    Definition Classes
    LightGBMParams
  47. def getBinSampleCount: Int

    Permalink
    Definition Classes
    LightGBMBinParams
  48. def getBoostFromAverage: Boolean

    Permalink
    Definition Classes
    LightGBMParams
  49. def getBoostingType: String

    Permalink
    Definition Classes
    LightGBMParams
  50. def getCategoricalSlotIndexes: Array[Int]

    Permalink
    Definition Classes
    LightGBMSlotParams
  51. def getCategoricalSlotNames: Array[String]

    Permalink
    Definition Classes
    LightGBMSlotParams
  52. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  53. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  54. def getDefaultListenPort: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  55. def getDelegate: Option[LightGBMDelegate]

    Permalink
    Definition Classes
    LightGBMParams
  56. def getDriverListenPort: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  57. def getEarlyStoppingRound: Int

    Permalink
    Definition Classes
    LightGBMLearnerParams
  58. def getEvalAt: Array[Int]

    Permalink
  59. def getFeatureFraction: Double

    Permalink
    Definition Classes
    LightGBMFractionParams
  60. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  61. def getFeaturesShapCol: String

    Permalink
    Definition Classes
    LightGBMPredictionParams
  62. def getGroupCol: String

    Permalink

    Definition Classes
    HasGroupCol
  63. def getImprovementTolerance: Double

    Permalink
    Definition Classes
    LightGBMLearnerParams
  64. def getInitScoreCol: String

    Permalink

    Definition Classes
    HasInitScoreCol
  65. def getIsProvideTrainingMetric: Boolean

    Permalink
    Definition Classes
    LightGBMParams
  66. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  67. def getLabelGain: Array[Double]

    Permalink
  68. def getLambdaL1: Double

    Permalink
    Definition Classes
    LightGBMParams
  69. def getLambdaL2: Double

    Permalink
    Definition Classes
    LightGBMParams
  70. def getLeafPredictionCol: String

    Permalink
    Definition Classes
    LightGBMPredictionParams
  71. def getLearningRate: Double

    Permalink
    Definition Classes
    LightGBMParams
  72. def getMaxBin: Int

    Permalink
    Definition Classes
    LightGBMBinParams
  73. def getMaxBinByFeature: Array[Int]

    Permalink
    Definition Classes
    LightGBMParams
  74. def getMaxDeltaStep: Double

    Permalink
    Definition Classes
    LightGBMParams
  75. def getMaxDepth: Int

    Permalink
    Definition Classes
    LightGBMParams
  76. def getMaxPosition: Int

    Permalink
  77. def getMetric: String

    Permalink
    Definition Classes
    LightGBMParams
  78. def getMinDataInLeaf: Int

    Permalink
    Definition Classes
    LightGBMParams
  79. def getMinGainToSplit: Double

    Permalink
    Definition Classes
    LightGBMParams
  80. def getMinSumHessianInLeaf: Double

    Permalink
    Definition Classes
    LightGBMParams
  81. def getModel(trainParams: TrainParams, lightGBMBooster: LightGBMBooster): LightGBMRankerModel

    Permalink

    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
  82. def getModelString: String

    Permalink
    Definition Classes
    LightGBMParams
  83. def getNegBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMFractionParams
  84. def getNumBatches: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  85. def getNumIterations: Int

    Permalink
    Definition Classes
    LightGBMParams
  86. def getNumLeaves: Int

    Permalink
    Definition Classes
    LightGBMParams
  87. def getNumTasks: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  88. def getObjective: String

    Permalink
    Definition Classes
    LightGBMParams
  89. def getOptGroupCol: Option[String]

    Permalink

    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
  90. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  91. def getParallelism: String

    Permalink
    Definition Classes
    LightGBMExecutionParams
  92. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  93. def getPosBaggingFraction: Double

    Permalink
    Definition Classes
    LightGBMFractionParams
  94. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  95. def getRepartitionByGroupingColumn: Boolean

    Permalink
    Definition Classes
    LightGBMExecutionParams
  96. def getSlotNames: Array[String]

    Permalink
    Definition Classes
    LightGBMSlotParams
  97. def getTimeout: Double

    Permalink
    Definition Classes
    LightGBMExecutionParams
  98. def getTopK: Int

    Permalink
    Definition Classes
    LightGBMExecutionParams
  99. def getTrainParams(numTasks: Int, categoricalIndexes: Array[Int], dataset: Dataset[_]): TrainParams

    Permalink

    Gets the training parameters.

    Gets the training parameters.

    returns

    train parameters.

    Definition Classes
    LightGBMRankerLightGBMBase
  100. def getTrainingCols(): Array[(String, Seq[DataType])]

    Permalink
    Attributes
    protected
    Definition Classes
    LightGBMBase
  101. def getUseBarrierExecutionMode: Boolean

    Permalink
    Definition Classes
    LightGBMExecutionParams
  102. def getValidationIndicatorCol: String

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  103. def getVerbosity: Int

    Permalink
    Definition Classes
    LightGBMParams
  104. def getWeightCol: String

    Permalink

    Definition Classes
    HasWeightCol
  105. val groupCol: Param[String]

    Permalink

    The name of the group column

    The name of the group column

    Definition Classes
    HasGroupCol
  106. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  107. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  108. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  109. val improvementTolerance: DoubleParam

    Permalink
    Definition Classes
    LightGBMLearnerParams
  110. val initScoreCol: Param[String]

    Permalink

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  111. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  112. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  113. def innerTrain(dataset: Dataset[_], batchIndex: Int): LightGBMRankerModel

    Permalink

    Inner train method for LightGBM learners.

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

    dataset

    The dataset to train on.

    batchIndex

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

    returns

    The LightGBM Model from the trained LightGBM Booster.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  114. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  115. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  116. val isProvideTrainingMetric: BooleanParam

    Permalink
    Definition Classes
    LightGBMParams
  117. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  118. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  119. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol
  120. val labelGain: DoubleArrayParam

    Permalink
  121. val lambdaL1: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  122. val lambdaL2: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  123. val leafPredictionCol: Param[String]

    Permalink
    Definition Classes
    LightGBMPredictionParams
  124. val learningRate: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  125. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  126. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  127. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  128. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  129. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  130. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  131. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  132. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  133. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  134. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  135. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  136. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  137. val maxBin: IntParam

    Permalink
    Definition Classes
    LightGBMBinParams
  138. val maxBinByFeature: IntArrayParam

    Permalink
    Definition Classes
    LightGBMParams
  139. val maxDeltaStep: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  140. val maxDepth: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  141. val maxPosition: IntParam

    Permalink
  142. val metric: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  143. val minDataInLeaf: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  144. val minGainToSplit: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  145. val minSumHessianInLeaf: DoubleParam

    Permalink
    Definition Classes
    LightGBMParams
  146. val modelString: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  147. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  148. val negBaggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMFractionParams
  149. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  150. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  151. val numBatches: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  152. val numIterations: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  153. val numLeaves: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  154. val numTasks: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  155. val objective: Param[String]

    Permalink
    Definition Classes
    LightGBMParams
  156. val parallelism: Param[String]

    Permalink
    Definition Classes
    LightGBMExecutionParams
  157. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  158. val posBaggingFraction: DoubleParam

    Permalink
    Definition Classes
    LightGBMFractionParams
  159. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol
  160. def prepareDataframe(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])], numTasks: Int): DataFrame

    Permalink
    Definition Classes
    LightGBMRankerLightGBMBase
  161. def preprocessData(dataset: DataFrame): DataFrame

    Permalink

    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.

    dataset

    The dataset to preprocess prior to training.

    returns

    The preprocessed data, sorted within partiton by group.

    Definition Classes
    LightGBMRankerLightGBMBase
  162. val repartitionByGroupingColumn: BooleanParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  163. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  164. final def set(paramPair: ParamPair[_]): LightGBMRanker.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  165. final def set(param: String, value: Any): LightGBMRanker.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  166. final def set[T](param: Param[T], value: T): LightGBMRanker.this.type

    Permalink
    Definition Classes
    Params
  167. def setBaggingFraction(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMFractionParams
  168. def setBaggingFreq(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  169. def setBaggingSeed(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  170. def setBinSampleCount(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMBinParams
  171. def setBoostFromAverage(value: Boolean): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  172. def setBoostingType(value: String): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  173. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMSlotParams
  174. def setCategoricalSlotNames(value: Array[String]): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMSlotParams
  175. final def setDefault(paramPairs: ParamPair[_]*): LightGBMRanker.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  176. final def setDefault[T](param: Param[T], value: T): LightGBMRanker.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  177. def setDefaultListenPort(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  178. def setDelegate(delegate: LightGBMDelegate): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  179. def setDriverListenPort(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  180. def setEarlyStoppingRound(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMLearnerParams
  181. def setEvalAt(value: Array[Int]): LightGBMRanker.this.type

    Permalink
  182. def setFeatureFraction(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMFractionParams
  183. def setFeaturesCol(value: String): LightGBMRanker

    Permalink
    Definition Classes
    Predictor
  184. def setFeaturesShapCol(value: String): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMPredictionParams
  185. def setGroupCol(value: String): LightGBMRanker.this.type

    Permalink

    Definition Classes
    HasGroupCol
  186. def setImprovementTolerance(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMLearnerParams
  187. def setInitScoreCol(value: String): LightGBMRanker.this.type

    Permalink

    Definition Classes
    HasInitScoreCol
  188. def setIsProvideTrainingMetric(value: Boolean): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  189. def setLabelCol(value: String): LightGBMRanker

    Permalink
    Definition Classes
    Predictor
  190. def setLabelGain(value: Array[Double]): LightGBMRanker.this.type

    Permalink
  191. def setLambdaL1(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  192. def setLambdaL2(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  193. def setLeafPredictionCol(value: String): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMPredictionParams
  194. def setLearningRate(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  195. def setMaxBin(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMBinParams
  196. def setMaxBinByFeature(value: Array[Int]): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  197. def setMaxDeltaStep(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  198. def setMaxDepth(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  199. def setMaxPosition(value: Int): LightGBMRanker.this.type

    Permalink
  200. def setMetric(value: String): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  201. def setMinDataInLeaf(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  202. def setMinGainToSplit(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  203. def setMinSumHessianInLeaf(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  204. def setModelString(value: String): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  205. def setNegBaggingFraction(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMFractionParams
  206. def setNumBatches(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  207. def setNumIterations(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  208. def setNumLeaves(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  209. def setNumTasks(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  210. def setObjective(value: String): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  211. def setParallelism(value: String): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  212. def setPosBaggingFraction(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMFractionParams
  213. def setPredictionCol(value: String): LightGBMRanker

    Permalink
    Definition Classes
    Predictor
  214. def setRepartitionByGroupingColumn(value: Boolean): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  215. def setSlotNames(value: Array[String]): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMSlotParams
  216. def setTimeout(value: Double): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  217. def setTopK(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  218. def setUseBarrierExecutionMode(value: Boolean): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMExecutionParams
  219. def setValidationIndicatorCol(value: String): LightGBMRanker.this.type

    Permalink

    Definition Classes
    HasValidationIndicatorCol
  220. def setVerbosity(value: Int): LightGBMRanker.this.type

    Permalink
    Definition Classes
    LightGBMParams
  221. def setWeightCol(value: String): LightGBMRanker.this.type

    Permalink

    Definition Classes
    HasWeightCol
  222. val slotNames: StringArrayParam

    Permalink
    Definition Classes
    LightGBMSlotParams
  223. def stringFromTrainedModel(model: LightGBMRankerModel): String

    Permalink
    Definition Classes
    LightGBMRankerLightGBMBase
  224. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  225. val timeout: DoubleParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  226. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  227. val topK: IntParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  228. def train(dataset: Dataset[_]): LightGBMRankerModel

    Permalink

    Trains the LightGBM model.

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

    dataset

    The input dataset to train.

    returns

    The trained model.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  229. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    Predictor → PipelineStage
  230. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  231. val uid: String

    Permalink

    The unique ID.

    The unique ID.

    Definition Classes
    LightGBMRanker → Identifiable
  232. val useBarrierExecutionMode: BooleanParam

    Permalink
    Definition Classes
    LightGBMExecutionParams
  233. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PredictorParams
  234. val validationIndicatorCol: Param[String]

    Permalink

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  235. val verbosity: IntParam

    Permalink
    Definition Classes
    LightGBMParams
  236. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  237. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  238. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  239. val weightCol: Param[String]

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  240. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from LightGBMParams

Inherited from LightGBMPredictionParams

Inherited from LightGBMLearnerParams

Inherited from LightGBMBinParams

Inherited from LightGBMFractionParams

Inherited from LightGBMSlotParams

Inherited from LightGBMExecutionParams

Inherited from HasInitScoreCol

Inherited from HasValidationIndicatorCol

Inherited from HasWeightCol

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from Ranker[Vector, LightGBMRanker, LightGBMRankerModel]

Inherited from HasGroupCol

Inherited from Predictor[Vector, LightGBMRanker, LightGBMRankerModel]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Estimator[LightGBMRankerModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped