mindspore.communication.get_group_rank_from_world_rank

查看源文件
mindspore.communication.get_group_rank_from_world_rank(world_rank_id, group)[源代码]

由通信集群中的全局设备序号获取指定用户通信组中的rank ID。

说明

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

  • 参数 group 不能是 "hccl_world_group"。

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

参数：

  • world_rank_id (int) - 通信集群内的全局rank ID。

  • group (str) - 指定通信组实例（由 create_group 方法创建）的名称。

返回：

当前通信组内的rank_ID，数据类型为int。

异常：

  • TypeError - 在参数 world_rank_id 不是数字或参数 group 不是字符串时抛出。

  • ValueError - 在参数 group 是 "hccl_world_group" 或后端不可用时抛出。

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

支持平台：

Ascend GPU CPU

样例：

说明

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

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

>>> import mindspore as ms
>>> from mindspore import set_context
>>> from mindspore.communication import init, create_group, get_group_rank_from_world_rank, get_rank
>>> set_context(mode=ms.GRAPH_MODE)
>>> ms.set_device(device_target="Ascend")
>>> init()
>>> group = "0-4"
>>> rank_ids = [0,4]
>>> if get_rank() in rank_ids:
...     create_group(group, rank_ids)
...     group_rank_id = get_group_rank_from_world_rank(4, group)
...     print("group_rank_id is: ", group_rank_id)
group_rank_id is: 1