mindspore.ops.communication.all_to_all_single
===============================================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg
    :target: https://atomgit.com/mindspore/mindspore/blob/master/docs/api/api_python/ops/mindspore.ops.communication.all_to_all_single.rst
    :alt: 查看源文件


.. py:function:: mindspore.ops.communication.all_to_all_single(output, input, output_split_sizes=None, input_split_sizes=None, group=None, async_op=False)

    使用分割大小在所有rank之间分散和收集输入，并在单个张量中返回结果。

    .. note::
        当前仅支持PyNative模式，不支持Graph模式。

    参数：
        - **output** (Union(Tensor, Tuple(int))) - 如果函数以in-place模式运行，则是从远程rank收集并连接的输出张量。否则，是表示从远程rank收集并连接的张量shape的张量或shape。
        - **input** (Tensor) - 要分散到远程rank的张量。
        - **output_split_sizes** (Union(Tuple(int), List(int)), 可选) - 接收tensor在0维的切分大小列表。默认值： ``None`` ，表示均匀切分。
        - **input_split_sizes** (Union(Tuple(int), List(int)), 可选) - 发送tensor在0维的切分大小列表。默认值： ``None`` ，表示均匀切分。
        - **group** (str，可选) - 通信组名称。默认值： ``None`` ，即Ascend平台表示为 ``"hccl_world_group"`` 。
        - **async_op** (bool, 可选) - 本算子是否是异步算子。默认值： ``False`` 。

    返回：
        - 若函数以in-place模式运行，返回CommHandle。
        - 若函数以非in-place模式运行，返回Tuple(Tensor, CommHandle)。第一个元素存储输出结果，第二个元素是CommHandle。

        其中，当 `async_op` 是 ``True`` ，则CommHandle是一个异步工作句柄；当 `async_op` 是 ``False`` ，则CommHandle将返回 ``None`` 。

    异常：
        - **TypeError** - 如果 `input` 或 `output` 不是张量，`group` 不是str，或 `async_op` 不是bool。
        - **ValueError** - 当 `input_split_sizes` 为空时，输入维度0不能被通信组内卡数整除。
        - **ValueError** - 当 `output_split_sizes` 为空时，输出维度0不能被通信组内卡数整除。

    样例：

    .. note::
        .. include:: ../mint/mindspore.mint.comm_note.txt

        该样例需要在2卡环境下运行。