mindspore.ops.communication.get_process_group_ranks

mindspore.ops.communication.get_process_group_ranks(group=None)

获取特定组的rank，并以列表形式返回通信组中的进程rank。

参数：

• group (str，可选) - 要工作的通信组。通常，组应由 mindspore.ops.communication.new_group() 创建。默认值： None，在Ascend中表示 "hccl_world_group"。

返回：

List[int]。指定通信组中的进程rank列表。

异常：

• TypeError - 如果 group 不是str。

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

支持平台：

Ascend CPU

样例：

说明

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

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

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

>>> import mindspore as ms
>>> from mindspore.ops.communication import init_process_group, get_process_group_ranks
>>> # Launch 4 processes.
>>> ms.set_device(device_target="Ascend")
>>> init_process_group()
>>> output = get_process_group_ranks()
>>> print(output)
[0, 1, 2, 3]