org.apache.spark.ml.evaluation

Class BinaryClassificationEvaluator

Object

org.apache.spark.ml.Evaluator

org.apache.spark.ml.evaluation.BinaryClassificationEvaluator

All Implemented Interfaces:

java.io.Serializable, Identifiable, HasLabelCol, HasRawPredictionCol, Params

public class BinaryClassificationEvaluator
extends Evaluator
implements Params, HasRawPredictionCol, HasLabelCol

:: AlphaComponent ::

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BinaryClassificationEvaluator()

Method Summary

Methods

Modifier and Type	Method and Description
double	evaluate(DataFrame dataset, ParamMap paramMap) Evaluates the output.
String	getMetricName()
Param<String>	metricName() param for metric name in evaluation
BinaryClassificationEvaluator	setLabelCol(String value)
BinaryClassificationEvaluator	setMetricName(String value)
BinaryClassificationEvaluator	setScoreCol(String value)

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.param.HasRawPredictionCol

getRawPredictionCol, rawPredictionCol

Methods inherited from interface org.apache.spark.ml.param.HasLabelCol

getLabelCol, labelCol

Methods inherited from interface org.apache.spark.ml.param.Params

addOutputColumn, checkInputColumn, explainParams, get, getParam, isSet, paramMap, params, set, set, validate, validate

Methods inherited from interface org.apache.spark.ml.Identifiable

uid

Constructor Detail

BinaryClassificationEvaluator

public BinaryClassificationEvaluator()

Method Detail

metricName

public Param<String> metricName()

param for metric name in evaluation

getMetricName

public String getMetricName()

setMetricName

public BinaryClassificationEvaluator setMetricName(String value)

setScoreCol

public BinaryClassificationEvaluator setScoreCol(String value)

setLabelCol

public BinaryClassificationEvaluator setLabelCol(String value)

evaluate

public double evaluate(DataFrame dataset,
              ParamMap paramMap)

Description copied from class: Evaluator

Evaluates the output.

Specified by:

evaluate in class Evaluator

Parameters:

dataset - a dataset that contains labels/observations and predictions.

paramMap - parameter map that specifies the input columns and output metrics

Returns:

metric