get_rank_id

产品支持情况

产品	是否支持
Atlas A3 训练系列产品/Atlas A3 推理系列产品	√
Atlas A2 训练系列产品	√
Atlas 800I A2 推理产品/A200I A2 Box 异构组件	x
Atlas 200I/500 A2 推理产品	x
Atlas 推理系列产品	√
Atlas 训练系列产品	√
Atlas 200/300/500 推理产品	x

针对Atlas 推理系列产品，仅支持此系列产品中的Atlas 300I Duo 推理卡。

功能说明

获取device在group中对应的rank序号。

函数原型

def get_rank_id(group="hccl_world_group")

参数说明

参数名	输入/输出	描述
group	输入	String类型，最大长度为128字节，含结束符。 group名称，可以为用户自定义group，如果用户不传，默认为"hccl_world_group"。

参数名

输入/输出

描述

group

输入

String类型，最大长度为128字节，含结束符。

group名称，可以为用户自定义group，如果用户不传，默认为"hccl_world_group"。

返回值

int类型，返回device所在group的rank id。

约束说明

必须在集合通信初始化完成之后调用。
调用该接口的rank必须在当前接口入参group定义的范围内，不在此范围内的rank调用该接口会失败。
create_group完成之后，调用此API获取进程在group中的rank id。
如果传入"hccl_world_group"，返回进程在hccl_world_group的rank id。

调用示例

以下仅为代码片段，不可执行，调用HCCL Python接口进行集合通信操作的完整示例可参见样例代码。

from hccl.manage.api import create_group
from hccl.manage.api import get_rank_id
create_group("myGroup", 4, [0, 1, 2, 3])
rankId = get_rank_id("myGroup")

父主题： hccl.manage.api