分布式优化器#

创建时间: 2021年03月01日 | 最后更新时间: 2025年06月16日

警告

目前使用 CUDA 张量时不支持分布式优化器

torch.distributed.optim 暴露了 DistributedOptimizer，它接受一个远程参数列表（RRef），并在参数所在的 worker 上本地运行优化器。分布式优化器可以使用任何本地优化器基类在每个 worker 上应用梯度。

class torch.distributed.optim.DistributedOptimizer(optimizer_class, params_rref, *args, **kwargs)[source]#

DistributedOptimizer 接受分布在不同 worker 上的参数的远程引用，并在每个参数上本地应用给定的优化器。

此类使用 get_gradients() 来检索特定参数的梯度。

对 step() 的并发调用，无论来自同一客户端还是不同客户端，都会在每个 worker 上进行串行化处理——因为每个 worker 的优化器一次只能处理一组梯度。然而，不能保证整个前向-后向-优化器序列一次只为一个客户端执行。这意味着正在应用的梯度可能不对应于给定 worker 上执行的最新前向传递。此外，跨 worker 也没有保证的顺序。

DistributedOptimizer 默认情况下使用 TorchScript 创建本地优化器，以便在多线程训练（例如分布式模型并行）的情况下，优化器更新不会被 Python 全局解释器锁 (GIL) 阻塞。此功能目前对大多数优化器都已启用。您也可以按照 PyTorch 教程中的示例为自己的自定义优化器启用 TorchScript 支持。

参数

optimizer_class (optim.Optimizer) – 在每个 worker 上实例化的优化器类。
params_rref (list[RRef]) – 到本地或远程参数的 RRefs 列表，用于优化。
args – 传递给每个 worker 上优化器构造函数的参数。
kwargs – 传递给每个 worker 上优化器构造函数的参数。

示例：

>>> import torch.distributed.autograd as dist_autograd
>>> import torch.distributed.rpc as rpc
>>> from torch import optim
>>> from torch.distributed.optim import DistributedOptimizer
>>>
>>> with dist_autograd.context() as context_id:
>>>   # Forward pass.
>>>   rref1 = rpc.remote("worker1", torch.add, args=(torch.ones(2), 3))
>>>   rref2 = rpc.remote("worker1", torch.add, args=(torch.ones(2), 1))
>>>   loss = rref1.to_here() + rref2.to_here()
>>>
>>>   # Backward pass.
>>>   dist_autograd.backward(context_id, [loss.sum()])
>>>
>>>   # Optimizer.
>>>   dist_optim = DistributedOptimizer(
>>>      optim.SGD,
>>>      [rref1, rref2],
>>>      lr=0.05,
>>>   )
>>>   dist_optim.step(context_id)

step(context_id)[source]#

执行一次优化步骤。

这将调用包含要优化的参数的每个 worker 上的 torch.optim.Optimizer.step()，并一直阻塞直到所有 worker 返回。提供的 context_id 将用于检索包含应应用于参数的梯度的相应 context。

参数: context_id – 我们应该为其运行优化器步骤的 autograd 上下文 id。

class torch.distributed.optim.PostLocalSGDOptimizer(optim, averager)[source]#

包装任意 torch.optim.Optimizer 并运行 post-local SGD。此优化器在每一步运行本地优化器。预热阶段之后，它在应用本地优化器后定期平均参数。

参数

optim (Optimizer) – 本地优化器。
averager (ModelAverager) – 用于运行 post-localSGD 算法的模型平均器实例。

示例

