org.nd4j.evaluation.classification

Enum ROCMultiClass.Metric

java.lang.Object

java.lang.Enum<ROCMultiClass.Metric>

org.nd4j.evaluation.classification.ROCMultiClass.Metric

All Implemented Interfaces:

Serializable, Comparable<ROCMultiClass.Metric>, IMetric

Enclosing class:

ROCMultiClass

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

AUROC: Area under ROC curve
AUPRC: Area under Precision-Recall Curve

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUPRC
AUROC

Method Summary

Modifier and Type	Method and 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 ROCMultiClass.Metric	valueOf(String name) Returns the enum constant of this type with the specified name.
static ROCMultiClass.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

AUROC

public static final ROCMultiClass.Metric AUROC

AUPRC

public static final ROCMultiClass.Metric AUPRC

Method Detail

values

public static ROCMultiClass.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 (ROCMultiClass.Metric c : ROCMultiClass.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 ROCMultiClass.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