Class

org.apache.spark.ml

Ranker

Related Doc: package ml

Permalink

abstract class Ranker[FeaturesType, Learner <: Ranker[FeaturesType, Learner, M], M <: RankerModel[FeaturesType, M]] extends Predictor[FeaturesType, Learner, M] with PredictorParams with HasGroupCol

Ranker base class

FeaturesType

Type of input features. E.g., org.apache.spark.mllib.linalg.Vector

Learner

Concrete Estimator type

M

Concrete Model type

Linear Supertypes
HasGroupCol, Wrappable, Predictor[FeaturesType, Learner, M], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Estimator[M], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Ranker
  2. HasGroupCol
  3. Wrappable
  4. Predictor
  5. PredictorParams
  6. HasPredictionCol
  7. HasFeaturesCol
  8. HasLabelCol
  9. Estimator
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Ranker()

    Permalink

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Learner

    Permalink
    Definition Classes
    Predictor → Estimator → PipelineStage → Params
  2. abstract def train(dataset: Dataset[_]): M

    Permalink
    Attributes
    protected
    Definition Classes
    Predictor
  3. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

Concrete Value Members

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

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

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

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

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

    Permalink
    Definition Classes
    Wrappable
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. final def clear(param: Param[_]): Ranker.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  11. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def explainParam(param: Param[_]): String

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

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

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

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

    Permalink
    Definition Classes
    Params
  18. final val featuresCol: Param[String]

    Permalink
    Definition Classes
    HasFeaturesCol
  19. def finalize(): Unit

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  25. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  27. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  28. def getGroupCol: String

    Permalink

    Definition Classes
    HasGroupCol
  29. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol
  30. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  31. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  32. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  33. val groupCol: Param[String]

    Permalink

    The name of the group column

    The name of the group column

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  37. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  39. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    HasLabelCol
  44. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  57. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  59. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  60. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol
  61. final def set(paramPair: ParamPair[_]): Ranker.this.type

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

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

    Permalink
    Definition Classes
    Params
  64. final def setDefault(paramPairs: ParamPair[_]*): Ranker.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  66. def setFeaturesCol(value: String): Learner

    Permalink
    Definition Classes
    Predictor
  67. def setGroupCol(value: String): Ranker.this.type

    Permalink

    Definition Classes
    HasGroupCol
  68. def setLabelCol(value: String): Learner

    Permalink
    Definition Classes
    Predictor
  69. def setPredictionCol(value: String): Learner

    Permalink
    Definition Classes
    Predictor
  70. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  71. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  72. def transformSchema(schema: StructType): StructType

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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  74. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PredictorParams
  75. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from HasGroupCol

Inherited from Wrappable

Inherited from Predictor[FeaturesType, Learner, M]

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from Estimator[M]

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