HcclChannelDescInit

Applicability

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

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.

Function

Initializes the communication channel description list.

Prototype

HcclResult HcclChannelDescInit(HcclChannelDesc *channelDesc, uint32_t descNum)

Parameters

Parameter	Input/Output	Description
channelDesc	Input	Communication channel description list. The list length is descNum. For the definition of the HcclChannelDesc type, see HcclChannelDesc.
descNum	Input	Number of communication channel descriptions.

Parameter

Input/Output

Description

channelDesc

Input

Communication channel description list. The list length is descNum.

For the definition of the HcclChannelDesc type, see HcclChannelDesc.

descNum

Input

Number of communication channel descriptions.

Returns

HcclResult: HCCL_SUCCESS on success, or else failure.

Restrictions

The HcclChannelDesc structure must call this API for initialization.

Example

The following uses the communication channel description list with two descriptions as an example:

uint32_t channelNum = 2;
std::vector<HcclChannelDesc> channelDesc(channelNum);
HcclChannelDescInit(channelDesc.data(), channelNum);

Parent topic: Communicator Resource Management