Enum Class AnomalyMetrics

java.lang.Object

java.lang.Enum<AnomalyMetrics>

org.tribuo.anomaly.evaluation.AnomalyMetrics

All Implemented Interfaces:

Serializable, Comparable<AnomalyMetrics>, Constable

public enum AnomalyMetrics
extends Enum<AnomalyMetrics>

Default metrics for evaluating anomaly detection.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
F1	The F_1 score, i.e., the harmonic mean of the precision and the recall.
FN	The number of false negatives.
FP	The number of false positives.
PRECISION	The precision, i.e., the true positives divided by the predicted positives.
RECALL	The recall, i.e., the true positives divided by the ground truth positives.
TN	The number of true negatives.
TP	The number of true positives.

Method Summary

Modifier and Type	Method	Description
static AnomalyMetrics	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AnomalyMetrics[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TP

public static final AnomalyMetrics TP

The number of true positives.

FP

public static final AnomalyMetrics FP

The number of false positives.

TN

public static final AnomalyMetrics TN

The number of true negatives.

FN

public static final AnomalyMetrics FN

The number of false negatives.

PRECISION

public static final AnomalyMetrics PRECISION

The precision, i.e., the true positives divided by the predicted positives.

RECALL

public static final AnomalyMetrics RECALL

The recall, i.e., the true positives divided by the ground truth positives.

F1

public static final AnomalyMetrics F1

The F_1 score, i.e., the harmonic mean of the precision and the recall.

Method Details

values

public static AnomalyMetrics[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AnomalyMetrics valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null