评价此页
★ ★ ★ ★ ★
intermediate/pipelining_tutorial

分布式流水线并行介绍#

创建日期：2024年7月9日 | 最后更新：2025年11月5日 | 最后验证：2024年11月5日

作者：Howard Huang

注意

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

本教程使用 gpt 风格的 transformer 模型来演示如何使用 torch.distributed.pipelining APIs 实现分布式流水线并行。

您将学到什么

  • 如何使用 torch.distributed.pipelining APIs

  • 如何将流水线并行应用于 transformer 模型

  • 如何在一个微批次集合上利用不同的调度

先决条件

设置#

使用 torch.distributed.pipelining，我们将对模型的执行进行分区，并在微批次上调度计算。我们将使用一个简化的 transformer 解码器模型。该模型架构仅用于教育目的，并且具有多个 transformer 解码器层，因为我们希望演示如何将模型拆分为不同的块。首先，让我们定义模型

import torch
import torch.nn as nn
from dataclasses import dataclass

@dataclass
class ModelArgs:
   dim: int = 512
   n_layers: int = 8
   n_heads: int = 8
   vocab_size: int = 10000

class Transformer(nn.Module):
   def __init__(self, model_args: ModelArgs):
      super().__init__()

      self.tok_embeddings = nn.Embedding(model_args.vocab_size, model_args.dim)

      # Using a ModuleDict lets us delete layers witout affecting names,
      # ensuring checkpoints will correctly save and load.
      self.layers = torch.nn.ModuleDict()
      for layer_id in range(model_args.n_layers):
            self.layers[str(layer_id)] = nn.TransformerDecoderLayer(model_args.dim, model_args.n_heads)

      self.norm = nn.LayerNorm(model_args.dim)
      self.output = nn.Linear(model_args.dim, model_args.vocab_size)

   def forward(self, tokens: torch.Tensor):
      # Handling layers being 'None' at runtime enables easy pipeline splitting
      h = self.tok_embeddings(tokens) if self.tok_embeddings else tokens

      for layer in self.layers.values():
            h = layer(h, h)

      h = self.norm(h) if self.norm else h
      output = self.output(h).clone() if self.output else h
      return output

然后，我们需要在脚本中导入必要的库并初始化分布式训练过程。在这种情况下，我们定义了一些全局变量，稍后将在脚本中使用

import os
import torch.distributed as dist
from torch.distributed.pipelining import pipeline, SplitPoint, PipelineStage, ScheduleGPipe

global rank, device, pp_group, stage_index, num_stages
def init_distributed():
   global rank, device, pp_group, stage_index, num_stages
   rank = int(os.environ["LOCAL_RANK"])
   world_size = int(os.environ["WORLD_SIZE"])
   device = torch.device(f"cuda:{rank}") if torch.cuda.is_available() else torch.device("cpu")
   dist.init_process_group()

   # This group can be a sub-group in the N-D parallel case
   pp_group = dist.new_group()
   stage_index = rank
   num_stages = world_size

您应该对 rank、world_size 和 init_process_group() 代码感到熟悉，因为这些代码通常在所有分布式程序中使用。流水线并行特有的全局变量包括 pp_group，它将用于发送/接收通信的过程组，stage_index，在本例中，每个阶段只有一个 rank，因此索引等同于 rank，以及 num_stages，它等同于 world_size。

num_stages 用于设置将在流水线并行调度中使用的阶段数。例如，对于 num_stages=4，一个微批次需要经过 4 次前向传播和 4 次反向传播才能完成。 stage_index 对于框架了解如何在阶段之间进行通信是必要的。例如，对于第一个阶段 (stage_index=0)，它将使用来自 dataloader 的数据，并且不需要从任何先前的 peer 接收数据来执行其计算。

步骤 1：划分 Transformer 模型#

有两种不同的模型划分方式

第一种是手动模式，在这种模式下，我们可以通过删除模型的某些属性来手动创建模型的两个实例。在本例中，对于两个阶段（2 个 rank），模型被分成两半。

def manual_model_split(model) -> PipelineStage:
   if stage_index == 0:
      # prepare the first stage model
      for i in range(4, 8):
            del model.layers[str(i)]
      model.norm = None
      model.output = None

   elif stage_index == 1:
      # prepare the second stage model
      for i in range(4):
            del model.layers[str(i)]
      model.tok_embeddings = None

   stage = PipelineStage(
      model,
      stage_index,
      num_stages,
      device,
   )
   return stage

