org.apache.spark.ml.evaluation

Class BinaryClassificationEvaluator

java.lang.Object

org.apache.spark.ml.evaluation.Evaluator

org.apache.spark.ml.evaluation.BinaryClassificationEvaluator

All Implemented Interfaces:

java.io.Serializable, Params, Identifiable

public class BinaryClassificationEvaluator
extends Evaluator

:: Experimental :: Evaluator for binary classification, which expects two input columns: rawPrediction and label. The rawPrediction column can be of type double (binary 0/1 prediction, or probability of label 1) or of type vector (length-2 vector of raw predictions, scores, or label probabilities).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BinaryClassificationEvaluator()
BinaryClassificationEvaluator(java.lang.String uid)

Method Summary

Methods

Modifier and Type	Method and Description
protected static <T> T	$(Param<T> param)
static Params	clear(Param<?> param)
BinaryClassificationEvaluator	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
protected static <T extends Params> T	copyValues(T to, ParamMap extra)
protected static <T extends Params> ParamMap	copyValues$default$2()
protected static <T extends Params> T	defaultCopy(ParamMap extra)
double	evaluate(Dataset<?> dataset) Evaluates the output.
static java.lang.String	explainParam(Param<?> param)
static java.lang.String	explainParams()
static ParamMap	extractParamMap()
static ParamMap	extractParamMap(ParamMap extra)
static <T> scala.Option<T>	get(Param<T> param)
static <T> scala.Option<T>	getDefault(Param<T> param)
static java.lang.String	getLabelCol()
java.lang.String	getMetricName()
static <T> T	getOrDefault(Param<T> param)
static Param<java.lang.Object>	getParam(java.lang.String paramName)
static java.lang.String	getRawPredictionCol()
static <T> boolean	hasDefault(Param<T> param)
static boolean	hasParam(java.lang.String paramName)
static boolean	isDefined(Param<?> param)
boolean	isLargerBetter() Indicates whether the metric returned by evaluate() should be maximized (true, default) or minimized (false).
static boolean	isSet(Param<?> param)
static Param<java.lang.String>	labelCol()
static BinaryClassificationEvaluator	load(java.lang.String path)
Param<java.lang.String>	metricName() param for metric name in evaluation (supports "areaUnderROC" (default), "areaUnderPR")
static Param<?>[]	params()
static Param<java.lang.String>	rawPredictionCol()
static void	save(java.lang.String path)
static <T> Params	set(Param<T> param, T value)
protected static Params	set(ParamPair<?> paramPair)
protected static Params	set(java.lang.String param, java.lang.Object value)
protected static <T> Params	setDefault(Param<T> param, T value)
protected static Params	setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)
BinaryClassificationEvaluator	setLabelCol(java.lang.String value)
BinaryClassificationEvaluator	setMetricName(java.lang.String value)
BinaryClassificationEvaluator	setRawPredictionCol(java.lang.String value)
static java.lang.String	toString()
java.lang.String	uid() An immutable unique ID for the object and its derivatives.
static void	validateParams()
static MLWriter	write()

Methods inherited from class org.apache.spark.ml.evaluation.Evaluator

evaluate

Methods inherited from class java.lang.Object

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

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

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

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

toString

Constructor Detail

BinaryClassificationEvaluator

public BinaryClassificationEvaluator(java.lang.String uid)

BinaryClassificationEvaluator

public BinaryClassificationEvaluator()

Method Detail

load

public static BinaryClassificationEvaluator load(java.lang.String path)

toString

public static java.lang.String toString()

params

public static Param<?>[] params()

validateParams

public static void validateParams()

explainParam

public static java.lang.String explainParam(Param<?> param)

explainParams

public static java.lang.String explainParams()

isSet

public static final boolean isSet(Param<?> param)

isDefined

public static final boolean isDefined(Param<?> param)

hasParam

public static boolean hasParam(java.lang.String paramName)

getParam

public static Param<java.lang.Object> getParam(java.lang.String paramName)

set

public static final <T> Params set(Param<T> param,
             T value)

set

protected static final Params set(java.lang.String param,
         java.lang.Object value)

set

protected static final Params set(ParamPair<?> paramPair)

get

public static final <T> scala.Option<T> get(Param<T> param)

clear

public static final Params clear(Param<?> param)

getOrDefault

public static final <T> T getOrDefault(Param<T> param)

$

protected static final <T> T $(Param<T> param)

setDefault

protected static final <T> Params setDefault(Param<T> param,
                    T value)

setDefault

protected static final Params setDefault(scala.collection.Seq<ParamPair<?>> paramPairs)

getDefault

public static final <T> scala.Option<T> getDefault(Param<T> param)

hasDefault

public static final <T> boolean hasDefault(Param<T> param)

defaultCopy

protected static final <T extends Params> T defaultCopy(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap(ParamMap extra)

extractParamMap

public static final ParamMap extractParamMap()

copyValues

protected static <T extends Params> T copyValues(T to,
                              ParamMap extra)

copyValues$default$2

protected static <T extends Params> ParamMap copyValues$default$2()

rawPredictionCol

public static final Param<java.lang.String> rawPredictionCol()

getRawPredictionCol

public static final java.lang.String getRawPredictionCol()

labelCol

public static final Param<java.lang.String> labelCol()

getLabelCol

public static final java.lang.String getLabelCol()

save

public static void save(java.lang.String path)
                 throws java.io.IOException

Throws:

java.io.IOException

write

public static MLWriter write()

uid

public java.lang.String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Returns:

(undocumented)

metricName

public Param<java.lang.String> metricName()

param for metric name in evaluation (supports "areaUnderROC" (default), "areaUnderPR")

Returns:

(undocumented)

getMetricName

public java.lang.String getMetricName()

setMetricName

public BinaryClassificationEvaluator setMetricName(java.lang.String value)

setRawPredictionCol

public BinaryClassificationEvaluator setRawPredictionCol(java.lang.String value)

setLabelCol

public BinaryClassificationEvaluator setLabelCol(java.lang.String value)

evaluate

public double evaluate(Dataset<?> dataset)

Description copied from class: Evaluator

Evaluates the output.

Specified by:

evaluate in class Evaluator

Parameters:

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

Returns:

metric

isLargerBetter

public boolean isLargerBetter()

Description copied from class: Evaluator

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.

Overrides:

isLargerBetter in class Evaluator

Returns:

(undocumented)

copy

public BinaryClassificationEvaluator copy(ParamMap extra)

Description copied from interface: 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.

Specified by:

copy in interface Params

Specified by:

copy in class Evaluator

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()