Package org.tribuo.evaluation.metrics

Enum Class EvaluationMetric.Average

java.lang.Object

java.lang.Enum<EvaluationMetric.Average>

org.tribuo.evaluation.metrics.EvaluationMetric.Average

All Implemented Interfaces:

Serializable, Comparable<EvaluationMetric.Average>, Constable

Enclosing interface:

EvaluationMetric<T extends Output<T>,C extends MetricContext<T>>

public static enum EvaluationMetric.Average
extends Enum<EvaluationMetric.Average>

Specifies what form of average to use for a EvaluationMetric.

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
MACRO	The macro average.
MICRO	The micro average.

Method Summary

Modifier and Type	Method	Description
static EvaluationMetric.Average	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EvaluationMetric.Average[]	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

MACRO

public static final EvaluationMetric.Average MACRO

The macro average.

MICRO

public static final EvaluationMetric.Average MICRO

The micro average.

Method Details

values

public static EvaluationMetric.Average[] 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 EvaluationMetric.Average 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