张量并行 - torch.distributed.tensor.parallel

张量并行 (TP) 建立在 PyTorch 分布式张量 (DTensor) 之上，并提供不同的并行模式：列式并行、行式并行和序列并行。

警告

张量并行 API 处于实验阶段，可能会发生变化。

使用张量并行并行化您的 nn.Module 的入口点是

torch.distributed.tensor.parallel.parallelize_module(module, device_mesh, parallelize_plan)

通过根据用户指定的计划并行化模块或子模块，在 PyTorch 中应用张量并行。

我们根据 parallelize_plan 并行化模块或子模块。parallelize_plan 包含 ParallelStyle，它指示用户希望如何并行化模块或子模块。

用户还可以为每个模块的全限定名 (FQN) 指定不同的并行模式。

请注意，parallelize_module 仅接受 1 维 DeviceMesh，如果您有 2 维或 N 维 DeviceMesh，请先将 DeviceMesh 切片成 1 维子 DeviceMesh，然后传递给此 API（即 device_mesh["tp"]）。

参数

• module (nn.Module) – 要并行化的模块。

• device_mesh (DeviceMesh) – 描述 DTensor 设备网格拓扑的对象。

• parallelize_plan (Union[ParallelStyle, Dict[str, ParallelStyle]]) – 用于并行化模块的计划。它可以是 ParallelStyle 对象，其中包含我们如何为张量并行准备输入/输出，也可以是模块 FQN 的字典及其对应的 ParallelStyle 对象。

返回值

已并行化的 nn.Module 对象。

返回类型

模块

示例：

>>> from torch.distributed.tensor.parallel import parallelize_module, ColwiseParallel
>>> from torch.distributed.device_mesh import init_device_mesh
>>>
>>> # Define the module.
>>> m = Model(...)
>>> tp_mesh = init_device_mesh("cuda", (8,))
>>> m = parallelize_module(m, tp_mesh, {"w1": ColwiseParallel(), "w2": RowwiseParallel()})
>>>

注意

对于像注意力、MLP 层这样的复杂模块架构，我们建议将不同的 ParallelStyles 组合在一起（例如 ColwiseParallel 和 RowwiseParallel），并将它们作为 parallelize_plan 传递，以实现所需的分片计算。

张量并行支持以下并行模式

class torch.distributed.tensor.parallel.ColwiseParallel(*, input_layouts=None, output_layouts=None, use_local_output=True)

以列式方式对兼容的 nn.Module 进行分区。目前支持 nn.Linear 和 nn.Embedding。用户可以将它与 RowwiseParallel 组合在一起，以实现更复杂模块的分片（例如 MLP、注意力）。

关键字参数

• input_layouts (Placement, optional) – nn.Module 的输入张量的 DTensor 布局，用于将输入张量注释为 DTensor。如果未指定，我们假设输入张量已复制。

• output_layouts (Placement, optional) – nn.Module 输出的 DTensor 布局，用于确保 nn.Module 的输出具有用户所需的布局。如果未指定，则输出张量在最后一个维度上被分片。

• use_local_output (bool, optional) – 是否使用本地 torch.Tensor 而不是 DTensor 作为模块输出，默认值为 True。

返回值

表示 nn.Module 的列方向切片的一个 ParallelStyle 对象。

示例：

>>> from torch.distributed.tensor.parallel import parallelize_module, ColwiseParallel
>>> from torch.distributed.device_mesh import init_device_mesh
>>> ...
>>> m = Model(...)  # m is a nn.Module that contains a "w1" nn.Linear submodule
>>> tp_mesh = init_device_mesh("cuda", (8,))
>>>
>>> # By default, the input of the "w1" Linear will be converted to Replicated DTensor
>>> # and the output of "w1" will return :class:`torch.Tensor` that shards on the last dim.
>>>
>>> sharded_mod = parallelize_module(m, tp_mesh, {"w1": ColwiseParallel()})
>>> ...

注意

默认情况下，如果未指定 output_layouts，则 ColwiseParallel 输出将在最后一个维度上切片。如果存在需要特定张量形状的操作符（例如，在配对的 RowwiseParallel 之前），请记住，如果输出被切片，则操作符可能需要调整到切片大小。

class torch.distributed.tensor.parallel.RowwiseParallel(*, input_layouts=None, output_layouts=None, use_local_output=True)

以行方向将兼容的 nn.Module 进行分区。目前支持 nn.Linear 和 nn.Embedding。用户可以将其与 ColwiseParallel 组合起来，实现对更复杂模块（例如 MLP、Attention）的切片。

关键字参数

• input_layouts (Placement, optional) – nn.Module 输入张量的 DTensor 布局，用于将输入张量标注为 DTensor。如果未指定，我们假设输入张量在最后一个维度上被切片。

• output_layouts (Placement, optional) – nn.Module 输出的 DTensor 布局，用于确保 nn.Module 的输出具有用户所需的布局。如果未指定，则输出张量将被复制。

