mindspore.ops.communication.reduce_scatter_tensor

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

对指定通信组中的张量进行归约和分散操作,并返回归约和分散后的张量。

说明

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

参数:
  • output (Tensor) - 输出张量,与 input 具有相同的数据类型,shape为 \((N/rank\_size, *)\)。如果函数以非in-place模式运行,此参数无效。

  • input (Tensor) - 待归约和分散的输入张量,假设其shape为 \((N, *)\),其中 * 表示任意数量的额外维度。N必须能被rank_size整除。rank_size指通信组中的卡数。

  • op (str,可选) - 用于逐元素归约的操作,如SUM和MAX。默认值: ReduceOp.SUM

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

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

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

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

其中,当 async_opTrue ,则CommHandle是一个异步工作句柄;当 async_opFalse ,则CommHandle将返回 None

异常:
  • TypeError - inputoutput 参数的类型不是Tensor,opgroup 不是str,async_op 不是bool或 op 无效。

  • ValueError - 如果 input 的第一维不能被通信组大小整除。

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

支持平台:

Ascend

样例:

说明

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

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

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

>>> import mindspore as ms
>>> from mindspore import Tensor
>>> from mindspore.ops.communication import init_process_group
>>> from mindspore.ops.communication import reduce_scatter_tensor
>>> import numpy as np
>>>
>>> ms.set_device(device_target="Ascend")
>>> init_process_group()
>>> input_tensor = Tensor(np.ones([8, 8]).astype(np.float32))
>>> output_tensor = Tensor(np.ones([4, 8]).astype(np.float32))
>>> output = reduce_scatter_tensor(output_tensor ,input_tensor)
>>> print(output_tensor)
[[2. 2. 2. 2. 2. 2. 2. 2.]
[2. 2. 2. 2. 2. 2. 2. 2.]
[2. 2. 2. 2. 2. 2. 2. 2.]
[2. 2. 2. 2. 2. 2. 2. 2.]]