mindspore.mint.distributed.get_rank

查看源文件
mindspore.mint.distributed.get_rank(group=None)[源代码]

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

说明

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

参数:
  • group (str) - 通信组名称,通常由 mindspore.communication.create_group 方法创建,否则将使用默认组。如果设置为 None ,会使用 GlobalComm.WORLD_COMM_GROUP 。默认值: None

返回:

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

异常:
  • TypeError - 在参数 group 不是字符串时抛出。

支持平台:

Ascend

样例:

说明

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

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

>>> from mindspore import set_context
>>> from mindspore.mint.distributed import init_process_group, get_rank
>>> set_context(device_target="Ascend")
>>> init_process_group()
>>> rank_id = get_rank()
>>> print(rank_id)
>>> # the result is the rank_id in world_group