destroy_group

Description

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.

Applicability

Atlas Training Series Product

Example

The following is only a code snippet and cannot be executed. For details about how to call the HCCL Python APIs to perform collective communication, see Sample Code.

from npu_bridge.npu_init import *
create_group("myGroup", 4, [0, 1, 2, 3])
destroy_group("myGroup")

Parent topic: hccl.manage.api