>>> import torch
>>> import torch.distributed as dist
>>> import torch.distributed.algorithms.model_averaging.averagers as averagers
>>> import torch.nn as nn
>>> from torch.distributed.optim import PostLocalSGDOptimizer
>>> from torch.distributed.algorithms.ddp_comm_hooks.post_localSGD_hook import (
>>>   PostLocalSGDState,
>>>   post_localSGD_hook,
>>> )
>>>
>>> model = nn.parallel.DistributedDataParallel(
>>>    module, device_ids=[rank], output_device=rank
>>> )
>>>
>>> # Register a post-localSGD communication hook.
>>> state = PostLocalSGDState(process_group=None, subgroup=None, start_localSGD_iter=100)
>>> model.register_comm_hook(state, post_localSGD_hook)
>>>
>>> # Create a post-localSGD optimizer that wraps a local optimizer.
>>> # Note that ``warmup_steps`` used in ``PostLocalSGDOptimizer`` must be the same as
>>> # ``start_localSGD_iter`` used in ``PostLocalSGDState``.
>>> local_optim = torch.optim.SGD(params=model.parameters(), lr=0.01)
>>> opt = PostLocalSGDOptimizer(
>>>     optim=local_optim,
>>>     averager=averagers.PeriodicModelAverager(period=4, warmup_steps=100)
>>> )
>>>
>>> # In the first 100 steps, DDP runs global gradient averaging at every step.
>>> # After 100 steps, DDP runs gradient averaging within each subgroup (intra-node by default),
>>> # and post-localSGD optimizer runs global model averaging every 4 steps after applying the local optimizer.
>>> for step in range(0, 200):
>>>    opt.zero_grad()
>>>    loss = loss_fn(output, labels)
>>>    loss.backward()
>>>    opt.step()

load_state_dict(state_dict)[source]#

这与 torch.optim.Optimizer 的 load_state_dict() 相同，但还恢复了模型平均器的步数到提供的 state_dict 中保存的值。

如果在 state_dict 中没有 "step" 条目，它将发出警告并将模型平均器的步数初始化为 0。

state_dict()[source]#: 这与 torch.optim.Optimizer 的 state_dict() 相同，但增加了一个额外的条目来记录模型平均器的步数到检查点，以确保重新加载时不会再次导致不必要的预热。

step()[source]#: 执行一次优化步骤（参数更新）。

class torch.distributed.optim.ZeroRedundancyOptimizer(params, optimizer_class, process_group=None, parameters_as_bucket_view=False, overlap_with_ddp=False, **defaults)[source]#

包装任意 optim.Optimizer 并将其状态分片到组内的 ranks 中。

共享方式描述如 ZeRO 所述。

每个 rank 的本地优化器实例仅负责更新大约 1 / world_size 的参数，因此只需要保留 1 / world_size 的优化器状态。在本地更新参数后，每个 rank 将其参数广播给所有其他对等节点，以使所有模型副本保持相同的状态。ZeroRedundancyOptimizer 可以与 torch.nn.parallel.DistributedDataParallel 结合使用，以减少每个 rank 的峰值内存消耗。

ZeroRedundancyOptimizer 使用排序贪心算法在每个 rank 上打包一定数量的参数。每个参数属于一个 rank，并且不跨 rank 分割。分区是任意的，可能不匹配参数的注册或使用顺序。

参数

params (Iterable) – 一个 Iterable，包含 torch.Tensor 或 dict，它们将跨 rank 进行分片。

关键字参数

optimizer_class (torch.nn.Optimizer) – 本地优化器的类。
process_group (ProcessGroup, 可选) – torch.distributed ProcessGroup（默认值：由 torch.distributed.init_process_group()初始化的 dist.group.WORLD）。
parameters_as_bucket_view (bool, 可选) – 如果为 True，则参数会被打包到 bucket 中以加快通信速度，并且 param.data 字段指向不同偏移量的 bucket 视图；如果为 False，则每个单独的参数都会单独通信，并且每个 params.data 保持不变（默认值：False）。
overlap_with_ddp (bool, 可选) – 如果为 True，则 step() 与 DistributedDataParallel 的梯度同步重叠；这需要 (1) 要么为 optimizer_class 参数提供一个函数式优化器，要么提供一个具有函数式等价物的优化器，并且 (2) 注册一个从 ddp_zero_hook.py 中的函数之一构造的 DDP 通信钩子；参数将被打包到与 DistributedDataParallel 匹配的 bucket 中，这意味着 parameters_as_bucket_view 参数将被忽略。如果为 False，则 step() 在后向传播之后（正常情况下）独立运行。（默认值：False）
**defaults – 任何尾随参数，它们会被原样转发给本地优化器。

示例

