org.apache.spark.ml.evaluation

BinaryClassificationEvaluator

class BinaryClassificationEvaluator extends Evaluator with Params with HasRawPredictionCol with HasLabelCol

:: AlphaComponent ::

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

Annotations
@AlphaComponent()
Linear Supertypes
HasLabelCol, HasRawPredictionCol, Params, Evaluator, Identifiable, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. BinaryClassificationEvaluator
  2. HasLabelCol
  3. HasRawPredictionCol
  4. Params
  5. Evaluator
  6. Identifiable
  7. Serializable
  8. Serializable
  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()

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 ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addOutputColumn(schema: StructType, colName: String, dataType: DataType): StructType

    Attributes
    protected
    Definition Classes
    Params
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def checkInputColumn(schema: StructType, colName: String, dataType: DataType): Unit

    Check whether the given schema contains an input column.

    Check whether the given schema contains an input column.

    colName

    Parameter name for the input column.

    dataType

    SQL DataType of the input column.

    Attributes
    protected
    Definition Classes
    Params
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  12. def evaluate(dataset: DataFrame, paramMap: ParamMap): Double

    Evaluates the output.

    Evaluates the output.

    dataset

    a dataset that contains labels/observations and predictions.

    paramMap

    parameter map that specifies the input columns and output metrics

    returns

    metric

    Definition Classes
    BinaryClassificationEvaluatorEvaluator
  13. def explainParams(): String

    Returns the documentation of all params.

    Returns the documentation of all params.

    Definition Classes
    Params
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def get[T](param: Param[T]): T

    Gets the value of a parameter in the embedded param map.

    Gets the value of a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. def getLabelCol: String

    Definition Classes
    HasLabelCol
  18. def getMetricName: String

  19. def getRawPredictionCol: String

    Definition Classes
    HasRawPredictionCol
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. def isSet(param: Param[_]): Boolean

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  23. val labelCol: Param[String]

    param for label column name

    param for label column name

    Definition Classes
    HasLabelCol
  24. val metricName: Param[String]

    param for metric name in evaluation

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

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. val paramMap: ParamMap

    Internal param map.

    Internal param map.

    Attributes
    protected
    Definition Classes
    Params
  29. def params: Array[Param[_]]

    Returns all params.

    Returns all params.

    Definition Classes
    Params
  30. val rawPredictionCol: Param[String]

    param for raw prediction column name

    param for raw prediction column name

    Definition Classes
    HasRawPredictionCol
  31. 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
  32. def setLabelCol(value: String): BinaryClassificationEvaluator.this.type

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

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

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

    Definition Classes
    AnyRef
  36. def toString(): String

    Definition Classes
    AnyRef → Any
  37. def validate(): Unit

    Validates parameter values stored internally.

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

    Definition Classes
    Params
  38. def validate(paramMap: ParamMap): Unit

    Validates parameter values stored internally plus the input parameter map.

    Validates parameter values stored internally plus the input parameter map. Raises an exception if any parameter is invalid.

    Definition Classes
    Params
  39. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from HasLabelCol

Inherited from HasRawPredictionCol

Inherited from Params

Inherited from Evaluator

Inherited from Identifiable

Inherited from Serializable

Inherited from Serializable

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