DDP 通信钩子¶

DDP 通信钩子是一个通用接口，用于通过覆盖 DistributedDataParallel 中的普通 allreduce 来控制如何在工作进程之间通信梯度。提供了一些内置的通信钩子，用户可以轻松地将这些钩子应用于优化通信。此外，钩子接口还可以支持用户定义的通信策略，以满足更高级的用例。

如何使用通信钩子？¶

要使用通信钩子，用户只需要在训练循环之前让 DDP 模型注册钩子，如下所示。

torch.nn.parallel.DistributedDataParallel.register_comm_hook()

通信钩子对什么进行操作？¶

通信钩子提供了一种灵活的方式来对梯度进行 allreduce。因此，它主要对每个副本上的梯度进行操作，这些梯度在 allreduce 之前被分桶，以增加通信和计算之间的重叠。特别是，torch.distributed.GradBucket 代表一个要进行 allreduce 的梯度张量桶。

class torch.distributed.GradBucket¶: 此类主要将扁平化的梯度张量（由 buffer() 返回）传递给 DDP 通信钩子。此张量可以进一步分解为该桶中每个参数的张量列表（由 get_per_parameter_tensors() 返回），以应用逐层操作。

torch.distributed.GradBucket.index(self: torch._C._distributed_c10d.GradBucket) → int¶

警告

由于桶在第一次迭代后会重建，因此不应依赖训练开始时的索引。

返回值: 存储几个连续层的梯度的桶的索引。所有梯度都被分桶。

torch.distributed.GradBucket.buffer(self: torch._C._distributed_c10d.GradBucket) → torch.Tensor¶

返回值: 一个扁平化的 1D torch.Tensor 缓冲区，可以进一步分解为该桶中每个参数的张量列表。

torch.distributed.GradBucket.gradients(self: torch._C._distributed_c10d.GradBucket) → list[torch.Tensor]¶

返回值: 一个 torch.Tensor 列表。列表中的每个张量对应一个梯度。

torch.distributed.GradBucket.is_last(self: torch._C._distributed_c10d.GradBucket) → bool¶

返回值: 判断该桶是否为一次迭代中最后一个进行 allreduce 的桶。这也意味着该桶对应于前向传播中的前几层。

torch.distributed.GradBucket.set_buffer(self: torch._C._distributed_c10d.GradBucket, buffer: torch.Tensor) → None¶: 用输入张量 buffer 替换桶中的张量。

torch.distributed.GradBucket.parameters(self: torch._C._distributed_c10d.GradBucket) → list[torch.Tensor]¶

返回值: 一个 torch.Tensor 列表。列表中的每个张量对应一个模型参数。

默认通信钩子¶

默认通信钩子是简单的无状态钩子，因此 register_comm_hook 中的输入状态要么是进程组，要么是 None。输入 bucket 是一个 torch.distributed.GradBucket 对象。

torch.distributed.algorithms.ddp_comm_hooks.default_hooks.allreduce_hook(process_group, bucket)[source]¶

使用 GradBucket 张量调用 allreduce。

一旦梯度张量在所有工作器上聚合，它的 then 回调将取平均值并返回结果。

如果用户注册了此 DDP 通信钩子，则 DDP 结果预计与未注册钩子的情况相同。因此，这不会改变 DDP 的行为，用户可以使用它作为参考或修改此钩子来记录有用的信息或任何其他目的，同时不会影响 DDP 行为。

示例：

>>> ddp_model.register_comm_hook(process_group, allreduce_hook)

返回类型: Future[Tensor]

torch.distributed.algorithms.ddp_comm_hooks.default_hooks.fp16_compress_hook(process_group, bucket)[source]¶

通过将 GradBucket 转换为 torch.float16 并除以进程组大小来压缩。

此 DDP 通信钩子实现了一种简单的梯度压缩方法，它将 GradBucket 张量转换为半精度浮点格式 (torch.float16)，然后将其除以进程组大小。它对这些 float16 梯度张量进行 allreduce。一旦压缩后的梯度张量被 allreduce，链式回调 decompress 将其转换回输入数据类型（例如 float32）。

示例：

>>> ddp_model.register_comm_hook(process_group, fp16_compress_hook)

返回类型: Future[Tensor]

