Packages

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

Trains a LightGBMRanker model, a fast, distributed, high performance gradient boosting framework based on decision tree algorithms. For more information please see here: https://github.com/Microsoft/LightGBM. For parameter information see here: https://github.com/Microsoft/LightGBM/blob/master/docs/Parameters.rst

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

Instance Constructors

  1. new LightGBMRanker()
  2. new LightGBMRanker(uid: String)

    uid

    The unique ID.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMRankerModel): Unit
    Definition Classes
    LightGBMBase
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val baggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  8. val baggingFreq: IntParam
    Definition Classes
    LightGBMParams
  9. val baggingSeed: IntParam
    Definition Classes
    LightGBMParams
  10. def beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMRankerModel]): Unit
    Definition Classes
    LightGBMBase
  11. val binSampleCount: IntParam
    Definition Classes
    LightGBMBinParams
  12. val boostFromAverage: BooleanParam
    Definition Classes
    LightGBMParams
  13. val boostingType: Param[String]
    Definition Classes
    LightGBMParams
  14. def castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  15. val categoricalSlotIndexes: IntArrayParam
    Definition Classes
    LightGBMSlotParams
  16. val categoricalSlotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  17. val chunkSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  18. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  19. final def clear(param: Param[_]): LightGBMRanker.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  22. def copy(extra: ParamMap): LightGBMRanker
    Definition Classes
    LightGBMRanker → Predictor → Estimator → PipelineStage → Params
  23. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  25. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  26. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  27. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  28. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  29. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  30. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  33. val evalAt: IntArrayParam
  34. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  35. def explainParams(): String
    Definition Classes
    Params
  36. def extractInstances(dataset: Dataset[_], validateInstance: (Instance) ⇒ Unit): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  37. def extractInstances(dataset: Dataset[_]): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  38. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]
    Attributes
    protected
    Definition Classes
    Predictor
  39. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  40. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  41. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  42. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  43. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  44. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  45. def fit(dataset: Dataset[_]): LightGBMRankerModel
    Definition Classes
    Predictor → Estimator
  46. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMRankerModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  47. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  48. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  49. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  50. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  51. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  52. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  53. def getBaggingSeed: Int
    Definition Classes
    LightGBMParams
  54. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  55. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  56. def getBoostingType: String
    Definition Classes
    LightGBMParams
  57. def getCategoricalIndexes(featuresSchema: StructField): Array[Int]

    Retrieves the categorical indexes in the features column.

    Retrieves the categorical indexes in the features column.

    featuresSchema

    The schema of the features column

    returns

    the categorical indexes in the features column.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  58. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  59. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  60. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  61. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  62. def getColumnParams: ColumnParams
    Attributes
    protected
    Definition Classes
    LightGBMBase
  63. def getDartParams: DartModeParams

    Constructs the DartModeParams

    Constructs the DartModeParams

    returns

    DartModeParams object containing parameters related to dart mode.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  64. def getDatasetParams(categoricalIndexes: Array[Int], numThreads: Int): String
    Definition Classes
    LightGBMBase
  65. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  66. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  67. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  68. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  69. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  70. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  71. def getEvalAt: Array[Int]
  72. def getExecutionParams: ExecutionParams

    Constructs the ExecutionParams.

    Constructs the ExecutionParams.

    returns

    ExecutionParams object containing parameters related to LightGBM execution.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  73. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  74. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  75. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  76. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  77. def getGroupCol: String

    Definition Classes
    HasGroupCol
  78. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  79. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  80. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  81. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  82. def getLabelGain: Array[Double]
  83. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  84. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  85. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  86. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  87. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  88. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  89. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  90. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  91. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  92. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  93. def getMaxPosition: Int
  94. def getMetric: String
    Definition Classes
    LightGBMParams
  95. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  96. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  97. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  98. def getModel(trainParams: TrainParams, 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
  99. def getModelString: String
    Definition Classes
    LightGBMParams
  100. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  101. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  102. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  103. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  104. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  105. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  106. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  107. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  108. 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
  109. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  110. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  111. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  112. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  113. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  114. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  115. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  116. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  117. def getSlotNamesWithMetadata(featuresSchema: StructField): Option[Array[String]]
    Definition Classes
    LightGBMBase
  118. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  119. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  120. def getTrainParams(numTasks: Int, dataset: Dataset[_], numTasksPerExec: Int): TrainParams

    Gets the training parameters.

    Gets the training parameters.

    numTasks

    The total number of tasks.

    dataset

    The training dataset.

    numTasksPerExec

    The number of tasks per executor.

    returns

    train parameters.

    Definition Classes
    LightGBMRanker → LightGBMBase
  121. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
    Definition Classes
    LightGBMBase
  122. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  123. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  124. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  125. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  126. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  127. def getWeightCol: String

    Definition Classes
    HasWeightCol
  128. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  129. val groupCol: Param[String]

    The name of the group column

    The name of the group column

    Definition Classes
    HasGroupCol
  130. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  131. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  132. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  133. val improvementTolerance: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  134. val initScoreCol: Param[String]

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  135. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  136. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  137. def innerTrain(dataset: Dataset[_], batchIndex: Int): LightGBMRankerModel

    Inner train method for LightGBM learners.

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

    dataset

    The dataset to train on.

    batchIndex

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

    returns

    The LightGBM Model from the trained LightGBM Booster.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  138. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  139. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  140. val isProvideTrainingMetric: BooleanParam
    Definition Classes
    LightGBMParams
  141. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  142. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  143. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  144. val labelGain: DoubleArrayParam
  145. val lambdaL1: DoubleParam
    Definition Classes
    LightGBMParams
  146. val lambdaL2: DoubleParam
    Definition Classes
    LightGBMParams
  147. val leafPredictionCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  148. val learningRate: DoubleParam
    Definition Classes
    LightGBMParams
  149. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  150. def logBase(methodName: String): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  151. def logClass(): Unit
    Definition Classes
    BasicLogging
  152. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  153. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  154. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  155. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  156. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    BasicLogging
  157. def logFit[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  158. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  159. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  160. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  161. def logPredict[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  162. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  163. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  164. def logTrain[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  165. def logTransform[T](f: ⇒ T): T
    Definition Classes
    BasicLogging
  166. def logVerb[T](verb: String, f: ⇒ T): T
    Definition Classes
    BasicLogging
  167. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  168. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  169. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  170. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  171. val matrixType: Param[String]
    Definition Classes
    LightGBMExecutionParams
  172. val maxBin: IntParam
    Definition Classes
    LightGBMBinParams
  173. val maxBinByFeature: IntArrayParam
    Definition Classes
    LightGBMParams
  174. val maxDeltaStep: DoubleParam
    Definition Classes
    LightGBMParams
  175. val maxDepth: IntParam
    Definition Classes
    LightGBMParams
  176. val maxDrop: IntParam
    Definition Classes
    LightGBMDartParams
  177. val maxPosition: IntParam
  178. val metric: Param[String]
    Definition Classes
    LightGBMParams
  179. val minDataInLeaf: IntParam
    Definition Classes
    LightGBMParams
  180. val minGainToSplit: DoubleParam
    Definition Classes
    LightGBMParams
  181. val minSumHessianInLeaf: DoubleParam
    Definition Classes
    LightGBMParams
  182. val modelString: Param[String]
    Definition Classes
    LightGBMParams
  183. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  184. val negBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  185. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  186. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  187. val numBatches: IntParam
    Definition Classes
    LightGBMExecutionParams
  188. val numIterations: IntParam
    Definition Classes
    LightGBMParams
  189. val numLeaves: IntParam
    Definition Classes
    LightGBMParams
  190. val numTasks: IntParam
    Definition Classes
    LightGBMExecutionParams
  191. val numThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  192. val objective: Param[String]
    Definition Classes
    LightGBMObjectiveParams
  193. val parallelism: Param[String]
    Definition Classes
    LightGBMExecutionParams
  194. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  195. val posBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  196. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  197. def prepareDataframe(dataset: Dataset[_], numTasks: Int): DataFrame
    Definition Classes
    LightGBMRanker → LightGBMBase
  198. def preprocessData(dataset: 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.

    dataset

    The dataset to preprocess prior to training.

    returns

    The preprocessed data, sorted within partiton by group.

    Definition Classes
    LightGBMRanker → LightGBMBase
  199. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  200. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  201. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  202. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  203. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  204. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  205. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  206. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  207. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  208. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  209. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  210. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  211. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  212. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  213. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  214. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  215. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  216. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  217. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  218. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  219. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  220. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  221. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  222. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  223. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  224. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  225. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  226. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  227. val repartitionByGroupingColumn: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  228. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  229. final def set(paramPair: ParamPair[_]): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  230. final def set(param: String, value: Any): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  231. final def set[T](param: Param[T], value: T): LightGBMRanker.this.type
    Definition Classes
    Params
  232. def setBaggingFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  233. def setBaggingFreq(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  234. def setBaggingSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  235. def setBinSampleCount(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMBinParams
  236. def setBoostFromAverage(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  237. def setBoostingType(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  238. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMRanker.this.type
    Definition Classes
    LightGBMSlotParams
  239. def setCategoricalSlotNames(value: Array[String]): LightGBMRanker.this.type
    Definition Classes
    LightGBMSlotParams
  240. def setChunkSize(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  241. final def setDefault(paramPairs: ParamPair[_]*): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  242. final def setDefault[T](param: Param[T], value: T): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  243. def setDefaultListenPort(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  244. def setDelegate(delegate: LightGBMDelegate): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  245. def setDriverListenPort(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  246. def setDropRate(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  247. def setEarlyStoppingRound(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  248. def setEvalAt(value: Array[Int]): LightGBMRanker.this.type
  249. def setFObj(value: FObjTrait): LightGBMRanker.this.type
    Definition Classes
    LightGBMObjectiveParams
  250. def setFeatureFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  251. def setFeaturesCol(value: String): LightGBMRanker
    Definition Classes
    Predictor
  252. def setFeaturesShapCol(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMPredictionParams
  253. def setGroupCol(value: String): LightGBMRanker.this.type

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

    Definition Classes
    HasInitScoreCol
  256. def setIsProvideTrainingMetric(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  257. def setLabelCol(value: String): LightGBMRanker
    Definition Classes
    Predictor
  258. def setLabelGain(value: Array[Double]): LightGBMRanker.this.type
  259. def setLambdaL1(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  260. def setLambdaL2(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  261. def setLeafPredictionCol(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMPredictionParams
  262. def setLearningRate(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  263. def setMatrixType(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  264. def setMaxBin(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMBinParams
  265. def setMaxBinByFeature(value: Array[Int]): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  266. def setMaxDeltaStep(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  267. def setMaxDepth(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  268. def setMaxDrop(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  269. def setMaxPosition(value: Int): LightGBMRanker.this.type
  270. def setMetric(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  271. def setMinDataInLeaf(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  272. def setMinGainToSplit(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  273. def setMinSumHessianInLeaf(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  274. def setModelString(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  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 setParallelism(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  283. def setPosBaggingFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  284. def setPredictionCol(value: String): LightGBMRanker
    Definition Classes
    Predictor
  285. def setRepartitionByGroupingColumn(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  286. def setSkipDrop(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  287. def setSlotNames(value: Array[String]): LightGBMRanker.this.type
    Definition Classes
    LightGBMSlotParams
  288. def setTimeout(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  289. def setTopK(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  290. def setUniformDrop(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  291. def setUseBarrierExecutionMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  292. def setUseSingleDatasetMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  293. def setValidationIndicatorCol(value: String): LightGBMRanker.this.type

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

    Definition Classes
    HasWeightCol
  296. def setXGBoostDartMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  297. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  298. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  299. def stringFromTrainedModel(model: LightGBMRankerModel): String
    Definition Classes
    LightGBMRanker → LightGBMBase
  300. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  301. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  302. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  303. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  304. def train(dataset: Dataset[_]): LightGBMRankerModel

    Trains the LightGBM model.

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

    dataset

    The input dataset to train.

    returns

    The trained model.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  305. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  306. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  307. val uid: String
    Definition Classes
    LightGBMRanker → BasicLogging → Identifiable
  308. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  309. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  310. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  311. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
    Attributes
    protected
    Definition Classes
    PredictorParams
  312. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  313. val ver: String
    Definition Classes
    BasicLogging
  314. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  315. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  316. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  317. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  318. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  319. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable
  320. val xgboostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams

Inherited from LightGBMBase[LightGBMRankerModel]

Inherited from BasicLogging

Inherited from LightGBMParams

Inherited from LightGBMObjectiveParams

Inherited from LightGBMPredictionParams

Inherited from LightGBMDartParams

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 RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Ranker[Vector, LightGBMRanker, LightGBMRankerModel]

Inherited from HasGroupCol

Inherited from Predictor[Vector, LightGBMRanker, LightGBMRankerModel]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Estimator[LightGBMRankerModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped