使用 PyTorch 编写分布式应用程序¶

注意

在 github 上查看和编辑本教程。

先决条件

PyTorch 分布式概述

在本简短教程中，我们将介绍 PyTorch 的分布式包。我们将了解如何设置分布式环境、使用不同的通信策略，以及了解该包的一些内部机制。

设置¶

PyTorch 中包含的分布式包（即 torch.distributed）使研究人员和从业人员能够轻松地跨进程和机器集群并行化他们的计算。为此，它利用消息传递语义，允许每个进程将数据通信到任何其他进程。与 multiprocessing (torch.multiprocessing) 包相反，进程可以使用不同的通信后端，并且不限于在同一台机器上执行。

为了开始，我们需要能够同时运行多个进程。如果您有权访问计算集群，您应该咨询您的本地系统管理员或使用您喜欢的协调工具（例如，pdsh、clustershell或其他）。出于本教程的目的，我们将使用单台机器并使用以下模板生成多个进程。

"""run.py:"""
#!/usr/bin/env python
import os
import torch
import torch.distributed as dist
import torch.multiprocessing as mp

def run(rank, size):
    """ Distributed function to be implemented later. """
    pass

def init_process(rank, size, fn, backend='gloo'):
    """ Initialize the distributed environment. """
    os.environ['MASTER_ADDR'] = '127.0.0.1'
    os.environ['MASTER_PORT'] = '29500'
    dist.init_process_group(backend, rank=rank, world_size=size)
    fn(rank, size)


if __name__ == "__main__":
    size = 2
    processes = []
    mp.set_start_method("spawn")
    for rank in range(size):
        p = mp.Process(target=init_process, args=(rank, size, run))
        p.start()
        processes.append(p)

    for p in processes:
        p.join()

以上脚本生成两个进程，每个进程将分别设置分布式环境、初始化进程组（dist.init_process_group），最后执行给定的run函数。

让我们看看init_process函数。它确保每个进程都能够通过一个主进程进行协调，使用相同的IP地址和端口。请注意，我们使用了gloo后端，但还有其他后端可用。（参见第5.1节）我们将在本教程的最后介绍dist.init_process_group中发生的“魔法”，但它本质上允许进程通过共享其位置相互通信。

点对点通信¶

发送和接收¶

从一个进程到另一个进程的数据传输称为点对点通信。这些通过send和recv函数或它们的“立即”对应函数isend和irecv来实现。

"""Blocking point-to-point communication."""

def run(rank, size):
    tensor = torch.zeros(1)
    if rank == 0:
        tensor += 1
        # Send the tensor to process 1
        dist.send(tensor=tensor, dst=1)
    else:
        # Receive tensor from process 0
        dist.recv(tensor=tensor, src=0)
    print('Rank ', rank, ' has data ', tensor[0])

在上面的示例中，两个进程都以零张量开始，然后进程0递增张量并将其发送到进程1，以便它们最终都得到1.0。请注意，进程1需要分配内存来存储它将接收的数据。

还要注意send/recv是**阻塞**的：两个进程都停止，直到通信完成。另一方面，立即操作是**非阻塞**的；脚本继续执行，并且方法在我们可以选择wait()的Work对象上返回。

"""Non-blocking point-to-point communication."""

def run(rank, size):
    tensor = torch.zeros(1)
    req = None
    if rank == 0:
        tensor += 1
        # Send the tensor to process 1
        req = dist.isend(tensor=tensor, dst=1)
        print('Rank 0 started sending')
    else:
        # Receive tensor from process 0
        req = dist.irecv(tensor=tensor, src=0)
        print('Rank 1 started receiving')
    req.wait()
    print('Rank ', rank, ' has data ', tensor[0])

使用立即操作时，我们必须小心如何使用发送和接收的张量。由于我们不知道数据何时会传送到另一个进程，因此在req.wait()完成之前，我们不应该修改发送的张量，也不应该访问接收的张量。换句话说，

在dist.isend()之后写入tensor将导致未定义的行为。
在dist.irecv()之后从tensor读取将导致未定义的行为。

但是，在req.wait()执行后，我们可以保证通信已发生，并且tensor[0]中存储的值为1.0。

当我们想要更细粒度地控制进程的通信时，点对点通信很有用。它们可用于实现复杂的算法，例如百度DeepSpeech或Facebook的大规模实验中使用的算法。（参见第4.1节）

集体通信¶

