Packages

class RankingEvaluator extends Evaluator with HasPredictionCol with HasLabelCol with DefaultParamsWritable

:: Experimental :: Evaluator for ranking, which expects two input columns: prediction and label.

Annotations
@Experimental() @Since( "3.0.0" )
Source
RankingEvaluator.scala
Linear Supertypes
DefaultParamsWritable, MLWritable, HasLabelCol, HasPredictionCol, Evaluator, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RankingEvaluator
  2. DefaultParamsWritable
  3. MLWritable
  4. HasLabelCol
  5. HasPredictionCol
  6. Evaluator
  7. Params
  8. Serializable
  9. Serializable
  10. Identifiable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RankingEvaluator()
    Annotations
    @Since( "3.0.0" )
  2. new RankingEvaluator(uid: String)
    Annotations
    @Since( "3.0.0" )

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

    An alias for getOrDefault().

    An alias for getOrDefault().

    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def clear(param: Param[_]): RankingEvaluator.this.type

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def copy(extra: ParamMap): RankingEvaluator

    Creates a copy of this instance with the same UID and some extra params.

    Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

    Definition Classes
    RankingEvaluator → Evaluator → Params
    Annotations
    @Since( "3.0.0" )
  9. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Copies param values from this instance to another instance for params shared by them.

    Copies param values from this instance to another instance for params shared by them.

    This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

    to

    the target instance, which should work with the same set of default Params as this source instance

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

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

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

    Attributes
    protected
    Definition Classes
    Params
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def evaluate(dataset: Dataset[_]): Double

    Evaluates model output and returns a scalar metric.

    Evaluates model output and returns a scalar metric. The value of isLargerBetter specifies whether larger values are better.

    dataset

    a dataset that contains labels/observations and predictions.

    returns

    metric

    Definition Classes
    RankingEvaluator → Evaluator
    Annotations
    @Since( "3.0.0" )
  14. def evaluate(dataset: Dataset[_], paramMap: ParamMap): Double

    Evaluates model output and returns a scalar metric.

    Evaluates model output and returns a scalar metric. The value of isLargerBetter specifies whether larger values are better.

    dataset

    a dataset that contains labels/observations and predictions.

    paramMap

    parameter map that specifies the input columns and output metrics

    returns

    metric

    Definition Classes
    Evaluator
    Annotations
    @Since( "2.0.0" )
  15. def explainParam(param: Param[_]): String

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

    a string that contains the input param name, doc, and optionally its default value and the user-supplied value

    Definition Classes
    Params
  16. def explainParams(): String

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

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

    extractParamMap with no extra values.

    extractParamMap with no extra values.

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

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Definition Classes
    Params
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def get[T](param: Param[T]): Option[T]

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def getDefault[T](param: Param[T]): Option[T]

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  23. def getK: Int

    Annotations
    @Since( "3.0.0" )
  24. final def getLabelCol: String

    Definition Classes
    HasLabelCol
  25. def getMetricName: String

    Annotations
    @Since( "3.0.0" )
  26. def getMetrics(dataset: Dataset[_]): RankingMetrics[Double]

    Get a RankingMetrics, which can be used to get ranking metrics such as meanAveragePrecision, meanAveragePrecisionAtK, etc.

    Get a RankingMetrics, which can be used to get ranking metrics such as meanAveragePrecision, meanAveragePrecisionAtK, etc.

    dataset

    a dataset that contains labels/observations and predictions.

    returns

    RankingMetrics

    Annotations
    @Since( "3.1.0" )
  27. final def getOrDefault[T](param: Param[T]): T

    Gets the value of a param in the embedded param map or its default value.

    Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

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

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  29. final def getPredictionCol: String

    Definition Classes
    HasPredictionCol
  30. final def hasDefault[T](param: Param[T]): Boolean

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

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

    Tests whether this instance contains a param with a given name.

    Tests whether this instance contains a param with a given name.

    Definition Classes
    Params
  32. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  33. final def isDefined(param: Param[_]): Boolean

    Checks whether a param is explicitly set or has a default value.

    Checks whether a param is explicitly set or has a default value.

    Definition Classes
    Params
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def isLargerBetter: Boolean

    Indicates whether the metric returned by evaluate should be maximized (true, default) or minimized (false).

    Indicates whether the metric returned by evaluate should be maximized (true, default) or minimized (false). A given evaluator may support multiple metrics which may be maximized or minimized.

    Definition Classes
    RankingEvaluator → Evaluator
    Annotations
    @Since( "3.0.0" )
  36. final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  37. final val k: IntParam

    param for ranking position value used in "meanAveragePrecisionAtK", "precisionAtK", "ndcgAtK", "recallAtK".

    param for ranking position value used in "meanAveragePrecisionAtK", "precisionAtK", "ndcgAtK", "recallAtK". Must be > 0. The default value is 10.

    Annotations
    @Since( "3.0.0" )
  38. final val labelCol: Param[String]

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  39. final val metricName: Param[String]

    param for metric name in evaluation (supports "meanAveragePrecision" (default), "meanAveragePrecisionAtK", "precisionAtK", "ndcgAtK", "recallAtK")

    param for metric name in evaluation (supports "meanAveragePrecision" (default), "meanAveragePrecisionAtK", "precisionAtK", "ndcgAtK", "recallAtK")

    Annotations
    @Since( "3.0.0" )
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. lazy val params: Array[Param[_]]

    Returns all params sorted by their names.

    Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

    Definition Classes
    Params
    Note

    Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

  44. final val predictionCol: Param[String]

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  45. def save(path: String): Unit

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  46. final def set(paramPair: ParamPair[_]): RankingEvaluator.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  47. final def set(param: String, value: Any): RankingEvaluator.this.type

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

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

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  49. final def setDefault(paramPairs: ParamPair[_]*): RankingEvaluator.this.type

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

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

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes
    protected[ml]
    Definition Classes
    Params
  51. def setK(value: Int): RankingEvaluator.this.type

    Annotations
    @Since( "3.0.0" )
  52. def setLabelCol(value: String): RankingEvaluator.this.type

    Annotations
    @Since( "3.0.0" )
  53. def setMetricName(value: String): RankingEvaluator.this.type

    Annotations
    @Since( "3.0.0" )
  54. def setPredictionCol(value: String): RankingEvaluator.this.type

    Annotations
    @Since( "3.0.0" )
  55. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  56. def toString(): String
    Definition Classes
    RankingEvaluator → Identifiable → AnyRef → Any
    Annotations
    @Since( "3.0.0" )
  57. val uid: String

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    RankingEvaluator → Identifiable
    Annotations
    @Since( "3.0.0" )
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  61. def write: MLWriter

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasLabelCol

Inherited from HasPredictionCol

Inherited from Evaluator

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters