mindspore.mint.distributed.scatter

mindspore.mint.distributed.scatter(tensor, scatter_list, src=0, group=None, async_op=False)

对输入张量进行均匀散射到通信域的卡上。

说明

• 该接口支持Tensor List输入，只支持均匀切分。

• 只有源为src的进程(全局的进程编号)才会将输入张量作为散射源。

• 当前支持PyNative模式，不支持Graph模式。

参数：

• tensor (Tensor) - 输出散射的Tensor。

• scatter_list (list[Tensor]) - 输入待散射的Tensor列表。

• src (int，可选) - 表示发送源的进程编号。只有该进程会发送散射源张量。默认值： 0 。

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

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

返回：

CommHandle，若 async_op 是True，CommHandle是一个异步工作句柄。若 async_op 是False，CommHandle将返回None。

异常：

• TypeError - 输入 tensor 的数据类型不为Tensor， scatter_list 不为Tensor列表。

• TypeError - op 或 group 不是str， async_op 不是bool， op 值非法。

• TypeError - scatter_list 的大小不为通信组大小。

• TypeError - tensor 的数据类型和shape与 scatter_list 中所有元素存在不一致。

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

支持平台：

Ascend

样例：

说明

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

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

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

>>> from mindspore import Tensor
>>> from mindspore.mint.distributed import init_process_group, scatter
>>> import numpy as np
>>> # Launch 2 processes.
>>>
>>> init_process_group()
>>> inputs = [Tensor(np.ones([2, 2]).astype(np.float32)), Tensor(np.ones([2, 2]).astype(np.float32))]
>>> output = Tensor(np.zeros([2, 2]).astype(np.float32))
>>> scatter(output, inputs, src=0)
>>> print(output)
# rank_0
[[1. 1.]
[1. 1.]]
# rank_1
[[1. 1.]
[1. 1.]]