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

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.