Enum MetricReduction

java.lang.Object

java.lang.Enum<MetricReduction>

org.tensorflow.framework.metrics.MetricReduction

All Implemented Interfaces:

Serializable, Comparable<MetricReduction>

public enum MetricReduction
extends Enum<MetricReduction>

Defines the different types of metric reductions

Enum Constant Summary

Enum Constants

Enum Constant	Description
SUM	Scalar sum of weighted values.
SUM_OVER_BATCH_SIZE	Scalar sum of weighted values divided by number of elements.
WEIGHTED_MEAN	Scalar sum of weighted values divided by sum of weights.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUM

public static final MetricReduction SUM

Scalar sum of weighted values.

SUM_OVER_BATCH_SIZE

public static final MetricReduction SUM_OVER_BATCH_SIZE

Scalar sum of weighted values divided by number of elements.

WEIGHTED_MEAN

public static final MetricReduction WEIGHTED_MEAN

Scalar sum of weighted values divided by sum of weights.

Method Details

values

public static MetricReduction[] values()

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

Returns:

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

valueOf

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