• use_local_output (bool, optional) – 是否使用本地 torch.Tensor 而不是 DTensor 作为模块输出，默认值为 True。

返回值

表示 nn.Module 的行方向切片的一个 ParallelStyle 对象。

示例：

>>> from torch.distributed.tensor.parallel import parallelize_module, RowwiseParallel
>>> from torch.distributed.device_mesh import init_device_mesh
>>> ...
>>> m = Model(...)  # m is a nn.Module that contains a "w2" nn.Linear submodule
>>> tp_mesh = init_device_mesh("cuda", (8,))
>>>
>>> # By default, the input of the "w2" Linear will be converted to DTensor that shards on the last dim
>>> # and the output of "w2" will return a replicated :class:`torch.Tensor`.
>>>
>>> sharded_mod = parallelize_module(m, tp_mesh, {"w2": RowwiseParallel()}),
>>> ...

class torch.distributed.tensor.parallel.SequenceParallel(*, sequence_dim=1, use_local_output=False)

SequenceParallel 复制兼容的 nn.Module 参数，并在输入在序列维度上切片的情况下运行切片计算。目前支持 nn.LayerNorm、nn.Dropout 和 RMSNorm 的 Python 实现

这种方式实现了论文 Reducing Activation Recomputation in Large Transformer Models 中描述的操作。

nn.Module 的输入和输出都将在序列维度上被切片。

关键字参数

• sequence_dim (int, optional) – nn.Module 输入张量的序列维度，用于将输入张量标注为在序列维度上被切片的 DTensor，默认值：1。

• use_local_output (bool, optional) – 是否对模块输出使用本地 torch.Tensor 而不是 DTensor，默认值：False。

返回值

表示 nn.Module 的序列并行的 ParallelStyle 对象。

示例：

>>> from torch.distributed.tensor.parallel import parallelize_module, SequenceParallel
>>> from torch.distributed.device_mesh import init_device_mesh
>>> ...
>>> m = Model(...)  # m is a nn.Module that contains a "norm" nn.LayerNorm submodule
>>> tp_mesh = init_device_mesh("cuda", (8,))
>>>
>>> # By default, the input of the "norm" will be converted to DTensor that shards on the sequence dim
>>> # and the output of "norm" will return a sharded on sequence dimension :class:`DTensor`.
>>>
>>> sharded_mod = parallelize_module(m, tp_mesh, {"norm": SequenceParallel()}),
>>> ...

注意

SequenceParallel 方式假设如果 nn.Module 中存在权重（例如 nn.LayerNorm 或 RMSNorm，它们默认具有全 1 初始化），则进行全 1 初始化。如果您对这些模块上的权重有自定义初始化，则需要在并行化之前或之后广播权重，以确保它们被复制。

为了简单地使用 DTensor 布局配置 nn.Module 的输入和输出，并执行必要的布局重新分配，而不将模块参数分布到 DTensors，以下 ParallelStyle 可在调用 parallelize_module 时在 parallelize_plan 中使用。

class torch.distributed.tensor.parallel.PrepareModuleInput(*, input_layouts=None, desired_input_layouts=None, input_kwarg_layouts=None, desired_input_kwarg_layouts=None, use_local_output=False)

配置 nn.Module 的输入，以便在运行时根据 input_layouts 将 nn.Module 的输入张量转换为 DTensors，并根据 desired_input_layouts 执行布局重新分配。

关键字参数

• input_layouts (Union[Placement, Tuple[Optional[Placement]]]) – nn.Module 输入张量的 DTensor 布局，用于将输入张量转换为 DTensors。如果某些输入不是 torch.Tensor 或不需要转换为 DTensors，则需要指定 None 作为占位符。默认值：None。

• desired_input_layouts (Union[Placement, Tuple[Optional[Placement]]]) – nn.Module 输入张量的所需 DTensor 布局，用于确保 nn.Module 的输入具有所需的 DTensor 布局。此参数的长度需要与 input_layouts 相同。默认值：None。

• input_kwarg_layouts (Dict[str, Placement]) – nn.Module 输入 kwarg 的 DTensor 布局，用于将输入 kwarg 张量转换为 DTensors。默认值：None

• desired_input_kwarg_layouts – (Dict[str, Placement]): nn.Module 输入 kwarg 的所需 DTensor 布局，用于确保 nn.Module 的输入具有所需的 DTensor 布局。默认值：None。

• use_local_output (bool, optional) – 是否对模块输入使用本地 torch.Tensor 而不是 DTensor，默认值：False。

返回值

准备 nn.Module 输入的切片布局的 ParallelStyle 对象。

示例：