torch.distributed.algorithms.ddp_comm_hooks.default_hooks.bf16_compress_hook(process_group, bucket)[source]¶

警告：此 API 处于实验阶段，需要 NCCL 版本高于 2.9.6。

此 DDP 通信钩子实现了一种简单的梯度压缩方法，它将 GradBucket 张量转换为半精度 Brain 浮点格式 (torch.bfloat16)，然后除以进程组大小。它对这些 bfloat16 梯度张量进行全约简。压缩后的梯度张量全约简后，链式回调 decompress 会将其转换回输入数据类型（例如 float32）。

示例：

>>> ddp_model.register_comm_hook(process_group, bf16_compress_hook)

返回类型: Future[Tensor]

此外，还提供了一个通信钩子包装器来支持 fp16_compress_hook() 或 bf16_compress_hook() 作为包装器，可以与其他通信钩子结合使用。

torch.distributed.algorithms.ddp_comm_hooks.default_hooks.fp16_compress_wrapper(hook)[source]¶

将输入张量转换为 torch.float16，将钩子结果转换回输入数据类型。

此包装器将给定 DDP 通信钩子的输入梯度张量转换为半精度浮点格式 (torch.float16)，并将给定钩子的结果张量转换回输入数据类型，例如 float32。因此，fp16_compress_hook 等效于 fp16_compress_wrapper(allreduce_hook)。

示例：

>>> state = PowerSGDState(process_group=process_group, matrix_approximation_rank=1, start_powerSGD_iter=10)
>>> ddp_model.register_comm_hook(state, fp16_compress_wrapper(powerSGD_hook))

返回类型: 可调用[[任何, GradBucket], 未来[张量]]

torch.distributed.algorithms.ddp_comm_hooks.default_hooks.bf16_compress_wrapper(hook)[源代码]¶

警告：此 API 处于实验阶段，需要 NCCL 版本高于 2.9.6。

此包装器将给定 DDP 通信钩子的输入梯度张量转换为半精度 Brain floating point format <https://en.wikipedia.org/wiki/Bfloat16_floating-point_format> `_ (``torch.bfloat16`)，并将给定钩子的结果张量转换回输入数据类型，例如 float32。

因此，bf16_compress_hook 等效于 bf16_compress_wrapper(allreduce_hook)。

示例：

>>> state = PowerSGDState(process_group=process_group, matrix_approximation_rank=1, start_powerSGD_iter=10)
>>> ddp_model.register_comm_hook(state, bf16_compress_wrapper(powerSGD_hook))

返回类型: 可调用[[任何, GradBucket], 未来[张量]]

PowerSGD 通信钩子¶

PowerSGD (Vogels 等人，NeurIPS 2019) 是一种梯度压缩算法，可以提供非常高的压缩率并加速带宽受限的分布式训练。该算法需要维护一些超参数和内部状态。因此，PowerSGD 通信钩子是一个**有状态**的钩子，用户需要提供如下定义的状态对象。

PowerSGD 状态¶

class torch.distributed.algorithms.ddp_comm_hooks.powerSGD_hook.PowerSGDState(process_group, matrix_approximation_rank=1, start_powerSGD_iter=1000, min_compression_rate=2, use_error_feedback=True, warm_start=True, orthogonalization_epsilon=0, random_seed=0, compression_stats_logging_frequency=10000, batch_tensors_with_same_shape=False)[source]¶

存储算法的超参数和训练期间所有梯度的内部状态。

特别是，matrix_approximation_rank 和 start_powerSGD_iter 是用户应该调整的主要超参数。为了性能，我们建议将二进制超参数 use_error_feedback 和 warm_start 保持开启。

matrix_approximation_rank 控制压缩低秩张量的尺寸，这决定了压缩率。秩越低，压缩越强。

1.1. 如果 matrix_approximation_rank 太低，完整模型的质量将需要更多训练步骤才能达到，或者永远无法达到，并导致精度下降。

1.2. 增加 matrix_approximation_rank 会大幅增加压缩的计算成本，并且精度可能不会在超过某个 matrix_approximation_rank 阈值后得到进一步提高。

