mindspore.ops.communication.gather_object

查看源文件
mindspore.ops.communication.gather_object(obj, object_gather_list=None, dst=0, group=None)[源代码]

在单个进程中从整个组收集Python对象。

说明

警告

本接口会隐式使用pickle模块,该模块是不安全的。核心原因是反序列化时会执行任意代码,攻击者可通过构造恶意对象触发系统命令执行。因此,调用者须自行保障接口使用数据的安全性。

参数:
  • obj (Any) - 要收集的Python对象。

  • object_gather_list (list[Any], 可选) - 用于收集数据的相同大小的张量列表。在 dst rank上,它应该正确调整为该集合的组大小,并将包含输出。默认值: None

  • dst (int, 可选) - 指定接收张量的进程的rank(全局rank)。只有进程 dst 会接收收集的张量。默认值: 0

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

异常:
  • TypeError - 如果 dst 不是整数,或 group 不是字符串。

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

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

支持平台:

Ascend

样例:

说明

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

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

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

>>> from mindspore.ops.communication import init_process_group, gather_object, get_rank
>>> init_process_group()
>>> rank = get_rank()
>>> obj = ["test", {1: 2}]
>>> object_gather_list=[None, None]
>>> gather_object(obj[rank], object_gather_list)
>>> print(object_gather_list)
# rank_0
['test', {1: 2}]