mindspore.ops.communication.all_gather

查看源文件
mindspore.ops.communication.all_gather(tensor_list, tensor, group=None, async_op=False)[源代码]

从指定通信组中收集张量,并返回收集的张量列表。

参数:
  • tensor_list (list[Tensor]) - 输出列表。

  • tensor (Tensor) - 要收集到张量中的输入张量。

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

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

返回:

CommHandle。若 async_opTrue,CommHandle是一个异步工作句柄;若 async_opFalse,CommHandle将返回 None

异常:
  • TypeError - 如果输入 tensor 的类型不是Tensor,tensor_list 不是Tensor列表,group 不是str或 async_op 不是bool。

  • TypeError - 如果 tensor_list 的大小不等于组大小。

  • TypeError - 如果 tensor 的类型或shape不等于 tensor_list 的成员。

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

支持平台:

Ascend CPU

样例:

说明

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

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

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

>>> import numpy as np
>>> import mindspore as ms
>>> from mindspore.ops.communication import init_process_group
>>> from mindspore.ops.communication import all_gather
>>> from mindspore import Tensor
>>>
>>> init_process_group()
>>> input_tensor = Tensor(np.ones([2, 8]).astype(np.float32))
>>> out_tensors = [Tensor(np.zeros([2, 8]).astype(np.float32)), Tensor(np.zeros([2, 8]).astype(np.float32))]
>>> output = all_gather(out_tensors, input_tensor)
>>> print(out_tensors)
[Tensor(shape=[2, 8], dtype=Float32, value=
[[ 1.00000000e+00,  1.00000000e+00,  1.00000000e+00 ...  1.00000000e+00,  1.00000000e+00,  1.00000000e+00],
[ 1.00000000e+00,  1.00000000e+00,  1.00000000e+00 ...  1.00000000e+00,  1.00000000e+00,  1.00000000e+00]]),
Tensor(shape=[2, 8], dtype=Float32, value=
[[ 1.00000000e+00,  1.00000000e+00,  1.00000000e+00 ...  1.00000000e+00,  1.00000000e+00,  1.00000000e+00],
[ 1.00000000e+00,  1.00000000e+00,  1.00000000e+00 ...  1.00000000e+00,  1.00000000e+00,  1.00000000e+00]])]