Packages

class XGBoostRankerModel extends PredictionModel[Vector, XGBoostRankerModel] with RankerRegressorBaseModel[XGBoostRankerModel] with HasGroupCol

Linear Supertypes
HasGroupCol, RankerRegressorBaseModel[XGBoostRankerModel], XGBPredictorParams[XGBoostRankerModel], XGBoostModel[XGBoostRankerModel], ParamUtils[XGBoostRankerModel], SparkParams[XGBoostRankerModel], SchemaValidationTrait, RabitParams, NonXGBoostParams, HasContribPredictionCol, HasLeafPredictionCol, HasWeightCol, HasBaseMarginCol, HasFeaturesCols, XGBoostParams[XGBoostRankerModel], DartBoosterParams, GeneralParams, LearningTaskParams, TreeBoosterParams, MLWritable, PredictionModel[Vector, XGBoostRankerModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Model[XGBoostRankerModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XGBoostRankerModel
  2. HasGroupCol
  3. RankerRegressorBaseModel
  4. XGBPredictorParams
  5. XGBoostModel
  6. ParamUtils
  7. SparkParams
  8. SchemaValidationTrait
  9. RabitParams
  10. NonXGBoostParams
  11. HasContribPredictionCol
  12. HasLeafPredictionCol
  13. HasWeightCol
  14. HasBaseMarginCol
  15. HasFeaturesCols
  16. XGBoostParams
  17. DartBoosterParams
  18. GeneralParams
  19. LearningTaskParams
  20. TreeBoosterParams
  21. MLWritable
  22. PredictionModel
  23. PredictorParams
  24. HasPredictionCol
  25. HasFeaturesCol
  26. HasLabelCol
  27. Model
  28. Transformer
  29. PipelineStage
  30. Logging
  31. Params
  32. Serializable
  33. Serializable
  34. Identifiable
  35. AnyRef
  36. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new XGBoostRankerModel(uid: String)

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. val TMP_TRANSFORMED_COL: String
    Attributes
    protected
    Definition Classes
    XGBoostModel
  6. def addNonXGBoostParam(ps: Param[_]*): Unit
    Attributes
    protected
    Definition Classes
    NonXGBoostParams
  7. final val aftLossDistribution: Param[String]
    Definition Classes
    LearningTaskParams
  8. final val alpha: DoubleParam
    Definition Classes
    TreeBoosterParams
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. final val baseMarginCol: Param[String]

    Param for initial prediction (aka base margin) column name.

    Param for initial prediction (aka base margin) column name.

    Definition Classes
    HasBaseMarginCol
  11. final val baseScore: DoubleParam
    Definition Classes
    LearningTaskParams
  12. final val booster: Param[String]
    Definition Classes
    GeneralParams
  13. final val cacheHostRatio: FloatParam
    Definition Classes
    SparkParams
  14. final def clear(param: Param[_]): XGBoostRankerModel.this.type
    Definition Classes
    Params
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  16. final val colsampleBylevel: DoubleParam
    Definition Classes
    TreeBoosterParams
  17. final val colsampleBynode: DoubleParam
    Definition Classes
    TreeBoosterParams
  18. final val colsampleBytree: DoubleParam
    Definition Classes
    TreeBoosterParams
  19. final val contribPredictionCol: Param[String]

    Param for contribution prediction column name.

    Param for contribution prediction column name.

    Definition Classes
    HasContribPredictionCol
  20. def copy(extra: ParamMap): XGBoostRankerModel
    Definition Classes
    XGBoostRankerModel → XGBoostModel → Model → Transformer → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. final val customEval: CustomEvalParam
    Definition Classes
    SparkParams
  23. final val customObj: CustomObjParam
    Definition Classes
    SparkParams
  24. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  25. final val device: Param[String]
    Definition Classes
    GeneralParams
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  28. final val eta: DoubleParam
    Definition Classes
    TreeBoosterParams
  29. final val evalMetric: Param[String]
    Definition Classes
    LearningTaskParams
  30. final val expectileAlpha: Param[String]
    Definition Classes
    LearningTaskParams
  31. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  32. def explainParams(): String
    Definition Classes
    Params
  33. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  34. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  35. def featureIsArrayType(schema: StructType): Boolean
    Attributes
    protected[spark]
    Definition Classes
    SparkParams
  36. final val featureNames: StringArrayParam

    Feature's name, it will be set to DMatrix and Booster, and in the final native json model.

    Feature's name, it will be set to DMatrix and Booster, and in the final native json model. In native code, the parameter name is feature_name.

    Definition Classes
    SparkParams
  37. final val featureTypes: StringArrayParam

    Feature types, q is numeric and c is categorical.

    Feature types, q is numeric and c is categorical. In native code, the parameter name is feature_type

    Definition Classes
    SparkParams
  38. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  39. final val featuresCols: StringArrayParam

    Param for the names of feature columns.

    Param for the names of feature columns.

    Definition Classes
    HasFeaturesCols
  40. def featuresDataType: DataType
    Attributes
    protected
    Definition Classes
    PredictionModel
  41. final val forceRepartition: BooleanParam
    Definition Classes
    SparkParams
  42. final val gamma: DoubleParam
    Definition Classes
    TreeBoosterParams
  43. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. final def getAftLossDistribution: String
    Definition Classes
    LearningTaskParams
  45. final def getAlpha: Double
    Definition Classes
    TreeBoosterParams
  46. final def getBaseMarginCol: String

    Definition Classes
    HasBaseMarginCol
  47. final def getBaseScore: Double
    Definition Classes
    LearningTaskParams
  48. final def getBooster: String
    Definition Classes
    GeneralParams
  49. final def getCacheHostRatio: Float
    Definition Classes
    SparkParams
  50. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  51. final def getColsampleBylevel: Double
    Definition Classes
    TreeBoosterParams
  52. final def getColsampleBynode: Double
    Definition Classes
    TreeBoosterParams
  53. final def getColsampleBytree: Double
    Definition Classes
    TreeBoosterParams
  54. final def getContribPredictionCol: String

    Definition Classes
    HasContribPredictionCol
  55. final def getCustomEval: EvalTrait
    Definition Classes
    SparkParams
  56. final def getCustomObj: ObjectiveTrait
    Definition Classes
    SparkParams
  57. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  58. final def getDevice: String
    Definition Classes
    GeneralParams
  59. final def getEta: Double
    Definition Classes
    TreeBoosterParams
  60. final def getEvalMetric: String
    Definition Classes
    LearningTaskParams
  61. final def getExpectileAlpha: String
    Definition Classes
    LearningTaskParams
  62. final def getFeatureNames: Array[String]
    Definition Classes
    SparkParams
  63. final def getFeatureTypes: Array[String]
    Definition Classes
    SparkParams
  64. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  65. final def getFeaturesCols: Array[String]

    Definition Classes
    HasFeaturesCols
  66. final def getForceRepartition: Boolean
    Definition Classes
    SparkParams
  67. final def getGamma: Double
    Definition Classes
    TreeBoosterParams
  68. final def getGroupCol: String

    Definition Classes
    HasGroupCol
  69. final def getGrowPolicy: String
    Definition Classes
    TreeBoosterParams
  70. final def getHuberSlope: Double
    Definition Classes
    LearningTaskParams
  71. final def getInferBatchSize: Int

    Definition Classes
    SparkParams
  72. final def getInteractionConstraints: String
    Definition Classes
    TreeBoosterParams
  73. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  74. final def getLambda: Double
    Definition Classes
    TreeBoosterParams
  75. final def getLambdarankBiasNorm: Double
    Definition Classes
    LearningTaskParams
  76. final def getLambdarankNumPairPerSample: Int
    Definition Classes
    LearningTaskParams
  77. final def getLambdarankPairMethod: String
    Definition Classes
    LearningTaskParams
  78. final def getLambdarankUnbiased: Boolean
    Definition Classes
    LearningTaskParams
  79. final def getLeafPredictionCol: String

    Definition Classes
    HasLeafPredictionCol
  80. final def getMaxBins: Int
    Definition Classes
    TreeBoosterParams
  81. final def getMaxCachedHistNode: Int
    Definition Classes
    TreeBoosterParams
  82. final def getMaxDeltaStep: Double
    Definition Classes
    TreeBoosterParams
  83. final def getMaxDepth: Int
    Definition Classes
    TreeBoosterParams
  84. final def getMaxLeaves: Int
    Definition Classes
    TreeBoosterParams
  85. final def getMaxQuantileBatches: Int
    Definition Classes
    SparkParams
  86. final def getMinCachePageBytes: Long
    Definition Classes
    SparkParams
  87. final def getMinChildWeight: Double
    Definition Classes
    TreeBoosterParams
  88. final def getMissing: Float
    Definition Classes
    SparkParams
  89. final def getMonotoneConstraints: Array[Int]
    Definition Classes
    TreeBoosterParams
  90. final def getNdcgExpGain: Boolean
    Definition Classes
    LearningTaskParams
  91. final def getNormalizeType: String
    Definition Classes
    DartBoosterParams
  92. final def getNthread: Int
    Definition Classes
    GeneralParams
  93. final def getNumClass: Int
    Definition Classes
    LearningTaskParams
  94. final def getNumEarlyStoppingRounds: Int
    Definition Classes
    SparkParams
  95. final def getNumParallelTree: Int
    Definition Classes
    TreeBoosterParams
  96. final def getNumRound: Int
    Definition Classes
    SparkParams
  97. final def getNumWorkers: Int
    Definition Classes
    SparkParams
  98. final def getObjective: String
    Definition Classes
    LearningTaskParams
  99. final def getOneDrop: Boolean
    Definition Classes
    DartBoosterParams
  100. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  101. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  102. final def getPredictionCol: String
    Definition Classes
    HasPredictionCol
  103. final def getProcessType: String
    Definition Classes
    TreeBoosterParams
  104. final def getRabitTrackerHostIp: String
    Definition Classes
    RabitParams
  105. final def getRabitTrackerPort: Int
    Definition Classes
    RabitParams
  106. final def getRabitTrackerTimeout: Int
    Definition Classes
    RabitParams
  107. final def getRateDrop: Double
    Definition Classes
    DartBoosterParams
  108. final def getRefreshLeaf: Boolean
    Definition Classes
    TreeBoosterParams
  109. final def getSampleType: String
    Definition Classes
    DartBoosterParams
  110. final def getSamplingMethod: String
    Definition Classes
    TreeBoosterParams
  111. final def getScalePosWeight: Double
    Definition Classes
    TreeBoosterParams
  112. final def getSeed: Long
    Definition Classes
    LearningTaskParams
  113. final def getSeedPerIteration: Boolean
    Definition Classes
    LearningTaskParams
  114. final def getSkipDrop: Double
    Definition Classes
    DartBoosterParams
  115. final def getSubsample: Double
    Definition Classes
    TreeBoosterParams
  116. final def getTreeMethod: String
    Definition Classes
    TreeBoosterParams
  117. final def getTweedieVariancePower: Double
    Definition Classes
    LearningTaskParams
  118. final def getUpdater: String
    Definition Classes
    TreeBoosterParams
  119. final def getUseExternalMemory: Boolean
    Definition Classes
    SparkParams
  120. final def getValidateParameters: Boolean
    Definition Classes
    GeneralParams
  121. final def getVerbosity: Int
    Definition Classes
    GeneralParams
  122. final def getWeightCol: String
    Definition Classes
    HasWeightCol
  123. final val groupCol: Param[String]
    Definition Classes
    HasGroupCol
  124. final val growPolicy: Param[String]
    Definition Classes
    TreeBoosterParams
  125. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  126. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  127. def hasParent: Boolean
    Definition Classes
    Model
  128. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  129. final val huberSlope: DoubleParam
    Definition Classes
    LearningTaskParams
  130. final val inferBatchSize: IntParam
    Definition Classes
    SparkParams
  131. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  132. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  133. final val interactionConstraints: Param[String]
    Definition Classes
    TreeBoosterParams
  134. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  135. def isDefinedNonEmpty(param: Param[String]): Boolean
    Definition Classes
    ParamUtils
  136. def isFeaturesColsValid: Boolean

    Check if featuresCols is valid

    Check if featuresCols is valid

    Definition Classes
    HasFeaturesCols
  137. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  138. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  139. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  140. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  141. final val lambda: DoubleParam

    L2 regularization term on weights, increase this value will make model more conservative.

    L2 regularization term on weights, increase this value will make model more conservative. [default=1]

    Definition Classes
    TreeBoosterParams
  142. final val lambdarankBiasNorm: DoubleParam
    Definition Classes
    LearningTaskParams
  143. final val lambdarankNumPairPerSample: IntParam
    Definition Classes
    LearningTaskParams
  144. final val lambdarankPairMethod: Param[String]
    Definition Classes
    LearningTaskParams
  145. final val lambdarankUnbiased: BooleanParam
    Definition Classes
    LearningTaskParams
  146. final val leafPredictionCol: Param[String]

    Param for leaf prediction column name.

    Param for leaf prediction column name.

    Definition Classes
    HasLeafPredictionCol
  147. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  148. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  149. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  150. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  151. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  152. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  153. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  154. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  155. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  156. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  157. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  158. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  159. final val maxBins: IntParam
    Definition Classes
    TreeBoosterParams
  160. final val maxCachedHistNode: IntParam
    Definition Classes
    TreeBoosterParams
  161. final val maxDeltaStep: DoubleParam
    Definition Classes
    TreeBoosterParams
  162. final val maxDepth: IntParam
    Definition Classes
    TreeBoosterParams
  163. final val maxLeaves: IntParam
    Definition Classes
    TreeBoosterParams
  164. final val maxQuantileBatches: IntParam
    Definition Classes
    SparkParams
  165. final val minCachePageBytes: LongParam
    Definition Classes
    SparkParams
  166. final val minChildWeight: DoubleParam
    Definition Classes
    TreeBoosterParams
  167. final val missing: FloatParam

    the value treated as missing.

    the value treated as missing. default: Float.NaN

    Definition Classes
    SparkParams
  168. final val monotoneConstraints: IntArrayParam
    Definition Classes
    TreeBoosterParams
  169. val nativeBooster: Booster

    Get the native XGBoost Booster

    Get the native XGBoost Booster

    Definition Classes
    XGBoostRankerModel → XGBoostModel
  170. final val ndcgExpGain: BooleanParam
    Definition Classes
    LearningTaskParams
  171. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  172. lazy val nonXGBoostParams: Array[String]
    Attributes
    protected
    Definition Classes
    NonXGBoostParams
  173. final val normalizeType: Param[String]
    Definition Classes
    DartBoosterParams
  174. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  175. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  176. final val nthread: IntParam
    Definition Classes
    GeneralParams
  177. final val numClass: IntParam
    Definition Classes
    LearningTaskParams
  178. final val numEarlyStoppingRounds: IntParam
    Definition Classes
    SparkParams
  179. def numFeatures: Int
    Definition Classes
    PredictionModel
    Annotations
    @Since( "1.6.0" )
  180. final val numParallelTree: IntParam
    Definition Classes
    TreeBoosterParams
  181. final val numRound: IntParam
    Definition Classes
    SparkParams
  182. final val numWorkers: IntParam
    Definition Classes
    SparkParams
  183. final val objective: Param[String]
    Definition Classes
    LearningTaskParams
  184. final val oneDrop: BooleanParam
    Definition Classes
    DartBoosterParams
  185. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  186. var parent: Estimator[XGBoostRankerModel]
    Definition Classes
    Model
  187. def postTransform(dataset: Dataset[_], pred: PredictedColumns): Dataset[_]
    Attributes
    protected[spark]
    Definition Classes
    RankerRegressorBaseModel → XGBoostModel
  188. def predict(features: Vector): Double
    Definition Classes
    XGBoostRankerModel → PredictionModel
  189. def predictSingleInstance(features: Vector): Array[Float]
    Attributes
    protected
    Definition Classes
    XGBoostModel
  190. final val predictionCol: Param[String]
    Definition Classes
    HasPredictionCol
  191. final val processType: Param[String]
    Definition Classes
    TreeBoosterParams
  192. final val rabitTrackerHostIp: Param[String]
    Definition Classes
    RabitParams
  193. final val rabitTrackerPort: IntParam
    Definition Classes
    RabitParams
  194. final val rabitTrackerTimeout: IntParam
    Definition Classes
    RabitParams
  195. final val rateDrop: DoubleParam
    Definition Classes
    DartBoosterParams
  196. final val refreshLeaf: BooleanParam
    Definition Classes
    TreeBoosterParams
  197. final val sampleType: Param[String]
    Definition Classes
    DartBoosterParams
  198. final val samplingMethod: Param[String]
    Definition Classes
    TreeBoosterParams
  199. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  200. final val scalePosWeight: DoubleParam
    Definition Classes
    TreeBoosterParams
  201. final val seed: LongParam
    Definition Classes
    LearningTaskParams
  202. final val seedPerIteration: BooleanParam
    Definition Classes
    LearningTaskParams
  203. final def set(paramPair: ParamPair[_]): XGBoostRankerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  204. final def set(param: String, value: Any): XGBoostRankerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  205. final def set[T](param: Param[T], value: T): XGBoostRankerModel.this.type
    Definition Classes
    Params
  206. def setAftLossDistribution(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  207. def setAlpha(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  208. def setBaseMarginCol(value: String): XGBoostRankerModel
    Definition Classes
    SparkParams
  209. def setBaseScore(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  210. def setBooster(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  211. def setCacheHostRatio(value: Float): XGBoostRankerModel
    Definition Classes
    SparkParams
  212. def setColsampleBylevel(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  213. def setColsampleBynode(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  214. def setColsampleBytree(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  215. def setContribPredictionCol(value: String): XGBoostRankerModel
    Definition Classes
    SparkParams
  216. def setCustomEval(value: EvalTrait): XGBoostRankerModel
    Definition Classes
    SparkParams
  217. def setCustomObj(value: ObjectiveTrait): XGBoostRankerModel
    Definition Classes
    SparkParams
  218. final def setDefault(paramPairs: ParamPair[_]*): XGBoostRankerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  219. final def setDefault[T](param: Param[T], value: T): XGBoostRankerModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  220. def setDevice(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  221. def setEta(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  222. def setEvalMetric(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  223. def setFeatureNames(value: Array[String]): XGBoostRankerModel
    Definition Classes
    SparkParams
  224. def setFeatureTypes(value: Array[String]): XGBoostRankerModel
    Definition Classes
    SparkParams
  225. def setFeaturesCol(value: Array[String]): XGBoostRankerModel
    Definition Classes
    SparkParams
  226. def setFeaturesCol(value: String): XGBoostRankerModel
    Definition Classes
    PredictionModel
  227. def setForceRepartition(value: Boolean): XGBoostRankerModel
    Definition Classes
    SparkParams
  228. def setGamma(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  229. def setGroupCol(value: String): XGBoostRankerModel
  230. def setGrowPolicy(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  231. def setHuberSlope(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  232. def setInferBatchSize(value: Int): XGBoostRankerModel
    Definition Classes
    SparkParams
  233. def setInteractionConstraints(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  234. def setLambda(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  235. def setLambdarankBiasNorm(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  236. def setLambdarankNumPairPerSample(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  237. def setLambdarankPairMethod(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  238. def setLambdarankUnbiased(value: Boolean): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  239. def setLeafPredictionCol(value: String): XGBoostRankerModel
    Definition Classes
    SparkParams
  240. def setMaxBins(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  241. def setMaxCachedHistNode(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  242. def setMaxDeltaStep(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  243. def setMaxDepth(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  244. def setMaxLeaves(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  245. def setMaxQuantileBatches(value: Int): XGBoostRankerModel
    Definition Classes
    SparkParams
  246. def setMinCachePageBytes(value: Long): XGBoostRankerModel
    Definition Classes
    SparkParams
  247. def setMinChildWeight(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  248. def setMissing(value: Float): XGBoostRankerModel
    Definition Classes
    SparkParams
  249. def setNdcgExpGain(value: Boolean): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  250. def setNormalizeType(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  251. def setNthread(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  252. def setNumClass(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  253. def setNumEarlyStoppingRounds(value: Int): XGBoostRankerModel
    Definition Classes
    SparkParams
  254. def setNumParallelTree(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  255. def setNumRound(value: Int): XGBoostRankerModel
    Definition Classes
    SparkParams
  256. def setNumWorkers(value: Int): XGBoostRankerModel
    Definition Classes
    SparkParams
  257. def setObjective(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  258. def setOneDrop(value: Boolean): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  259. def setParent(parent: Estimator[XGBoostRankerModel]): XGBoostRankerModel
    Definition Classes
    Model
  260. def setPredictionCol(value: String): XGBoostRankerModel
    Definition Classes
    PredictionModel
  261. def setProcessType(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  262. def setRabitTrackerHostIp(value: String): XGBoostRankerModel
    Definition Classes
    SparkParams
  263. def setRabitTrackerPort(value: Int): XGBoostRankerModel
    Definition Classes
    SparkParams
  264. def setRabitTrackerTimeout(value: Int): XGBoostRankerModel
    Definition Classes
    SparkParams
  265. def setRateDrop(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  266. def setRefreshLeaf(value: Boolean): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  267. def setSampleType(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  268. def setSamplingMethod(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  269. def setScalePosWeight(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  270. def setSeed(value: Long): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  271. def setSeedPerIteration(value: Boolean): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  272. def setSkipDrop(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  273. def setSubsample(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  274. def setTreeMethod(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  275. def setTweedieVariancePower(value: Double): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  276. def setUpdater(value: String): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  277. def setUseExternalMemory(value: Boolean): XGBoostRankerModel
    Definition Classes
    SparkParams
  278. def setValidateParameters(value: Boolean): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  279. def setVerbosity(value: Int): XGBoostRankerModel
    Definition Classes
    XGBoostParams
  280. def setWeightCol(value: String): XGBoostRankerModel
    Definition Classes
    SparkParams
  281. final val skipDrop: DoubleParam
    Definition Classes
    DartBoosterParams
  282. final val subsample: DoubleParam
    Definition Classes
    TreeBoosterParams
  283. val summary: Option[XGBoostTrainingSummary]
    Definition Classes
    XGBoostRankerModel → XGBoostModel
  284. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  285. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  286. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    XGBoostModel → Transformer
  287. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  288. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  289. def transformImpl(dataset: Dataset[_]): DataFrame
    Attributes
    protected
    Definition Classes
    PredictionModel
  290. def transformSchema(schema: StructType): StructType
    Definition Classes
    PredictionModel → PipelineStage
  291. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  292. final val treeMethod: Param[String]
    Definition Classes
    TreeBoosterParams
  293. final val tweedieVariancePower: DoubleParam
    Definition Classes
    LearningTaskParams
  294. val uid: String
    Definition Classes
    XGBoostRankerModel → Identifiable
  295. final val updater: Param[String]
    Definition Classes
    TreeBoosterParams
  296. final val useExternalMemory: BooleanParam
    Definition Classes
    SparkParams
  297. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    XGBoost doesn't use validateAndTransformSchema since spark validateAndTransformSchema needs to ensure the feature is vector type

    XGBoost doesn't use validateAndTransformSchema since spark validateAndTransformSchema needs to ensure the feature is vector type

    Attributes
    protected
    Definition Classes
    XGBPredictorParams → PredictorParams
  298. def validateAndTransformSchema(schema: StructType, fitting: Boolean): StructType
    Definition Classes
    SchemaValidationTrait
  299. def validateFeatureType(schema: StructType): Unit
    Attributes
    protected[spark]
    Definition Classes
    SparkParams
  300. final val validateParameters: BooleanParam
    Definition Classes
    GeneralParams
  301. final val verbosity: IntParam
    Definition Classes
    GeneralParams
  302. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  303. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  304. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  305. final val weightCol: Param[String]
    Definition Classes
    HasWeightCol
  306. def write: MLWriter
    Definition Classes
    XGBoostModel → MLWritable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from HasGroupCol

Inherited from RankerRegressorBaseModel[XGBoostRankerModel]

Inherited from XGBPredictorParams[XGBoostRankerModel]

Inherited from XGBoostModel[XGBoostRankerModel]

Inherited from ParamUtils[XGBoostRankerModel]

Inherited from SparkParams[XGBoostRankerModel]

Inherited from SchemaValidationTrait

Inherited from RabitParams

Inherited from NonXGBoostParams

Inherited from HasContribPredictionCol

Inherited from HasLeafPredictionCol

Inherited from HasWeightCol

Inherited from HasBaseMarginCol

Inherited from HasFeaturesCols

Inherited from XGBoostParams[XGBoostRankerModel]

Inherited from DartBoosterParams

Inherited from GeneralParams

Inherited from LearningTaskParams

Inherited from TreeBoosterParams

Inherited from MLWritable

Inherited from PredictionModel[Vector, XGBoostRankerModel]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Model[XGBoostRankerModel]

Inherited from Transformer

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

Ungrouped