目录
  • 教程 >
  • 完全分片数据并行 (FSDP) 入门
快捷方式
intermediate/FSDP_tutorial

完全分片数据并行 (FSDP) 入门

作者: Hamid Shojanazeri、Yanli Zhao、Shen Li

注意

edit 在 github 中查看和编辑本教程。

以大规模训练 AI 模型是一项具有挑战性的任务，需要大量计算能力和资源。它还带来了相当大的工程复杂性，需要处理这些大型模型的训练。PyTorch FSDP 于 PyTorch 1.11 中发布，使这变得更容易。

在本教程中，我们将展示如何使用 FSDP API，用于简单的 MNIST 模型，这些模型可以扩展到其他更大的模型，例如 HuggingFace BERT 模型、GPT 3 模型，参数数量高达 1 万亿。示例 DDP MNIST 代码借鉴于 此处。

FSDP 的工作原理

在 分布式数据并行 (DDP) 训练中，每个进程/工作器拥有模型的副本并处理一批数据，最后它使用全减少将梯度累加到不同的工作器上。在 DDP 中，模型权重和优化器状态在所有工作器上进行复制。FSDP 是一种数据并行类型，它在 DDP 等级中对模型参数、优化器状态和梯度进行分片。

在使用 FSDP 训练时，所有工作进程的 GPU 内存占用都小于使用 DDP 训练时的占用。这使得训练一些非常大的模型成为可能，因为可以将更大的模型或批次大小放入设备中。这样做会带来通信量增加的代价。通过内部优化（如重叠通信和计算）可以降低通信开销。

FSDP workflow

FSDP 工作流程

从高层次上来说，FSDP 的工作原理如下：

在构造函数中：

  • 对模型参数进行分片，每个进程只保留自己的分片。

在正向传播路径中：

  • 运行 all_gather 收集所有进程的所有分片，以恢复此 FSDP 单位中的完整参数。

  • 运行正向计算。

  • 丢弃刚刚收集的参数分片。

在反向传播路径中：

  • 运行 all_gather 收集所有进程的所有分片，以恢复此 FSDP 单位中的完整参数。

  • 运行反向计算。

  • 运行 reduce_scatter 同步梯度。

  • 丢弃参数。

可以将 FSDP 的分片视为将 DDP 梯度 all-reduce 分解为 reduce-scatter 和 all-gather。具体来说，在反向传播过程中，FSDP 减少并分散梯度，确保每个进程都拥有梯度的一个分片。然后，它在优化器步骤中更新参数的相应分片。最后，在随后的正向传播过程中，它执行 all-gather 操作来收集和组合更新后的参数分片。

FSDP allreduce

FSDP Allreduce

如何使用 FSDP

这里我们使用一个玩具模型在 MNIST 数据集上运行训练，以演示目的。这些 API 和逻辑也可以应用于训练更大的模型。

设置

1.1 安装 PyTorch 以及 Torchvision

有关安装的信息，请参阅 入门指南。

我们在一个名为 “FSDP_mnist.py” 的 Python 脚本中添加了以下代码片段。

1.2 导入必要的包

注意

本教程适用于 PyTorch 1.12 及更高版本。如果您使用的是早期版本，请将所有 size_based_auto_wrap_policy 实例替换为 default_auto_wrap_policy，并将所有 fsdp_auto_wrap_policy 实例替换为 auto_wrap_policy。

# Based on: https://github.com/pytorch/examples/blob/master/mnist/main.py
import os
import argparse
import functools
import torch
import torch.nn as nn
import torch.nn.functional as F
import torch.optim as optim
from torchvision import datasets, transforms


from torch.optim.lr_scheduler import StepLR

import torch.distributed as dist
import torch.multiprocessing as mp
from torch.nn.parallel import DistributedDataParallel as DDP
from torch.utils.data.distributed import DistributedSampler
from torch.distributed.fsdp import FullyShardedDataParallel as FSDP
from torch.distributed.fsdp.fully_sharded_data_parallel import (
    CPUOffload,
    BackwardPrefetch,
)
from torch.distributed.fsdp.wrap import (
    size_based_auto_wrap_policy,
    enable_wrap,
    wrap,
)

1.3 分布式训练设置。正如我们提到的，FSDP 是一种数据并行性，它需要分布式训练环境，因此这里我们使用两个辅助函数来初始化分布式训练的进程并进行清理。

def setup(rank, world_size):
    os.environ['MASTER_ADDR'] = 'localhost'
    os.environ['MASTER_PORT'] = '12355'

    # initialize the process group
    dist.init_process_group("nccl", rank=rank, world_size=world_size)

def cleanup():
    dist.destroy_process_group()

2.1 定义我们的手写数字分类玩具模型。

