HcclGetRankId

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 rank ID of a device in a communicator.

Prototype

HcclResult HcclGetRankId(HcclComm comm, uint32_t *rank)

Parameters

Parameter	Input/Output	Description
comm	Input	Communicator where the operation is performed. For details about the definition of the HcclComm type, see HcclComm.
rank	Output	Pointer to the output address of the rank ID in the collective communicator.

Parameter

Input/Output

Description

comm

Input

Communicator where the operation is performed.

For details about the definition of the HcclComm type, see HcclComm.

rank

Output

Pointer to the output address of the rank ID in the collective communicator.

Returns

HcclResult: HCCL_SUCCESS on success, or else failure.

Constraints

None

Call Example

// Initialize the communicator.
HcclComm comm;
// Obtain the rank ID of the current device.
uint32_t rank;
HcclGetRankId(comm, &rank);

Parent topic: C APIs