评价此页

★ ★ ★ ★ ★

分布式通信包 - torch.distributed#

创建日期：2017年7月12日 | 最后更新日期：2025年9月4日

注意

有关分布式训练所有功能的简要介绍，请参阅PyTorch 分布式概述。

后端#

torch.distributed 支持四种内置后端，每种后端都有不同的功能。下表显示了每个后端在 CPU 或 GPU 上可用的功能。对于 NCCL，GPU 指的是 CUDA GPU，而对于 XCCL 指的是 XPU GPU。

只有当用于构建 PyTorch 的实现支持时，MPI 才支持 CUDA。

后端	`gloo`		`mpi`		`nccl`		`xccl`
设备	CPU	GPU	CPU	GPU	CPU	GPU	CPU	GPU
send	✓	✘	✓	?	✘	✓	✘	✓
recv	✓	✘	✓	?	✘	✓	✘	✓
broadcast	✓	✓	✓	?	✘	✓	✘	✓
all_reduce	✓	✓	✓	?	✘	✓	✘	✓
reduce	✓	✓	✓	?	✘	✓	✘	✓
all_gather	✓	✓	✓	?	✘	✓	✘	✓
gather	✓	✓	✓	?	✘	✓	✘	✓
scatter	✓	✓	✓	?	✘	✓	✘	✓
reduce_scatter	✓	✓	✘	✘	✘	✓	✘	✓
all_to_all	✓	✓	✓	?	✘	✓	✘	✓
barrier	✓	✘	✓	?	✘	✓	✘	✓

PyTorch 自带的后端#

PyTorch 分布式包支持 Linux（稳定）、MacOS（稳定）和 Windows（原型）。默认情况下，对于 Linux，Gloo 和 NCCL 后端在 PyTorch 分布式中构建并包含（NCCL 仅在通过 CUDA 构建时包含）。MPI 是一个可选后端，只有当您从源代码构建 PyTorch 时才能包含（例如，在已安装 MPI 的主机上构建 PyTorch）。

注意

从 PyTorch v1.8 开始，Windows 支持所有集体通信后端，但 NCCL 除外。如果 init_method 参数 init_process_group() 指向一个文件，则该文件必须遵循以下模式

本地文件系统，init_method="file:///d:/tmp/some_file"
共享文件系统，init_method="file://////{machine_name}/{share_folder_name}/some_file"

与 Linux 平台相同，您可以设置环境变量 MASTER_ADDR 和 MASTER_PORT 来启用 TcpStore。

选择哪个后端？#

过去，我们经常被问到：“我应该使用哪个后端？”。

经验法则
- 使用 NCCL 后端进行 CUDA **GPU** 的分布式训练。
- 使用 XCCL 后端进行 XPU **GPU** 的分布式训练。
- 使用 Gloo 后端进行 **CPU** 的分布式训练。
配备 InfiniBand 互连的 GPU 主机
- 使用 NCCL，因为它是目前唯一支持 InfiniBand 和 GPUDirect 的后端。
配备以太网互连的 GPU 主机
- 使用 NCCL，因为它目前提供了最佳的分布式 GPU 训练性能，尤其是在多进程单节点或多节点分布式训练方面。如果您在使用 NCCL 时遇到任何问题，请将 Gloo 作为备选方案。（请注意，Gloo 目前在 GPU 上的速度比 NCCL 慢。）
配备 InfiniBand 互连的 CPU 主机
- 如果您的 InfiniBand 启用了 IP over IB，请使用 Gloo，否则，请使用 MPI。我们计划在未来的版本中为 Gloo 添加 InfiniBand 支持。
配备以太网互连的 CPU 主机
- 使用 Gloo，除非您有特别的原因要使用 MPI。

常用环境变量#

选择要使用的网络接口#

默认情况下，NCCL 和 Gloo 后端都会尝试找到要使用的正确网络接口。如果自动检测到的接口不正确，您可以使用以下环境变量覆盖它（适用于相应的后端）

NCCL_SOCKET_IFNAME，例如 export NCCL_SOCKET_IFNAME=eth0
GLOO_SOCKET_IFNAME，例如 export GLOO_SOCKET_IFNAME=eth0

如果您使用的是 Gloo 后端，可以通过用逗号分隔来指定多个接口，例如：export GLOO_SOCKET_IFNAME=eth0,eth1,eth2,eth3。后端将通过这些接口以轮循方式分派操作。在此变量中，所有进程指定相同数量的接口是至关重要的。

其他 NCCL 环境变量#

调试 - 如果 NCCL 失败，您可以设置 NCCL_DEBUG=INFO 来打印明确的警告消息以及基本的 NCCL 初始化信息。

您还可以使用 NCCL_DEBUG_SUBSYS 来获取 NCCL 特定方面的更多详细信息。例如，NCCL_DEBUG_SUBSYS=COLL 将打印集体调用的日志，这在调试挂起时可能很有用，尤其是那些由集体类型或消息大小不匹配引起的情况。如果拓扑检测失败，设置 NCCL_DEBUG_SUBSYS=GRAPH 来检查详细的检测结果并保存作为参考，以便在需要 NCCL 团队的进一步帮助时使用，这将很有帮助。

性能调优 - NCCL 基于其拓扑检测执行自动调优，以节省用户的调优工作。在某些基于套接字的系统上，用户可能仍然尝试调优 NCCL_SOCKET_NTHREADS 和 NCCL_NSOCKS_PERTHREAD 来提高套接字网络带宽。这两个环境变量已由 NCCL 为某些云提供商（如 AWS 或 GCP）预调优。

有关 NCCL 环境变量的完整列表，请参阅NVIDIA NCCL 官方文档。

您可以使用 torch.distributed.ProcessGroupNCCL.NCCLConfig 和 torch.distributed.ProcessGroupNCCL.Options 进一步调优 NCCL 通信器。在解释器中使用 help（例如 help(torch.distributed.ProcessGroupNCCL.NCCLConfig)）了解更多信息。

基础#

torch.distributed 包为在多台机器上运行的多个计算节点上的多进程并行性提供了 PyTorch 支持和通信原语。类 torch.nn.parallel.DistributedDataParallel() 在此功能的基础上构建，通过包装任何 PyTorch 模型来提供同步分布式训练。这与多进程包 - torch.multiprocessing 和 torch.nn.DataParallel() 提供的并行性类型不同，因为它支持多台网络连接的机器，并且用户必须为每个进程显式启动训练脚本的独立副本。

在单机同步情况下，torch.distributed 或 torch.nn.parallel.DistributedDataParallel() 包装器可能仍具有优于其他数据并行方法（包括 torch.nn.DataParallel()）的优势。

每个进程都维护自己的优化器，并在每次迭代中执行完整的优化步骤。虽然这可能看起来是冗余的，因为梯度已经被收集并跨进程平均，因此对每个进程都相同，但这意味着不需要参数广播步骤，从而减少了在节点之间传输张量的时间。
每个进程包含一个独立的 Python 解释器，消除了来自驱动单个 Python 进程的多个执行线程、模型副本或 GPU 的额外解释器开销和“GIL 争用”。这对于大量使用 Python 运行时（包括具有循环层或许多小组件的模型）的模型尤其重要。

初始化#

在调用任何其他方法之前，需要使用 torch.distributed.init_process_group() 或 torch.distributed.device_mesh.init_device_mesh() 函数初始化包。两者都会阻塞直到所有进程加入。

警告

初始化不是线程安全的。进程组创建应从单个线程执行，以防止跨 rank 的不一致“UUID”分配，并防止初始化期间的争用导致挂起。

torch.distributed.is_available()[source]#

如果分布式包可用，则返回 True。

否则，torch.distributed 不会公开任何其他 API。目前，torch.distributed 在 Linux、MacOS 和 Windows 上可用。在从源代码构建 PyTorch 时，请设置 USE_DISTRIBUTED=1 来启用它。目前，Linux 和 Windows 的默认值为 USE_DISTRIBUTED=1，MacOS 的默认值为 USE_DISTRIBUTED=0。

返回类型: 布尔值

torch.distributed.init_process_group(backend=None, init_method=None, timeout=None, world_size=-1, rank=-1, store=None, group_name='', pg_options=None, device_id=None)[source]#

初始化默认的分布式进程组。

这将初始化分布式包。

初始化进程组主要有两种方法：

显式指定 store、rank 和 world_size。
指定 init_method（URL 字符串），它指示在哪里/如何发现对等节点。可以选择指定 rank 和 world_size，或者将所有必需的参数编码到 URL 中并省略它们。

如果两者都未指定，则假定 init_method 为“env://”。

参数

backend (str 或 Backend, 可选) – 要使用的后端。根据构建时配置，有效值包括 mpi、gloo、nccl、ucc、xccl 或第三方插件注册的后端。自 2.6 版本起，如果未提供 backend，c10d 将使用为 device_id 关键字参数（如果提供）指示的设备类型注册的后端。当前已知的默认注册是：cuda 的 nccl，cpu 的 gloo，xpu 的 xccl。如果未提供 backend 或 device_id，c10d 将检测运行时机器上的加速器并使用为该检测到的加速器（或 cpu）注册的后端。此字段可以作为小写字符串（例如，"gloo"）给出，也可以通过 Backend 属性（例如 Backend.GLOO）访问。如果使用 nccl 后端的每台机器上的多个进程，则每个进程必须能够独占访问它使用的每个 GPU，因为进程之间共享 GPU 可能导致死锁或 NCCL 使用无效。ucc 后端是实验性的。可以通过 get_default_backend_for_device() 查询设备的默认后端。
init_method (str, 可选) – 指定如何初始化进程组的 URL。如果未指定 init_method 或 store，则默认为“env://”。与 store 互斥。
world_size (int, 可选) – 参与作业的进程数。如果指定了 store，则必需。
rank (int, 可选) – 当前进程的 rank（应为介于 0 和 world_size-1 之间的数字）。如果指定了 store，则必需。
store (Store, 可选) – 所有工作节点都可以访问的键/值存储，用于交换连接/地址信息。与 init_method 互斥。
timeout (timedelta, 可选) – 对进程组执行的操作的超时时间。NCCL 的默认值为 10 分钟，其他后端的默认值为 30 分钟。这是集体操作将被异步中止且进程将崩溃的时间。这样做是因为 CUDA 执行是异步的，并且继续执行用户代码不再安全，因为失败的异步 NCCL 操作可能导致后续 CUDA 操作在损坏的数据上运行。当设置 TORCH_NCCL_BLOCKING_WAIT 时，进程将阻塞并等待此超时。
group_name (str, 可选, 已弃用) – 组名。此参数将被忽略
pg_options (ProcessGroupOptions, 可选) – 进程组选项，指定在构造特定进程组时需要传递哪些其他选项。目前，我们支持的唯一选项是 nccl 后端的 ProcessGroupNCCL.Options，可以指定 is_high_priority_stream，以便 nccl 后端可以在存在计算内核等待时选择高优先级 CUDA 流。有关配置 nccl 的其他可用选项，请参阅 https://docs.nvda.net.cn/deeplearning/nccl/user-guide/docs/api/types.html#ncclconfig-t
device_id (torch.device | int, 可选) – 此进程将工作的单个特定设备，允许进行后端特定优化。目前这有两个影响，仅在 NCCL 下：通信器将立即形成（调用 ncclCommInit* 而不是正常的延迟调用），并且子组将使用 ncclCommSplit（如果可能）来避免不必要的组创建开销。如果您想提早知道 NCCL 初始化错误，也可以使用此字段。如果提供了 int，API 会假设编译时加速器类型将被使用。

注意

要启用 backend == Backend.MPI，PyTorch 需要在支持 MPI 的系统上从源代码构建。

注意

对多个后端的支持是实验性的。目前，当未指定后端时，将创建 gloo 和 nccl 后端。对于 CPU 张量的集体操作，将使用 gloo 后端，而对于 CUDA 张量的集体操作，将使用 nccl 后端。可以通过传递格式为“<device_type>:<backend_name>,<device_type>:<backend_name>”的字符串来指定自定义后端，例如“cpu:gloo,cuda:custom_backend”。

torch.distributed.device_mesh.init_device_mesh(device_type, mesh_shape, *, mesh_dim_names=None, backend_override=None)[source]#

根据 device_type、mesh_shape 和 mesh_dim_names 参数初始化一个 DeviceMesh。

这会创建一个具有 n 维数组布局的 DeviceMesh，其中 n 是 mesh_shape 的长度。如果提供了 mesh_dim_names，则每个维度都将标记为 mesh_dim_names[i]。

注意

init_device_mesh 遵循 SPMD 编程模型，这意味着相同的 PyTorch Python 程序将在群集中的所有进程/rank 上运行。请确保 mesh_shape（描述设备布局的 nD 数组的维度）在所有 rank 上都相同。不一致的 mesh_shape 可能导致挂起。

注意

如果没有找到进程组，init_device_mesh 将在后台初始化分布式通信所需的进程组。

参数

device_type (str) – Mesh 的设备类型。当前支持：“cpu”、“cuda/cuda-like”、“xpu”。不允许传入带有 GPU 索引的设备类型，例如“cuda:0”。
mesh_shape (Tuple[int]) – 定义描述设备布局的多维数组的维度的元组。
mesh_dim_names (Tuple[str], 可选) – 要分配给描述设备布局的多维数组每个维度的 mesh 维度名称的元组。其长度必须与 mesh_shape 的长度匹配。 mesh_dim_names 中的每个字符串都必须是唯一的。
backend_override (Dict[int | str, tuple[str, Options] | str | Options], 可选) – 对将为每个 mesh 维度创建的某些或所有 ProcessGroups 的覆盖。每个键可以是维度的索引或其名称（如果提供了 mesh_dim_names）。每个值可以是包含后端名称及其选项的元组，或者仅包含这两个组件中的一个（在这种情况下，另一个将被设置为其默认值）。

返回

一个 DeviceMesh 对象，表示设备布局。

返回类型

DeviceMesh

示例

>>> from torch.distributed.device_mesh import init_device_mesh
>>>
>>> mesh_1d = init_device_mesh("cuda", mesh_shape=(8,))
>>> mesh_2d = init_device_mesh("cuda", mesh_shape=(2, 8), mesh_dim_names=("dp", "tp"))

torch.distributed.is_initialized()[source]#

检查默认进程组是否已初始化。

返回类型: 布尔值

torch.distributed.is_mpi_available()[source]#

检查 MPI 后端是否可用。

返回类型: 布尔值

torch.distributed.is_nccl_available()[source]#

检查 NCCL 后端是否可用。

返回类型: 布尔值

torch.distributed.is_gloo_available()[source]#

检查 Gloo 后端是否可用。

返回类型: 布尔值

torch.distributed.distributed_c10d.is_xccl_available()[source]#

检查 XCCL 后端是否可用。

返回类型: 布尔值

torch.distributed.is_torchelastic_launched()[source]#

检查此进程是否由 torch.distributed.elastic（又名 torchelastic）启动。

是否存在 TORCHELASTIC_RUN_ID 环境变量被用作确定当前进程是否由 torchelastic 启动的代理。这是一个合理的代理，因为 TORCHELASTIC_RUN_ID 映射到 rendezvous id，它始终是一个非空值，用于对等发现目的。

返回类型: 布尔值

torch.distributed.get_default_backend_for_device(device)[source]#