为了调整 matrix_approximation_rank，我们建议从 1 开始，以 2 的倍数递增（类似于指数网格搜索，1、2、4、…），直到达到令人满意的精度。通常只使用一个较小的值 1-4。对于某些 NLP 任务（如原始论文的附录 D 中所示），此值已增加到 32。

start_powerSGD_iter 将 PowerSGD 压缩推迟到步骤 start_powerSGD_iter，在步骤 start_powerSGD_iter 之前运行普通 allreduce。这种 **普通 allreduce + PowerSGD** 的混合方案可以有效地提高精度，即使使用相对较小的 matrix_approximation_rank。这是因为，训练阶段的开始通常对不准确的梯度非常敏感，过早压缩梯度可能会使训练快速走上次优轨迹，从而对精度产生不可逆的影响。

为了调整 start_powerSGD_iter，我们建议从总训练步骤的 10% 开始，并逐渐增加它，直到达到令人满意的精度。如果训练中存在预热阶段，start_powerSGD_iter 通常应该不小于预热步骤的数量。

min_compression_rate 是压缩层时所需的最小压缩率。由于压缩带来的计算开销，只有在带宽节省足够的情况下，才值得压缩张量，其中 (num_rows + num_cols) * matrix_approximation_rank * min_compression_rate < num_rows * num_cols。如果指定的压缩率阈值无法满足，则该张量将直接进行 allreduce，而不会进行压缩。

一旦 PowerSGD 压缩开始，压缩统计信息将在每 compression_stats_logging_frequency 次迭代中记录一次。

orthogonalization_epsilon 可以是一个非常小的值（例如，1e-8），在正交化步骤中添加到每个归一化矩阵列中，以防止任何列全为 0 时出现除以零错误。如果这已经可以防止（例如，通过批归一化），建议使用 0 的 epsilon 来提高精度。
batch_tensors_with_same_shape 控制是否在批处理操作中压缩和解压缩具有相同形状的张量，以实现更高的并行性。请注意，您还应该增加桶大小（即 DDP 构造函数中的 bucket_cap_mb 参数），以使更多相同形状的张量出现在同一个桶中，但这可能会减少计算和通信之间的重叠，并由于堆叠相同形状的张量而增加内存占用。如果压缩/解压缩计算是瓶颈，则将其设置为 True。

警告

如果启用了错误反馈或预热，则 DDP 中允许的 start_powerSGD_iter 的最小值为 2。这是因为 DDP 中存在另一个内部优化，它在迭代 1 处重建桶，这可能会与重建过程之前记忆的任何张量发生冲突。

PowerSGD 钩子¶

警告

PowerSGD 通常需要与模型梯度相同大小的额外内存来启用错误反馈，这可以补偿有偏差的压缩通信并提高准确性。

警告

PowerSGD 钩子可能与 Apex 自动混合精度包冲突。请改用 PyTorch 原生自动混合精度包。

torch.distributed.algorithms.ddp_comm_hooks.powerSGD_hook.powerSGD_hook(state, bucket)[source]¶

实现 PowerSGD 算法。

此 DDP 通信钩子实现了 PowerSGD 梯度压缩算法，如论文中所述。一旦梯度张量在所有工作器上聚合，此钩子将按如下方式应用压缩

将输入扁平化的 1D 梯度张量视为每个参数张量的列表，并将所有张量分成两组

1.1 应该在 allreduce 之前压缩的张量，因为压缩可以节省足够的带宽。

1.2 其余的张量将直接进行 allreduce，而不会进行压缩，包括所有向量张量（用于偏差）。
处理未压缩张量

2.1. 为这些未压缩张量分配连续内存，并将所有未压缩张量作为一批进行全缩减，不进行压缩；

2.2. 将各个未压缩张量从连续内存复制回输入张量。
处理应通过 PowerSGD 压缩进行压缩的张量

3.1. 对于每个张量 M，创建两个低秩张量 P 和 Q 用于分解 M，使得 M = PQ^T，其中 Q 从标准正态分布初始化并正交化；

3.2. 计算 Ps 中的每个 P，它等于 MQ；

3.3. 将 Ps 作为一批进行全缩减；

3.4. 将 Ps 中的每个 P 正交化；

3.5. 计算 Qs 中的每个 Q，它近似等于 M^TP；

3.6. 将 Qs 作为一批进行全缩减；

