HcclGetCommConfigCapability

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

Checks whether the current software version supports the initialization configuration of a communicator.

For details about all the configuration items supported during communicator initialization, see HcclCommConfigCapability. Examples include the buffer size of the shared data, deterministic compute switch, communicator name, and communication operator expansion mode.

The process of using the HcclGetCommConfigCapability API to check whether the current software supports a configuration option is as follows:

Call the HcclGetCommConfigCapability API to obtain a value that represents the initialization configuration capability of the current software communicator.
Compare the value with the enumerated value of a configuration item in HcclCommConfigCapability. If the value is greater than the enumerated value, the software supports the configuration of the corresponding enumerated value in HcclCommConfigCapability. If the value is less than or equal to the enumerated value, the software does not support the configuration.
For example, to determine whether the current software supports the configuration of a communicator name, compare the return value of the HcclGetCommConfigCapability API with the enumerated value HCCL_COMM_CONFIG_COMM_NAME. If the return value is greater than HCCL_COMM_CONFIG_COMM_NAME, the software supports the configuration of a communicator name. If the return value is less than or equal to HCCL_COMM_CONFIG_COMM_NAME, the software does not support the configuration of a communicator name.

Prototype

uint32_t HcclGetCommConfigCapability()

Parameters

None

Returns

uint32_t: value of the initial configuration capability of the communicator.

For details about the value, see Function.

Constraints

None

Call Example

uint32_t configCapability = HcclGetCommConfigCapability();
bool isSupportCommName = configCapability > HCCL_COMM_CONFIG_COMM_NAME;  // Check whether the communicator name can be configured.

Parent topic: C APIs