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. def extractInstances(dataset: Dataset[_], validateInstance: (Instance) ⇒ Unit): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  62. def extractInstances(dataset: Dataset[_]): RDD[Instance]
    Attributes
    protected
    Definition Classes
    PredictorParams
  63. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]
    Attributes
    protected
    Definition Classes
    Predictor
  64. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  65. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  66. val featureFraction: DoubleParam
    Definition Classes
    LightGBMFractionParams
  67. val featureFractionByNode: DoubleParam
    Definition Classes
    LightGBMFractionParams
  68. val featureFractionSeed: IntParam
    Definition Classes
    LightGBMSeedParams
  69. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  70. val featuresShapCol: Param[String]
    Definition Classes
    LightGBMPredictionParams
  71. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  72. def fit(dataset: Dataset[_]): LightGBMRankerModel
    Definition Classes
    Predictor → Estimator
  73. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[LightGBMRankerModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  74. def fit(dataset: Dataset[_], paramMap: ParamMap): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  75. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): LightGBMRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  76. val fobj: FObjParam
    Definition Classes
    LightGBMObjectiveParams
  77. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  78. def getAllPerformanceMeasures: Option[Array[InstrumentationMeasures]]
    Definition Classes
    LightGBMPerformance
  79. def getBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  80. def getBaggingFreq: Int
    Definition Classes
    LightGBMParams
  81. def getBaggingSeed: Int
    Definition Classes
    LightGBMSeedParams
  82. def getBinSampleCount: Int
    Definition Classes
    LightGBMBinParams
  83. def getBoostFromAverage: Boolean
    Definition Classes
    LightGBMParams
  84. def getBoostingType: String
    Definition Classes
    LightGBMParams
  85. def getCatSmooth: Double
    Definition Classes
    LightGBMCategoricalParams
  86. 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
  87. 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
  88. def getCategoricalSlotIndexes: Array[Int]
    Definition Classes
    LightGBMSlotParams
  89. def getCategoricalSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  90. def getCatl2: Double
    Definition Classes
    LightGBMCategoricalParams
  91. def getChunkSize: Int
    Definition Classes
    LightGBMExecutionParams
  92. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  93. def getColumnParams: ColumnParams

    Constructs the ColumnParams.

    Constructs the ColumnParams.

    returns

    ColumnParams object containing the parameters related to LightGBM columns.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  94. def getDartParams: DartModeParams

    Constructs the DartModeParams

    Constructs the DartModeParams

    returns

    DartModeParams object containing parameters related to dart mode.

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

    Constructs the DatasetParams.

    Constructs the DatasetParams.

    returns

    DatasetParams object containing parameters related to LightGBM Dataset parameters.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  99. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  100. def getDefaultListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  101. def getDelegate: Option[LightGBMDelegate]
    Definition Classes
    LightGBMParams
  102. def getDeterministic: Boolean
    Definition Classes
    LightGBMSeedParams
  103. def getDriverListenPort: Int
    Definition Classes
    LightGBMExecutionParams
  104. def getDropRate: Double
    Definition Classes
    LightGBMDartParams
  105. def getDropSeed: Int
    Definition Classes
    LightGBMSeedParams
  106. def getEarlyStoppingRound: Int
    Definition Classes
    LightGBMLearnerParams
  107. def getEvalAt: Array[Int]
  108. 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
  109. def getExtraSeed: Int
    Definition Classes
    LightGBMSeedParams
  110. def getFObj: FObjTrait
    Definition Classes
    LightGBMObjectiveParams
  111. def getFeatureFraction: Double
    Definition Classes
    LightGBMFractionParams
  112. def getFeatureFractionByNode: Double
    Definition Classes
    LightGBMFractionParams
  113. def getFeatureFractionSeed: Int
    Definition Classes
    LightGBMSeedParams
  114. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  115. def getFeaturesShapCol: String
    Definition Classes
    LightGBMPredictionParams
  116. 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
  117. def getGroupCol: String

    Definition Classes
    HasGroupCol
  118. def getImprovementTolerance: Double
    Definition Classes
    LightGBMLearnerParams
  119. def getInitScoreCol: String

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

    Constructs the ObjectiveParams.

    Constructs the ObjectiveParams.

    returns

    ObjectiveParams object containing parameters related to the objective function.

    Attributes
    protected
    Definition Classes
    LightGBMBase
  159. def getObjectiveSeed: Int
    Definition Classes
    LightGBMSeedParams
  160. 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
  161. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  162. def getOtherRate: Double
    Definition Classes
    LightGBMLearnerParams
  163. def getParallelism: String
    Definition Classes
    LightGBMExecutionParams
  164. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  165. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  166. def getPassThroughArgs: String
    Definition Classes
    LightGBMExecutionParams
  167. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  168. 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
  169. def getPosBaggingFraction: Double
    Definition Classes
    LightGBMFractionParams
  170. def getPredictDisableShapeCheck: Boolean
    Definition Classes
    LightGBMPredictionParams
  171. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  172. def getReferenceDataset: Array[Byte]
    Definition Classes
    LightGBMExecutionParams
  173. def getRepartitionByGroupingColumn: Boolean
    Definition Classes
    LightGBMExecutionParams
  174. def getSamplingMode: String
    Definition Classes
    LightGBMExecutionParams
  175. def getSamplingSubsetSize: Int
    Definition Classes
    LightGBMExecutionParams
  176. def getSeed: Int
    Definition Classes
    LightGBMSeedParams
  177. 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
  178. def getSkipDrop: Double
    Definition Classes
    LightGBMDartParams
  179. def getSlotNames: Array[String]
    Definition Classes
    LightGBMSlotParams
  180. def getTimeout: Double
    Definition Classes
    LightGBMExecutionParams
  181. def getTopK: Int
    Definition Classes
    LightGBMExecutionParams
  182. def getTopRate: Double
    Definition Classes
    LightGBMLearnerParams
  183. 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
  184. def getTrainingCols: Array[(String, Seq[DataType])]
    Attributes
    protected
    Definition Classes
    LightGBMBase
  185. def getUniformDrop: Boolean
    Definition Classes
    LightGBMDartParams
  186. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  187. def getUseMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  188. def getUseSingleDatasetMode: Boolean
    Definition Classes
    LightGBMExecutionParams
  189. def getValidationIndicatorCol: String

    Definition Classes
    HasValidationIndicatorCol
  190. def getVerbosity: Int
    Definition Classes
    LightGBMParams
  191. def getWeightCol: String

    Definition Classes
    HasWeightCol
  192. def getXGBoostDartMode: Boolean
    Definition Classes
    LightGBMDartParams
  193. def getZeroAsMissing: Boolean
    Definition Classes
    LightGBMDatasetParams
  194. val groupCol: Param[String]

    The name of the group column

    The name of the group column

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

    The name of the initial score column

    The name of the initial score column

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

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

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

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

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

    The name of the validation indicator column

    The name of the validation indicator column

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

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  438. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable
  439. val xGBoostDartMode: BooleanParam
    Definition Classes
    LightGBMDartParams
  440. 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