# tf.distribute.ReductionToOneDevice

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 1 version](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/distribute/ReductionToOneDevice) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.2.0/tensorflow/python/distribute/cross_device_ops.py#L406-L451) |

Always do reduction to one device first and then do broadcasting.

Inherits From: [`CrossDeviceOps`](https://www.tensorflow.org/versions/r2.2/api_docs/python/tf/distribute/CrossDeviceOps)

#### View aliases


**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.distribute.ReductionToOneDevice`](https://www.tensorflow.org/api_docs/python/tf/distribute/ReductionToOneDevice)

<br />

    tf.distribute.ReductionToOneDevice(
        reduce_to_device=None, accumulation_fn=None
    )

Batch reduction is done by reduction on each element one by one.

      mirrored_strategy = tf.distribute.MirroredStrategy(
        cross_device_ops=tf.distribute.ReductionToOneDevice())

<br />

<br />

<br />

| ## Args ||
|---|---|
| `reduce_to_device` | the intermediate device to reduce to. If None, reduce to the first device in `destinations` of the `reduce()` method. |
| `accumulation_fn` | a function that does accumulation. If None, then [`tf.math.add_n`](https://www.tensorflow.org/versions/r2.2/api_docs/python/tf/math/add_n) is used. |

<br />

## Methods

### `batch_reduce`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.2.0/tensorflow/python/distribute/cross_device_ops.py#L269-L319)

    batch_reduce(
        reduce_op, value_destination_pairs, experimental_hints=None
    )

Reduce PerReplica objects in a batch.

Reduce each first element in `value_destination_pairs` to each second
element which indicates the destinations.

This can be faster than multiple individual `reduce`s because we can
fuse several tensors into one or multiple packs before reduction.

<br />

<br />

<br />

| Args ||
|---|---|
| `reduce_op` | An instance of [`tf.distribute.ReduceOp`](https://www.tensorflow.org/versions/r2.2/api_docs/python/tf/distribute/ReduceOp) that indicates how the `per_replica_value` will be reduced. |
| `value_destination_pairs` | A list or a tuple of PerReplica objects (or tensors with device set if there is one device) and destinations. |
| `experimental_hints` | A `tf.distrbute.experimental.CollectiveHints`. Hints to perform collective operations. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| a list of Mirrored objects. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | if `value_destination_pairs` is not an iterable of tuples of PerReplica objects and destinations. |

<br />

### `broadcast`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.2.0/tensorflow/python/distribute/cross_device_ops.py#L321-L332)

    broadcast(
        tensor, destinations
    )

Broadcast the `tensor` to destinations.

<br />

<br />

<br />

| Args ||
|---|---|
| `tensor` | the tensor to broadcast. |
| `destinations` | the broadcast destinations. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| a Mirrored object. ||

<br />

### `reduce`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.2.0/tensorflow/python/distribute/cross_device_ops.py#L226-L267)

    reduce(
        reduce_op, per_replica_value, destinations, experimental_hints=None
    )

Reduce `per_replica_value` to `destinations`.

It runs the reduction operation defined by `reduce_op` and put the
result on `destinations`.

<br />

<br />

<br />

| Args ||
|---|---|
| `reduce_op` | An instance of [`tf.distribute.ReduceOp`](https://www.tensorflow.org/versions/r2.2/api_docs/python/tf/distribute/ReduceOp) that indicates how per_replica_value will be reduced. |
| `per_replica_value` | A PerReplica object or a tensor with device set. |
| `destinations` | the reduction destinations. |
| `experimental_hints` | A `tf.distrbute.experimental.CollectiveHints`. Hints to perform collective operations. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| a Mirrored object. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | if per_replica_value can't be converted to a PerReplica object or if destinations aren't strings, Variables or DistributedValues |

<br />