# tf.contrib.distribute.AllReduceCrossDeviceOps

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/distribute/cross_device_ops.py#L674-L783) |

Reduction using all-reduce.

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

    tf.contrib.distribute.AllReduceCrossDeviceOps(
        all_reduce_alg='nccl', num_packs=1, agg_small_grads_max_bytes=0,
        agg_small_grads_max_group=10
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `all_reduce_alg` | the all-reduce algorithm to use, currently only "nccl" or "hierarchical_copy" are supported. |
| `num_packs` | see above. |
| `agg_small_grads_max_bytes` | see above. |
| `agg_small_grads_max_group` | see above. |

<br />

## Methods

### `batch_reduce`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/distribute/cross_device_ops.py#L284-L324)

    batch_reduce(
        reduce_op, value_destination_pairs
    )

Reduce PerReplica objects in a batch.

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

<br />

<br />

<br />

| Args ||
|---|---|
| `reduce_op` | Indicates how per_replica_value will be reduced. Accepted values are [`tf.distribute.ReduceOp.SUM`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/distribute/ReduceOp#SUM), [`tf.distribute.ReduceOp.MEAN`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/distribute/ReduceOp#MEAN). |
| `value_destination_pairs` | a list or a tuple of tuples of PerReplica objects (or tensors with device set if there is one device) and destinations. |

<br />

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | if `value_destination_pairs` is not a list or a tuple of tuples of PerReplica objects and destinations |

<br />

### `broadcast`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/distribute/cross_device_ops.py#L326-L337)

    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/v1.15.0/tensorflow/python/distribute/cross_device_ops.py#L248-L282)

    reduce(
        reduce_op, per_replica_value, destinations
    )

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` | Indicates how per_replica_value will be reduced. Accepted values are [`tf.distribute.ReduceOp.SUM`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/distribute/ReduceOp#SUM), [`tf.distribute.ReduceOp.MEAN`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/distribute/ReduceOp#MEAN). |
| `per_replica_value` | a PerReplica object or a tensor with device set. |
| `destinations` | the reduction destinations. |

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

<br />