44 lines
1.9 KiB
ReStructuredText
44 lines
1.9 KiB
ReStructuredText
mindspore.mint.distributed.new_group
|
||
=====================================
|
||
|
||
.. py:function:: mindspore.mint.distributed.new_group(ranks=None,timeout=None,backend=None,pg_options=None,use_local_synchronization=False,group_desc=None)
|
||
|
||
创建用户自定义的通信组实例。
|
||
|
||
.. note::
|
||
- `new_group` 方法应该在 :func:`mindspore.mint.distributed.init_process_group` 方法之后使用。
|
||
- 当前仅支持PyNative模式，不支持Graph模式。
|
||
|
||
参数：
|
||
- **ranks** (list[int], 可选) - 设备编号列表。如果为 ``None`` ，创建全局通信组。默认值为 ``None`` 。
|
||
- **timeout** (int, 无效参数) - 当前为预留参数。
|
||
- **backend** (str, 无效参数) - 当前为预留参数。
|
||
- **pg_options** (GroupOptions, 可选) - 额外通信组配置参数。后端会自动选择支持的参数并在通信组初始化时生效。例如对于 `HCCL` 后端，可以指定 `hccl_config` 来应用特定的通信组初始化配置。默认值为 ``None`` 。
|
||
|
||
`GroupOptions` 被定义为一个可以实例化为python对象的类。
|
||
|
||
.. code-block::
|
||
|
||
GroupOptions {
|
||
hccl_config(dict)
|
||
}
|
||
|
||
`hccl_config` 当前仅支持 "hccl_buffer_size" 和 "hccl_comm" 两个参数。
|
||
|
||
- **hccl_buffer_size** (uint32)：指定HCCL通信缓冲区的大小。
|
||
- **hccl_comm** (int64)：指定已存在的HcclComm指针。如果设置了 "hccl_comm"，则 "hccl_buffer_size" 无效。
|
||
|
||
- **use_local_synchronization** (bool, 无效参数) - 当前为预留参数。
|
||
- **group_desc** (str, 无效参数) - 当前为预留参数。
|
||
|
||
返回：
|
||
str，生成的通信组名称，如果执行异常则返回空。
|
||
|
||
异常：
|
||
- **TypeError** - 在参数 `ranks` 不是列表时或有重复设备号。
|
||
|
||
样例：
|
||
|
||
.. note::
|
||
.. include:: mindspore.mint.comm_note.rst
|