Class Sum<T extends TNumber>

java.lang.Object

org.tensorflow.framework.metrics.BaseMetric

org.tensorflow.framework.metrics.Sum<T>

All Implemented Interfaces:

Metric

public class Sum<T extends TNumber>
extends BaseMetric

Computes the (weighted) sum of the given values.

For example, if values is [1, 3, 5, 7] then the sum is 16. If the weights were specified as [1, 1, 0, 0], then the sum would be 4.

This metric creates one variable, total, that is used to compute the sum of values. This is ultimately returned as sum.

If sample_weight is None, weights default to 1. Use sample_weight of 0 to mask values.

Field Summary

Fields

Modifier and Type	Field	Description
protected Variable<T>	count	the variable that holds the count of the metric values.
static final String	COUNT
protected final MetricReduction	reduction
protected Variable<T>	total	the variable that holds the total of the metric values
static final String	TOTAL

Constructor Summary

Constructors

Constructor	Description
Sum(long seed, Class<T> type)	Creates a Sum metric with a name of Class.getSimpleName()
Sum(String name, long seed, Class<T> type)	Creates a Sum metric.

Method Summary

Modifier and Type	Method	Description
Variable<T>	getCount()	Gets the count variable
Class<T>	getInternalType()	Gets the type for the variables
Variable<T>	getTotal()	Gets the total variable
protected void	init(Ops tf)	Initialize the TensorFlow Ops
Op	resetStates(Ops tf)	Resets any state variables to their initial values
<U extends TNumber> Operand<U>	result(Ops tf, Class<U> type)	Gets the current result of the metric
List<Op>	updateStateList(Ops tf, Operand<? extends TNumber> values, Operand<? extends TNumber> sampleWeights)	Updates the metric variables based on the inputs.

Methods inherited from class BaseMetric

callOnce, checkIsGraph, getName, getSeed, getTF, getVariableName, isInitialized, setInitialized, setName, setTF, updateState, updateState, updateStateList

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TOTAL

public static final String TOTAL

See Also:

• Constant Field Values

COUNT

public static final String COUNT

See Also:

• Constant Field Values

reduction

protected final MetricReduction reduction

total

protected Variable<T extends TNumber> total

the variable that holds the total of the metric values

count

protected Variable<T extends TNumber> count

the variable that holds the count of the metric values. For MetricReduction.WEIGHTED_MEAN, this count may be weighted

Constructor Details

Sum

public Sum(long seed,
 Class<T> type)

Creates a Sum metric with a name of Class.getSimpleName()

Parameters:

seed - the seed for random number generation. An initializer created with a given seed will always produce the same random tensor for a given shape and data type.

type - the type for the variables and result

Sum

public Sum(String name,
 long seed,
 Class<T> type)

Creates a Sum metric.

Parameters:

name - the name of the metric instance. If null, defaults to Class.getSimpleName()

seed - the seed for random number generation. An initializer created with a given seed will always produce the same random tensor for a given shape and data type.

type - the type for the variables and result

Method Details

init

protected void init(Ops tf)

Initialize the TensorFlow Ops

Specified by:

init in class BaseMetric

Parameters:

tf - the TensorFlow Ops encapsulating a Graph environment.

resetStates

public Op resetStates(Ops tf)

Resets any state variables to their initial values

Parameters:

tf - the TensorFlow Ops encapsulating a Graph environment.

Returns:

the operation for doing the reset

updateStateList

public List<Op> updateStateList(Ops tf,
 Operand<? extends TNumber> values,
 Operand<? extends TNumber> sampleWeights)

Updates the metric variables based on the inputs. At least one input arg required for values, an optional additional input for the sampleWeights

Specified by:

updateStateList in interface Metric

Overrides:

updateStateList in class BaseMetric

Parameters:

tf - the TensorFlow Ops encapsulating a Graph environment.

values - the inputs to be passed to update state, this may not be null

sampleWeights - sample weights to be applied to values, will default to 1 if null.

Returns:

the result with a control dependency on update state Operands

Throws:

IllegalArgumentException - if values is null

result

public <U extends TNumber> Operand<U> result(Ops tf,
 Class<U> type)

Gets the current result of the metric

Type Parameters:

U - the date type for the result

Parameters:

tf - the TensorFlow Ops encapsulating a Graph environment.

type - the data type for the result

Returns:

the result, possibly with control dependencies

getTotal

public Variable<T> getTotal()

Gets the total variable

Returns:

the total variable

getCount

public Variable<T> getCount()

Gets the count variable

Returns:

the count variable

getInternalType

public Class<T> getInternalType()

Gets the type for the variables

Returns:

the type for the variables