mindspore.communication.create_group

mindspore.communication.create_group(group, rank_ids, options=None)[源代码]

创建用户自定义的通信组实例。

说明

MindSpore的GPU和CPU版本不支持此方法。
列表rank_ids的长度应大于1。
列表rank_ids内不能有重复数据。
create_group 方法应该在 init 方法之后使用。
如果没有使用mpirun启动，PyNative模式下仅支持全局单通信组。

参数：

group (str) - 输入用户自定义的通信组实例名称，支持数据类型为str。
rank_ids (list) - 设备编号列表。
options (GroupOptions, 可选) - 额外通信组配置参数。后端会自动选择支持的参数并在通信组初始化时生效。例如对于 HCCL 后端，可以指定 hccl_config 来应用特定的通信组初始化配置。默认值为 None 。

GroupOptions 被定义为一个可以实例化为python对象的类。
```
GroupOptions {
    hccl_config(dict)
}
```

异常：

TypeError - 参数 group 不是字符串或参数 rank_ids 不是列表。
ValueError - 列表rank_ids的长度小于1，或列表 rank_ids 内有重复数据，以及后端无效。
RuntimeError - HCCL 服务不可用时，或者使用了MindSpore的GPU或CPU版本。

支持平台：

Ascend GPU CPU

样例：

说明

运行以下样例之前，需要配置好通信环境变量。

针对Ascend/GPU/CPU设备，推荐使用msrun启动方式，无第三方以及配置文件依赖。详见 msrun启动。

>>> import mindspore as ms
>>> from mindspore import set_context, ops
>>> from mindspore._c_expression import GroupOptions
>>> from mindspore.communication import init, create_group, get_rank
>>> set_context(mode=ms.GRAPH_MODE)
>>> ms.set_device(device_target="Ascend")
>>> init()
>>> group = "0-7"
>>> rank_ids = [0,7]
>>> options = GroupOptions()
>>> options.hccl_config = {"hccl_buffer_size": 400}
>>> if get_rank() in rank_ids:
...     create_group(group, rank_ids, options)
...     allreduce = ops.AllReduce(group)