get_world_rank_from_group_rank

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas 200I/500 A2 inference product	☓
Atlas inference product	√
Atlas training product	√

For Atlas A2 training product/Atlas A2 inference product, only the Atlas 800T A2 training server, Atlas 900 A2 PoD cluster basic unit, and Atlas 200T A2 Box16 heterogeneous subrack are supported.

For the Atlas inference products, only the Atlas 300I Duo inference card is supported.

Function

Obtains the world rank ID based on the rank ID of the process in the group.

Prototype

def get_world_rank_from_group_rank(group, group_rank_id)

Parameters

Parameter	Input/Output	Description
group	Input	A string containing a maximum of 128 bytes, including the end character. Group name, which can be a user-defined value or hccl_world_group.
group_rank_id	Input	An int. Rank ID of a process in a group.

Parameter

Input/Output

Description

group

Input

A string containing a maximum of 128 bytes, including the end character.

Group name, which can be a user-defined value or hccl_world_group.

group_rank_id

Input

An int.

Rank ID of a process in a group.

Returns

Rank ID of the process in the global group (hccl_world_group), which is of the int type.

Constraints

This API must be called after the initialization of collective communication is complete.
The caller rank must be within the range defined by the group argument passed to this API call. Otherwise, the API call fails.
After the create_group call, call this API to convert the group rank ID to the world rank ID.

Call Example

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

Parent topic: hccl.manage.api