使用Fully Sharded Data Parallel(FSDP)入门

创建时间：2022年3月17日 | 最后更新时间：2024年7月30日 | 最后验证时间：2024年11月5日

作者: Hamid Shojanazeri, Yanli Zhao, Shen Li

注意

查看和编辑此教程在 github。

在大规模训练AI模型是一项具有挑战性的任务，需要大量的计算能力和资源。 它还伴随着相当大的工程复杂性，以处理这些非常大型模型的训练。 PyTorch FSDP，在PyTorch 1.11中发布，使这一过程更加简便。

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

如何工作

在 DistributedDataParallel，(DDP) 训练中，每个进程/工作者拥有模型的副本并处理一批数据，最后使用 all-reduce 在不同工作者之间汇总梯度。在 DDP 中，模型权重和优化器状态会在所有工作者之间复制。FSDP 是一种数据并行方式，它将模型参数、优化器状态和梯度分片到 DDP 等级。

在使用 FSDP 进行训练时，GPU 内存占用量比在所有工作进程中使用 DDP 时更小。这使得一些非常大的模型的训练成为可能，允许更大的模型或批量大小适合设备运行。这种做法的代价是通信量的增加。通过内部优化，如重叠通信和计算，可以减少通信开销。

FSDP 工作流程

在高层次上，FSDP 的工作方式如下：

在构造函数中

• 分片模型参数，每个进程仅保留自己的分片

前向路径

• 运行 all_gather 来收集所有 ranks 中的所有分片，以恢复此 FSDP 单元中的完整参数

• 运行前向计算

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

反向传播路径

• 运行 all_gather 来收集所有 ranks 中的所有分片，以恢复此 FSDP 单元中的完整参数

• 反向计算

• 运行 reduce_scatter 来同步梯度

• 丢弃参数。

一种理解FSDP分片的方法是将DDP的梯度全规约分解为reduce-scatter和all-gather。具体来说，在反向传播过程中，FSDP对梯度进行规约和散播，确保每个进程都拥有梯度的一个分片。然后在优化器步骤中，更新对应参数分片。最后，在后续的前向传播过程中，它执行all-gather操作来收集并合并更新后的参数分片。

FSDP Allreduce

如何使用FSDP

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

设置

1.1 安装 PyTorch 及其 Torchvision

请参阅入门指南以获取安装信息。

我们向 Python 脚本 “FSDP_mnist.py” 添加以下代码片段。

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 模型，我们需要在每个 rank 上调用 state_dict，然后在 Rank 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)
       )
   )
)

以下是在 g4dn.12.xlarge AWS EC2 实例上使用 4 张 GPU 进行 FSDP MNIST 训练时，通过 PyTorch Profiler 捕获的峰值内存使用情况。

FSDP 峰值内存使用量

应用 auto_wrap_policy 在 FSDP 中，否则 FSDP 会将整个模型放在一个 FSDP 单元中，这会降低计算效率和内存效率。 其工作方式是，假设你的模型包含 100 个 Linear 层。如果你执行 FSDP(model)，则只会有一个 FSDP 单元，该单元封装整个模型。 在这种情况下，allgather 会收集所有 100 个 Linear 层的完整参数，因此不会为参数分片节省 CUDA 内存。 此外，对于所有 100 个 Linear 层只会有一次 blocking 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 定义了如果某一层的参数数量大于 100，则可以被 FSDP 包装或分片。 如果某一层的参数数量小于 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

以下是在 g4dn.12.xlarge AWS EC2 实例上使用 4 个 GPU 进行 MNIST 训练时，采用 FSDP 的 auto_wrap 策略所捕获的峰值内存使用情况，数据来自 PyTorch Profiler。 可以观察到，每个设备上的峰值内存使用量相比未应用 auto wrap 策略的 FSDP，有所减少，从约 75 MB 降至 66 MB。

使用 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中我们只是正常地将模型包装在DDP中，并在“DDP_mnist.py”中保存更改。

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

python DDP_mnist.py

CUDA event elapsed time on training loop 39.77766015625sec

以下是在 g4dn.12.xlarge AWS EC2 实例上使用 4 张 GPU 进行 DDP MNIST 训练时，通过 PyTorch 分析器捕获的峰值内存使用情况。

DDP 内存使用情况（使用 Auto_wrap 策略）

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

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