获取给定设备的默认后端。

参数: device (Union[str, torch.device]) – 要获取默认后端的设备。
返回: 给定设备的默认后端（小写字符串）。
返回类型: str

目前支持三种初始化方法：

TCP 初始化#

有两种使用 TCP 进行初始化的方法，这两种方法都需要一个所有进程都能访问的网络地址和一个期望的 world_size。第一种方法需要指定属于 rank 0 进程的地址。此初始化方法要求所有进程都手动指定 rank。

请注意，在最新的分布式包中不再支持组播地址。group_name 也已弃用。

import torch.distributed as dist

# Use address of one of the machines
dist.init_process_group(backend, init_method='tcp://10.1.1.20:23456',
                        rank=args.rank, world_size=4)

共享文件系统初始化#

另一种初始化方法利用了一个在组内的所有机器上共享且可见的文件系统，以及一个期望的 world_size。URL 应以 file:// 开头，并包含共享文件系统上一个不存在文件（位于现有目录中）的路径。文件系统初始化将在文件不存在时自动创建它，但不会删除该文件。因此，您有责任确保在下一次使用相同文件路径/名称调用 init_process_group() 之前清理该文件。

请注意，在最新的分布式包中不再支持自动 rank 分配，并且 group_name 也已弃用。

警告

此方法假定文件系统支持使用 fcntl 进行锁定 - 大多数本地系统和 NFS 都支持它。

警告

此方法将始终创建文件，并在程序结束时尽力清理和删除文件。换句话说，每次初始化都需要一个全新的空文件才能成功。如果使用了上一次初始化（碰巧未被清理）的同一文件，这是意外行为，并且可能经常导致死锁和故障。因此，尽管此方法将尽力清理文件，但如果自动删除失败，您有责任确保在训练结束时删除该文件，以防止在下次运行时再次使用相同的文件。如果您计划在同一文件名上多次调用 init_process_group()，这一点尤其重要。换句话说，如果文件未被删除/清理，并且您再次在该文件上调用 init_process_group()，则会发生预期错误。这里的经验法则是，每次调用 init_process_group() 时，请确保文件不存在或为空。

import torch.distributed as dist

# rank should always be specified
dist.init_process_group(backend, init_method='file:///mnt/nfs/sharedfile',
                        world_size=4, rank=args.rank)

环境变量初始化#

此方法将从环境变量读取配置，允许完全自定义信息获取方式。需要设置的变量是：

MASTER_PORT - 必需；必须是 rank 0 机器上的一个空闲端口
MASTER_ADDR - 必需（rank 0 除外）；rank 0 节点的地址
WORLD_SIZE - 必需；可以在此处设置，或在 init 函数调用中设置
RANK - 必需；可以在此处设置，或在 init 函数调用中设置

rank 为 0 的机器将用于建立所有连接。

这是默认方法，意味着不必指定 init_method（或可以为 env://）。

改进初始化时间#

TORCH_GLOO_LAZY_INIT - 按需建立连接，而不是使用完整的网格，这可以大大缩短非 all2all 操作的初始化时间。

初始化后#

运行 torch.distributed.init_process_group() 后，可以使用以下函数。要检查进程组是否已初始化，请使用 torch.distributed.is_initialized()。

class torch.distributed.Backend(name)[source]#

后端的枚举类。

可用后端：GLOO、NCCL、UCC、MPI、XCCL 和其他已注册的后端。

此类的值是小写字符串，例如 "gloo"。它们可以作为属性访问，例如 Backend.NCCL。

此类可以直接调用以解析字符串，例如 Backend(backend_str) 将检查 backend_str 是否有效，然后返回解析后的小写字符串。它也接受大写字符串，例如 Backend("GLOO") 返回 "gloo"。

注意

条目 Backend.UNDEFINED 存在，但仅用作某些字段的初始值。用户不应直接使用它，也不应假定它的存在。

classmethod register_backend(name, func, extended_api=False, devices=None)[source]#

使用给定的名称和实例化函数注册新后端。

此类方法由第三方 ProcessGroup 扩展来注册新后端。

参数

name (str) – ProcessGroup 扩展的后端名称。它应与 init_process_group() 中的名称匹配。
func (function) – 实例化后端的函数句柄。该函数应在后端扩展中实现，并接受四个参数，包括 store、rank、world_size 和 timeout。
extended_api (bool, 可选) – 后端是否支持扩展参数结构。默认值：False。如果设置为 True，后端将获得 c10d::DistributedBackendOptions 的实例，以及后端实现定义的进程组选项对象。
device (str 或 list of str, 可选) – 此后端支持的设备类型，例如“cpu”、“cuda”等。如果为 None，则假定为“cpu”和“cuda”。

注意

此第三方后端支持是实验性的，可能会发生变化。

torch.distributed.get_backend(group=None)[source]#

返回给定进程组的后端。

参数: group (ProcessGroup, 可选) – 要操作的进程组。默认是通用主进程组。如果指定了另一个特定组，则调用进程必须是 group 的一部分。
返回: 给定进程组的后端（小写字符串）。
返回类型: 后端

torch.distributed.get_rank(group=None)[source]#

返回当前进程在提供的 group 中的 rank，否则返回默认值。

Rank 是分配给分布式进程组内每个进程的唯一标识符。它们始终是从 0 到 world_size 的连续整数。

参数: group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
返回: 进程组的 rank -1，如果不在组内
返回类型: int

torch.distributed.get_world_size(group=None)[source]#

返回当前进程组中的进程数。

参数: group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
返回: 进程组的世界大小 -1，如果不在组内
返回类型: int

关闭#

在退出时通过调用 destroy_process_group() 来清理资源非常重要。

遵循的最简单的模式是在通信不再需要时，通常在 main() 结束时，通过调用 destroy_process_group()（group 参数的默认值为 None）来销毁每个进程组和后端。此调用应由每个训练器进程调用一次，而不是由外部进程启动器级别调用。

如果在超时时间内，不是所有 rank 都调用了 destroy_process_group()，尤其是在应用程序中有多个进程组（例如，用于 N 维并行性）时，可能会在退出时发生挂起。这是因为 ProcessGroupNCCL 的析构函数调用 ncclCommAbort，必须集体调用它，但如果由 Python 的 GC 调用，ProcessGroupNCCL 析构函数的调用顺序是不确定的。调用 destroy_process_group() 有助于确保 ncclCommAbort 以一致的顺序在 rank 之间调用，并避免在 ProcessGroupNCCL 的析构函数期间调用 ncclCommAbort。

重新初始化#

destroy_process_group 也可用于销毁单个进程组。一种用例可能是容错训练，其中进程组可能在运行时被销毁然后重新初始化。在这种情况下，至关重要的是在调用 destroy 之后，并在随后初始化之前，使用除 torch.distributed 原始函数之外的某种方法来同步训练器进程。由于实现这种同步的难度，此行为目前不受支持/未经测试，并被视为已知问题。如果此用例阻碍了您，请提交一个 github 问题或 RFC。

组#

默认情况下，集体操作在默认组（也称为 world）上运行，并要求所有进程进入分布式函数调用。然而，某些工作负载可能受益于更精细的通信。这就是分布式组发挥作用的地方。可以使用 new_group() 函数创建新的组，其中包含任意数量的所有进程的子集。它返回一个不透明的组句柄，可以作为 group 参数传递给所有集体操作（集体操作是用于以某些众所周知的编程模式交换信息的分布式函数）。

torch.distributed.new_group(ranks=None, timeout=None, backend=None, pg_options=None, use_local_synchronization=False, group_desc=None, device_id=None)[source]#

创建一个新的分布式组。

此函数要求主组中的所有进程（即参与分布式作业的所有进程）都进入此函数，即使它们不属于该组。此外，组应该在所有进程中以相同的顺序创建。

警告

安全的并发使用：当使用具有 NCCL 后端的多个进程组时，用户必须确保跨 rank 的集体操作具有全局一致的执行顺序。

如果进程内的多个线程发出集体操作，则需要显式同步以确保一致的排序。

当使用 torch.distributed 通信 API 的异步变体时，将返回一个工作对象，并且通信内核将被入队到单独的 CUDA 流中，从而允许通信和计算的重叠。一旦在一个进程组上发出了一个或多个异步操作，就必须在使用另一个进程组之前通过调用 work.wait() 将它们与另一个 CUDA 流同步。

有关更多详细信息，请参阅并发使用多个 NCCL 通信器 <https://docs.nvda.net.cn/deeplearning/nccl/user-guide/docs/usage/communicators.html#using-multiple-nccl-communicators-concurrently>。

参数

ranks (list[int]) – 组员的 rank 列表。如果为 None，则设置为所有 rank。默认值为 None。
timeout (timedelta, 可选) – 请参阅 init_process_group 获取详细信息和默认值。
backend (str 或 Backend, 可选) – 要使用的后端。根据构建时配置，有效值为 gloo 和 nccl。默认使用与全局组相同的后端。此字段应作为小写字符串（例如 "gloo"）给出，也可以通过 Backend 属性（例如 Backend.GLOO）访问。如果传入 None，则将使用与默认进程组对应的后端。默认值为 None。
pg_options (ProcessGroupOptions, 可选) – 进程组选项，指定在构造特定进程组时需要传递的额外选项。即对于 nccl 后端，可以指定 is_high_priority_stream，以便进程组可以选取高优先级 CUDA 流。有关配置 nccl 的其他可用选项，请参阅 https://docs.nvda.net.cn/deeplearning/nccl/user-guide/docs/api/types.html#ncclconfig-tuse_local_synchronization (bool, optional): 在进程组创建结束时执行组本地屏障。这有所不同，因为非成员 rank 不需要调用 API 并且不加入屏障。
group_desc (str, 可选) – 用于描述进程组的字符串。
device_id (torch.device, 可选) – 要“绑定”此进程的单个特定设备。如果提供了此字段，new_group 调用将尝试立即为该设备初始化通信后端。

返回

分布式组的句柄，可以传递给集体调用或 GroupMember.NON_GROUP_MEMBER，如果 rank 不属于 ranks。

注意：use_local_synchronization 不能与 MPI 一起使用。

注意：虽然对于大型集群和小型进程组，use_local_synchronization=True 的速度可能快得多，但仍需谨慎，因为它会改变集群行为，因为非成员 rank 不会加入组屏障（barrier()）。

注意：当每个 rank 创建多个重叠的进程组时，use_local_synchronization=True 可能导致死锁。为避免这种情况，请确保所有 rank 都遵循相同的全局创建顺序。

torch.distributed.get_group_rank(group, global_rank)[source]#

将全局 rank 转换为组 rank。

global_rank 必须是 group 的一部分，否则会引发 RuntimeError。

参数

group (ProcessGroup) – 要查找相对 rank 的 ProcessGroup。
global_rank (int) – 要查询的全局 rank。

返回

global_rank 相对于 group 的组 rank。

返回类型

int

注意：在默认进程组上调用此函数会返回身份。

torch.distributed.get_global_rank(group, group_rank)[source]#

将组 rank 转换为全局 rank。

group_rank 必须是 group 的一部分，否则会引发 RuntimeError。

参数

group (ProcessGroup) – 要从中查找全局 rank 的 ProcessGroup。
group_rank (int) – 要查询的组 rank。

返回

group_rank 相对于 group 的全局 rank。

返回类型

int

注意：在默认进程组上调用此函数会返回身份。

torch.distributed.get_process_group_ranks(group)[source]#

获取与 group 关联的所有 rank。

参数: group (Optional[ProcessGroup]) – 要从中获取所有 rank 的 ProcessGroup。如果为 None，则使用默认进程组。
返回: 按组 rank 排序的全局 rank 列表。
返回类型: list[int]

DeviceMesh#

DeviceMesh 是一个更高级别的抽象，用于管理进程组（或 NCCL 通信器）。它允许用户轻松创建节点间和节点内进程组，而无需担心如何为不同的子进程组正确设置 rank，并且它有助于轻松管理那些分布式进程组。init_device_mesh() 函数可用于创建新的 DeviceMesh，其 mesh 形状描述了设备拓扑。

class torch.distributed.device_mesh.DeviceMesh(device_type, mesh, *, mesh_dim_names=None, backend_override=None, _init_backend=True)[source]#

DeviceMesh 表示一个设备网格，其中设备的布局可以表示为 n 维数组，n 维数组的每个值是默认进程组 rank 的全局 ID。

DeviceMesh 可用于设置群集中的 N 维设备连接，并管理 N 维并行性的 ProcessGroups。通信可以在 DeviceMesh 的每个维度上单独进行。DeviceMesh 尊重用户已选择的设备（即，如果用户在 DeviceMesh 初始化之前调用 torch.cuda.set_device），并且如果用户之前未设置设备，则会为当前进程选择/设置设备。请注意，手动设备选择应在 DeviceMesh 初始化之前发生。

当与 DTensor API 一起使用时，DeviceMesh 也可以用作上下文管理器。

注意

DeviceMesh 遵循 SPMD 编程模型，这意味着相同的 PyTorch Python 程序将在群集中的所有进程/rank 上运行。因此，用户需要确保 mesh 数组（描述设备布局）在所有 rank 上都相同。不一致的 mesh 将导致静默挂起。

参数

device_type (str) – Mesh 的设备类型。当前支持：“cpu”、“cuda/cuda-like”。
mesh (ndarray) – 一个多维数组或一个整数张量，描述设备的布局，其中 ID 是默认进程组的全局 ID。

返回

一个 DeviceMesh 对象，表示设备布局。

返回类型

DeviceMesh

以下程序以 SPMD 方式在每个进程/rank 上运行。在此示例中，我们有 2 个主机，每个主机有 4 个 GPU。沿 mesh 的第一个维度进行归约将跨列（0, 4）、... 和（3, 7）进行归约，沿 mesh 的第二个维度进行归约将跨行（0, 1, 2, 3）和（4, 5, 6, 7）进行归约。

示例

>>> from torch.distributed.device_mesh import DeviceMesh
>>>
>>> # Initialize device mesh as (2, 4) to represent the topology
>>> # of cross-host(dim 0), and within-host (dim 1).
>>> mesh = DeviceMesh(device_type="cuda", mesh=[[0, 1, 2, 3],[4, 5, 6, 7]])

static from_group(group, device_type, mesh=None, *, mesh_dim_names=None)[source]#

使用 device_type 从现有的 ProcessGroup 或一系列现有 ProcessGroup 构建一个 DeviceMesh。

构造的设备网格具有与传入组数相等的维度数。例如，如果传入单个进程组，则生成的 DeviceMesh 是一个 1D 网格。如果传入 2 个进程组的列表，则生成的 DeviceMesh 是一个 2D 网格。

如果传入多个组，则必须提供 mesh 和 mesh_dim_names 参数。传入进程组的顺序决定了网格的拓扑结构。例如，第一个进程组将是 DeviceMesh 的第 0 个维度。传入的 mesh 张量必须具有与传入进程组数量相同的维度数，并且 mesh 张量中的维度顺序必须与传入进程组中的顺序匹配。

参数

group (ProcessGroup 或 list[ProcessGroup]) – 现有的 ProcessGroup 或一组现有的 ProcessGroup。
device_type (str) – Mesh 的设备类型。当前支持：“cpu”、“cuda/cuda-like”。不允许传入带有 GPU 索引的设备类型，例如“cuda:0”。
mesh (torch.Tensor 或 ArrayLike, 可选) – 一个多维数组或一个整数张量，用于描述设备的布局，其中 ID 是默认进程组的全局 ID。默认为 None。
mesh_dim_names (tuple[str], 可选) – 一个描述设备布局的多维数组的每个维度要分配的网格维度名称的元组。其长度必须与 mesh_shape 的长度匹配。mesh_dim_names 中的每个字符串都必须是唯一的。默认为 None。

返回

一个 DeviceMesh 对象，表示设备布局。

返回类型

DeviceMesh

get_all_groups()[源码]#

返回所有网格维度的 ProcessGroup 列表。

返回: 一个 ProcessGroup 对象的列表。
返回类型: list[torch.distributed.distributed_c10d.ProcessGroup]

get_coordinate()[源码]#

返回此 rank 相对于网格所有维度的相对索引。如果此 rank 不属于网格，则返回 None。

返回类型: Optional[list[int]]

get_group(mesh_dim=None)[源码]#

返回由 mesh_dim 指定的单个 ProcessGroup，或者，如果未指定 mesh_dim 且 DeviceMesh 是 1 维的，则返回网格中的唯一 ProcessGroup。

参数

mesh_dim (str/python:int, 可选) – 它可以是网格维度的名称或索引
None. (网格维度的。默认为) –

返回

一个 ProcessGroup 对象。

返回类型

ProcessGroup

get_local_rank(mesh_dim=None)[源码]#

返回 DeviceMesh 的给定 mesh_dim 的本地 rank。

参数

mesh_dim (str/python:int, 可选) – 它可以是网格维度的名称或索引
None. (网格维度的。默认为) –

返回

一个表示本地 rank 的整数。

返回类型

int

以下程序以 SPMD 方式在每个进程/rank 上运行。在此示例中，我们有 2 个主机，每个主机有 4 个 GPU。在 rank 0、1、2、3 上调用 mesh_2d.get_local_rank(mesh_dim=0) 将返回 0。在 rank 4、5、6、7 上调用 mesh_2d.get_local_rank(mesh_dim=0) 将返回 1。在 rank 0、4 上调用 mesh_2d.get_local_rank(mesh_dim=1) 将返回 0。在 rank 1、5 上调用 mesh_2d.get_local_rank(mesh_dim=1) 将返回 1。在 rank 2、6 上调用 mesh_2d.get_local_rank(mesh_dim=1) 将返回 2。在 rank 3、7 上调用 mesh_2d.get_local_rank(mesh_dim=1) 将返回 3。

示例

>>> from torch.distributed.device_mesh import DeviceMesh
>>>
>>> # Initialize device mesh as (2, 4) to represent the topology
>>> # of cross-host(dim 0), and within-host (dim 1).
>>> mesh = DeviceMesh(device_type="cuda", mesh=[[0, 1, 2, 3],[4, 5, 6, 7]])

get_rank()[源码]#

返回当前全局 rank。

返回类型: int

点对点通信#

torch.distributed.send(tensor, dst=None, group=None, tag=0, group_dst=None)[源码]#

同步发送一个张量。

警告

tag 参数不支持 NCCL 后端。

参数

tensor (Tensor) – 要发送的张量。
dst (int) – 全局进程组中的目标 rank（无论 group 参数如何）。目标 rank 不得与当前进程的 rank 相同。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
tag (int, 可选) – 用于匹配发送和远程接收的标签
group_dst (int, 可选) – group 中的目标 rank。指定 dst 和 group_dst 时，两者不能同时有效。

torch.distributed.recv(tensor, src=None, group=None, tag=0, group_src=None)[源码]#

同步接收一个张量。

警告

tag 参数不支持 NCCL 后端。

参数

tensor (Tensor) – 用于填充接收数据的张量。
src (int, 可选) – 全局进程组中的源 rank（无论 group 参数如何）。如果未指定，将从任何进程接收。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
tag (int, 可选) – 用于匹配接收和远程发送的标签
group_src (int, 可选) – group 中的目标 rank。指定 src 和 group_src 时，两者不能同时有效。

返回

发送者 rank -1，如果不在组中

返回类型

int

isend() 和 irecv() 在使用时会返回分布式请求对象。通常，此对象的类型未指定，因为它们不应手动创建，但它们保证支持两个方法

is_completed() - 如果操作已完成，则返回 True
wait() - 将阻塞进程直到操作完成。is_completed() 保证在返回后返回 True。

torch.distributed.isend(tensor, dst=None, group=None, tag=0, group_dst=None)[源码]#

异步发送一个张量。

警告

在请求完成之前修改 tensor 会导致未定义行为。

警告

tag 参数不支持 NCCL 后端。

与阻塞式的 send 不同，isend 允许 src == dst rank，即发送给自己。

参数

tensor (Tensor) – 要发送的张量。
dst (int) – 全局进程组中的目标 rank（无论 group 参数如何）
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
tag (int, 可选) – 用于匹配发送和远程接收的标签
group_dst (int, 可选) – group 中的目标 rank。指定 dst 和 group_dst 时，两者不能同时有效

返回

分布式请求对象。如果不在组中，则为 None

返回类型

Optional[Work]

torch.distributed.irecv(tensor, src=None, group=None, tag=0, group_src=None)[源码]#

异步接收一个张量。

警告

tag 参数不支持 NCCL 后端。

与阻塞式的 recv 不同，irecv 允许 src == dst rank，即从自己接收。

参数

tensor (Tensor) – 用于填充接收数据的张量。
src (int, 可选) – 全局进程组中的源 rank（无论 group 参数如何）。如果未指定，将从任何进程接收。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
tag (int, 可选) – 用于匹配接收和远程发送的标签
group_src (int, 可选) – group 中的目标 rank。指定 src 和 group_src 时，两者不能同时有效。

返回

分布式请求对象。如果不在组中，则为 None

返回类型

Optional[Work]

torch.distributed.send_object_list(object_list, dst=None, group=None, device=None, group_dst=None, use_batch=False)[源码]#

同步发送 object_list 中的可序列化对象。

与 send() 类似，但可以传递 Python 对象。请注意，object_list 中的所有对象都必须是可序列化的才能发送。

参数

object_list (List[Any]) – 要发送的输入对象列表。每个对象都必须是可序列化的。接收方必须提供相同大小的列表。
dst (int) – 将 object_list 发送到的目标 rank。目标 rank 基于全局进程组（无论 group 参数如何）
group (Optional[ProcessGroup]) – 要操作的进程组。如果为 None，则使用默认进程组。默认为 None。
device (torch.device, 可选) – 如果不为 None，则对象将被序列化并转换为张量，然后发送到 device。默认为 None。
group_dst (int, 可选) – group 中的目标 rank。必须指定 dst 或 group_dst 中的一个，但不能同时指定两者。
use_batch (bool, 可选) – 如果为 True，则使用批量 p2p 操作而不是常规的 send 操作。这避免了初始化 2-rank 通信器，并使用现有的整个组通信器。有关用法和假设，请参阅 batch_isend_irecv。默认为 False。

返回

无.

注意

对于基于 NCCL 的进程组，对象内部的张量表示必须在通信发生之前移动到 GPU 设备。在这种情况下，使用的设备由 torch.cuda.current_device() 提供，用户有责任通过 torch.cuda.set_device() 确保每个 rank 都有独立的 GPU。

警告

对象集体操作存在一些严重的性能和可扩展性限制。详情请参阅对象集体操作。

警告

send_object_list() 隐式使用了 pickle 模块，该模块已知是不安全的。可以构造恶意 pickle 数据，在反序列化时执行任意代码。仅使用可信数据调用此函数。

警告

使用 GPU 张量调用 send_object_list() 支持不佳且效率低下，因为它会产生 GPU -> CPU 传输，因为张量会被 pickle。请考虑使用 send()。

示例：

>>> # Note: Process group initialization omitted on each rank.
>>> import torch.distributed as dist
>>> # Assumes backend is not NCCL
>>> device = torch.device("cpu")
>>> if dist.get_rank() == 0:
>>>     # Assumes world_size of 2.
>>>     objects = ["foo", 12, {1: 2}] # any picklable object
>>>     dist.send_object_list(objects, dst=1, device=device)
>>> else:
>>>     objects = [None, None, None]
>>>     dist.recv_object_list(objects, src=0, device=device)
>>> objects
['foo', 12, {1: 2}]

torch.distributed.recv_object_list(object_list, src=None, group=None, device=None, group_src=None, use_batch=False)[源码]#

同步接收 object_list 中的可序列化对象。

与 recv() 类似，但可以接收 Python 对象。

参数

object_list (List[Any]) – 要接收的对象列表。必须提供与要发送的列表大小相同的列表。
src (int, 可选) – 从哪个源 rank 接收 object_list。源 rank 基于全局进程组（无论 group 参数如何）。如果设置为 None，则从任何 rank 接收。默认为 None。
group (Optional[ProcessGroup]) – 要操作的进程组。如果为 None，则使用默认进程组。默认为 None。
device (torch.device, 可选) – 如果不为 None，则在此设备上接收。默认为 None。
group_src (int, 可选) – group 中的目标 rank。指定 src 和 group_src 时，两者不能同时有效。
use_batch (bool, 可选) – 如果为 True，则使用批量 p2p 操作而不是常规的 send 操作。这避免了初始化 2-rank 通信器，并使用现有的整个组通信器。有关用法和假设，请参阅 batch_isend_irecv。默认为 False。

返回

发送者 rank。如果 rank 不在组中，则为 -1。如果 rank 在组中，则 object_list 将包含来自 src rank 发送的对象。

注意

警告

对象集体操作存在一些严重的性能和可扩展性限制。详情请参阅对象集体操作。

警告

recv_object_list() 隐式使用了 pickle 模块，该模块已知是不安全的。可以构造恶意 pickle 数据，在反序列化时执行任意代码。仅使用可信数据调用此函数。

警告

使用 GPU 张量调用 recv_object_list() 支持不佳且效率低下，因为它会产生 GPU -> CPU 传输，因为张量会被 pickle。请考虑使用 recv()。

示例：

>>> # Note: Process group initialization omitted on each rank.
>>> import torch.distributed as dist
>>> # Assumes backend is not NCCL
>>> device = torch.device("cpu")
>>> if dist.get_rank() == 0:
>>>     # Assumes world_size of 2.
>>>     objects = ["foo", 12, {1: 2}] # any picklable object
>>>     dist.send_object_list(objects, dst=1, device=device)
>>> else:
>>>     objects = [None, None, None]
>>>     dist.recv_object_list(objects, src=0, device=device)
>>> objects
['foo', 12, {1: 2}]

torch.distributed.batch_isend_irecv(p2p_op_list)[源码]#

异步发送或接收一批张量并返回请求列表。

处理 p2p_op_list 中的每个操作，并返回相应的请求。目前支持 NCCL、Gloo 和 UCC 后端。

参数: p2p_op_list (list[torch.distributed.distributed_c10d.P2POp]) – 点对点操作列表（每个操作符的类型为 torch.distributed.P2POp）。列表中 isend/irecv 的顺序很重要，需要与远程端的相应 isend/irecv 匹配。
返回: 通过调用 op_list 中的相应操作返回的分布式请求对象列表。
返回类型: list[torch.distributed.distributed_c10d.Work]

示例

>>> send_tensor = torch.arange(2, dtype=torch.float32) + 2 * rank
>>> recv_tensor = torch.randn(2, dtype=torch.float32)
>>> send_op = dist.P2POp(dist.isend, send_tensor, (rank + 1) % world_size)
>>> recv_op = dist.P2POp(
...     dist.irecv, recv_tensor, (rank - 1 + world_size) % world_size
... )
>>> reqs = batch_isend_irecv([send_op, recv_op])
>>> for req in reqs:
>>>     req.wait()
>>> recv_tensor
tensor([2, 3])     # Rank 0
tensor([0, 1])     # Rank 1

注意

注意，当此 API 与 NCCL PG 后端一起使用时，用户必须使用 torch.cuda.set_device 设置当前 GPU 设备，否则会导致意外的挂起问题。

此外，如果此 API 是 group 中传递给 dist.P2POp 的第一个集合通信调用，则 group 的所有 rank 都必须参与此 API 调用；否则，行为未定义。如果此 API 调用不是 group 中的第一个集合通信调用，则允许仅涉及 group 子集 rank 的批量 P2P 操作。

class torch.distributed.P2POp(op, tensor, peer=None, group=None, tag=0, group_peer=None)[源码]#

用于 batch_isend_irecv 的点对点操作的构建类。

此类用于构建 P2P 操作的类型、通信缓冲区、对等 rank、进程组和标签。此类实例将传递给 batch_isend_irecv 以进行点对点通信。

参数

op (Callable) – 用于将数据发送到对等进程或从对等进程接收数据的函数。 op 的类型为 torch.distributed.isend 或 torch.distributed.irecv。
tensor (Tensor) – 要发送或接收的张量。
peer (int, 可选) – 目标或源 rank。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
tag (int, 可选) – 用于匹配发送和接收的标签。
group_peer (int, 可选) – 目标或源 rank。

同步和异步集合通信操作#

每个集合通信操作函数都支持以下两种操作，具体取决于传递给集合通信的 async_op 标志的设置

同步操作 - 默认模式，当 async_op 设置为 False 时。函数返回时，保证集合通信操作已执行。对于 CUDA 操作，不保证 CUDA 操作已完成，因为 CUDA 操作是异步的。对于 CPU 集合通信，使用集合通信结果的任何后续函数调用都将按预期运行。对于 CUDA 集合通信，在同一 CUDA 流上利用结果的函数调用将按预期运行。用户必须在不同流下运行时处理同步。有关 CUDA 语义（如流同步）的详细信息，请参阅 CUDA Semantics。请参阅下面的脚本，了解 CPU 和 CUDA 操作的语义差异示例。

异步操作 - 当 async_op 设置为 True 时。集合通信操作函数返回一个分布式请求对象。通常，您不需要手动创建它，并且它保证支持两个方法

is_completed() - 对于 CPU 集合通信，如果已完成，则返回 True。对于 CUDA 操作，如果操作已成功排队到 CUDA 流，并且在不进行进一步同步的情况下可以在默认流上使用该操作，则返回 True。
wait() - 对于 CPU 集合通信，将阻塞进程直到操作完成。对于 CUDA 集合通信，将阻塞当前活动的 CUDA 流直到操作完成（但不会阻塞 CPU）。
get_future() - 返回 torch._C.Future 对象。支持 NCCL，也支持 GLOO 和 MPI 的大多数操作，但点对点操作除外。注意：随着我们不断采用 Futures 并合并 API，get_future() 调用可能会变得多余。

示例

以下代码可以作为使用分布式集合通信时 CUDA 操作语义的参考。它显示了在使用不同 CUDA 流上的集合通信输出时显式同步的必要性

# Code runs on each rank.
dist.init_process_group("nccl", rank=rank, world_size=2)
output = torch.tensor([rank]).cuda(rank)
s = torch.cuda.Stream()
handle = dist.all_reduce(output, async_op=True)
# Wait ensures the operation is enqueued, but not necessarily complete.
handle.wait()
# Using result on non-default stream.
with torch.cuda.stream(s):
    s.wait_stream(torch.cuda.default_stream())
    output.add_(100)
