ConditionalAccumulator

public final class ConditionalAccumulator

A conditional accumulator for aggregating gradients.

The accumulator accepts gradients marked with local_step greater or equal to the most recent global_step known to the accumulator. The average can be extracted from the accumulator, provided sufficient gradients have been accumulated. Extracting the average automatically resets the aggregate to 0, and increments the global_step recorded by the accumulator.

Nested Classes

class ConditionalAccumulator.Options Optional attributes for ConditionalAccumulator

Constants

String OP_NAME The name of this op, as known by TensorFlow core engine

Public Methods

Output<TString>	asOutput() Returns the symbolic handle of the tensor.
static ConditionalAccumulator.Options	container(String container)
static <T extends TType> ConditionalAccumulator	create(Scope scope, Class<T> dtype, Shape shape, Options... options) Factory method to create a class wrapping a new ConditionalAccumulator operation.
Output<TString>	handle() The handle to the accumulator.
static ConditionalAccumulator.Options	reductionType(String reductionType)
static ConditionalAccumulator.Options	sharedName(String sharedName)

Inherited Methods

From class org.tensorflow.op.RawOp

final boolean	equals(Object obj)
final int	hashCode()
Operation	op() Return this unit of computation as a single `Operation`.
final String	toString()

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface org.tensorflow.op.Op

abstract ExecutionEnvironment	env() Return the execution environment this op was created in.
abstract Operation	op() Return this unit of computation as a single `Operation`.

From interface org.tensorflow.Operand

abstract Output<TString>	asOutput() Returns the symbolic handle of the tensor.
abstract TString	asTensor() Returns the tensor at this operand.
abstract Shape	shape() Returns the (possibly partially known) shape of the tensor referred to by the `Output` of this operand.
abstract Class<TString>	type() Returns the tensor type of this operand

From interface org.tensorflow.ndarray.Shaped

abstract int	rank()
abstract Shape	shape()
abstract long	size() Computes and returns the total size of this container, in number of values.

Constants

public static final String OP_NAME

The name of this op, as known by TensorFlow core engine

Constant Value: "ConditionalAccumulator"

Public Methods

public Output<TString> asOutput ()

Returns the symbolic handle of the tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to obtain a symbolic handle that represents the computation of the input.

public static ConditionalAccumulator.Options container (String container)

Parameters

container	If non-empty, this accumulator is placed in the given container. Otherwise, a default container is used.

public static ConditionalAccumulator create (Scope scope, Class<T> dtype, Shape shape, Options... options)

Factory method to create a class wrapping a new ConditionalAccumulator operation.

Parameters

scope	current scope
dtype	The type of the value being accumulated.
shape	The shape of the values, can be [], in which case shape is unknown.
options	carries optional attributes values

Returns

a new instance of ConditionalAccumulator

public Output<TString> handle ()

The handle to the accumulator.

public static ConditionalAccumulator.Options reductionType (String reductionType)

public static ConditionalAccumulator.Options sharedName (String sharedName)

Parameters

sharedName	If non-empty, this accumulator will be shared under the given name across multiple sessions.