3.7. 计算所有压缩张量中的每个 M，它近似等于 PQ^T。

请注意，此通信钩子强制对前 state.start_powerSGD_iter 次迭代执行普通全缩减。这不仅使用户可以更好地控制速度提升和准确性之间的权衡，而且还有助于抽象化 DDP 内部优化的一些复杂性，以便将来进行通信钩子开发。

参数

state (PowerSGDState) – 状态信息，用于配置压缩率并支持错误反馈、热启动等。要调整压缩配置，主要需要调整 matrix_approximation_rank、start_powerSGD_iter 和 min_compression_rate。
bucket (dist.GradBucket) – 存储一维扁平化梯度张量的桶，该张量对多个每个变量张量进行批处理。请注意，由于 DDP 通信钩子仅支持单进程单设备模式，因此此桶中仅存储一个张量。

返回值

通信的未来处理程序，它会就地更新梯度。

返回类型

Future[Tensor]

示例：

>>> state = PowerSGDState(process_group=process_group, matrix_approximation_rank=1,
                          start_powerSGD_iter=10, min_compression_rate=0.5)
>>> ddp_model.register_comm_hook(state, powerSGD_hook)

torch.distributed.algorithms.ddp_comm_hooks.powerSGD_hook.batched_powerSGD_hook(state, bucket)[source]¶

实现简化的 PowerSGD 算法。

此 DDP 通信钩子实现了简化的 PowerSGD 梯度压缩算法，该算法在论文中描述。此变体不会逐层压缩梯度，而是压缩将所有梯度批处理在一起的扁平化输入张量。因此，它比 powerSGD_hook() 更快，但通常会导致更低的精度，除非 matrix_approximation_rank 为 1。

警告

增加 matrix_approximation_rank 这里可能不会提高精度，因为在没有列/行对齐的情况下对每个参数张量进行批处理会破坏低秩结构。因此，用户应始终首先考虑 powerSGD_hook()，并且只有在 matrix_approximation_rank 为 1 时可以实现令人满意的精度时，才考虑此变体。

一旦梯度张量在所有工作器上聚合，此钩子将按如下方式应用压缩

将输入扁平化的 1D 梯度张量视为具有 0 填充的方形张量 M；
创建两个低秩张量 P 和 Q 用于分解 M，使得 M = PQ^T，其中 Q 从标准正态分布初始化并正交化；
计算 P，它等于 MQ；
对 P 进行全约简；
正交化 P；
计算 Q，它近似等于 M^TP；
对 Q 进行全约简；
计算 M，它近似等于 PQ^T。
将输入张量截断为原始长度。

请注意，此通信钩子强制对前 state.start_powerSGD_iter 次迭代执行普通全缩减。这不仅使用户可以更好地控制速度提升和准确性之间的权衡，而且还有助于抽象化 DDP 内部优化的一些复杂性，以便将来进行通信钩子开发。

参数

state (PowerSGDState) – 状态信息用于配置压缩率并支持错误反馈、热启动等。要调整压缩配置，主要需要调整 matrix_approximation_rank 和 start_powerSGD_iter。
bucket (dist.GradBucket) – 存储一维扁平化梯度张量的桶，该张量对多个每个变量张量进行批处理。请注意，由于 DDP 通信钩子仅支持单进程单设备模式，因此此桶中仅存储一个张量。

返回值

通信的未来处理程序，它会就地更新梯度。

返回类型

Future[Tensor]

示例：

>>> state = PowerSGDState(process_group=process_group, matrix_approximation_rank=1)
>>> ddp_model.register_comm_hook(state, batched_powerSGD_hook)

调试通信钩子¶

顾名思义，调试通信钩子仅用于调试和性能优化目的。

警告

调试通信钩子不一定输出正确的结果。

torch.distributed.algorithms.ddp_comm_hooks.debugging_hooks.noop_hook(_, bucket)[source]¶

返回一个包装输入的 Future，因此它是一个不执行任何操作且不会产生任何通信开销的空操作。

此钩子仅应用于 allreduce 优化的头部分析，而不是正常的梯度同步。例如，如果在注册此钩子后，训练时间的加速不到 10%，则通常意味着 allreduce 对于这种情况不是性能瓶颈。这种检测对于无法轻松检索 GPU 跟踪或跟踪分析因某些因素（例如 allreduce 与计算之间的重叠或跨 ranks 的不同步）而变得复杂的情况特别有用。