class Net(nn.Module):
    def __init__(self):
        super(Net, self).__init__()
        self.conv1 = nn.Conv2d(1, 32, 3, 1)
        self.conv2 = nn.Conv2d(32, 64, 3, 1)
        self.dropout1 = nn.Dropout(0.25)
        self.dropout2 = nn.Dropout(0.5)
        self.fc1 = nn.Linear(9216, 128)
        self.fc2 = nn.Linear(128, 10)

    def forward(self, x):

        x = self.conv1(x)
        x = F.relu(x)
        x = self.conv2(x)
        x = F.relu(x)
        x = F.max_pool2d(x, 2)
        x = self.dropout1(x)
        x = torch.flatten(x, 1)
        x = self.fc1(x)
        x = F.relu(x)
        x = self.dropout2(x)
        x = self.fc2(x)
        output = F.log_softmax(x, dim=1)
        return output

2.2 定义一个训练函数。

def train(args, model, rank, world_size, train_loader, optimizer, epoch, sampler=None):
    model.train()
    ddp_loss = torch.zeros(2).to(rank)
    if sampler:
        sampler.set_epoch(epoch)
    for batch_idx, (data, target) in enumerate(train_loader):
        data, target = data.to(rank), target.to(rank)
        optimizer.zero_grad()
        output = model(data)
        loss = F.nll_loss(output, target, reduction='sum')
        loss.backward()
        optimizer.step()
        ddp_loss[0] += loss.item()
        ddp_loss[1] += len(data)

    dist.all_reduce(ddp_loss, op=dist.ReduceOp.SUM)
    if rank == 0:
        print('Train Epoch: {} \tLoss: {:.6f}'.format(epoch, ddp_loss[0] / ddp_loss[1]))

2.3 定义一个验证函数。

def test(model, rank, world_size, test_loader):
    model.eval()
    correct = 0
    ddp_loss = torch.zeros(3).to(rank)
    with torch.no_grad():
        for data, target in test_loader:
            data, target = data.to(rank), target.to(rank)
            output = model(data)
            ddp_loss[0] += F.nll_loss(output, target, reduction='sum').item()  # sum up batch loss
            pred = output.argmax(dim=1, keepdim=True)  # get the index of the max log-probability
            ddp_loss[1] += pred.eq(target.view_as(pred)).sum().item()
            ddp_loss[2] += len(data)

    dist.all_reduce(ddp_loss, op=dist.ReduceOp.SUM)

    if rank == 0:
        test_loss = ddp_loss[0] / ddp_loss[2]
        print('Test set: Average loss: {:.4f}, Accuracy: {}/{} ({:.2f}%)\n'.format(
            test_loss, int(ddp_loss[1]), int(ddp_loss[2]),
            100. * ddp_loss[1] / ddp_loss[2]))

2.4 定义一个将模型包装在 FSDP 中的分布式训练函数。

注意：要保存 FSDP 模型，我们需要在每个进程上调用 state_dict，然后在进程 0 上保存所有状态。

def fsdp_main(rank, world_size, args):
    setup(rank, world_size)

    transform=transforms.Compose([
        transforms.ToTensor(),
        transforms.Normalize((0.1307,), (0.3081,))
    ])

    dataset1 = datasets.MNIST('../data', train=True, download=True,
                        transform=transform)
    dataset2 = datasets.MNIST('../data', train=False,
                        transform=transform)

    sampler1 = DistributedSampler(dataset1, rank=rank, num_replicas=world_size, shuffle=True)
    sampler2 = DistributedSampler(dataset2, rank=rank, num_replicas=world_size)

    train_kwargs = {'batch_size': args.batch_size, 'sampler': sampler1}
    test_kwargs = {'batch_size': args.test_batch_size, 'sampler': sampler2}
    cuda_kwargs = {'num_workers': 2,
                    'pin_memory': True,
                    'shuffle': False}
    train_kwargs.update(cuda_kwargs)
    test_kwargs.update(cuda_kwargs)

    train_loader = torch.utils.data.DataLoader(dataset1,**train_kwargs)
    test_loader = torch.utils.data.DataLoader(dataset2, **test_kwargs)
    my_auto_wrap_policy = functools.partial(
        size_based_auto_wrap_policy, min_num_params=100
    )
    torch.cuda.set_device(rank)


    init_start_event = torch.cuda.Event(enable_timing=True)
    init_end_event = torch.cuda.Event(enable_timing=True)

    model = Net().to(rank)

    model = FSDP(model)

    optimizer = optim.Adadelta(model.parameters(), lr=args.lr)

    scheduler = StepLR(optimizer, step_size=1, gamma=args.gamma)
    init_start_event.record()
    for epoch in range(1, args.epochs + 1):
        train(args, model, rank, world_size, train_loader, optimizer, epoch, sampler=sampler1)
        test(model, rank, world_size, test_loader)
        scheduler.step()

    init_end_event.record()

    if rank == 0:
        print(f"CUDA event elapsed time: {init_start_event.elapsed_time(init_end_event) / 1000}sec")
        print(f"{model}")

    if args.save_model:
        # use a barrier to make sure training is done on all ranks
        dist.barrier()
        states = model.state_dict()
        if rank == 0:
            torch.save(states, "mnist_cnn.pt")

    cleanup()