>>> import torch.nn as nn
>>> from torch.distributed.optim import ZeroRedundancyOptimizer
>>> from torch.nn.parallel import DistributedDataParallel as DDP
>>> model = nn.Sequential(*[nn.Linear(2000, 2000).to(rank) for _ in range(20)])
>>> ddp = DDP(model, device_ids=[rank])
>>> opt = ZeroRedundancyOptimizer(
>>>     ddp.parameters(),
>>>     optimizer_class=torch.optim.Adam,
>>>     lr=0.01
>>> )
>>> ddp(inputs).sum().backward()
>>> opt.step()

警告

目前，ZeroRedundancyOptimizer 要求所有传入的参数都是相同的密集类型。

警告

如果您传递 overlap_with_ddp=True，请注意以下几点：鉴于当前实现中的 DistributedDataParallel 与 ZeroRedundancyOptimizer 重叠的方式，前两到三次训练迭代在优化器步骤中不执行参数更新，具体取决于 static_graph=False 或 static_graph=True，分别是。这是因为需要关于 DistributedDataParallel 使用的梯度分桶策略的信息，如果 static_graph=False，则该信息在第二次前向传递时确定；如果 static_graph=True，则在第三次前向传递时确定。为了弥补这一点，一种选择是预置虚拟输入。

警告

ZeroRedundancyOptimizer 是实验性的，可能会发生变化。

add_param_group(param_group)[source]#

将一个参数组添加到 Optimizer 的 param_groups 中。

这在微调预训练网络时可能很有用，因为在训练过程中，可以使冻结层可训练并将其添加到 Optimizer 中。

参数: param_group (dict) – 指定要优化的参数以及特定于组的优化选项。

警告

此方法处理更新所有分片上的分片，但需要在所有 rank 上调用。在部分 rank 上调用此方法将导致训练挂起，因为通信原语是根据所管理的参数调用的，并且期望所有 rank 都参与同一组参数。

consolidate_state_dict(to=0)[source]#

在目标 rank 上合并一个 state_dict 列表（每个 rank 一个）。

参数: to (int) – 接收优化器状态的 rank（默认值：0）。
引发: RuntimeError – 如果 overlap_with_ddp=True 且在 ZeroRedundancyOptimizer 实例完全初始化（一旦 DistributedDataParallel 梯度 bucket 重建后）之前调用此方法。

警告

这需要在所有 rank 上调用。

property join_device: device#: 返回默认设备。

join_hook(**kwargs)[source]#

返回 ZeRO join 钩子。

它通过在优化器步骤中对集体通信进行影子处理，从而支持在不均匀输入上的训练。

在调用此钩子之前，必须正确设置梯度。

参数: kwargs (dict) – 一个 dict，包含任何用于在运行时修改 join 钩子行为的关键字参数；共享相同 join 上下文管理器所有 Joinable 实例将接收相同的 kwargs 值。

此钩子不支持任何关键字参数；即 kwargs 未使用。

property join_process_group: Any#: 返回进程组。

load_state_dict(state_dict)[source]#

从输入的 state_dict 加载与给定 rank 相关的状态，并根据需要更新本地优化器。

参数: state_dict (dict) – 优化器状态；应为调用 state_dict() 返回的对象。
引发: RuntimeError – 如果 overlap_with_ddp=True 且在 ZeroRedundancyOptimizer 实例完全初始化（一旦 DistributedDataParallel 梯度 bucket 重建后）之前调用此方法。

state_dict()[source]#

返回此 rank 已知的最后一个全局优化器状态。

引发: RuntimeError – 如果 overlap_with_ddp=True 且在 ZeroRedundancyOptimizer 实例完全初始化（一旦 DistributedDataParallel 梯度 bucket 重建后）之前调用此方法；或者如果在调用 consolidate_state_dict() 之前调用此方法。
返回类型: dict[str, Any]

step(closure=None, **kwargs)[source]#

执行一次优化步骤并跨所有 rank 同步参数。

参数: closure (Callable) – 一个重新评估模型并返回损失的闭包；对大多数优化器来说是可选的。
返回: 可选损失，取决于底层本地优化器。
返回类型: Optional[float]

注意

任何额外的参数都会原样传递给基础优化器。

分布式优化器#

文档

教程

资源