if rank == 0:
    # if the explicit call to wait_stream was omitted, the output below will be
    # non-deterministically 1 or 101, depending on whether the allreduce overwrote
    # the value after the add completed.
    print(output)

集合通信函数#

torch.distributed.broadcast(tensor, src=None, group=None, async_op=False, group_src=None)[源码]#

将张量广播到整个组。

tensor 在参与集合通信的所有进程中必须具有相同数量的元素。

参数

tensor (Tensor) – 如果 src 是当前进程的 rank，则为要发送的数据，否则为用于保存接收数据的张量。
src (int) – 全局进程组中的源 rank（无论 group 参数如何）。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作
group_src (int) – group 中的源 rank。必须指定 group_src 或 src 中的一个，但不能同时指定两者。

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None

torch.distributed.broadcast_object_list(object_list, src=None, group=None, device=None, group_src=None)[源码]#

将 object_list 中的可序列化对象广播到整个组。

与 broadcast() 类似，但可以传递 Python 对象。请注意，object_list 中的所有对象都必须是可序列化的才能广播。

参数

object_list (List[Any]) – 要广播的输入对象列表。每个对象都必须是可序列化的。只有 src rank 上的对象才会被广播，但每个 rank 都必须提供相同大小的列表。
src (int) – 从哪个源 rank 广播 object_list。源 rank 基于全局进程组（无论 group 参数如何）
group (Optional[ProcessGroup]) – 要操作的进程组。如果为 None，则使用默认进程组。默认为 None。
device (torch.device, 可选) – 如果不为 None，则对象将被序列化并转换为张量，然后广播到 device。默认为 None。
group_src (int) – group 中的源 rank。不得同时指定 group_src 和 src 中的一个。

返回

None。如果 rank 在组中，则 object_list 将包含从 src rank 广播的对象。

注意

请注意，此 API 与 broadcast() 集合通信略有不同，因为它不提供 async_op 句柄，因此将是一个阻塞调用。

警告

对象集体操作存在一些严重的性能和可扩展性限制。详情请参阅对象集体操作。

警告

broadcast_object_list() 隐式使用了 pickle 模块，该模块已知是不安全的。可以构造恶意 pickle 数据，在反序列化时执行任意代码。仅使用可信数据调用此函数。

警告

使用 GPU 张量调用 broadcast_object_list() 支持不佳且效率低下，因为它会产生 GPU -> CPU 传输，因为张量会被 pickle。请考虑使用 broadcast()。

示例：

>>> # Note: Process group initialization omitted on each rank.
>>> import torch.distributed as dist
>>> if dist.get_rank() == 0:
>>>     # Assumes world_size of 3.
>>>     objects = ["foo", 12, {1: 2}] # any picklable object
>>> else:
>>>     objects = [None, None, None]
>>> # Assumes backend is not NCCL
>>> device = torch.device("cpu")
>>> dist.broadcast_object_list(objects, src=0, device=device)
>>> objects
['foo', 12, {1: 2}]

torch.distributed.all_reduce(tensor, op=<RedOpType.SUM: 0>, group=None, async_op=False)[源码]#

以所有进程获得最终结果的方式对张量数据进行规约。

调用后 tensor 在所有进程中都将逐位相同。

支持复杂张量。

参数

tensor (Tensor) – 集合通信的输入和输出。函数原地操作。
op (optional) – torch.distributed.ReduceOp 枚举中的一个值。指定用于逐元素规约的操作。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None

示例

>>> # All tensors below are of torch.int64 type.
>>> # We have 2 process groups, 2 ranks.
>>> device = torch.device(f"cuda:{rank}")
>>> tensor = torch.arange(2, dtype=torch.int64, device=device) + 1 + 2 * rank
>>> tensor
tensor([1, 2], device='cuda:0') # Rank 0
tensor([3, 4], device='cuda:1') # Rank 1
>>> dist.all_reduce(tensor, op=ReduceOp.SUM)
>>> tensor
tensor([4, 6], device='cuda:0') # Rank 0
tensor([4, 6], device='cuda:1') # Rank 1

>>> # All tensors below are of torch.cfloat type.
>>> # We have 2 process groups, 2 ranks.
>>> tensor = torch.tensor(
...     [1 + 1j, 2 + 2j], dtype=torch.cfloat, device=device
... ) + 2 * rank * (1 + 1j)
>>> tensor
tensor([1.+1.j, 2.+2.j], device='cuda:0') # Rank 0
tensor([3.+3.j, 4.+4.j], device='cuda:1') # Rank 1
>>> dist.all_reduce(tensor, op=ReduceOp.SUM)
>>> tensor
tensor([4.+4.j, 6.+6.j], device='cuda:0') # Rank 0
tensor([4.+4.j, 6.+6.j], device='cuda:1') # Rank 1

torch.distributed.reduce(tensor, dst=None, op=<RedOpType.SUM: 0>, group=None, async_op=False, group_dst=None)[源码]#

对所有机器上的张量数据进行规约。

只有 rank 为 dst 的进程才会收到最终结果。

参数

tensor (Tensor) – 集合通信的输入和输出。函数原地操作。
dst (int) – 全局进程组中的目标 rank（无论 group 参数如何）
op (optional) – torch.distributed.ReduceOp 枚举中的一个值。指定用于逐元素规约的操作。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作
group_dst (int) – group 中的目标 rank。必须指定 group_dst 或 dst 中的一个，但不能同时指定两者。

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None

torch.distributed.all_gather(tensor_list, tensor, group=None, async_op=False)[源码]#

将来自整个组的张量收集到一个列表中。

支持复杂和不等大的张量。

参数

tensor_list (list[Tensor]) – 输出列表。应包含正确大小的张量，用于集合通信的输出。支持不等大的张量。
tensor (Tensor) – 要从当前进程广播的张量。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None

示例

>>> # All tensors below are of torch.int64 dtype.
>>> # We have 2 process groups, 2 ranks.
>>> device = torch.device(f"cuda:{rank}")
>>> tensor_list = [
...     torch.zeros(2, dtype=torch.int64, device=device) for _ in range(2)
... ]
>>> tensor_list
[tensor([0, 0], device='cuda:0'), tensor([0, 0], device='cuda:0')] # Rank 0
[tensor([0, 0], device='cuda:1'), tensor([0, 0], device='cuda:1')] # Rank 1
>>> tensor = torch.arange(2, dtype=torch.int64, device=device) + 1 + 2 * rank
>>> tensor
tensor([1, 2], device='cuda:0') # Rank 0
tensor([3, 4], device='cuda:1') # Rank 1
>>> dist.all_gather(tensor_list, tensor)
>>> tensor_list
[tensor([1, 2], device='cuda:0'), tensor([3, 4], device='cuda:0')] # Rank 0
[tensor([1, 2], device='cuda:1'), tensor([3, 4], device='cuda:1')] # Rank 1

>>> # All tensors below are of torch.cfloat dtype.
>>> # We have 2 process groups, 2 ranks.
>>> tensor_list = [
...     torch.zeros(2, dtype=torch.cfloat, device=device) for _ in range(2)
... ]
>>> tensor_list
[tensor([0.+0.j, 0.+0.j], device='cuda:0'), tensor([0.+0.j, 0.+0.j], device='cuda:0')] # Rank 0
[tensor([0.+0.j, 0.+0.j], device='cuda:1'), tensor([0.+0.j, 0.+0.j], device='cuda:1')] # Rank 1
>>> tensor = torch.tensor(
...     [1 + 1j, 2 + 2j], dtype=torch.cfloat, device=device
... ) + 2 * rank * (1 + 1j)
>>> tensor
tensor([1.+1.j, 2.+2.j], device='cuda:0') # Rank 0
tensor([3.+3.j, 4.+4.j], device='cuda:1') # Rank 1
>>> dist.all_gather(tensor_list, tensor)
>>> tensor_list
[tensor([1.+1.j, 2.+2.j], device='cuda:0'), tensor([3.+3.j, 4.+4.j], device='cuda:0')] # Rank 0
[tensor([1.+1.j, 2.+2.j], device='cuda:1'), tensor([3.+3.j, 4.+4.j], device='cuda:1')] # Rank 1

torch.distributed.all_gather_into_tensor(output_tensor, input_tensor, group=None, async_op=False)[源码]#

从所有 rank 收集张量并放入一个输出张量中。

此函数要求所有进程上的张量大小相同。

参数

output_tensor (Tensor) – 用于容纳所有 rank 张量元素的输出张量。它必须大小正确，具有以下形式之一：（i）沿主维度连接所有输入张量；“连接”的定义请参阅 torch.cat()；（ii）沿主维度堆叠所有输入张量；“堆叠”的定义请参阅 torch.stack()。下面的示例可以更好地解释支持的输出形式。
input_tensor (Tensor) – 从当前 rank 收集的张量。与 all_gather API 不同，此 API 中的输入张量在所有 rank 上必须具有相同的大小。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None

示例

>>> # All tensors below are of torch.int64 dtype and on CUDA devices.
>>> # We have two ranks.
>>> device = torch.device(f"cuda:{rank}")
>>> tensor_in = torch.arange(2, dtype=torch.int64, device=device) + 1 + 2 * rank
>>> tensor_in
tensor([1, 2], device='cuda:0') # Rank 0
tensor([3, 4], device='cuda:1') # Rank 1
>>> # Output in concatenation form
>>> tensor_out = torch.zeros(world_size * 2, dtype=torch.int64, device=device)
>>> dist.all_gather_into_tensor(tensor_out, tensor_in)
>>> tensor_out
tensor([1, 2, 3, 4], device='cuda:0') # Rank 0
tensor([1, 2, 3, 4], device='cuda:1') # Rank 1
>>> # Output in stack form
>>> tensor_out2 = torch.zeros(world_size, 2, dtype=torch.int64, device=device)
>>> dist.all_gather_into_tensor(tensor_out2, tensor_in)
>>> tensor_out2
tensor([[1, 2],
        [3, 4]], device='cuda:0') # Rank 0
tensor([[1, 2],
        [3, 4]], device='cuda:1') # Rank 1

torch.distributed.all_gather_object(object_list, obj, group=None)[源码]#

将可序列化对象从整个组收集到一个列表中。

与 all_gather() 类似，但可以传递 Python 对象。请注意，对象必须是可序列化的才能被收集。

参数

object_list (list[Any]) – 输出列表。应根据此集合通信的组的大小正确设置大小，并将包含输出。
obj (Any) – 要从当前进程广播的可序列化 Python 对象。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。默认为 None。

返回

None。如果调用 rank 属于此组，则集合通信的输出将被填充到输入的 object_list 中。如果调用 rank 不属于此组，则传递的 object_list 将保持不变。

注意

请注意，此 API 与 all_gather() 集合通信略有不同，因为它不提供 async_op 句柄，因此将是一个阻塞调用。

注意

警告

对象集体操作存在一些严重的性能和可扩展性限制。详情请参阅对象集体操作。

警告

all_gather_object() 隐式使用了 pickle 模块，该模块已知是不安全的。可以构造恶意 pickle 数据，在反序列化时执行任意代码。仅使用可信数据调用此函数。

警告

使用 GPU 张量调用 all_gather_object() 支持不佳且效率低下，因为它会产生 GPU -> CPU 传输，因为张量会被 pickle。请考虑使用 all_gather()。

示例：

>>> # Note: Process group initialization omitted on each rank.
>>> import torch.distributed as dist
>>> # Assumes world_size of 3.
>>> gather_objects = ["foo", 12, {1: 2}] # any picklable object
>>> output = [None for _ in gather_objects]
>>> dist.all_gather_object(output, gather_objects[dist.get_rank()])
>>> output
['foo', 12, {1: 2}]

torch.distributed.gather(tensor, gather_list=None, dst=None, group=None, async_op=False, group_dst=None)[源码]#

将张量列表收集到一个进程中。

此函数要求所有进程上的张量大小相同。

参数

tensor (Tensor) – 输入张量。
gather_list (list[Tensor], 可选) – 用于收集数据的正确大小的张量列表（默认为 None，必须在目标 rank 上指定）
dst (int, 可选) – 全局进程组中的目标 rank（无论 group 参数如何）。（如果 dst 和 group_dst 都为 None，则默认为全局 rank 0）
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作
group_dst (int, 可选) – group 中的目标 rank。指定 dst 和 group_dst 时，两者不能同时有效

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None

注意

注意，gather_list 中的所有张量必须具有相同的大小。

示例：

>>> # We have 2 process groups, 2 ranks.
>>> tensor_size = 2
>>> device = torch.device(f'cuda:{rank}')
>>> tensor = torch.ones(tensor_size, device=device) + rank
>>> if dist.get_rank() == 0:
>>>     gather_list = [torch.zeros_like(tensor, device=device) for i in range(2)]
>>> else:
>>>     gather_list = None
>>> dist.gather(tensor, gather_list, dst=0)
>>> # Rank 0 gets gathered data.
>>> gather_list
[tensor([1., 1.], device='cuda:0'), tensor([2., 2.], device='cuda:0')] # Rank 0
None                                                                   # Rank 1

torch.distributed.gather_object(obj, object_gather_list=None, dst=None, group=None, group_dst=None)[源码]#

将整个组中的可序列化对象收集到一个进程中。

与 gather() 类似，但可以传递 Python 对象。请注意，对象必须是可序列化的才能被收集。

参数

obj (Any) – 输入对象。必须是可序列化的。
object_gather_list (list[Any]) – 输出列表。在 dst rank 上，它的大小应与此集合通信的组大小相同，并将包含输出。在非 dst rank 上必须为 None。（默认为 None）
dst (int, 可选) – 全局进程组中的目标 rank（无论 group 参数如何）。（如果 dst 和 group_dst 都为 None，则默认为全局 rank 0）
group (Optional[ProcessGroup]) – 要操作的进程组。如果为 None，则使用默认进程组。默认为 None。
group_dst (int, 可选) – group 中的目标 rank。指定 dst 和 group_dst 时，两者不能同时有效

返回

None。在 dst rank 上，object_gather_list 将包含集合通信的输出。

注意

请注意，此 API 与 gather 集合通信略有不同，因为它不提供 async_op 句柄，因此将是一个阻塞调用。

注意

警告

对象集体操作存在一些严重的性能和可扩展性限制。详情请参阅对象集体操作。

警告

gather_object() 隐式使用了 pickle 模块，该模块已知是不安全的。可以构造恶意 pickle 数据，在反序列化时执行任意代码。仅使用可信数据调用此函数。

警告

使用 GPU 张量调用 gather_object() 支持不佳且效率低下，因为它会产生 GPU -> CPU 传输，因为张量会被 pickle。请考虑使用 gather()。

示例：

>>> # Note: Process group initialization omitted on each rank.
>>> import torch.distributed as dist
>>> # Assumes world_size of 3.
>>> gather_objects = ["foo", 12, {1: 2}] # any picklable object
>>> output = [None for _ in gather_objects]
>>> dist.gather_object(
...     gather_objects[dist.get_rank()],
...     output if dist.get_rank() == 0 else None,
...     dst=0
... )
>>> # On rank 0
>>> output
['foo', 12, {1: 2}]

torch.distributed.scatter(tensor, scatter_list=None, src=None, group=None, async_op=False, group_src=None)[源码]#

