mindspore.communication.get_rank

查看源文件
mindspore.communication.get_rank(group=GlobalComm.WORLD_COMM_GROUP)[源代码]

在指定通信组中获取当前的设备序号。

说明

  • get_rank 方法应该在 init 方法之后使用。

参数：

  • group (str, 可选) - 通信组名称，通常由 create_group 方法创建，否则将使用默认组。默认值：GlobalComm.WORLD_COMM_GROUP 。

返回：

int，调用该方法的进程对应的组内序号。

异常：

  • TypeError - 参数 group 不是字符串。

  • ValueError - 后端不可用。

  • RuntimeError - HCCL、NCCL 或 MCCL 服务不可用。

支持平台：

Ascend GPU CPU

样例：

说明

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

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

>>> from mindspore.communication import init, get_rank
>>> init()
>>> rank_id = get_rank()
>>> print(rank_id)
>>> # the result is the rank_id in world_group