# tf.distribute.NcclAllReduce

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 2 version](https://www.tensorflow.org/api_docs/python/tf/distribute/NcclAllReduce) | [![](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#L795-L817) |

Reduction using NCCL all-reduce.

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

#### View aliases


**Compat aliases for migration**

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

[`tf.compat.v1.distribute.NcclAllReduce`](https://www.tensorflow.org/api_docs/python/tf/distribute/NcclAllReduce), \`tf.compat.v2.distribute.NcclAllReduce\`

<br />

    tf.distribute.NcclAllReduce(
        num_packs=1
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `num_packs` | values will be packed in this many splits. `num_packs` should be greater than or equals 0. When it is zero, no packing will be done. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| ValueError if `num_packs` is negative. ||

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