tf.ConditionalAccumulatorBase

A conditional accumulator for aggregating gradients.

View aliases

Compat aliases for migration

See Migration guide for more details.

tf.compat.v1.ConditionalAccumulatorBase

tf.ConditionalAccumulatorBase(
    dtype, shape, accumulator_ref
)

Up-to-date gradients (i.e., time step at which gradient was computed is equal to the accumulator's time step) are added to the accumulator.

Extraction of the average gradient is blocked until the required number of gradients has been accumulated.

Args
dtype	Datatype of the accumulated gradients.
shape	Shape of the accumulated gradients.
accumulator_ref	A handle to the conditional accumulator, created by sub- classes

Attributes
accumulator_ref	The underlying accumulator reference.
dtype	The datatype of the gradients accumulated by this accumulator.
name	The name of the underlying accumulator.

Methods

num_accumulated

View source

num_accumulated(
    name=None
)

Number of gradients that have currently been aggregated in accumulator.

Args
name	Optional name for the operation.

Returns
Number of accumulated gradients currently in accumulator.

set_global_step

View source

set_global_step(
    new_global_step, name=None
)

Sets the global time step of the accumulator.

The operation logs a warning if we attempt to set to a time step that is lower than the accumulator's own time step.

Args
new_global_step	Value of new time step. Can be a variable or a constant
name	Optional name for the operation.

Returns
Operation that sets the accumulator's time step.