# tf.ConditionalAccumulatorBase

## Class ConditionalAccumulatorBase

See the guide: Inputs and Readers > Conditional Accumulators

A conditional accumulator for aggregating gradients.

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.

## Properties

### accumulator_ref

The underlying accumulator reference.

### dtype

The datatype of the gradients accumulated by this accumulator.

### name

The name of the underlying accumulator.

## Methods

### __init__

__init__(
dtype,
shape,
accumulator_ref
)


Creates a new ConditionalAccumulator.

#### 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

### num_accumulated

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

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.