正如我们所看到的，第一个阶段没有层归一化或输出层，并且仅包含前四个 transformer 块。第二个阶段没有输入嵌入层，但包含输出层和最后的四个 transformer 块。然后，该函数返回当前 rank 的 PipelineStage。

第二种方法是基于 tracer 的模式，它根据 split_spec 参数自动拆分模型。使用流水线规范，我们可以指示 torch.distributed.pipelining 在哪里拆分模型。在下面的代码块中，我们将在第 4 个 transformer 解码器层之前拆分，从而反映上述手动拆分。 同样，我们可以在完成此拆分后通过调用 build_stage 来检索 PipelineStage。

def tracer_model_split(model, example_input_microbatch) -> PipelineStage:
   pipe = pipeline(
      module=model,
      mb_args=(example_input_microbatch,),
      split_spec={
         "layers.4": SplitPoint.BEGINNING,
      }
   )
   stage = pipe.build_stage(stage_index, device, pp_group)
   return stage

步骤 2：定义主执行#

在主函数中，我们将创建一个特定的流水线调度，阶段应该遵循该调度。 torch.distributed.pipelining 支持多种调度，包括每 rank 一个阶段的调度 GPipe 和 1F1B，以及每个 rank 多个阶段的调度，例如 Interleaved1F1B 和 LoopedBFS。

if __name__ == "__main__":
   init_distributed()
   num_microbatches = 4
   model_args = ModelArgs()
   model = Transformer(model_args)

   # Dummy data
   x = torch.ones(32, 500, dtype=torch.long)
   y = torch.randint(0, model_args.vocab_size, (32, 500), dtype=torch.long)
   example_input_microbatch = x.chunk(num_microbatches)[0]

   # Option 1: Manual model splitting
   stage = manual_model_split(model)

   # Option 2: Tracer model splitting
   # stage = tracer_model_split(model, example_input_microbatch)

   model.to(device)
   x = x.to(device)
   y = y.to(device)

   def tokenwise_loss_fn(outputs, targets):
      loss_fn = nn.CrossEntropyLoss()
      outputs = outputs.reshape(-1, model_args.vocab_size)
      targets = targets.reshape(-1)
      return loss_fn(outputs, targets)

   schedule = ScheduleGPipe(stage, n_microbatches=num_microbatches, loss_fn=tokenwise_loss_fn)

   if rank == 0:
      schedule.step(x)
   elif rank == 1:
      losses = []
      output = schedule.step(target=y, losses=losses)
      print(f"losses: {losses}")
   dist.destroy_process_group()

在上面的示例中，我们使用手动方法来拆分模型，但是可以取消注释代码以尝试基于 tracer 的模型拆分函数。在我们的调度中，我们需要传入微批次的数量以及用于评估目标的损失函数。

.step() 函数处理整个 minibatch，并根据之前传入的 n_microbatches 将其自动拆分为微批次。然后，根据调度类对微批次进行操作。在上面的示例中，我们使用 GPipe，它遵循一个简单的全前向传播然后全反向传播的调度。从 rank 1 返回的输出与模型位于单个 GPU 上并使用整个批次运行时的输出相同。 同样，我们可以传入一个 losses 容器来存储每个微批次的相应损失。

步骤 3：启动分布式进程#

最后，我们准备运行脚本。我们将使用 torchrun 创建一个单主机、2 进程作业。我们的脚本已经编写成 rank 0 执行流水线阶段 0 所需的逻辑，而 rank 1 执行流水线阶段 1 的逻辑。

torchrun --nnodes 1 --nproc_per_node 2 pipelining_tutorial.py

结论#

在本教程中，我们学习了如何使用 PyTorch 的 torch.distributed.pipelining APIs 实现分布式流水线并行。我们探讨了设置环境、定义 transformer 模型以及将其划分为分布式训练。我们讨论了两种模型划分方法，手动和基于 tracer 的方法，并演示了如何在不同的阶段上调度微批次的计算。最后，我们介绍了流水线调度的执行以及使用 torchrun 启动分布式进程。

其他资源#

我们已成功将 torch.distributed.pipelining 集成到 torchtitan 仓库 中。 TorchTitan 是一个干净、最小的代码库，用于使用原生 PyTorch 进行大规模 LLM 训练。有关流水线并行的生产就绪用法以及与其他分布式技术的组合，请参阅 TorchTitan 3D 并行示例。

在此页面上
PyTorch 库