将张量列表散布到组中的所有进程。

每个进程将接收一个张量，并将其数据存储在 tensor 参数中。

支持复杂张量。

参数

tensor (Tensor) – 输出张量。
scatter_list (list[Tensor]) – 要散布的张量列表（默认为 None，必须在源 rank 上指定）
src (int) – 从哪个源 rank 散布 scatter_list。源 rank 基于全局进程组（无论 group 参数如何）。（如果 src 和 group_src 都为 None，则默认为全局 rank 0）
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作
group_src (int, 可选) – group 中的源 rank。不得同时指定 src 和 group_src。

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None

注意

注意，scatter_list 中的所有张量必须具有相同的大小。

示例：

>>> # Note: Process group initialization omitted on each rank.
>>> import torch.distributed as dist
>>> tensor_size = 2
>>> device = torch.device(f'cuda:{rank}')
>>> output_tensor = torch.zeros(tensor_size, device=device)
>>> if dist.get_rank() == 0:
>>>     # Assumes world_size of 2.
>>>     # Only tensors, all of which must be the same size.
>>>     t_ones = torch.ones(tensor_size, device=device)
>>>     t_fives = torch.ones(tensor_size, device=device) * 5
>>>     scatter_list = [t_ones, t_fives]
>>> else:
>>>     scatter_list = None
>>> dist.scatter(output_tensor, scatter_list, src=0)
>>> # Rank i gets scatter_list[i].
>>> output_tensor
tensor([1., 1.], device='cuda:0') # Rank 0
tensor([5., 5.], device='cuda:1') # Rank 1

torch.distributed.scatter_object_list(scatter_object_output_list, scatter_object_input_list=None, src=None, group=None, group_src=None)[源码]#

将 scatter_object_input_list 中的可序列化对象散布到整个组。

与 scatter() 类似，但可以传递 Python 对象。在每个 rank 上，散布的对象将存储在 scatter_object_output_list 的第一个元素中。请注意，scatter_object_input_list 中的所有对象都必须是可序列化的才能散布。

参数

scatter_object_output_list (List[Any]) – 非空列表，其第一个元素将存储散布到此 rank 的对象。
scatter_object_input_list (List[Any], 可选) – 要散布的输入对象列表。每个对象都必须是可序列化的。只有 src rank 上的对象才会被散布，对于非 src rank，此参数可以为 None。
src (int) – 从哪个源 rank 散布 scatter_object_input_list。源 rank 基于全局进程组（无论 group 参数如何）。（如果 src 和 group_src 都为 None，则默认为全局 rank 0）
group (Optional[ProcessGroup]) – 要操作的进程组。如果为 None，则使用默认进程组。默认为 None。
group_src (int, 可选) – group 中的源 rank。不得同时指定 src 和 group_src。

返回

None。如果 rank 在组中，则 scatter_object_output_list 的第一个元素将被设置为该 rank 的散布对象。

注意

请注意，此 API 与 scatter 集合通信略有不同，因为它不提供 async_op 句柄，因此将是一个阻塞调用。

警告

对象集体操作存在一些严重的性能和可扩展性限制。详情请参阅对象集体操作。

警告

scatter_object_list() 隐式使用了 pickle 模块，该模块已知是不安全的。可以构造恶意 pickle 数据，在反序列化时执行任意代码。仅使用可信数据调用此函数。

警告

使用 GPU 张量调用 scatter_object_list() 支持不佳且效率低下，因为它会产生 GPU -> CPU 传输，因为张量会被 pickle。请考虑使用 scatter()。

示例：

>>> # Note: Process group initialization omitted on each rank.
>>> import torch.distributed as dist
>>> if dist.get_rank() == 0:
>>>     # Assumes world_size of 3.
>>>     objects = ["foo", 12, {1: 2}] # any picklable object
>>> else:
>>>     # Can be any list on non-src ranks, elements are not used.
>>>     objects = [None, None, None]
>>> output_list = [None]
>>> dist.scatter_object_list(output_list, objects, src=0)
>>> # Rank i gets objects[i]. For example, on rank 2:
>>> output_list
[{1: 2}]

torch.distributed.reduce_scatter(output, input_list, op=<RedOpType.SUM: 0>, group=None, async_op=False)[源码]#

规约，然后将张量列表散布到组中的所有进程。

参数

output (Tensor) – 输出张量。
input_list (list[Tensor]) – 要规约和散布的张量列表。
op (optional) – torch.distributed.ReduceOp 枚举中的一个值。指定用于逐元素规约的操作。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作。

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None。

torch.distributed.reduce_scatter_tensor(output, input, op=<RedOpType.SUM: 0>, group=None, async_op=False)[源码]#

规约，然后将张量散布到组中的所有 rank。

参数

output (Tensor) – 输出张量。它在所有 rank 上都应具有相同的大小。
input (Tensor) – 要规约和散布的输入张量。其大小应为输出张量大小乘以世界大小。输入张量可以具有以下形状之一：（i）沿主维度连接输出张量，或（ii）沿主维度堆叠输出张量。有关“连接”的定义，请参阅 torch.cat()。有关“堆叠”的定义，请参阅 torch.stack()。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作。

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None。

示例

>>> # All tensors below are of torch.int64 dtype and on CUDA devices.
>>> # We have two ranks.
>>> device = torch.device(f"cuda:{rank}")
>>> tensor_out = torch.zeros(2, dtype=torch.int64, device=device)
>>> # Input in concatenation form
>>> tensor_in = torch.arange(world_size * 2, dtype=torch.int64, device=device)
>>> tensor_in
tensor([0, 1, 2, 3], device='cuda:0') # Rank 0
tensor([0, 1, 2, 3], device='cuda:1') # Rank 1
>>> dist.reduce_scatter_tensor(tensor_out, tensor_in)
>>> tensor_out
tensor([0, 2], device='cuda:0') # Rank 0
tensor([4, 6], device='cuda:1') # Rank 1
>>> # Input in stack form
>>> tensor_in = torch.reshape(tensor_in, (world_size, 2))
>>> tensor_in
tensor([[0, 1],
        [2, 3]], device='cuda:0') # Rank 0
tensor([[0, 1],
        [2, 3]], device='cuda:1') # Rank 1
>>> dist.reduce_scatter_tensor(tensor_out, tensor_in)
>>> tensor_out
tensor([0, 2], device='cuda:0') # Rank 0
tensor([4, 6], device='cuda:1') # Rank 1

torch.distributed.all_to_all_single(output, input, output_split_sizes=None, input_split_sizes=None, group=None, async_op=False)[源码]#

分割输入张量，然后将分割列表散布到组中的所有进程。

稍后，将从组中所有进程接收到的张量连接起来，并作为单个输出张量返回。

支持复杂张量。

参数

output (Tensor) – 收集的连接输出张量。
input (Tensor) – 要散布的输入张量。
output_split_sizes – (list[Int], 可选): 如果指定为 None 或空，则 dim 0 的输出分割大小。 output 张量的 dim 0 必须能被 world_size 整除。
input_split_sizes – (list[Int], 可选): 如果指定为 None 或空，则 dim 0 的输入分割大小。 input 张量的 dim 0 必须能被 world_size 整除。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作。

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None。

警告

all_to_all_single 是实验性的，可能会发生更改。

示例

>>> input = torch.arange(4) + rank * 4
>>> input
tensor([0, 1, 2, 3])     # Rank 0
tensor([4, 5, 6, 7])     # Rank 1
tensor([8, 9, 10, 11])   # Rank 2
tensor([12, 13, 14, 15]) # Rank 3
>>> output = torch.empty([4], dtype=torch.int64)
>>> dist.all_to_all_single(output, input)
>>> output
tensor([0, 4, 8, 12])    # Rank 0
tensor([1, 5, 9, 13])    # Rank 1
tensor([2, 6, 10, 14])   # Rank 2
tensor([3, 7, 11, 15])   # Rank 3

>>> # Essentially, it is similar to following operation:
>>> scatter_list = list(input.chunk(world_size))
>>> gather_list = list(output.chunk(world_size))
>>> for i in range(world_size):
>>>     dist.scatter(gather_list[i], scatter_list if i == rank else [], src = i)

>>> # Another example with uneven split
>>> input
tensor([0, 1, 2, 3, 4, 5])                                       # Rank 0
tensor([10, 11, 12, 13, 14, 15, 16, 17, 18])                     # Rank 1
tensor([20, 21, 22, 23, 24])                                     # Rank 2
tensor([30, 31, 32, 33, 34, 35, 36])                             # Rank 3
>>> input_splits
[2, 2, 1, 1]                                                     # Rank 0
[3, 2, 2, 2]                                                     # Rank 1
[2, 1, 1, 1]                                                     # Rank 2
[2, 2, 2, 1]                                                     # Rank 3
>>> output_splits
[2, 3, 2, 2]                                                     # Rank 0
[2, 2, 1, 2]                                                     # Rank 1
[1, 2, 1, 2]                                                     # Rank 2
[1, 2, 1, 1]                                                     # Rank 3
>>> output = ...
>>> dist.all_to_all_single(output, input, output_splits, input_splits)
>>> output
tensor([ 0,  1, 10, 11, 12, 20, 21, 30, 31])                     # Rank 0
tensor([ 2,  3, 13, 14, 22, 32, 33])                             # Rank 1
tensor([ 4, 15, 16, 23, 34, 35])                                 # Rank 2
tensor([ 5, 17, 18, 24, 36])                                     # Rank 3

>>> # Another example with tensors of torch.cfloat type.
>>> input = torch.tensor(
...     [1 + 1j, 2 + 2j, 3 + 3j, 4 + 4j], dtype=torch.cfloat
... ) + 4 * rank * (1 + 1j)
>>> input
tensor([1+1j, 2+2j, 3+3j, 4+4j])                                # Rank 0
tensor([5+5j, 6+6j, 7+7j, 8+8j])                                # Rank 1
tensor([9+9j, 10+10j, 11+11j, 12+12j])                          # Rank 2
tensor([13+13j, 14+14j, 15+15j, 16+16j])                        # Rank 3
>>> output = torch.empty([4], dtype=torch.int64)
>>> dist.all_to_all_single(output, input)
>>> output
tensor([1+1j, 5+5j, 9+9j, 13+13j])                              # Rank 0
tensor([2+2j, 6+6j, 10+10j, 14+14j])                            # Rank 1
tensor([3+3j, 7+7j, 11+11j, 15+15j])                            # Rank 2
tensor([4+4j, 8+8j, 12+12j, 16+16j])                            # Rank 3

torch.distributed.all_to_all(output_tensor_list, input_tensor_list, group=None, async_op=False)[源码]#

将输入张量列表散布到组中的所有进程，并在输出列表中返回收集的张量列表。

支持复杂张量。

参数

output_tensor_list (list[Tensor]) – 要收集的张量列表，每个 rank 一个。
input_tensor_list (list[Tensor]) – 要散布的张量列表，每个 rank 一个。
group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作。

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None。

警告

all_to_all 是实验性的，可能会发生更改。

示例

>>> input = torch.arange(4) + rank * 4
>>> input = list(input.chunk(4))
>>> input
[tensor([0]), tensor([1]), tensor([2]), tensor([3])]     # Rank 0
[tensor([4]), tensor([5]), tensor([6]), tensor([7])]     # Rank 1
[tensor([8]), tensor([9]), tensor([10]), tensor([11])]   # Rank 2
[tensor([12]), tensor([13]), tensor([14]), tensor([15])] # Rank 3
>>> output = list(torch.empty([4], dtype=torch.int64).chunk(4))
>>> dist.all_to_all(output, input)
>>> output
[tensor([0]), tensor([4]), tensor([8]), tensor([12])]    # Rank 0
[tensor([1]), tensor([5]), tensor([9]), tensor([13])]    # Rank 1
[tensor([2]), tensor([6]), tensor([10]), tensor([14])]   # Rank 2
[tensor([3]), tensor([7]), tensor([11]), tensor([15])]   # Rank 3

>>> # Essentially, it is similar to following operation:
>>> scatter_list = input
>>> gather_list = output
>>> for i in range(world_size):
>>>     dist.scatter(gather_list[i], scatter_list if i == rank else [], src=i)

>>> input
tensor([0, 1, 2, 3, 4, 5])                                       # Rank 0
tensor([10, 11, 12, 13, 14, 15, 16, 17, 18])                     # Rank 1
tensor([20, 21, 22, 23, 24])                                     # Rank 2
tensor([30, 31, 32, 33, 34, 35, 36])                             # Rank 3
>>> input_splits
[2, 2, 1, 1]                                                     # Rank 0
[3, 2, 2, 2]                                                     # Rank 1
[2, 1, 1, 1]                                                     # Rank 2
[2, 2, 2, 1]                                                     # Rank 3
>>> output_splits
[2, 3, 2, 2]                                                     # Rank 0
[2, 2, 1, 2]                                                     # Rank 1
[1, 2, 1, 2]                                                     # Rank 2
[1, 2, 1, 1]                                                     # Rank 3
>>> input = list(input.split(input_splits))
>>> input
[tensor([0, 1]), tensor([2, 3]), tensor([4]), tensor([5])]                   # Rank 0
[tensor([10, 11, 12]), tensor([13, 14]), tensor([15, 16]), tensor([17, 18])] # Rank 1
[tensor([20, 21]), tensor([22]), tensor([23]), tensor([24])]                 # Rank 2
[tensor([30, 31]), tensor([32, 33]), tensor([34, 35]), tensor([36])]         # Rank 3
>>> output = ...
>>> dist.all_to_all(output, input)
>>> output
[tensor([0, 1]), tensor([10, 11, 12]), tensor([20, 21]), tensor([30, 31])]   # Rank 0
[tensor([2, 3]), tensor([13, 14]), tensor([22]), tensor([32, 33])]           # Rank 1
[tensor([4]), tensor([15, 16]), tensor([23]), tensor([34, 35])]              # Rank 2
[tensor([5]), tensor([17, 18]), tensor([24]), tensor([36])]                  # Rank 3

>>> # Another example with tensors of torch.cfloat type.
>>> input = torch.tensor(
...     [1 + 1j, 2 + 2j, 3 + 3j, 4 + 4j], dtype=torch.cfloat
... ) + 4 * rank * (1 + 1j)
>>> input = list(input.chunk(4))
>>> input
[tensor([1+1j]), tensor([2+2j]), tensor([3+3j]), tensor([4+4j])]            # Rank 0
[tensor([5+5j]), tensor([6+6j]), tensor([7+7j]), tensor([8+8j])]            # Rank 1
[tensor([9+9j]), tensor([10+10j]), tensor([11+11j]), tensor([12+12j])]      # Rank 2
[tensor([13+13j]), tensor([14+14j]), tensor([15+15j]), tensor([16+16j])]    # Rank 3
>>> output = list(torch.empty([4], dtype=torch.int64).chunk(4))
>>> dist.all_to_all(output, input)
>>> output
[tensor([1+1j]), tensor([5+5j]), tensor([9+9j]), tensor([13+13j])]          # Rank 0
[tensor([2+2j]), tensor([6+6j]), tensor([10+10j]), tensor([14+14j])]        # Rank 1
[tensor([3+3j]), tensor([7+7j]), tensor([11+11j]), tensor([15+15j])]        # Rank 2
[tensor([4+4j]), tensor([8+8j]), tensor([12+12j]), tensor([16+16j])]        # Rank 3

