mindspore.communication.comm_func.all_gather_into_tensor

查看源文件
mindspore.communication.comm_func.all_gather_into_tensor(tensor, group=GlobalComm.WORLD_COMM_GROUP, async_op=False)[源代码]

汇聚指定的通信组中的Tensor,并返回汇聚后的张量。

说明

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

参数:
  • tensor (Tensor) - 输入待汇聚操作的Tensor,Tensor的shape为 \((x_1, x_2, ..., x_R)\)

  • group (str,可选) - 工作的通信组,默认值: GlobalComm.WORLD_COMM_GROUP (即Ascend平台为 "hccl_world_group" ,GPU平台为 "nccl_world_group" )。

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

返回:

Tuple(Tensor, CommHandle),如果组中的device数量为N,则输出Tensor的shape为 \((N, x_1, x_2, ..., x_R)\) 。 若 async_op 是True,CommHandle是一个异步工作句柄。若 async_op 是False,CommHandle将返回None。

异常:
  • TypeError - 首个输入的数据类型不为Tensor,group 不是str。

  • ValueError - 调用进程的rank id大于本通信组的rank大小。

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

支持平台:

Ascend

样例:

说明

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

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

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

>>> import numpy as np
>>> import mindspore as ms
>>> import mindspore.communication as comm
>>>
>>> ms.set_context(mode=ms.GRAPH_MODE)
>>> comm.init()
>>> input_tensor = ms.Tensor(np.ones([2, 8]).astype(np.float32))
>>> output = comm.comm_func.all_gather_into_tensor(input_tensor)
>>> print(output)
[[1. 1. 1. 1. 1. 1. 1. 1.]
[1. 1. 1. 1. 1. 1. 1. 1.]
[1. 1. 1. 1. 1. 1. 1. 1.]
[1. 1. 1. 1. 1. 1. 1. 1.]]