Package org.nd4j.evaluation.classification

Enum Evaluation.Metric

java.lang.Object

java.lang.Enum<Evaluation.Metric>

org.nd4j.evaluation.classification.Evaluation.Metric

All Implemented Interfaces:

Serializable, Comparable<Evaluation.Metric>, IMetric

Enclosing class:

Evaluation

public static enum Evaluation.Metric
extends Enum<Evaluation.Metric>
implements IMetric

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCURACY
F1
GMEASURE
MCC
PRECISION
RECALL

Method Summary

Modifier and Type	Method	Description
Class<? extends IEvaluation>	getEvaluationClass()	The IEvaluation class this metric is for
boolean	minimize()	Whether this metric should be minimized (aka whether lower values are better).
static Evaluation.Metric	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Evaluation.Metric[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACCURACY

public static final Evaluation.Metric ACCURACY

F1

public static final Evaluation.Metric F1

PRECISION

public static final Evaluation.Metric PRECISION

RECALL

public static final Evaluation.Metric RECALL

GMEASURE

public static final Evaluation.Metric GMEASURE

MCC

public static final Evaluation.Metric MCC

Method Detail

values

public static Evaluation.Metric[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Evaluation.Metric c : Evaluation.Metric.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Evaluation.Metric valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getEvaluationClass

public Class<? extends IEvaluation> getEvaluationClass()

Description copied from interface: IMetric

The IEvaluation class this metric is for

Specified by:

getEvaluationClass in interface IMetric

minimize

public boolean minimize()

Description copied from interface: IMetric

Whether this metric should be minimized (aka whether lower values are better).

Specified by:

minimize in interface IMetric