mindspore.communication.get_local_rank

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

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

说明

  • MindSpore的GPU和CPU版本不支持此方法。

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

参数：

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

返回：

int，指定通信组中当前设备的本地设备序号。

异常：

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

  • ValueError - 后端不可用。

  • RuntimeError - HCCL 服务不可用，或使用了MindSpore的GPU、CPU版本。

支持平台：

Ascend GPU CPU

样例：

说明

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

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

>>> import mindspore as ms
>>> from mindspore.communication import init, get_rank, get_local_rank
>>> ms.set_device(device_target="Ascend")
>>> init()
>>> world_rank = get_rank()
>>> local_rank = get_local_rank()
>>> print("local_rank is: {}, world_rank is {}".format(local_rank, world_rank))
local_rank is: 1, world_rank is 9