散射¶	收集¶
归约¶	全归约¶
广播¶	全收集¶

与点对点通信相反，集体通信允许在**组**中的所有进程之间进行通信模式。组是所有进程的一个子集。要创建组，我们可以将秩列表传递给dist.new_group(group)。默认情况下，集体通信在所有进程上执行，也称为**世界**。例如，为了获取所有进程上所有张量的总和，我们可以使用dist.all_reduce(tensor, op, group)集体通信。

""" All-Reduce example."""
def run(rank, size):
    """ Simple collective communication. """
    group = dist.new_group([0, 1])
    tensor = torch.ones(1)
    dist.all_reduce(tensor, op=dist.ReduceOp.SUM, group=group)
    print('Rank ', rank, ' has data ', tensor[0])

由于我们想要组中所有张量的总和，因此我们使用dist.ReduceOp.SUM作为归约运算符。一般来说，任何可交换的数学运算都可以用作运算符。PyTorch开箱即用地提供了4个这样的运算符，它们都在元素级上工作。

dist.ReduceOp.SUM,
dist.ReduceOp.PRODUCT,
dist.ReduceOp.MAX,
dist.ReduceOp.MIN.

除了dist.all_reduce(tensor, op, group)之外，PyTorch目前总共实现了6种集体通信。

dist.broadcast(tensor, src, group)：将tensor从src复制到所有其他进程。
dist.reduce(tensor, dst, op, group)：将op应用于每个tensor并将结果存储在dst中。
dist.all_reduce(tensor, op, group)：与reduce相同，但结果存储在所有进程中。
dist.scatter(tensor, scatter_list, src, group)：将第\(i^{\text{th}}\)个张量scatter_list[i]复制到第\(i^{\text{th}}\)个进程。
dist.gather(tensor, gather_list, dst, group)：将tensor从dst中的所有进程复制。
dist.all_gather(tensor_list, tensor, group)：将tensor从所有进程复制到tensor_list，在所有进程上。
dist.barrier(group)：阻塞group中的所有进程，直到每个进程都进入此函数。

分布式训练¶

注意：您可以在此GitHub存储库中找到本节的示例脚本。

现在我们了解了分布式模块的工作原理，让我们用它编写一些有用的东西。我们的目标是复制DistributedDataParallel的功能。当然，这将是一个教学示例，在实际情况下，您应该使用上面链接的官方、经过测试和优化的版本。

简单来说，我们想要实现随机梯度下降的分布式版本。我们的脚本将让所有进程计算其模型在其数据批次上的梯度，然后平均其梯度。为了确保在更改进程数量时获得类似的收敛结果，我们首先必须对数据集进行分区。（您也可以使用tnt.dataset.SplitDataset，而不是下面的代码段。）

""" Dataset partitioning helper """
class Partition(object):

    def __init__(self, data, index):
        self.data = data
        self.index = index

    def __len__(self):
        return len(self.index)

    def __getitem__(self, index):
        data_idx = self.index[index]
        return self.data[data_idx]


class DataPartitioner(object):

    def __init__(self, data, sizes=[0.7, 0.2, 0.1], seed=1234):
        self.data = data
        self.partitions = []
        rng = Random()  # from random import Random
        rng.seed(seed)
        data_len = len(data)
        indexes = [x for x in range(0, data_len)]
        rng.shuffle(indexes)

        for frac in sizes:
            part_len = int(frac * data_len)
            self.partitions.append(indexes[0:part_len])
            indexes = indexes[part_len:]

    def use(self, partition):
        return Partition(self.data, self.partitions[partition])

使用上面的代码段，我们现在可以使用以下几行代码轻松地对任何数据集进行分区。

""" Partitioning MNIST """
def partition_dataset():
    dataset = datasets.MNIST('./data', train=True, download=True,
                             transform=transforms.Compose([
                                 transforms.ToTensor(),
                                 transforms.Normalize((0.1307,), (0.3081,))
                             ]))
    size = dist.get_world_size()
    bsz = 128 // size
    partition_sizes = [1.0 / size for _ in range(size)]
    partition = DataPartitioner(dataset, partition_sizes)
    partition = partition.use(dist.get_rank())
    train_set = torch.utils.data.DataLoader(partition,
                                         batch_size=bsz,
                                         shuffle=True)
    return train_set, bsz

假设我们有2个副本，那么每个进程将有60000 / 2 = 30000个样本的train_set。我们还将批次大小除以副本数量，以保持128的**整体**批次大小。