>>> from torch.distributed.tensor.parallel import parallelize_module, PrepareModuleInput
>>> from torch.distributed.device_mesh import init_device_mesh
>>> ...
>>> block = TransformerBlock(...)  # block is a nn.Module that contains an "attn" Attention submodule
>>> tp_mesh = init_device_mesh("cuda", (8,))
>>>
>>> # According to the style specified below, the first input of attn will be annotated to Sharded DTensor
>>> # and then redistributed to Replicated DTensor.
>>> parallelize_module(
>>>     block, # this can be a submodule or module
>>>     tp_mesh,
>>>     parallelize_plan={
>>>         "attn": PrepareModuleInput(
>>>             input_layouts=(Shard(0), None, None, ...),
>>>             desired_input_layouts=(Replicate(), None, None, ...)
>>>         ),
>>>     }
>>> )

class torch.distributed.tensor.parallel.PrepareModuleOutput(*, output_layouts, desired_output_layouts, use_local_output=True)

配置 nn.Module 的输出，以便在运行时根据 output_layouts 将 nn.Module 的输出张量转换为 DTensors，并根据 desired_output_layouts 执行布局重新分配。

关键字参数

• output_layouts (Union[Placement, Tuple[Placement]]) – nn.Module 输出张量的 DTensor 布局，用于将输出张量转换为 DTensors（如果它们是 torch.Tensor）。如果某些输出不是 torch.Tensor 或不需要转换为 DTensors，则需要指定 None 作为占位符。

• desired_output_layouts (Union[Placement, Tuple[Placement]]) – nn.Module 输出张量的所需 DTensor 布局，用于确保 nn.Module 的输出具有所需的 DTensor 布局。

• use_local_output (bool, optional) – 是否对模块输出使用本地 torch.Tensor 而不是 DTensor，默认值：True。

返回值

准备 nn.Module 输出的切片布局的 ParallelStyle 对象。

示例：

>>> from torch.distributed.tensor.parallel import parallelize_module, PrepareModuleOutput
>>> from torch.distributed.device_mesh import init_device_mesh
>>> ...
>>> block = TransformerBlock(...)  # block is a nn.Module that contains an "attn" Attention submodule
>>> tp_mesh = init_device_mesh("cuda", (8,))
>>>
>>> # According to the style specified below, the output of the TransformerBlock will be converted to Replicated DTensor
>>> # and then redistributed to Sharded DTensor.
>>> parallelize_module(
>>>     block, # this can be a submodule or module
>>>     tp_mesh,
>>>     parallelize_plan = PrepareModuleOutput(
>>>         output_layouts=Replicate(),
>>>         desired_output_layouts=Shard(0)
>>>     )
>>> )

注意

当使用 Shard(dim) 作为上述 ParallelStyle 的输入/输出布局时，我们假设输入/输出激活张量在 DeviceMesh 上的张量维度 dim 上均匀分片。例如，由于 RowwiseParallel 接受在最后一个维度上分片的输入，因此它假设输入张量已经在线性上均匀分片。对于不均匀分片的激活张量，可以将 DTensor 直接传递给分区模块，并使用 use_local_output=False 在每个 ParallelStyle 后返回 DTensor，DTensor 可以跟踪不均匀分片信息。

对于像 Transformer 这样的模型，我们建议用户在 parallelize_plan 中同时使用 ColwiseParallel 和 RowwiseParallel 来实现整个模型（即注意力和 MLP）的所需分片。

通过以下上下文管理器支持并行化的交叉熵损失计算（损失并行）：

torch.distributed.tensor.parallel.loss_parallel()

一个启用损失并行的上下文管理器，当输入在类维度上分片时，可以执行高效的并行化损失计算。目前只支持交叉熵损失。

在这个上下文管理器中，可以使用 cross_entropy() 或 CrossEntropyLoss 像往常一样，但对输入参数有一些假设。如果存在，相应的 backward() 调用也需要在这个上下文管理器中进行。

参数

• input (DTensor) – 输入 logits。假设在类维度上分片。

• target (Union[torch.Tensor, DTensor]) – 必须是地面真实类索引（当前不支持类概率）。假设在 DeviceMesh 上复制。

• weight (Union[torch.Tensor, DTensor], optional) – 如果给出，假设在 DeviceMesh 上复制。

• label_smoothing – 当前不支持。

返回值

一个复制的 DTensor。

示例

这里手动创建了一个分片的 DTensor 来展示用法。在实践中，它通常是 TP 模块的输出。

>>> from torch.distributed.tensor.parallel import loss_parallel
>>> from torch.distributed.device_mesh import init_device_mesh
>>> ...
>>> device_mesh = init_device_mesh("cuda", (8,))
>>> input = torch.randn(4, 16, device="cuda", requires_grad=True)
>>> dist_input = distribute_tensor(input, device_mesh, placements=[Shard(1)])
>>> target = torch.randint(16, (4,), device="cuda")
>>> with loss_parallel():
>>>     loss = F.cross_entropy(dist_input, target, reduction="mean")
>>>     loss.backward()
>>> ...

警告

loss_parallel API 处于实验阶段，可能会发生变化。