torch.distributed.barrier(group=None, async_op=False, device_ids=None)[源码]#

同步所有进程。

此集合通信会阻塞进程，直到整个组进入此函数，如果 async_op 为 False，或者如果调用 wait() 上的异步工作句柄。

参数

group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
async_op (bool, 可选) – 此操作是否应为异步操作
device_ids ([int], 可选) – 设备/GPU ID 列表。只期望一个 ID。

返回

异步工作句柄，如果 async_op 设置为 True。如果不是异步操作或不在组中，则为 None

注意

ProcessGroupNCCL 现在会阻塞 CPU 线程直到 barrier 集合通信完成。

注意

ProcessGroupNCCL 将 barrier 实现为 1 元素张量的 all_reduce。必须为分配此张量选择一个设备。设备选择通过按以下顺序检查来完成：（1）如果 barrier 的 device_ids 参数不为 None，则为第一个设备；（2）传递给 init_process_group 的设备（如果不是 None）；（3）已与此进程组首次使用的设备（如果已执行另一个带有张量输入的集合通信）；（4）全局 rank 对本地设备计数取模指示的设备索引。

torch.distributed.monitored_barrier(group=None, timeout=None, wait_all_ranks=False)[源码]#

类似于 torch.distributed.barrier 同步进程，但考虑了可配置的超时。

它能够报告在规定超时时间内未通过此 barrier 的 rank。具体来说，对于非零 rank，将阻塞直到从 rank 0 处理发送/接收。Rank 0 将阻塞直到处理完所有其他 rank 的发送/接收，并将报告未及时响应的 rank 的失败。请注意，如果某个 rank 未达到 monitored_barrier（例如由于挂起），则所有其他 rank 在 monitored_barrier 中都会失败。

此集合通信会阻塞组中的所有进程/rank，直到整个组成功退出函数，这对于调试和同步非常有用。但是，它可能会影响性能，并且仅应用于调试或需要完全主机端同步点的场景。出于调试目的，可以在应用程序的集合通信调用之前插入此 barrier，以检查是否有任何 rank 不同步。

注意

请注意，此集合通信仅支持 GLOO 后端。

参数

group (ProcessGroup, 可选) – 要操作的进程组。如果为 None，则使用默认进程组。
timeout (datetime.timedelta, 可选) – monitored_barrier 的超时时间。如果为 None，则使用默认进程组超时。
wait_all_ranks (bool, optional) – 是否收集所有失败的 rank。默认情况下，此参数为 False，此时 rank 0 上的 monitored_barrier 会在遇到第一个失败的 rank 时立即抛出异常，以便快速失败。通过将 wait_all_ranks=True，monitored_barrier 将收集所有失败的 rank，并抛出一个包含所有失败 rank 信息中的错误。

返回

无.

示例：

>>> # Note: Process group initialization omitted on each rank.
>>> import torch.distributed as dist
>>> if dist.get_rank() != 1:
>>>     dist.monitored_barrier() # Raises exception indicating that
>>> # rank 1 did not call into monitored_barrier.
>>> # Example with wait_all_ranks=True
>>> if dist.get_rank() == 0:
>>>     dist.monitored_barrier(wait_all_ranks=True) # Raises exception
>>> # indicating that ranks 1, 2, ... world_size - 1 did not call into
>>> # monitored_barrier.

class torch.distributed.Work#

一个 Work 对象表示 PyTorch 分布式包中挂起的异步操作的句柄。它由非阻塞集合操作返回，例如 dist.all_reduce(tensor, async_op=True)。

block_current_stream(self: torch._C._distributed_c10d.Work) → None#

阻塞当前活动的 GPU 流以完成操作。对于基于 GPU 的集合操作，这等同于同步。对于 CPU 发起的集合操作（例如使用 Gloo），这将阻塞 CUDA 流直到操作完成。

此方法在所有情况下都会立即返回。

要检查操作是否成功，您应该异步检查 Work 对象的结果。

boxed(self: torch._C._distributed_c10d.Work) → object#

exception(self: torch._C._distributed_c10d.Work) → std::__exception_ptr::exception_ptr#

get_future(self: torch._C._distributed_c10d.Work) → torch.Future#

返回: 一个与 Work 完成相关的 torch.futures.Future 对象。例如，可以通过 fut = process_group.allreduce(tensors).get_future() 检索 Future 对象。

示例：

下面是一个简单的 allreduce DDP 通信钩子的示例，它使用 get_future API 来检索与 allreduce 完成相关的 Future。

>>> def allreduce(process_group: dist.ProcessGroup, bucket: dist.GradBucket): -> torch.futures.Future
>>>     group_to_use = process_group if process_group is not None else torch.distributed.group.WORLD
>>>     tensor = bucket.buffer().div_(group_to_use.size())
>>>     return torch.distributed.all_reduce(tensor, group=group_to_use, async_op=True).get_future()
>>> ddp_model.register_comm_hook(state=None, hook=allreduce)

警告

get_future API 支持 NCCL，部分支持 GLOO 和 MPI 后端（不支持点对点操作，如 send/recv），并返回一个 torch.futures.Future。

在上面的示例中，allreduce 操作将在 GPU 上使用 NCCL 后端完成，fut.wait() 将在同步适当的 NCCL 流与 PyTorch 的当前设备流后返回，以确保我们可以进行异步 CUDA 执行，而无需等待 GPU 上的整个操作完成。请注意，CUDAFuture 不支持 TORCH_NCCL_BLOCKING_WAIT 标志或 NCCL 的 barrier()。此外，如果 fut.then() 添加了一个回调函数，它将等待直到 WorkNCCL 的 NCCL 流与 ProcessGroupNCCL 的专用回调流同步，并在回调流上运行回调后内联调用该回调。 fut.then() 将返回另一个 CUDAFuture，该 Future 保存回调的返回值和一个记录了回调流的 CUDAEvent。

对于 CPU 操作，fut.done() 在操作完成且 value() 张量准备就绪时返回 true。

对于 GPU 操作，fut.done() 仅在操作已入队时返回 true。

对于混合 CPU-GPU 操作（例如使用 GLOO 发送 GPU 张量），fut.done() 在张量到达相应节点时返回 true，但不一定在相应 GPU 上同步（与 GPU 操作类似）。

get_future_result(self: torch._C._distributed_c10d.Work) → torch.Future#

返回: 一个 torch.futures.Future 对象，其类型为 int，映射到 WorkResult 的枚举类型。例如，可以通过 fut = process_group.allreduce(tensor).get_future_result() 检索 Future 对象。

示例：: 用户可以使用 fut.wait() 阻塞等待工作完成，并通过 fut.value() 获取 WorkResult。此外，用户还可以使用 fut.then(call_back_func) 注册一个回调函数，以便在工作完成时调用，而无需阻塞当前线程。

警告

get_future_result API 支持 NCCL。

is_completed(self: torch._C._distributed_c10d.Work) → bool#

is_success(self: torch._C._distributed_c10d.Work) → bool#

result(self: torch._C._distributed_c10d.Work) → list[torch.Tensor]#

source_rank(self: torch._C._distributed_c10d.Work) → int#

synchronize(self: torch._C._distributed_c10d.Work) → None#

static unbox(arg0: object) → torch._C._distributed_c10d.Work#

wait(self: torch._C._distributed_c10d.Work, timeout: datetime.timedelta = datetime.timedelta(0)) → bool#

返回: true/false。

示例：

try: work.wait(timeout)
except: # some handling

警告

在正常情况下，用户无需设置超时。调用 wait() 等同于调用 synchronize()：让当前流阻塞直到 NCCL 操作完成。但是，如果设置了超时，它将阻塞 CPU 线程直到 NCCL 操作完成或超时。如果超时，将抛出异常。

class torch.distributed.ReduceOp#

可用归约操作的枚举类：SUM, PRODUCT, MIN, MAX, BAND, BOR, BXOR, 和 PREMUL_SUM。

BAND, BOR, 和 BXOR 归约在与 NCCL 后端一起使用时不可用。

AVG 在求和跨 rank 之前将值除以 world size。AVG 仅适用于 NCCL 后端，并且仅适用于 NCCL 版本 2.10 或更高版本。

PREMUL_SUM 在归约之前将输入乘以给定的标量。PREMUL_SUM 仅适用于 NCCL 后端，并且仅适用于 NCCL 版本 2.11 或更高版本。用户应使用 torch.distributed._make_nccl_premul_sum。

此外，MAX, MIN 和 PRODUCT 不支持复数张量。

此类的值可以通过属性访问，例如 ReduceOp.SUM。它们用于指定归约集合操作的策略，例如 reduce()。

此类不支持 __members__ 属性。

class torch.distributed.reduce_op#

已弃用的归约操作的枚举类：SUM, PRODUCT, MIN, 和 MAX。

推荐使用 ReduceOp 代替。

分布式键值存储#

分布式包带有一个分布式的键值存储，可用于在组中的进程之间共享信息，以及在 torch.distributed.init_process_group() 中初始化分布式包（通过显式创建存储作为指定 init_method 的替代方法）。有 3 种键值存储可供选择：TCPStore, FileStore, 和 HashStore。

class torch.distributed.Store#

所有存储实现的基类，例如 PyTorch 分布式提供的 3 种实现：（TCPStore, FileStore, 和 HashStore）。

__init__(self: torch._C._distributed_c10d.Store) → None#

add(self: torch._C._distributed_c10d.Store, arg0: str, arg1: SupportsInt) → int#

第一次为给定的 key 调用 add 会在存储中创建一个与 key 关联的计数器，并初始化为 amount。对于同一个 key 的后续 add 调用会将计数器增加指定的 amount。使用已通过 set() 在存储中设置的键调用 add() 将导致异常。

参数

key (str) – 将被递增的计数器在存储中的键。
amount (int) – 计数器将增加的数量。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> # Using TCPStore as an example, other store types can also be used
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.add("first_key", 1)
>>> store.add("first_key", 6)
>>> # Should return 7
>>> store.get("first_key")

append(self: torch._C._distributed_c10d.Store, arg0: str, arg1: str) → None#

将键值对追加到存储中，基于提供的 key 和 value。如果 key 在存储中不存在，它将被创建。

参数

key (str) – 要追加到存储中的键。
value (str) – 与 key 关联的要添加到存储中的值。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.append("first_key", "po")
>>> store.append("first_key", "tato")
>>> # Should return "potato"
>>> store.get("first_key")

check(self: torch._C._distributed_c10d.Store, arg0: collections.abc.Sequence[str]) → bool#

调用以检查给定的 keys 列表是否在存储中有值。此调用在正常情况下会立即返回，但仍可能遇到一些边缘的死锁情况，例如，在 TCPStore 被销毁后调用 check。调用 check() 并传入一个键列表，用于检查它们是否存在于存储中。

参数: keys (list[str]) – 要查询是否存储在存储中的键。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> # Using TCPStore as an example, other store types can also be used
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.add("first_key", 1)
>>> # Should return 7
>>> store.check(["first_key"])

clone(self: torch._C._distributed_c10d.Store) → torch._C._distributed_c10d.Store#: 克隆存储并返回一个指向相同底层存储的新对象。返回的存储可以与原始对象并发使用。这旨在为从多个线程安全地使用存储提供一种方式，每个线程克隆一个存储。

compare_set(self: torch._C._distributed_c10d.Store, arg0: str, arg1: str, arg2: str) → bytes#

根据提供的 key 和 expected_value 与 desired_value 之间的比较，将键值对插入存储。仅当 key 的 expected_value 已存在于存储中，或者 expected_value 是空字符串时，才会设置 desired_value。

参数

key (str) – 要在存储中检查的键。
expected_value (str) – 在插入前要检查的与 key 关联的值。
desired_value (str) – 要添加到存储中的与 key 关联的值。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.set("key", "first_value")
>>> store.compare_set("key", "first_value", "second_value")
>>> # Should return "second_value"
>>> store.get("key")

delete_key(self: torch._C._distributed_c10d.Store, arg0: str) → bool#

从存储中删除与 key 关联的键值对。如果键成功删除，则返回 true，如果未删除，则返回 false。

警告

delete_key API 仅由 TCPStore 和 HashStore 支持。使用此 API 与 FileStore 将导致异常。

参数: key (str) – 要从存储中删除的键
返回: True 如果 key 已删除，否则为 False。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> # Using TCPStore as an example, HashStore can also be used
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.set("first_key")
>>> # This should return true
>>> store.delete_key("first_key")
>>> # This should return false
>>> store.delete_key("bad_key")

get(self: torch._C._distributed_c10d.Store, arg0: str) → bytes#

检索存储中与给定 key 关联的值。如果 key 不存在于存储中，该函数将等待 timeout（在初始化存储时定义）后再抛出异常。

参数: key (str) – 函数将返回与此键关联的值。
返回: 如果 key 存在于存储中，则返回与 key 关联的值。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.set("first_key", "first_value")
>>> # Should return "first_value"
>>> store.get("first_key")

has_extended_api(self: torch._C._distributed_c10d.Store) → bool#: 返回存储是否支持扩展操作。

multi_get(self: torch._C._distributed_c10d.Store, arg0: collections.abc.Sequence[str]) → list[bytes]#

检索 keys 中的所有值。如果 keys 中的任何键在存储中不存在，该函数将等待 timeout。

参数: keys (List[str]) – 要从存储中检索的键。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.set("first_key", "po")
>>> store.set("second_key", "tato")
>>> # Should return [b"po", b"tato"]
>>> store.multi_get(["first_key", "second_key"])

multi_set(self: torch._C._distributed_c10d.Store, arg0: collections.abc.Sequence[str], arg1: collections.abc.Sequence[str]) → None#

根据提供的 keys 和 values 将键值对列表插入存储。

参数

keys (List[str]) – 要插入的键。
values (List[str]) – 要插入的值。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.multi_set(["first_key", "second_key"], ["po", "tato"])
>>> # Should return b"po"
>>> store.get("first_key")

num_keys(self: torch._C._distributed_c10d.Store) → int#

返回存储中已设置的键的数量。请注意，此数字通常比通过 set() 和 add() 添加的键的数量多一个，因为会有一个键用于协调使用该存储的所有 worker。

警告

与 TCPStore 一起使用时，num_keys 返回写入底层文件的键的数量。如果存储被销毁，并且使用相同文件的另一个存储被创建，则原始键将被保留。

返回: 存储中存在的键的数量。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> # Using TCPStore as an example, other store types can also be used
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.set("first_key", "first_value")
>>> # This should return 2
>>> store.num_keys()

queue_len(self: torch._C._distributed_c10d.Store, arg0: str) → int#

返回指定队列的长度。

如果队列不存在，则返回 0。

有关更多详细信息，请参阅 queue_push。

参数: key (str) – 获取长度的队列的键。

queue_pop(self: torch._C._distributed_c10d.Store, key: str, block: bool = True) → bytes#

从指定队列中弹出值，或在队列为空时等待直到超时。

有关更多详细信息，请参阅 queue_push。

如果 block 为 False，当队列为空时将引发 dist.QueueEmptyError。

参数

key (str) – 要从中弹出的队列的键。
block (bool) – 是否阻塞等待键或立即返回。

queue_push(self: torch._C._distributed_c10d.Store, arg0: str, arg1: str) → None#