我们现在可以编写我们通常的前向-后向-优化训练代码，并添加一个函数调用来平均我们模型的梯度。（以下内容主要受到官方PyTorch MNIST示例的启发。）

""" Distributed Synchronous SGD Example """
def run(rank, size):
    torch.manual_seed(1234)
    train_set, bsz = partition_dataset()
    model = Net()
    optimizer = optim.SGD(model.parameters(),
                          lr=0.01, momentum=0.5)

    num_batches = ceil(len(train_set.dataset) / float(bsz))
    for epoch in range(10):
        epoch_loss = 0.0
        for data, target in train_set:
            optimizer.zero_grad()
            output = model(data)
            loss = F.nll_loss(output, target)
            epoch_loss += loss.item()
            loss.backward()
            average_gradients(model)
            optimizer.step()
        print('Rank ', dist.get_rank(), ', epoch ',
              epoch, ': ', epoch_loss / num_batches)

剩下的就是实现average_gradients(model)函数，它简单地接收一个模型并在整个世界中平均其梯度。

""" Gradient averaging. """
def average_gradients(model):
    size = float(dist.get_world_size())
    for param in model.parameters():
        dist.all_reduce(param.grad.data, op=dist.ReduceOp.SUM)
        param.grad.data /= size

瞧！我们成功实现了分布式同步SGD，并且可以在大型计算机集群上训练任何模型。

注意：虽然最后一句话在**技术上**是正确的，但要实现同步SGD的生产级实现，还需要更多技巧。再次强调，请使用经过测试和优化的内容。

我们自己的环形全归约¶

作为一个额外的挑战，假设我们想要实现DeepSpeech的高效环形全归约。使用点对点集体通信可以很容易地实现这一点。

""" Implementation of a ring-reduce with addition. """
def allreduce(send, recv):
   rank = dist.get_rank()
   size = dist.get_world_size()
   send_buff = send.clone()
   recv_buff = send.clone()
   accum = send.clone()

   left = ((rank - 1) + size) % size
   right = (rank + 1) % size

   for i in range(size - 1):
       if i % 2 == 0:
           # Send send_buff
           send_req = dist.isend(send_buff, right)
           dist.recv(recv_buff, left)
           accum[:] += recv_buff[:]
       else:
           # Send recv_buff
           send_req = dist.isend(recv_buff, right)
           dist.recv(send_buff, left)
           accum[:] += send_buff[:]
       send_req.wait()
   recv[:] = accum[:]

在上面的脚本中，allreduce(send, recv)函数的签名与PyTorch中的略有不同。它接收一个recv张量，并将所有send张量的总和存储在其中。作为留给读者的练习，我们的版本和DeepSpeech中的版本之间仍然存在一个差异：它们的实现将梯度张量划分为**块**，以便最佳地利用通信带宽。（提示：torch.chunk）

高级主题¶

现在我们准备探索torch.distributed的一些更高级的功能。由于内容很多，本节分为两个小节。

通信后端：我们将学习如何使用MPI和Gloo进行GPU-GPU通信。
初始化方法：我们将了解如何在dist.init_process_group()中最佳地设置初始协调阶段。

通信后端¶

torch.distributed 最优雅的方面之一是其能够抽象并构建在不同后端之上的能力。如前所述，PyTorch 目前实现了三个后端：Gloo、NCCL 和 MPI。它们各自具有不同的规格和权衡，具体取决于所需的用例。支持的功能比较表可以在这里找到。

Gloo 后端

到目前为止，我们已经广泛使用了Gloo 后端。它作为开发平台非常方便，因为它包含在预编译的 PyTorch 二进制文件中，并且可以在 Linux（从 0.2 版开始）和 macOS（从 1.3 版开始）上运行。它支持 CPU 上的所有点对点和集体操作，以及 GPU 上的所有集体操作。CUDA 张量的集体操作实现没有 NCCL 后端提供的那么优化。

您肯定已经注意到，如果将 model 放到 GPU 上，我们的分布式 SGD 示例将无法运行。为了使用多个 GPU，让我们也进行以下修改

使用 device = torch.device("cuda:{}".format(rank))
model = Net() \(\rightarrow\) model = Net().to(device)
使用 data, target = data.to(device), target.to(device)

通过以上修改，我们的模型现在正在两个 GPU 上进行训练，您可以使用 watch nvidia-smi 监控它们的利用率。

