mindspore.ops.communication.get_rank

mindspore.ops.communication.get_rank(group=None)[源代码]

获取指定集合通信组中当前设备的rank ID。

说明

此方法应在 mindspore.ops.communication.init_process_group() 之后使用。

参数：

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

返回：

int，组内调用进程的rank ID。如果不在组内，返回-1。

异常：

TypeError - 如果 group 不是字符串。

支持平台：

Ascend CPU

样例：

说明

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

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

>>> import mindspore as ms
>>> from mindspore.ops.communication import init_process_group, get_rank
>>> ms.set_device(device_target="Ascend")
>>> init_process_group()
>>> rank_id = get_rank()
>>> print(rank_id)
>>> # the result is the rank_id in world_group
#rank 0: 0
#rank 1: 1