org.apache.spark.ml.evaluation

BinaryClassificationEvaluator

class BinaryClassificationEvaluator extends Evaluator with HasRawPredictionCol with HasLabelCol

:: Experimental :: Evaluator for binary classification, which expects two input columns: score and label.

Annotations
@Experimental()
Linear Supertypes
HasLabelCol, HasRawPredictionCol, Evaluator, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. BinaryClassificationEvaluator
  2. HasLabelCol
  3. HasRawPredictionCol
  4. Evaluator
  5. Params
  6. Serializable
  7. Serializable
  8. Identifiable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BinaryClassificationEvaluator()

  2. new BinaryClassificationEvaluator(uid: String)

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def $[T](param: Param[T]): T

    An alias for getOrDefault().

    An alias for getOrDefault().

    Attributes
    protected
    Definition Classes
    Params

  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. final def clear(param: Param[_]): BinaryClassificationEvaluator.this.type

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Attributes
    protected
    Definition Classes
    Params

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def copy(extra: ParamMap): BinaryClassificationEvaluator

    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.

    Definition Classes
    BinaryClassificationEvaluator → Evaluator → Params
    See also

    defaultCopy()

  11. 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.

    to

    the target instance

    extra

    extra params to be copied

    returns

    the target instance with param values copied

    Attributes
    protected
    Definition Classes
    Params

  12. 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

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  15. def evaluate(dataset: DataFrame): Double

    Evaluates the output.

    Evaluates the output.

    dataset

    a dataset that contains labels/observations and predictions.

    returns

    metric

    Definition Classes
    BinaryClassificationEvaluator → Evaluator

  16. def evaluate(dataset: DataFrame, paramMap: ParamMap): Double

    Evaluates model output and returns a scalar metric (larger is better).

    Evaluates model output and returns a scalar metric (larger is 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

  17. 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

  18. def explainParams(): String

    Explains all params of this instance.

    Explains all params of this instance.

    Definition Classes
    Params
    See also

    explainParam()

  19. final def extractParamMap(): ParamMap

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params

  20. 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.

    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 < user-supplied values < extra.

    Definition Classes
    Params

  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  22. 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

  23. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  24. 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

  25. final def getLabelCol: String

    Definition Classes
    HasLabelCol

  26. def getMetricName: String

  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 getRawPredictionCol: String

    Definition Classes
    HasRawPredictionCol

  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

  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. final def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params

  36. final val labelCol: Param[String]

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol

  37. val metricName: Param[String]

    param for metric name in evaluation

  38. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  39. final def notify(): Unit

    Definition Classes
    AnyRef

  40. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  41. 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.

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

    Definition Classes
    Params

  42. final val rawPredictionCol: Param[String]

    Param for raw prediction (a.

    Param for raw prediction (a.k.a. confidence) column name.

    Definition Classes
    HasRawPredictionCol

  43. final def set(paramPair: ParamPair[_]): BinaryClassificationEvaluator.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params

  44. final def set(param: String, value: Any): BinaryClassificationEvaluator.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

  45. final def set[T](param: Param[T], value: T): BinaryClassificationEvaluator.this.type

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params

  46. final def setDefault(paramPairs: ParamPair[_]*): BinaryClassificationEvaluator.this.type

    Sets default values for a list of params.

    Sets default values for a list of params.

    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
    Annotations
    @varargs()

  47. final def setDefault[T](param: Param[T], value: T): BinaryClassificationEvaluator.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
    Definition Classes
    Params

  48. def setLabelCol(value: String): BinaryClassificationEvaluator.this.type

  49. def setMetricName(value: String): BinaryClassificationEvaluator.this.type

  50. def setScoreCol(value: String): BinaryClassificationEvaluator.this.type

  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  52. def toString(): String

    Definition Classes
    Identifiable → AnyRef → Any

  53. 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
    BinaryClassificationEvaluator → Identifiable

  54. def validateParams(): Unit

    Validates parameter values stored internally.

    Validates parameter values stored internally. Raise an exception if any parameter value is invalid.

    This only needs to check for interactions between parameters. Parameter value checks which do not depend on other parameters are handled by Param.validate(). This method does not handle input/output column parameters; those are checked during schema validation.

    Definition Classes
    Params

  55. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  56. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  57. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from HasLabelCol

Inherited from HasRawPredictionCol

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