2.5 最后，解析参数并设置主函数。

if __name__ == '__main__':
    # Training settings
    parser = argparse.ArgumentParser(description='PyTorch MNIST Example')
    parser.add_argument('--batch-size', type=int, default=64, metavar='N',
                        help='input batch size for training (default: 64)')
    parser.add_argument('--test-batch-size', type=int, default=1000, metavar='N',
                        help='input batch size for testing (default: 1000)')
    parser.add_argument('--epochs', type=int, default=10, metavar='N',
                        help='number of epochs to train (default: 14)')
    parser.add_argument('--lr', type=float, default=1.0, metavar='LR',
                        help='learning rate (default: 1.0)')
    parser.add_argument('--gamma', type=float, default=0.7, metavar='M',
                        help='Learning rate step gamma (default: 0.7)')
    parser.add_argument('--no-cuda', action='store_true', default=False,
                        help='disables CUDA training')
    parser.add_argument('--seed', type=int, default=1, metavar='S',
                        help='random seed (default: 1)')
    parser.add_argument('--save-model', action='store_true', default=False,
                        help='For Saving the current Model')
    args = parser.parse_args()

    torch.manual_seed(args.seed)

    WORLD_SIZE = torch.cuda.device_count()
    mp.spawn(fsdp_main,
        args=(WORLD_SIZE, args),
        nprocs=WORLD_SIZE,
        join=True)

我们记录了 CUDA 事件来测量 FSDP 模型特性的时间。CUDA 事件时间为 110.85 秒。

python FSDP_mnist.py

CUDA event elapsed time on training loop 40.67462890625sec

使用 FSDP 包装模型后，模型将如下所示，我们可以看到模型已经被包装在一个 FSDP 单位中。或者，我们将查看添加 auto_wrap_policy，并讨论差异。

   FullyShardedDataParallel(
   (_fsdp_wrapped_module): FlattenParamsWrapper(
       (_fpw_module): Net(
       (conv1): Conv2d(1, 32, kernel_size=(3, 3), stride=(1, 1))
       (conv2): Conv2d(32, 64, kernel_size=(3, 3), stride=(1, 1))
       (dropout1): Dropout(p=0.25, inplace=False)
       (dropout2): Dropout(p=0.5, inplace=False)
       (fc1): Linear(in_features=9216, out_features=128, bias=True)
       (fc2): Linear(in_features=128, out_features=10, bias=True)
       )
   )
)

以下是在带有 4 个 GPU 的 g4dn.12.xlarge AWS EC2 实例上使用 PyTorch Profiler 从 FSDP MNIST 训练中捕获的峰值内存使用情况。

FSDP peak memory

FSDP 峰值内存使用情况

在 FSDP 中应用 auto_wrap_policy，否则，FSDP 将把整个模型放在一个 FSDP 单位中，这将降低计算效率和内存效率。它的工作原理是，假设您的模型包含 100 个线性层。如果您使用 FSDP(model)，那么将只有一个 FSDP 单位，它包装整个模型。在这种情况下，allgather 将收集所有 100 个线性层的完整参数，因此不会为参数分片节省 CUDA 内存。此外，只有一个用于所有 100 个线性层的阻塞 allgather 调用，层之间不会进行通信和计算重叠。

为了避免这种情况，您可以传入一个 auto_wrap_policy，它将在满足指定条件（例如，大小限制）时自动密封当前的 FSDP 单位并开始一个新的单位。这样，您将拥有多个 FSDP 单位，并且一次只需要一个 FSDP 单位来收集完整参数。例如，假设您有 5 个 FSDP 单位，每个单位包装 20 个线性层。那么，在正向传播过程中，第一个 FSDP 单位将为前 20 个线性层收集参数，进行计算，丢弃参数，然后继续进行接下来的 20 个线性层。因此，在任何时间点，每个进程只实际使用 20 个线性层的参数/梯度，而不是 100 个。

