destroy_group

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

Destroys a user-defined group for collective communication.

Prototype

def destroy_group(group)

Parameters

Parameter	Input/Output	Description
group	Input	A string containing a maximum of 128 bytes, including the end character. Group name, which is the ID of the collective communication group.

Parameter

Input/Output

Description

group

Input

A string containing a maximum of 128 bytes, including the end character.

Group name, which is the ID of the collective communication group.

Returns

None

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.
Groups with the same name must be used in conjunction with destroy_group and create_group and called after create_group is complete.
If the group passed by the user is hccl_world_group (default group), the group fails to be destroyed.

Call Example

from hccl.manage.api import create_group
from hccl.manage.api import destroy_group
create_group("myGroup", 4, [0, 1, 2, 3])
destroy_group("myGroup")

Parent topic: hccl.manage.api