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. 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 addCustomTrainParams(params: BaseTrainParams, dataset: Dataset[_]): BaseTrainParams
    Attributes
    protected
    Definition Classes
    LightGBMBase
  6. def afterTrainBatch(batchIndex: Int, dataset: Dataset[_], model: LightGBMRankerModel): Unit
    Definition Classes
    LightGBMBase
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val baggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  9. val baggingFreq: IntParam
    Definition Classes
    LightGBMParams
  10. val baggingSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  11. def beforeTrainBatch(batchIndex: Int, dataset: Dataset[_], model: Option[LightGBMRankerModel]): Unit
    Definition Classes
    LightGBMBase
  12. val binSampleCount: IntParam
    Definition Classes
    LightGBMBinParams
  13. val boostFromAverage: BooleanParam
    Definition Classes
    LightGBMParams
  14. val boostingType: Param[String]
    Definition Classes
    LightGBMParams
  15. def castColumns(dataset: Dataset[_], trainingCols: Array[(String, Seq[DataType])]): DataFrame
    Attributes
    protected
    Definition Classes
    LightGBMBase
  16. val catSmooth: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  17. val categoricalSlotIndexes: IntArrayParam
    Definition Classes
    LightGBMSlotParams
  18. val categoricalSlotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  19. val catl2: DoubleParam
    Definition Classes
    LightGBMCategoricalParams
  20. val chunkSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  21. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  22. final def clear(param: Param[_]): LightGBMRanker.this.type
    Definition Classes
    Params
  23. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  25. def copy(extra: ParamMap): LightGBMRanker
    Definition Classes
    LightGBMRanker → Predictor → Estimator → PipelineStage → Params
  26. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  27. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  28. val dataRandomSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  29. val dataTransferMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  30. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  31. val defaultListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  32. val delegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  33. val deterministic: BooleanParam
    Definition Classes
    LightGBMSeedParams
  34. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  35. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  36. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  37. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  38. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  39. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  40. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  41. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  42. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  43. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  44. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  45. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  46. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  47. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  48. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  49. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  50. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  51. val driverListenPort: IntParam
    Definition Classes
    LightGBMExecutionParams
  52. val dropRate: DoubleParam
    Definition Classes
    LightGBMDartParams
  53. val dropSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  54. val earlyStoppingRound: IntParam
    Definition Classes
    LightGBMLearnerParams
  55. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  57. val evalAt: IntArrayParam
  58. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  59. def explainParams(): String
    Definition Classes
    Params
  60. val extraSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  61. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  62. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  63. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  64. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  65. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  66. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  67. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  68. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  69. def fit(dataset: Dataset[_]): LightGBMRankerModel
    Definition Classes
    Predictor → Estimator
  70. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMRankerModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  71. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  72. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  73. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  74. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  75. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  76. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  77. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  78. def getBaggingSeed: Int
    Definition Classes
    LightGBMSeedParams
  79. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  80. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  81. def getBoostingType: String
    Definition Classes
    LightGBMParams
  82. def getCatSmooth: Double
    Definition Classes
    LightGBMCategoricalParams
  83. 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
  84. def getCategoricalParams: CategoricalParams

    Constructs the CategoricalParams.

    Constructs the CategoricalParams.

    returns

    CategoricalParams object containing the parameters related to LightGBM categorical features.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  85. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  86. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  87. def getCatl2: Double
    Definition Classes
    LightGBMCategoricalParams
  88. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  89. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  90. def getColumnParams: ColumnParams

    Constructs the ColumnParams.

    Constructs the ColumnParams.

    returns

    ColumnParams object containing the parameters related to LightGBM columns.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  91. def getDartParams: DartModeParams

    Constructs the DartModeParams

    Constructs the DartModeParams

    returns

    DartModeParams object containing parameters related to dart mode.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  92. def getDataRandomSeed: Int
    Definition Classes
    LightGBMSeedParams
  93. def getDataTransferMode: String
    Definition Classes
    LightGBMExecutionParams
  94. def getDatasetCreationParams(categoricalIndexes: Array[Int], numThreads: Int): String
    Attributes
    protected
    Definition Classes
    LightGBMBase
  95. def getDatasetParams: DatasetParams

    Constructs the DatasetParams.

    Constructs the DatasetParams.

    returns

    DatasetParams object containing parameters related to LightGBM Dataset parameters.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  96. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  97. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  98. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  99. def getDeterministic: Boolean
    Definition Classes
    LightGBMSeedParams
  100. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  101. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  102. def getDropSeed: Int
    Definition Classes
    LightGBMSeedParams
  103. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  104. def getEvalAt: Array[Int]
  105. def getExecutionParams(numTasksPerExec: Int): ExecutionParams

    Constructs the ExecutionParams.

    Constructs the ExecutionParams.

    returns

    ExecutionParams object containing parameters related to LightGBM execution.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  106. def getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  107. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  108. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  109. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  110. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  111. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  112. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  113. def getGeneralParams(numTasks: Int, featuresSchema: StructField): GeneralParams

    Constructs the GeneralParams.

    Constructs the GeneralParams.

    returns

    GeneralParams object containing parameters related to general LightGBM parameters.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  114. def getGroupCol: String

    Definition Classes
    HasGroupCol
  115. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  116. def getInitScoreCol: String

    Definition Classes
    HasInitScoreCol
  117. def getIsEnableSparse: Boolean
    Definition Classes
    LightGBMDatasetParams
  118. def getIsProvideTrainingMetric: Boolean
    Definition Classes
    LightGBMParams
  119. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  120. def getLabelGain: Array[Double]
  121. def getLambdaL1: Double
    Definition Classes
    LightGBMParams
  122. def getLambdaL2: Double
    Definition Classes
    LightGBMParams
  123. def getLeafPredictionCol: String
    Definition Classes
    LightGBMPredictionParams
  124. def getLearningRate: Double
    Definition Classes
    LightGBMParams
  125. def getMatrixType: String
    Definition Classes
    LightGBMExecutionParams
  126. def getMaxBin: Int
    Definition Classes
    LightGBMBinParams
  127. def getMaxBinByFeature: Array[Int]
    Definition Classes
    LightGBMParams
  128. def getMaxCatThreshold: Int
    Definition Classes
    LightGBMCategoricalParams
  129. def getMaxCatToOnehot: Int
    Definition Classes
    LightGBMCategoricalParams
  130. def getMaxDeltaStep: Double
    Definition Classes
    LightGBMParams
  131. def getMaxDepth: Int
    Definition Classes
    LightGBMParams
  132. def getMaxDrop: Int
    Definition Classes
    LightGBMDartParams
  133. def getMaxNumClasses: Int
    Definition Classes
    LightGBMParams
  134. def getMaxPosition: Int
  135. def getMaxStreamingOMPThreads: Int
    Definition Classes
    LightGBMExecutionParams
  136. def getMetric: String
    Definition Classes
    LightGBMParams
  137. def getMicroBatchSize: Int
    Definition Classes
    LightGBMExecutionParams
  138. def getMinDataInLeaf: Int
    Definition Classes
    LightGBMParams
  139. def getMinDataPerBin: Int
    Definition Classes
    LightGBMParams
  140. def getMinDataPerGroup: Int
    Definition Classes
    LightGBMCategoricalParams
  141. def getMinGainToSplit: Double
    Definition Classes
    LightGBMParams
  142. def getMinSumHessianInLeaf: Double
    Definition Classes
    LightGBMParams
  143. 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
  144. def getModelString: String
    Definition Classes
    LightGBMParams
  145. def getMonotoneConstraints: Array[Int]
    Definition Classes
    LightGBMLearnerParams
  146. def getMonotoneConstraintsMethod: String
    Definition Classes
    LightGBMLearnerParams
  147. def getMonotonePenalty: Double
    Definition Classes
    LightGBMLearnerParams
  148. def getNegBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  149. def getNumBatches: Int
    Definition Classes
    LightGBMExecutionParams
  150. def getNumIterations: Int
    Definition Classes
    LightGBMParams
  151. def getNumLeaves: Int
    Definition Classes
    LightGBMParams
  152. def getNumTasks: Int
    Definition Classes
    LightGBMExecutionParams
  153. def getNumThreads: Int
    Definition Classes
    LightGBMExecutionParams
  154. def getObjective: String
    Definition Classes
    LightGBMObjectiveParams
  155. def getObjectiveParams: ObjectiveParams

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  156. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  157. 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
  158. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  159. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  160. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  161. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  162. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  163. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  164. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  165. 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
  166. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  167. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  168. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  169. def getReferenceDataset: Array[Byte]
    Definition Classes
    LightGBMExecutionParams
  170. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  171. def getSamplingMode: String
    Definition Classes
    LightGBMExecutionParams
  172. def getSamplingSubsetSize: Int
    Definition Classes
    LightGBMExecutionParams
  173. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  174. def getSeedParams: SeedParams

    Constructs the SeedParams.

    Constructs the SeedParams.

    returns

    SeedParams object containing the parameters related to LightGBM seeds and determinism.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  175. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  176. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  177. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  178. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  179. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  180. 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
  181. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
    Definition Classes
    LightGBMBase
  182. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  183. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  184. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  185. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  186. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  187. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  188. def getWeightCol: String

    Definition Classes
    HasWeightCol
  189. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  190. def getZeroAsMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  191. val groupCol: Param[String]

    The name of the group column

    The name of the group column

    Definition Classes
    HasGroupCol
  192. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  193. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  194. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  195. val improvementTolerance: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  196. def initPerformanceMeasures(batchCount: Int): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  197. val initScoreCol: Param[String]

    The name of the initial score column

    The name of the initial score column

    Definition Classes
    HasInitScoreCol
  198. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  199. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  200. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  201. val isEnableSparse: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  202. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  203. val isProvideTrainingMetric: BooleanParam
    Definition Classes
    LightGBMParams
  204. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  205. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  206. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  207. val labelGain: DoubleArrayParam
  208. val lambdaL1: DoubleParam
    Definition Classes
    LightGBMParams
  209. val lambdaL2: DoubleParam
    Definition Classes
    LightGBMParams
  210. val leafPredictionCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  211. val learningRate: DoubleParam
    Definition Classes
    LightGBMParams
  212. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  213. def logBase(info: Map[String, String], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  214. def logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  215. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  216. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  217. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  218. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  219. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  220. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  221. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  222. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  223. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  224. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  225. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  226. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  227. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  228. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  229. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  230. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  231. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  232. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  233. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  234. val matrixType: Param[String]
    Definition Classes
    LightGBMExecutionParams
  235. val maxBin: IntParam
    Definition Classes
    LightGBMBinParams
  236. val maxBinByFeature: IntArrayParam
    Definition Classes
    LightGBMParams
  237. val maxCatThreshold: IntParam
    Definition Classes
    LightGBMCategoricalParams
  238. val maxCatToOnehot: IntParam
    Definition Classes
    LightGBMCategoricalParams
  239. val maxDeltaStep: DoubleParam
    Definition Classes
    LightGBMParams
  240. val maxDepth: IntParam
    Definition Classes
    LightGBMParams
  241. val maxDrop: IntParam
    Definition Classes
    LightGBMDartParams
  242. val maxNumClasses: IntParam
    Definition Classes
    LightGBMParams
  243. val maxPosition: IntParam
  244. val maxStreamingOMPThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  245. val metric: Param[String]
    Definition Classes
    LightGBMParams
  246. val microBatchSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  247. val minDataInLeaf: IntParam
    Definition Classes
    LightGBMParams
  248. val minDataPerBin: IntParam
    Definition Classes
    LightGBMParams
  249. val minDataPerGroup: IntParam
    Definition Classes
    LightGBMCategoricalParams
  250. val minGainToSplit: DoubleParam
    Definition Classes
    LightGBMParams
  251. val minSumHessianInLeaf: DoubleParam
    Definition Classes
    LightGBMParams
  252. val modelString: Param[String]
    Definition Classes
    LightGBMParams
  253. val monotoneConstraints: IntArrayParam
    Definition Classes
    LightGBMLearnerParams
  254. val monotoneConstraintsMethod: Param[String]
    Definition Classes
    LightGBMLearnerParams
  255. val monotonePenalty: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  256. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  257. val negBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  258. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  259. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  260. val numBatches: IntParam
    Definition Classes
    LightGBMExecutionParams
  261. val numIterations: IntParam
    Definition Classes
    LightGBMParams
  262. val numLeaves: IntParam
    Definition Classes
    LightGBMParams
  263. val numTasks: IntParam
    Definition Classes
    LightGBMExecutionParams
  264. val numThreads: IntParam
    Definition Classes
    LightGBMExecutionParams
  265. val objective: Param[String]
    Definition Classes
    LightGBMObjectiveParams
  266. val objectiveSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  267. val otherRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  268. val parallelism: Param[String]
    Definition Classes
    LightGBMExecutionParams
  269. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  270. val passThroughArgs: Param[String]
    Definition Classes
    LightGBMExecutionParams
  271. val posBaggingFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  272. val predictDisableShapeCheck: BooleanParam
    Definition Classes
    LightGBMPredictionParams
  273. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  274. def prepareDataframe(dataset: Dataset[_], numTasks: Int): DataFrame
    Definition Classes
    LightGBMRanker → LightGBMBase
  275. 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
  276. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  277. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  278. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  279. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  280. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  281. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  282. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  283. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    PythonWrappable
  284. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  285. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  286. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  287. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  288. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  289. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  290. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  291. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  292. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  293. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  294. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  295. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  296. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  297. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  298. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  299. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  300. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  301. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  302. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  303. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  304. val referenceDataset: ByteArrayParam
    Definition Classes
    LightGBMExecutionParams
  305. val repartitionByGroupingColumn: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  306. val samplingMode: Param[String]
    Definition Classes
    LightGBMExecutionParams
  307. val samplingSubsetSize: IntParam
    Definition Classes
    LightGBMExecutionParams
  308. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  309. val seed: IntParam
    Definition Classes
    LightGBMSeedParams
  310. final def set(paramPair: ParamPair[_]): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  311. final def set(param: String, value: Any): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  312. final def set[T](param: Param[T], value: T): LightGBMRanker.this.type
    Definition Classes
    Params
  313. def setBaggingFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  314. def setBaggingFreq(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  315. def setBaggingSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  316. def setBatchPerformanceMeasure(index: Int, measures: InstrumentationMeasures): Unit
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  317. def setBatchPerformanceMeasures(measures: Array[Option[InstrumentationMeasures]]): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    LightGBMPerformance
  318. def setBinSampleCount(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMBinParams
  319. def setBoostFromAverage(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  320. def setBoostingType(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  321. def setCatSmooth(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMCategoricalParams
  322. def setCategoricalSlotIndexes(value: Array[Int]): LightGBMRanker.this.type
    Definition Classes
    LightGBMSlotParams
  323. def setCategoricalSlotNames(value: Array[String]): LightGBMRanker.this.type
    Definition Classes
    LightGBMSlotParams
  324. def setCatl2(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMCategoricalParams
  325. def setChunkSize(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  326. def setDataRandomSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  327. def setDataTransferMode(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  328. final def setDefault(paramPairs: ParamPair[_]*): LightGBMRanker.this.type
    Attributes
    protected
    Definition Classes
    Params
  329. final def setDefault[T](param: Param[T], value: T): LightGBMRanker.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  330. def setDefaultListenPort(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  331. def setDelegate(delegate: LightGBMDelegate): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  332. def setDeterministic(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  333. def setDriverListenPort(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  334. def setDropRate(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  335. def setDropSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  336. def setEarlyStoppingRound(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  337. def setEvalAt(value: Array[Int]): LightGBMRanker.this.type
  338. def setExtraSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  339. def setFObj(value: FObjTrait): LightGBMRanker.this.type
    Definition Classes
    LightGBMObjectiveParams
  340. def setFeatureFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  341. def setFeatureFractionByNode(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  342. def setFeatureFractionSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  343. def setFeaturesCol(value: String): LightGBMRanker
    Definition Classes
    Predictor
  344. def setFeaturesShapCol(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMPredictionParams
  345. def setGroupCol(value: String): LightGBMRanker.this.type

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

    Definition Classes
    HasInitScoreCol
  348. def setIsEnableSparse(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDatasetParams
  349. def setIsProvideTrainingMetric(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  350. def setLabelCol(value: String): LightGBMRanker
    Definition Classes
    Predictor
  351. def setLabelGain(value: Array[Double]): LightGBMRanker.this.type
  352. def setLambdaL1(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  353. def setLambdaL2(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  354. def setLeafPredictionCol(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMPredictionParams
  355. def setLearningRate(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  356. def setMatrixType(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  357. def setMaxBin(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMBinParams
  358. def setMaxBinByFeature(value: Array[Int]): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  359. def setMaxCatThreshold(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMCategoricalParams
  360. def setMaxCatToOnehot(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMCategoricalParams
  361. def setMaxDeltaStep(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  362. def setMaxDepth(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  363. def setMaxDrop(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  364. def setMaxNumClasses(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  365. def setMaxPosition(value: Int): LightGBMRanker.this.type
  366. def setMaxStreamingOMPThreads(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  367. def setMetric(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  368. def setMicroBatchSize(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  369. def setMinDataInLeaf(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  370. def setMinDataPerBin(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  371. def setMinDataPerGroup(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMCategoricalParams
  372. def setMinGainToSplit(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  373. def setMinSumHessianInLeaf(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  374. def setModelString(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  375. def setMonotoneConstraints(value: Array[Int]): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  376. def setMonotoneConstraintsMethod(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  377. def setMonotonePenalty(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  378. def setNegBaggingFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  379. def setNumBatches(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  380. def setNumIterations(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  381. def setNumLeaves(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMParams
  382. def setNumTasks(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  383. def setNumThreads(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  384. def setObjective(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMObjectiveParams
  385. def setObjectiveSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  386. def setOtherRate(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  387. def setParallelism(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  388. def setPassThroughArgs(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  389. def setPosBaggingFraction(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMFractionParams
  390. def setPredictDisableShapeCheck(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMPredictionParams
  391. def setPredictionCol(value: String): LightGBMRanker
    Definition Classes
    Predictor
  392. def setReferenceDataset(value: Array[Byte]): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  393. def setRepartitionByGroupingColumn(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  394. def setSamplingMode(value: String): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  395. def setSamplingSubsetSize(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  396. def setSeed(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMSeedParams
  397. def setSkipDrop(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  398. def setSlotNames(value: Array[String]): LightGBMRanker.this.type
    Definition Classes
    LightGBMSlotParams
  399. def setTimeout(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  400. def setTopK(value: Int): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  401. def setTopRate(value: Double): LightGBMRanker.this.type
    Definition Classes
    LightGBMLearnerParams
  402. def setUniformDrop(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  403. def setUseBarrierExecutionMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  404. def setUseMissing(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDatasetParams
  405. def setUseSingleDatasetMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMExecutionParams
  406. def setValidationIndicatorCol(value: String): LightGBMRanker.this.type

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

    Definition Classes
    HasWeightCol
  409. def setXGBoostDartMode(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDartParams
  410. def setZeroAsMissing(value: Boolean): LightGBMRanker.this.type
    Definition Classes
    LightGBMDatasetParams
  411. val skipDrop: DoubleParam
    Definition Classes
    LightGBMDartParams
  412. val slotNames: StringArrayParam
    Definition Classes
    LightGBMSlotParams
  413. def stringFromTrainedModel(model: LightGBMRankerModel): String
    Definition Classes
    LightGBMRanker → LightGBMBase
  414. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  415. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  416. val timeout: DoubleParam
    Definition Classes
    LightGBMExecutionParams
  417. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  418. val topK: IntParam
    Definition Classes
    LightGBMExecutionParams
  419. val topRate: DoubleParam
    Definition Classes
    LightGBMLearnerParams
  420. 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
  421. def transformSchema(schema: StructType): StructType
    Definition Classes
    Predictor → PipelineStage
  422. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  423. val uid: String
    Definition Classes
    LightGBMRanker → SynapseMLLogging → Identifiable
  424. val uniformDrop: BooleanParam
    Definition Classes
    LightGBMDartParams
  425. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  426. val useMissing: BooleanParam
    Definition Classes
    LightGBMDatasetParams
  427. val useSingleDatasetMode: BooleanParam
    Definition Classes
    LightGBMExecutionParams
  428. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
    Attributes
    protected
    Definition Classes
    PredictorParams
  429. val validationIndicatorCol: Param[String]

    The name of the validation indicator column

    The name of the validation indicator column

    Definition Classes
    HasValidationIndicatorCol
  430. val verbosity: IntParam
    Definition Classes
    LightGBMParams
  431. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  432. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  433. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  434. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

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

Inherited from LightGBMBase[LightGBMRankerModel]

Inherited from SynapseMLLogging

Inherited from LightGBMPerformance

Inherited from ComplexParamsWritable

Inherited from LightGBMParams

Inherited from LightGBMCategoricalParams

Inherited from LightGBMSeedParams

Inherited from LightGBMObjectiveParams

Inherited from LightGBMPredictionParams

Inherited from LightGBMDartParams

Inherited from LightGBMDatasetParams

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 DotnetWrappable

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