为了在 2.4 中实现这一点，我们定义了 auto_wrap_policy 并将其传递给 FSDP 包装器，在以下示例中，my_auto_wrap_policy 定义了一个层可以被 FSDP 包装或分片，如果该层中的参数数量大于 100。如果该层中的参数数量小于 100，它将与其他小层一起被 FSDP 包装。找到最佳的自动包装策略具有挑战性，PyTorch 将在未来添加此配置的自动调整功能。如果没有自动调整工具，最好通过实验使用不同的自动包装策略来分析您的工作流程，并找到最佳的策略。

my_auto_wrap_policy = functools.partial(
        size_based_auto_wrap_policy, min_num_params=20000
    )
torch.cuda.set_device(rank)
model = Net().to(rank)

model = FSDP(model,
    auto_wrap_policy=my_auto_wrap_policy)

应用 auto_wrap_policy 后，模型将如下所示。

  FullyShardedDataParallel(
(_fsdp_wrapped_module): FlattenParamsWrapper(
  (_fpw_module): Net(
    (conv1): Conv2d(1, 32, kernel_size=(3, 3), stride=(1, 1))
    (conv2): Conv2d(32, 64, kernel_size=(3, 3), stride=(1, 1))
    (dropout1): Dropout(p=0.25, inplace=False)
    (dropout2): Dropout(p=0.5, inplace=False)
    (fc1): FullyShardedDataParallel(
      (_fsdp_wrapped_module): FlattenParamsWrapper(
        (_fpw_module): Linear(in_features=9216, out_features=128, bias=True)
      )
    )
    (fc2): Linear(in_features=128, out_features=10, bias=True)
  )
)

python FSDP_mnist.py

CUDA event elapsed time on training loop 41.89130859375sec

以下是在带有 4 个 GPU 的 g4dn.12.xlarge AWS EC2 实例上使用 PyTorch Profiler 从带有 auto_wrap 策略的 FSDP MNIST 训练中捕获的峰值内存使用情况。可以观察到，与没有应用 auto_wrap 策略的 FSDP 相比，每个设备的峰值内存使用情况更低，从大约 75 MB 降至 66 MB。

FSDP peak memory

使用 Auto_wrap 策略的 FSDP 峰值内存使用情况

CPU 卸载：如果模型非常大，即使使用 FSDP 也无法放入 GPU，那么 CPU 卸载在这里可以提供帮助。

目前，只支持参数和梯度 CPU 卸载。可以通过传入 cpu_offload=CPUOffload(offload_params=True) 来启用它。

请注意，这目前隐式地启用了梯度卸载到 CPU，以便参数和梯度位于同一个设备上，以便与优化器一起使用。此 API 可能会发生变化。默认值为 None，在这种情况下不会进行卸载。

使用此功能可能会显著减慢训练速度，因为需要频繁地将张量从主机复制到设备，但这有助于提高内存效率并训练更大规模的模型。

在 2.4 中，我们只是将其添加到 FSDP 包装器中。

model = FSDP(model,
    auto_wrap_policy=my_auto_wrap_policy,
    cpu_offload=CPUOffload(offload_params=True))

与 DDP 进行比较，如果在 2.4 中我们只是简单地将模型包装在 DPP 中，并在 “DDP_mnist.py” 中保存更改。

model = Net().to(rank)
model = DDP(model)

python DDP_mnist.py

CUDA event elapsed time on training loop 39.77766015625sec

以下是在带有 4 个 GPU 的 g4dn.12.xlarge AWS EC2 实例上使用 PyTorch Profiler 从 DDP MNIST 训练中捕获的峰值内存使用情况。

FSDP peak memory

使用 Auto_wrap 策略的 DDP 峰值内存使用情况

考虑到这里定义的玩具示例和微小的 MNIST 模型，我们可以观察到 DDP 和 FSDP 的峰值内存使用情况之间的差异。在 DDP 中，每个进程都保存模型的副本，因此与 FSDP 相比，内存占用更高，FSDP 对模型参数、优化器状态和梯度进行了分片，并将它们分布在 DDP 进程上。使用带有 auto_wrap 策略的 FSDP 的峰值内存使用情况最低，其次是 FSDP 和 DDP。

此外，在查看计时时，考虑到小型模型并在单台机器上运行训练，带有和不带有 auto_wrap 策略的 FSDP 的性能几乎与 DDP 一样快。这个示例不代表大多数实际应用，有关 DDP 和 FSDP 之间的详细分析和比较，请参阅这篇 博文 。

文档

访问 PyTorch 的全面开发者文档

查看文档

教程

获取面向初学者和高级开发人员的深入教程

查看教程

资源

查找开发资源并获取您的问题的答案

查看资源

为了分析流量并优化您的体验，我们在本网站上提供 Cookie。通过点击或导航，您同意允许我们使用 Cookie。作为本网站的当前维护者，Facebook 的 Cookie 政策适用。了解有关可用控件的更多信息：Cookie 政策。