将值推送到指定队列。

将相同的键用于队列和 set/get 操作可能会导致意外行为。

wait/check 操作支持队列。

队列上的 wait 将只唤醒一个等待的 worker 而不是全部。

参数

key (str) – 要推送到队列的键。
value (str) – 要推送到队列的值。

set(self: torch._C._distributed_c10d.Store, arg0: str, arg1: str) → None#

根据提供的 key 和 value 将键值对插入存储。如果 key 已存在于存储中，则会用新提供的 value 覆盖旧值。

参数

key (str) – 要添加到存储中的键。
value (str) – 与 key 关联的要添加到存储中的值。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.set("first_key", "first_value")
>>> # Should return "first_value"
>>> store.get("first_key")

set_timeout(self: torch._C._distributed_c10d.Store, arg0: datetime.timedelta) → None#

设置存储的默认超时时间。此超时时间用于初始化以及 wait() 和 get() 方法。

参数: timeout (timedelta) – 要在存储中设置的超时时间。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> # Using TCPStore as an example, other store types can also be used
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> store.set_timeout(timedelta(seconds=10))
>>> # This will throw an exception after 10 seconds
>>> store.wait(["bad_key"])

property timeout#: 获取存储的超时时间。

wait(*args, **kwargs)#

重载函数。

wait(self: torch._C._distributed_c10d.Store, arg0: collections.abc.Sequence[str]) -> None

等待 keys 中的每个键被添加到存储中。如果在 timeout（在存储初始化期间设置）之前并非所有键都已设置，则 wait 将抛出异常。

参数: keys (list) – 在其中等待直到它们在存储中设置的键列表。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> # Using TCPStore as an example, other store types can also be used
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> # This will throw an exception after 30 seconds
>>> store.wait(["bad_key"])

wait(self: torch._C._distributed_c10d.Store, arg0: collections.abc.Sequence[str], arg1: datetime.timedelta) -> None

等待 keys 中的每个键被添加到存储中，并在 timeout 时间内未设置键时抛出异常。

参数

keys (list) – 在其中等待直到它们在存储中设置的键列表。
timeout (timedelta) – 在抛出异常之前等待键添加的时间。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> # Using TCPStore as an example, other store types can also be used
>>> store = dist.TCPStore("127.0.0.1", 0, 1, True, timedelta(seconds=30))
>>> # This will throw an exception after 10 seconds
>>> store.wait(["bad_key"], timedelta(seconds=10))

class torch.distributed.TCPStore#

一个基于 TCP 的分布式键值存储实现。服务器存储持有数据，而客户端存储可以通过 TCP 连接到服务器存储并执行操作，例如 set() 来插入键值对，get() 来检索键值对等。因为客户端存储（们）将等待服务器建立连接，所以总应该有一个服务器存储被初始化。

参数

host_name (str) – 服务器存储应运行的主机名或 IP 地址。
port (int) – 服务器存储应监听传入请求的端口。
world_size (int, optional) – 存储用户的总数（客户端数 + 1 个服务器）。默认为 None（None 表示非固定数量的存储用户）。
is_master (bool, optional) – 初始化服务器存储时为 True，客户端存储时为 False。默认为 False。
timeout (timedelta, optional) – 存储在初始化期间以及 get() 和 wait() 方法中使用的超时时间。默认为 timedelta(seconds=300)
wait_for_workers (bool, optional) – 是否等待所有 worker 连接到服务器存储。这仅在 world_size 是固定值时适用。默认为 True。
multi_tenant (bool, optional) – 如果为 True，则当前进程中所有具有相同主机/端口的 TCPStore 实例将使用相同的底层 TCPServer。默认为 False。
master_listen_fd (int, optional) – 如果指定，底层 TCPServer 将在该文件描述符上监听，该文件描述符必须是已绑定到 port 的套接字。为了绑定一个临时端口，我们建议将端口设置为 0 并读取 .port。默认为 None（表示服务器创建一个新套接字并尝试将其绑定到 port）。
use_libuv (bool, optional) – 如果为 True，则为 TCPServer 后端使用 libuv。默认为 True。

示例：

>>> import torch.distributed as dist
>>> from datetime import timedelta
>>> # Run on process 1 (server)
>>> server_store = dist.TCPStore("127.0.0.1", 1234, 2, True, timedelta(seconds=30))
>>> # Run on process 2 (client)
>>> client_store = dist.TCPStore("127.0.0.1", 1234, 2, False)
>>> # Use any of the store methods from either the client or server after initialization
>>> server_store.set("first_key", "first_value")
>>> client_store.get("first_key")

__init__(self: torch._C._distributed_c10d.TCPStore, host_name: str, port: SupportsInt, world_size: SupportsInt | None = None, is_master: bool = False, timeout: datetime.timedelta = datetime.timedelta(seconds=300), wait_for_workers: bool = True, multi_tenant: bool = False, master_listen_fd: SupportsInt | None = None, use_libuv: bool = True) → None#: 创建一个新的 TCPStore。

property host#: 获取存储监听请求的主机名。

property libuvBackend#: 如果正在使用 libuv 后端，则返回 True。

property port#: 获取存储监听请求的端口号。

class torch.distributed.HashStore#

基于底层哈希表的线程安全存储实现。此存储可以在同一进程内使用（例如，由其他线程），但不能跨进程使用。

示例：

>>> import torch.distributed as dist
>>> store = dist.HashStore()
>>> # store can be used from other threads
>>> # Use any of the store methods after initialization
>>> store.set("first_key", "first_value")

__init__(self: torch._C._distributed_c10d.HashStore) → None#: 创建一个新的 HashStore。

class torch.distributed.FileStore#

使用文件存储底层键值对的存储实现。

参数

file_name (str) – 用于存储键值对的文件的路径
world_size (int, optional) – 使用存储的进程总数。默认为 -1（负值表示非固定数量的存储用户）。

示例：

>>> import torch.distributed as dist
>>> store1 = dist.FileStore("/tmp/filestore", 2)
>>> store2 = dist.FileStore("/tmp/filestore", 2)
>>> # Use any of the store methods from either the client or server after initialization
>>> store1.set("first_key", "first_value")
>>> store2.get("first_key")

__init__(self: torch._C._distributed_c10d.FileStore, file_name: str, world_size: SupportsInt = -1) → None#: 创建一个新的 FileStore。

property path#: 获取 FileStore 用于存储键值对的文件的路径。

class torch.distributed.PrefixStore#

围绕 3 种键值存储（TCPStore, FileStore, 和 HashStore）之一的包装器，它在将每个键插入存储之前添加一个前缀。

参数

prefix (str) – 在插入存储之前添加到每个键的前缀字符串。
store (torch.distributed.store) – 构成底层键值存储的存储对象。

__init__(self: torch._C._distributed_c10d.PrefixStore, prefix: str, store: torch._C._distributed_c10d.Store) → None#: 创建一个新的 PrefixStore。

property underlying_store#: 获取 PrefixStore 包装的底层存储对象。

剖析集合通信#

请注意，您可以使用 torch.profiler（推荐，仅在 1.8.1 后可用）或 torch.autograd.profiler 来剖析此处提到的集合通信和点对点通信 API。所有现成的后端（gloo, nccl, mpi）均受支持，并且集合通信的使用将在剖析输出/跟踪中如预期般呈现。剖析代码与任何常规的 torch 操作相同。

import torch
import torch.distributed as dist
with torch.profiler():
    tensor = torch.randn(20, 10)
    dist.all_reduce(tensor)

有关剖析器功能的完整概述，请参阅剖析器文档。

多 GPU 集合函数#

警告

多 GPU 函数（代表每个 CPU 线程有多个 GPU）已弃用。截至目前，PyTorch Distributed 首选的编程模型是每个线程一个设备，正如本文档中的 API 所证明的那样。如果您是后端开发人员并希望支持每个线程有多个设备，请联系 PyTorch Distributed 的维护者。

对象集合#

警告

对象集合具有一系列严重的限制。请进一步阅读以确定它们是否对您的用例安全。

对象集合是一系列类似集合的操作，它们作用于任意 Python 对象，只要它们可以被 pickle。实现了各种集合模式（例如 broadcast, all_gather, …），但它们大致遵循以下模式：

将输入对象转换为 pickle（原始字节），然后将其放入字节张量中
将此字节张量的大小通信给对等方（第一个集合操作）
分配适当大小的张量以执行实际的集合操作
通信对象数据（第二个集合操作）
将原始数据转换回 Python（unpickle）

对象集合有时具有令人惊讶的性能或内存特性，导致运行时长或 OOM，因此应谨慎使用。以下是一些常见问题。

不对称的 pickle/unpickle 时间 - Pickling 对象可能很慢，具体取决于对象的数量、类型和大小。当集合操作是 fan-in（例如 gather_object）时，接收 rank 必须 unpickle N 倍于发送 rank pickle 的对象的数量，这可能导致其他 rank 在下一次集合操作时超时。

低效的张量通信 - 张量应通过常规集合 API 发送，而不是对象集合 API。可以通过对象集合 API 发送张量，但它们将被序列化和反序列化（对于非 CPU 张量，包括 CPU 同步和从设备到主机的复制），并且在几乎所有情况下，除了调试或故障排除代码之外，都值得重构代码以使用非对象集合。

意外的张量设备 - 如果您仍然想通过对象集合发送张量，还有另一个特定于 CUDA（以及可能的其他加速器）张量的方面。如果您 pickle 了一个当前位于 cuda:3 上的张量，然后 unpickle 它，您将获得另一个位于 cuda:3 上的张量，**无论您在哪一个进程上，或者哪个 CUDA 设备是该进程的“默认”设备**。使用常规的张量集合 API，“输出张量”始终位于相同的本地设备上，这通常是您所期望的。

unpickling 一个张量将隐式激活一个 CUDA 上下文，如果这是进程第一次使用 GPU，这可能会浪费大量 GPU 内存。可以通过在将张量作为对象集合的输入之前将其移动到 CPU 来避免此问题。

第三方后端#

除了内置的 GLOO/MPI/NCCL 后端之外，PyTorch 分布式还通过运行时注册机制支持第三方后端。关于如何通过 C++ 扩展开发第三方后端的参考，请参阅教程 - 自定义 C++ 和 CUDA 扩展和 test/cpp_extensions/cpp_c10d_extension.cpp。第三方后端的性能取决于其自身的实现。

新的后端继承自 c10d::ProcessGroup，并在导入时通过 torch.distributed.Backend.register_backend() 注册后端名称和实例化接口。

当手动导入此后端并使用相应的后端名称调用 torch.distributed.init_process_group() 时，torch.distributed 包将在新后端上运行。

警告

第三方后端的支持是实验性的，可能会发生变化。

启动实用程序#

torch.distributed 包还在 torch.distributed.launch 中提供了一个启动实用程序。这个辅助实用程序可用于在节点上启动多个进程进行分布式训练。

模块 torch.distributed.launch。

torch.distributed.launch 是一个模块，用于在每个训练节点上启动多个分布式训练进程。

警告

该模块将被弃用，推荐使用 torchrun。

该实用程序可用于单节点分布式训练，其中每个节点将启动一个或多个进程。该实用程序可用于 CPU 训练或 GPU 训练。如果用于 GPU 训练，每个分布式进程将操作于单个 GPU。这可以显著提高单节点训练性能。它还可以用于多节点分布式训练，通过在每个节点上启动多个进程来显著提高多节点分布式训练性能。这对于支持直接 GPU 的多 Infiniband 接口的系统尤其有益，因为所有接口都可以用于聚合通信带宽。

在单节点分布式训练或多节点分布式训练这两种情况下，该实用程序都会根据 --nproc-per-node 参数启动每个节点上的进程数。如果用于 GPU 训练，此数量必须小于或等于当前系统的 GPU 数量（nproc_per_node），并且每个进程将操作于从 *GPU 0 到 GPU (nproc_per_node - 1)* 的单个 GPU。

如何使用此模块

单节点多进程分布式训练

python -m torch.distributed.launch --nproc-per-node=NUM_GPUS_YOU_HAVE
           YOUR_TRAINING_SCRIPT.py (--arg1 --arg2 --arg3 and all other
           arguments of your training script)

多节点多进程分布式训练：(例如，两个节点)

节点 1：*(IP：192.168.1.1，并有一个空闲端口：1234)*

python -m torch.distributed.launch --nproc-per-node=NUM_GPUS_YOU_HAVE
           --nnodes=2 --node-rank=0 --master-addr="192.168.1.1"
           --master-port=1234 YOUR_TRAINING_SCRIPT.py (--arg1 --arg2 --arg3
           and all other arguments of your training script)

节点 2

python -m torch.distributed.launch --nproc-per-node=NUM_GPUS_YOU_HAVE
           --nnodes=2 --node-rank=1 --master-addr="192.168.1.1"
           --master-port=1234 YOUR_TRAINING_SCRIPT.py (--arg1 --arg2 --arg3
           and all other arguments of your training script)

要查看此模块提供的可选参数

python -m torch.distributed.launch --help

重要通知

1. 该实用程序和多进程分布式（单节点或多节点）GPU 训练目前仅在使用 NCCL 分布式后端时能达到最佳性能。因此， NCCL 后端是 GPU 训练推荐使用的后端。

2. 在您的训练程序中，必须解析由本模块提供的命令行参数：--local-rank=LOCAL_PROCESS_RANK。如果您的训练程序使用 GPU，您应该确保您的代码仅在 LOCAL_PROCESS_RANK 的 GPU 设备上运行。这可以通过以下方式实现：

解析 local_rank 参数

>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument("--local-rank", "--local_rank", type=int)
>>> args = parser.parse_args()

使用以下任一方式将您的设备设置为 local rank：

>>> torch.cuda.set_device(args.local_rank)  # before your code runs

或

>>> with torch.cuda.device(args.local_rank):
>>>    # your code to run
>>>    ...

版本 2.0.0 中已更改：启动器会将 --local-rank=<rank> 参数传递给您的脚本。从 PyTorch 2.0.0 开始，推荐使用带连字符的 --local-rank 而非之前使用的带下划线的 --local_rank。

为了向后兼容，用户可能需要在其参数解析代码中同时处理这两种情况。这意味着在参数解析器中包含 "--local-rank" 和 "--local_rank"。如果只提供了 "--local_rank"，启动器将触发一个错误：“error: unrecognized arguments: –local-rank=<rank>”。对于仅支持 PyTorch 2.0.0+ 的训练代码，包含 "--local-rank" 应该就足够了。

3. 在您的训练程序中，您应该在开始时调用以下函数来启动分布式后端。强烈推荐使用 init_method=env://。其他初始化方法（例如 tcp://）也可能有效，但 env:// 是该模块官方支持的方法。

>>> torch.distributed.init_process_group(backend='YOUR BACKEND',
>>>                                      init_method='env://')

4. 在您的训练程序中，您可以使用常规的分布式函数，或者使用 torch.nn.parallel.DistributedDataParallel() 模块。如果您的训练程序使用 GPU 进行训练，并且您想使用 torch.nn.parallel.DistributedDataParallel() 模块，配置方法如下。

>>> model = torch.nn.parallel.DistributedDataParallel(model,
>>>                                                   device_ids=[args.local_rank],
>>>                                                   output_device=args.local_rank)

