mindspore.ops.communication.get_process_group_ranks
====================================================

.. 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.get_process_group_ranks.rst
    :alt: 查看源文件


.. py:function:: mindspore.ops.communication.get_process_group_ranks(group=None)

    获取特定组的rank，并以列表形式返回通信组中的进程rank。

    参数：
        - **group** (str，可选) - 要工作的通信组。通常，组应由 :func:`mindspore.ops.communication.new_group` 创建。默认值： ``None``，在Ascend中表示 ``"hccl_world_group"``。

    返回：
        List[int]。指定通信组中的进程rank列表。

    异常：
        - **TypeError** - 如果 `group` 不是str。
        - **RuntimeError** - 如果设备目标无效，或后端无效，或分布式初始化失败。

    样例：

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

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