org.tribuo.multilabel.evaluation

Enum MultiLabelMetrics

java.lang.Object

java.lang.Enum<MultiLabelMetrics>

org.tribuo.multilabel.evaluation.MultiLabelMetrics

All Implemented Interfaces:

Serializable, Comparable<MultiLabelMetrics>

public enum MultiLabelMetrics
extends Enum<MultiLabelMetrics>

An enum of the default MultiLabelMetrics supported by the multi-label classification evaluation package.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BALANCED_ERROR_RATE The balanced error rate, i.e., the mean of the per class recalls.
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 number of true positives divided by the number of predicted positives.
RECALL The recall, i.e., the number of true positives divided by the number of ground truth positives.
TN The number of true negatives.
TP The number of true positives.

Method Summary

Modifier and Type	Method and Description
MultiLabelMetric	forTarget(MetricTarget<MultiLabel> tgt)
BiFunction<MetricTarget<MultiLabel>,org.tribuo.multilabel.evaluation.MultiLabelMetric.Context,Double>	getImpl()
static MultiLabelMetrics	valueOf(String name) Returns the enum constant of this type with the specified name.
static MultiLabelMetrics[]	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

TP

public static final MultiLabelMetrics TP

The number of true positives.

FP

public static final MultiLabelMetrics FP

The number of false positives.

TN

public static final MultiLabelMetrics TN

The number of true negatives.

FN

public static final MultiLabelMetrics FN

The number of false negatives.

PRECISION

public static final MultiLabelMetrics PRECISION

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

RECALL

public static final MultiLabelMetrics RECALL

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

F1

public static final MultiLabelMetrics F1

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

BALANCED_ERROR_RATE

public static final MultiLabelMetrics BALANCED_ERROR_RATE

The balanced error rate, i.e., the mean of the per class recalls.

Method Detail

values

public static MultiLabelMetrics[] 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 (MultiLabelMetrics c : MultiLabelMetrics.values())
    System.out.println(c);

Returns:

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

valueOf

public static MultiLabelMetrics 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

getImpl

public BiFunction<MetricTarget<MultiLabel>,org.tribuo.multilabel.evaluation.MultiLabelMetric.Context,Double> getImpl()

forTarget

public MultiLabelMetric forTarget(MetricTarget<MultiLabel> tgt)