MPI 后端

消息传递接口 (MPI) 是高性能计算领域中的一种标准化工具。它允许进行点对点和集体通信，并且是 torch.distributed API 的主要灵感来源。MPI 存在多种实现（例如 Open-MPI、MVAPICH2、Intel MPI），每种实现都针对不同的目的进行了优化。使用 MPI 后端的好处在于 MPI 在大型计算机集群中具有广泛的可用性和高级别的优化。一些最近的实现也能够利用 CUDA IPC 和 GPU Direct 技术来避免通过 CPU 进行内存复制。

不幸的是，PyTorch 的二进制文件无法包含 MPI 实现，我们必须手动重新编译它。幸运的是，鉴于编译后，PyTorch 会自行查找可用的 MPI 实现，因此此过程相当简单。以下步骤通过从源代码安装 PyTorch 来安装 MPI 后端。从源代码。

创建并激活您的 Anaconda 环境，按照指南安装所有先决条件，但**不要**运行 python setup.py install。
选择并安装您喜欢的 MPI 实现。请注意，启用 CUDA 感知 MPI 可能需要一些额外的步骤。在我们的例子中，我们将坚持使用不带 GPU 支持的 Open-MPI：conda install -c conda-forge openmpi
现在，转到您克隆的 PyTorch 存储库并执行 python setup.py install。

为了测试我们新安装的后端，需要进行一些修改。

将 if __name__ == '__main__': 下的内容替换为 init_process(0, 0, run, backend='mpi')。
运行 mpirun -n 4 python myscript.py。

进行这些更改的原因是 MPI 需要在生成进程之前创建自己的环境。MPI 还将生成自己的进程并执行初始化方法中描述的握手，从而使 init_process_group 的 rank 和 size 参数变得多余。这实际上非常强大，因为您可以将其他参数传递给 mpirun 以调整每个进程的计算资源。（例如每个进程的核心数、手动将机器分配给特定等级以及更多）这样做，您应该获得与其他通信后端相同的熟悉输出。

NCCL 后端

NCCL 后端提供了针对 CUDA 张量的集体操作的优化实现。如果您仅对集体操作使用 CUDA 张量，请考虑使用此后端以获得一流的性能。NCCL 后端包含在具有 CUDA 支持的预构建二进制文件中。

初始化方法¶

为了完成本教程，让我们谈谈我们调用的第一个函数：dist.init_process_group(backend, init_method)。特别是，我们将介绍不同的初始化方法，这些方法负责每个进程之间的初始协调步骤。这些方法允许您定义如何完成此协调。根据您的硬件设置，其中一种方法自然比其他方法更适合。除了以下部分外，您还应该查看官方文档。

环境变量

在本教程中，我们一直在使用环境变量初始化方法。通过在所有机器上设置以下四个环境变量，所有进程都将能够正确连接到主节点，获取有关其他进程的信息，并最终与它们进行握手。

MASTER_PORT：将在其上托管等级为 0 的进程的机器上的一个空闲端口。
MASTER_ADDR：将在其上托管等级为 0 的进程的机器的 IP 地址。
WORLD_SIZE：进程的总数，以便主节点知道要等待多少个工作节点。
RANK：每个进程的等级，以便它们知道它是主节点还是工作节点。

共享文件系统

共享文件系统要求所有进程都能访问共享文件系统，并通过共享文件协调它们。这意味着每个进程将打开文件，写入其信息，并等待所有进程都这样做。之后，所有必需的信息将随时可供所有进程使用。为了避免竞争条件，文件系统必须通过fcntl支持锁定。

dist.init_process_group(
    init_method='file:///mnt/nfs/sharedfile',
    rank=args.rank,
    world_size=4)

TCP

通过提供等级为 0 的进程的 IP 地址和可访问的端口号，可以实现通过 TCP 初始化。在这里，所有工作节点都将能够连接到等级为 0 的进程并交换有关如何相互访问的信息。

dist.init_process_group(
    init_method='tcp://10.1.1.20:23456',
    rank=args.rank,
    world_size=4)

鸣谢

我要感谢 PyTorch 开发人员在他们的实现、文档和测试方面所做的出色工作。当代码不清楚时，我总是可以依靠文档或测试来找到答案。特别是，我要感谢 Soumith Chintala、Adam Paszke 和 Natalia Gimelshein 提供有见地的评论并回答早期草稿中的问题。