示例：

>>> ddp_model.register_comm_hook(None, noop_hook)

返回类型: Future[Tensor]

通信钩子的检查点¶

有状态的通信钩子可以作为模型检查点的一部分保存，以启用训练器重启。为了使钩子可序列化，应定义 __setstate__ 和 __getstate__。

警告

__getstate__ 应从返回的字典中排除不可序列化的属性。

警告

__setstate__ 应正确初始化从提供的 state 中排除的不可序列化的属性。

PowerSGDState 已实现 __setstate__ 和 __getstate__，可以作为参考。

class torch.distributed.algorithms.ddp_comm_hooks.powerSGD_hook.PowerSGDState[source]

__getstate__()[source]¶

返回一个 Dict[str, Any]，它将被序列化并保存。

process_group 不可序列化，并从返回的状态中排除。

__setstate__(state)[source]¶

使用提供的 state 设置此 PowerSGDState 实例。

process_group 设置为默认值。

以下是一个简单、端到端的示例，展示如何保存和重新加载 PowerSGD 状态和钩子。

import os
import sys
import tempfile
import torch
import torch.distributed as dist
import torch.nn as nn
import torch.optim as optim
import torch.multiprocessing as mp

from torch.nn.parallel import DistributedDataParallel
from torch.distributed.algorithms.ddp_comm_hooks import powerSGD_hook as powerSGD

class SimpleModel(nn.Module):
    def __init__(self):
        super().__init__()
        self.fc1 = nn.Linear(24,24)
        self.relu = nn.ReLU()
        self.fc2 = nn.Linear(24,12)

    def forward(self, x):
        return self.fc2(self.relu(self.fc1(x)))

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()

def run_demo(demo_fn, world_size):
    mp.spawn(
        demo_fn,
        args=(world_size,),
        nprocs=world_size,
        join=True)

def demo_serialization(rank, world_size):
    setup(rank, world_size)

    CHECKPOINT = tempfile.gettempdir() + "/checkpoint.pt"

    model = SimpleModel().to(rank)
    ddp_model = DistributedDataParallel(model, device_ids=[rank])

    powersgd_hook = powerSGD.powerSGD_hook
    powersgd_state = powerSGD.PowerSGDState(process_group=None)

    optimizer = optim.SGD(ddp_model.parameters(), lr=0.001)
    ddp_model.register_comm_hook(powersgd_state, powersgd_hook)

    state = {
        'state_dict': ddp_model.state_dict(),
        'comm_hook': powersgd_hook,
        'comm_hook_state': powersgd_state}

    if rank == 0:
        torch.save(state, CHECKPOINT)

    dist.barrier()
    map_location = {'cuda:%d' % 0: 'cuda:%d' % rank}
    checkpoint = torch.load(CHECKPOINT, map_location=map_location)

    new_ddp_model = DistributedDataParallel(SimpleModel().to(rank), device_ids=[rank])
    new_ddp_model.load_state_dict(checkpoint['state_dict'])
    powersgd_hook = checkpoint['comm_hook']
    powersgd_state = checkpoint['comm_hook_state']

    new_ddp_model.register_comm_hook(powersgd_state, powersgd_hook)

    if rank == 0:
        os.remove(CHECKPOINT)

    cleanup()

if __name__ == "__main__":
    n_gpus = torch.cuda.device_count()
    assert n_gpus >= 2, f"Requires at least 2 GPUs to run, but got {n_gpus}"
    world_size = n_gpus
    run_demo(demo_serialization, world_size)

致谢¶

非常感谢 PowerSGD 论文作者 **Thijs Vogels** 对 PowerSGD 通信钩子的代码审查，以及对比实验，这些实验表明 PowerSGD 通信钩子的性能与原始论文中的实现相当。

DDP 通信钩子¶

如何使用通信钩子？¶

通信钩子对什么进行操作？¶

默认通信钩子¶

PowerSGD 通信钩子¶

PowerSGD 状态¶

PowerSGD 钩子¶

调试通信钩子¶

通信钩子的检查点¶

致谢¶

文档

教程

资源