HcclCommInitRootInfoConfig

Initializes the HCCL based on rootInfo and creates an HCCL communicator with specific configurations.

HcclResult HcclCommInitRootInfoConfig(uint32_t nRanks, const HcclRootInfo *rootInfo, uint32_t rank, const HcclCommConfig *config, HcclComm *comm)

Parameter	Input/Output	Description
nRanks	Input	Number of ranks in a cluster.
rootInfo	Input	Root rank information including the IP address and ID of the root rank, which is generated by HcclGetRootInfo.
rank	Input	ID of the current rank.
config	Input	Configuration options of the communicator, including the buffer size, deterministic computing switch, and communicator name. The configuration parameters must be within the valid value range. For details, see HcclCommConfig. Notes: The input config must be initialized by calling HcclCommConfigInit. If you use config to specify a communicator name, ensure that the name is unique. In config, the configuration option hcclBufferSize takes precedence over the environment variable HCCL_BUFFSIZE, and the configuration option hcclDeterministic takes precedence over the environment variable HCCL_DETERMINISTIC. For details about environment variables, see Environment Variables.
comm	Output	Pointer to the initialized communicator. For details about the definition of the HcclComm type, see HcclComm.

HcclResult: HCCL_SUCCESS on success; else, failure.

The values of nRanks, rootInfo, and config of all ranks in the same communicator must be the same.
This API can be called only in serial mode. Concurrent calls to this API are not supported.

Atlas Training Series Product

Parent topic: Communicator Management