mindspore.communication
=======================

Collective communication interface.

Note that the APIs in the following list need to preset communication environment variables.

For Ascend/GPU/CPU devices, it is recommended to use the msrun startup method
without any third-party or configuration file dependencies.
Please see the `msrun start up
<https://www.mindspore.cn/tutorials/en/r2.7.0rc1/parallel/msrun_launcher.html>`_
for more details.

.. autosummary::
    :toctree: communication
    :nosignatures:
    :template: classtemplate.rst

    mindspore.communication.GlobalComm
    mindspore.communication.init
    mindspore.communication.release
    mindspore.communication.create_group
    mindspore.communication.destroy_group
    mindspore.communication.get_comm_name
    mindspore.communication.get_group_size
    mindspore.communication.get_group_rank_from_world_rank
    mindspore.communication.get_local_rank
    mindspore.communication.get_local_rank_size
    mindspore.communication.get_process_group_ranks
    mindspore.communication.get_rank
    mindspore.communication.get_world_rank_from_group_rank
    mindspore.communication.HCCL_WORLD_COMM_GROUP
    mindspore.communication.NCCL_WORLD_COMM_GROUP
    mindspore.communication.MCCL_WORLD_COMM_GROUP

mindspore.communication.comm_func
---------------------------------

Collection communication functional interface

.. autosummary::
    :toctree: communication
    :nosignatures:
    :template: classtemplate.rst

    mindspore.communication.comm_func.all_gather_into_tensor
    mindspore.communication.comm_func.all_reduce
    mindspore.communication.comm_func.all_to_all_single_with_output_shape
    mindspore.communication.comm_func.all_to_all_with_output_shape
    mindspore.communication.comm_func.barrier
    mindspore.communication.comm_func.batch_isend_irecv
    mindspore.communication.comm_func.broadcast
    mindspore.communication.comm_func.gather_into_tensor
    mindspore.communication.comm_func.irecv
    mindspore.communication.comm_func.isend
    mindspore.communication.comm_func.recv
    mindspore.communication.comm_func.send
    mindspore.communication.comm_func.P2POp
    mindspore.communication.comm_func.reduce
    mindspore.communication.comm_func.reduce_scatter_tensor
    mindspore.communication.comm_func.scatter_tensor