mindspore.ops.communication.all_reduce

查看源文件
mindspore.ops.communication.all_reduce(tensor, op=ReduceOp.SUM, group=None, async_op=False)[源代码]

使用指定方式对通信组内的所有设备的tensor数据进行归约操作，所有设备都得到相同的结果，返回归约操作后的张量。

说明

集合中的所有进程的tensor必须具有相同的shape和格式。

参数：

  • tensor (Tensor) - 输入和输出待归约操作的tensor，tensor的shape为 \((x_1, x_2, ..., x_R)\)，该函数输出直接覆盖输入。

  • op (str，可选) - 归约的具体操作。如 "sum" 、 "prod" 、 "max" 和 "min" 。默认值： ReduceOp.SUM 。

  • group (str，可选) - 通信组名称。默认值： None ，即Ascend平台表示为 "hccl_world_group" 。

  • async_op (bool, 可选) - 本算子是否是异步算子。默认值： False 。

返回：

  • 若函数以in-place模式运行，返回CommHandle。

  • 若函数以非in-place模式运行，返回Tuple(Tensor, CommHandle)。第一个元素存储输出结果，第二个元素是CommHandle。

其中，当 async_op 是 True ，则CommHandle是一个异步工作句柄；当 async_op 是 False ，则CommHandle将返回 None 。

异常：

  • TypeError - 首个输入的数据类型不为Tensor，op 或 group 不是str， async_op 不是bool或者 op 值非法。

  • RuntimeError - 如果目标设备无效，或者后端无效，或者分布式初始化失败。

支持平台：

Ascend CPU

样例：

说明

运行以下样例之前，需要配置好通信环境变量。

针对Ascend设备，推荐使用msrun启动方式，无第三方以及配置文件依赖。详见 msrun启动 。

该样例需要在2卡环境下运行。

>>> import numpy as np
>>> from mindspore.ops.communication import init_process_group
>>> from mindspore.ops.communication import all_reduce
>>> from mindspore import Tensor
>>>
>>> init_process_group()
>>> tensor = Tensor(np.ones([2, 8]).astype(np.float32))
>>> output = all_reduce(tensor)
>>> print(tensor)
[[2. 2. 2. 2. 2. 2. 2. 2.]
[2. 2. 2. 2. 2. 2. 2. 2.]]