get_group_rank_from_world_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 group rank ID of the process in the group using the world rank ID.

Prototype

def get_group_rank_from_world_rank(world_rank_id, group)

Parameters

Parameter	Input/Output	Description
world_rank_id	Input	An int. Rank ID of the process in hccl_world_group.
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.

Parameter

Input/Output

Description

world_rank_id

Input

An int.

Rank ID of the process in hccl_world_group.

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.

Returns

An int for the rank ID of a process in a group

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 world rank ID to the group rank ID.

Call Example

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

Parent topic: hccl.manage.api