请确保 device_ids 参数设置为您的代码将要操作的唯一 GPU 设备 ID。这通常是 local rank。换句话说，device_ids 需要是 [args.local_rank]，并且 output_device 需要是 args.local_rank 才能使用此实用程序。

5. 另一种通过环境变量 LOCAL_RANK 将 local_rank 传递给子进程的方法。当您使用 --use-env=True 启动脚本时，此功能将被启用。您必须调整上面的子进程示例，将 args.local_rank 替换为 os.environ['LOCAL_RANK']；当您指定此标志时，启动器将不会传递 --local-rank。

警告

local_rank **不**是全局唯一的：它只在同一台机器上的进程之间是唯一的。因此，不要用它来决定是否应该，例如，写入网络文件系统。有关可能出错的示例，请参阅 pytorch/pytorch#12042。

启动实用程序#

Multiprocessing package - torch.multiprocessing 包还提供了 torch.multiprocessing.spawn() 中的 spawn 函数。此辅助函数可用于启动多个进程。它通过传入您想要运行的函数来工作，并启动 N 个进程来运行它。这也可以用于多进程分布式训练。

有关如何使用它的参考，请参阅 PyTorch 示例 - ImageNet 实现

请注意，此函数需要 Python 3.4 或更高版本。

调试 `torch.distributed` 应用程序#

由于难以理解的挂起、崩溃或跨 rank 的不一致行为，调试分布式应用程序可能具有挑战性。torch.distributed 提供了一套工具来帮助用户自行调试训练应用程序。

Python 断点#

在分布式环境中，使用 Python 的调试器非常方便，但由于它不能开箱即用，许多人根本不使用它。PyTorch 提供了一个围绕 pdb 的自定义包装器，可以简化此过程。

torch.distributed.breakpoint 使此过程变得容易。在内部，它通过两种方式自定义了 pdb 的断点行为，但否则与正常的 pdb 行为一致。

仅在一个 rank（用户指定）上附加调试器。
通过使用 torch.distributed.barrier() 来确保所有其他 rank 停止，一旦被调试的 rank 发出 continue 命令，就会释放。
将 stdin 从子进程重定向，以便它连接到您的终端。

要使用它，只需在每个 rank 上发出 torch.distributed.breakpoint(rank)，并在每种情况下使用相同的 rank 值。

监控屏障#

从 v1.10 开始，torch.distributed.monitored_barrier() 作为 torch.distributed.barrier() 的替代方案而存在，当出现崩溃时（即并非所有 rank 都在提供的超时时间内调用 torch.distributed.monitored_barrier()），它会提供有关哪个 rank 可能存在问题的有用信息。 torch.distributed.monitored_barrier() 使用 send/recv 通信原语实现了主机端屏障，其过程类似于确认，允许 rank 0 报告哪个（些）rank 未及时确认屏障。例如，考虑以下函数，其中 rank 1 未调用 torch.distributed.monitored_barrier()（在实际情况中，这可能是由于应用程序 bug 或先前集体操作的挂起）。

import os
from datetime import timedelta

import torch
import torch.distributed as dist
import torch.multiprocessing as mp


def worker(rank):
    dist.init_process_group("nccl", rank=rank, world_size=2)
    # monitored barrier requires gloo process group to perform host-side sync.
    group_gloo = dist.new_group(backend="gloo")
    if rank not in [1]:
        dist.monitored_barrier(group=group_gloo, timeout=timedelta(seconds=2))


if __name__ == "__main__":
    os.environ["MASTER_ADDR"] = "localhost"
    os.environ["MASTER_PORT"] = "29501"
    mp.spawn(worker, nprocs=2, args=())

以下错误消息将在 rank 0 上生成，允许用户确定哪个（些）rank 可能存在问题并进一步调查。

RuntimeError: Rank 1 failed to pass monitoredBarrier in 2000 ms
 Original exception:
[gloo/transport/tcp/pair.cc:598] Connection closed by peer [2401:db00:eef0:1100:3560:0:1c05:25d]:8594

`TORCH_DISTRIBUTED_DEBUG`#

通过 TORCH_CPP_LOG_LEVEL=INFO，可以使用环境变量 TORCH_DISTRIBUTED_DEBUG 来触发额外的有用的日志记录和集体同步检查，以确保所有 rank 都得到适当的同步。TORCH_DISTRIBUTED_DEBUG 可以设置为 OFF（默认）、INFO 或 DETAIL，具体取决于所需的调试级别。请注意，最详细的选项 DETAIL 可能会影响应用程序性能，因此应仅在调试问题时使用。

将 TORCH_DISTRIBUTED_DEBUG=INFO 设置为在初始化使用 torch.nn.parallel.DistributedDataParallel() 训练的模型时产生额外的调试日志，而 TORCH_DISTRIBUTED_DEBUG=DETAIL 将额外记录选定迭代次数的运行时性能统计信息。这些运行时统计信息包括前向传播时间、后向传播时间、梯度通信时间等数据。例如，给定以下应用程序：

import os

import torch
import torch.distributed as dist
import torch.multiprocessing as mp


class TwoLinLayerNet(torch.nn.Module):
    def __init__(self):
        super().__init__()
        self.a = torch.nn.Linear(10, 10, bias=False)
        self.b = torch.nn.Linear(10, 1, bias=False)

    def forward(self, x):
        a = self.a(x)
        b = self.b(x)
        return (a, b)


def worker(rank):
    dist.init_process_group("nccl", rank=rank, world_size=2)
    torch.cuda.set_device(rank)
    print("init model")
    model = TwoLinLayerNet().cuda()
    print("init ddp")
    ddp_model = torch.nn.parallel.DistributedDataParallel(model, device_ids=[rank])

    inp = torch.randn(10, 10).cuda()
    print("train")

    for _ in range(20):
        output = ddp_model(inp)
        loss = output[0] + output[1]
        loss.sum().backward()


if __name__ == "__main__":
    os.environ["MASTER_ADDR"] = "localhost"
    os.environ["MASTER_PORT"] = "29501"
    os.environ["TORCH_CPP_LOG_LEVEL"]="INFO"
    os.environ[
        "TORCH_DISTRIBUTED_DEBUG"
    ] = "DETAIL"  # set to DETAIL for runtime logging.
    mp.spawn(worker, nprocs=2, args=())

初始化时会生成以下日志：

I0607 16:10:35.739390 515217 logger.cpp:173] [Rank 0]: DDP Initialized with:
broadcast_buffers: 1
bucket_cap_bytes: 26214400
find_unused_parameters: 0
gradient_as_bucket_view: 0
is_multi_device_module: 0
iteration: 0
num_parameter_tensors: 2
output_device: 0
rank: 0
total_parameter_size_bytes: 440
world_size: 2
backend_name: nccl
bucket_sizes: 440
cuda_visible_devices: N/A
device_ids: 0
dtypes: float
master_addr: localhost
master_port: 29501
module_name: TwoLinLayerNet
nccl_async_error_handling: N/A
nccl_blocking_wait: N/A
nccl_debug: WARN
nccl_ib_timeout: N/A
nccl_nthreads: N/A
nccl_socket_ifname: N/A
torch_distributed_debug: INFO

运行时会生成以下日志（当设置 TORCH_DISTRIBUTED_DEBUG=DETAIL 时）：

I0607 16:18:58.085681 544067 logger.cpp:344] [Rank 1 / 2] Training TwoLinLayerNet unused_parameter_size=0
 Avg forward compute time: 40838608
 Avg backward compute time: 5983335
Avg backward comm. time: 4326421
 Avg backward comm/comp overlap time: 4207652
I0607 16:18:58.085693 544066 logger.cpp:344] [Rank 0 / 2] Training TwoLinLayerNet unused_parameter_size=0
 Avg forward compute time: 42850427
 Avg backward compute time: 3885553
Avg backward comm. time: 2357981
 Avg backward comm/comp overlap time: 2234674

此外，TORCH_DISTRIBUTED_DEBUG=INFO 增强了 torch.nn.parallel.DistributedDataParallel() 中由于模型中存在未使用的参数而导致的崩溃日志。目前，如果在初始化 torch.nn.parallel.DistributedDataParallel() 时传递了 find_unused_parameters=True，则可能存在前向传播中未使用的参数，并且从 v1.10 开始，模型的所有输出都必须用于损失计算，因为 torch.nn.parallel.DistributedDataParallel() 不支持后向传播中的未使用参数。这些约束对于大型模型尤其具有挑战性，因此当发生崩溃时，torch.nn.parallel.DistributedDataParallel() 将会记录所有未使用的参数的完整限定名称。例如，在上述应用程序中，如果我们修改 loss 以便计算为 loss = output[1]，那么 TwoLinLayerNet.a 在后向传播中将不会接收到梯度，因此会导致 DDP 失败。在崩溃时，用户会收到有关未使用参数的信息，而对于大型模型来说，这些信息可能很难手动找到。

RuntimeError: Expected to have finished reduction in the prior iteration before starting a new one. This error indicates that your module has parameters that were not used in producing loss. You can enable unused parameter detection by passing
 the keyword argument `find_unused_parameters=True` to `torch.nn.parallel.DistributedDataParallel`, and by
making sure all `forward` function outputs participate in calculating loss.
If you already have done the above, then the distributed data parallel module wasn't able to locate the output tensors in the return value of your module's `forward` function. Please include the loss function and the structure of the return va
lue of `forward` of your module when reporting this issue (e.g. list, dict, iterable).
Parameters which did not receive grad for rank 0: a.weight
Parameter indices which did not receive grad for rank 0: 0

将 TORCH_DISTRIBUTED_DEBUG=DETAIL 设置将触发对用户直接或间接发出的每个集体调用（例如 DDP allreduce）的额外一致性和同步检查。这是通过创建一个包装器进程组来实现的，该进程组包装由 torch.distributed.init_process_group() 和 torch.distributed.new_group() API 返回的所有进程组。因此，这些 API 将返回一个包装器进程组，该进程组可以用作常规进程组，但在将集体操作分派到底层进程组之前会执行一致性检查。目前，这些检查包括一个 torch.distributed.monitored_barrier()，它确保所有 rank 完成其挂起的集体调用，并报告卡住的 rank。接下来，通过确保所有集体函数匹配并以一致的张量形状调用来检查集体本身的一致性。如果不是这种情况，当应用程序崩溃时，会包含一个详细的错误报告，而不是挂起或无信息的错误消息。例如，考虑以下函数，该函数在 torch.distributed.all_reduce() 中具有不匹配的输入形状：

import torch
import torch.distributed as dist
import torch.multiprocessing as mp


def worker(rank):
    dist.init_process_group("nccl", rank=rank, world_size=2)
    torch.cuda.set_device(rank)
    tensor = torch.randn(10 if rank == 0 else 20).cuda()
    dist.all_reduce(tensor)
    torch.cuda.synchronize(device=rank)


if __name__ == "__main__":
    os.environ["MASTER_ADDR"] = "localhost"
    os.environ["MASTER_PORT"] = "29501"
    os.environ["TORCH_CPP_LOG_LEVEL"]="INFO"
    os.environ["TORCH_DISTRIBUTED_DEBUG"] = "DETAIL"
    mp.spawn(worker, nprocs=2, args=())

使用 NCCL 后端，此类应用程序可能会导致挂起，而在非平凡场景中，这可能难以追溯根本原因。如果用户启用 TORCH_DISTRIBUTED_DEBUG=DETAIL 并重新运行应用程序，以下错误消息将揭示根本原因：

work = default_pg.allreduce([tensor], opts)
RuntimeError: Error when verifying shape tensors for collective ALLREDUCE on rank 0. This likely indicates that input shapes into the collective are mismatched across ranks. Got shapes:  10
[ torch.LongTensor{1} ]

注意

有关运行时调试级别的精细控制，还可以使用函数 torch.distributed.set_debug_level()、torch.distributed.set_debug_level_from_env() 和 torch.distributed.get_debug_level()。

此外，TORCH_DISTRIBUTED_DEBUG=DETAIL 可以与 TORCH_SHOW_CPP_STACKTRACES=1 结合使用，在检测到集体操作不同步时记录整个调用堆栈。这些集体操作不同步检查将适用于所有使用 c10d 集体调用，并由使用 torch.distributed.init_process_group() 和 torch.distributed.new_group() API 创建的进程组支持的应用程序。

日志记录#

除了通过 torch.distributed.monitored_barrier() 和 TORCH_DISTRIBUTED_DEBUG 提供的显式调试支持外，torch.distributed 的底层 C++ 库还会输出不同级别的日志消息。这些消息有助于理解分布式训练作业的执行状态，并排查网络连接失败等问题。下表显示了如何通过 TORCH_CPP_LOG_LEVEL 和 TORCH_DISTRIBUTED_DEBUG 环境变量的组合来调整日志级别。

`TORCH_CPP_LOG_LEVEL`	`TORCH_DISTRIBUTED_DEBUG`	生效日志级别
`ERROR`	ignored	错误
`WARNING`	ignored	警告
`INFO`	ignored	Info
`INFO`	`INFO`	Debug
`INFO`	`DETAIL`	Trace (a.k.a. All)

分布式组件会引发派生自 RuntimeError 的自定义异常类型。

torch.distributed.DistError: 这是所有分布式异常的基类。
torch.distributed.DistBackendError: 当发生后端特定的错误时会抛出此异常。例如，如果使用 NCCL 后端，而用户尝试使用 NCCL 库无法访问的 GPU。
torch.distributed.DistNetworkError: 当网络库遇到错误时（例如：连接被远程主机重置）会抛出此异常。
torch.distributed.DistStoreError: 当 Store 遇到错误时（例如：TCPStore 超时）会抛出此异常。

class torch.distributed.DistError#: 分布式库中发生错误时引发的异常

class torch.distributed.DistBackendError#: 分布式中发生后端错误时引发的异常

class torch.distributed.DistNetworkError#: 分布式中发生网络错误时引发的异常

class torch.distributed.DistStoreError#: 分布式存储中发生错误时引发的异常

如果您正在进行单节点训练，则可以方便地对脚本进行交互式断点。我们提供了一种方便地对单个 rank 进行断点的方法。

torch.distributed.breakpoint(rank=0, skip=0, timeout_s=3600)[source]#

设置一个断点，但仅在一个 rank 上。所有其他 rank 将等待您完成断点后再继续。

参数

rank (int) – 要断在哪一个 rank。默认值：0
skip (int) – 跳过对该断点的前 skip 次调用。默认值：0。

分布式通信包 - torch.distributed#

后端#

PyTorch 自带的后端#

选择哪个后端？#

常用环境变量#

选择要使用的网络接口#

其他 NCCL 环境变量#

基础#

初始化#

TCP 初始化#

共享文件系统初始化#

环境变量初始化#

改进初始化时间#

初始化后#

关闭#

重新初始化#

组#

DeviceMesh#

点对点通信#

同步和异步集合通信操作#

集合通信函数#

分布式键值存储#

剖析集合通信#

多 GPU 集合函数#

对象集合#

第三方后端#

启动实用程序#

启动实用程序#

调试 torch.distributed 应用程序#

Python 断点#

监控屏障#

TORCH_DISTRIBUTED_DEBUG#

日志记录#

文档

教程

资源

调试 `torch.distributed` 应用程序#

`TORCH_DISTRIBUTED_DEBUG`#