分布式优化器

警告

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

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

class torch.distributed.optim.DistributedOptimizer(optimizer_class, params_rref, *args, **kwargs)

DistributedOptimizer 接受分散在 worker 之间的参数的远程引用，并为每个参数在本地应用给定的优化器。

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

对 step() 的并发调用（来自相同或不同的客户端）将在每个 worker 上序列化 - 因为每个 worker 的优化器一次只能处理一组梯度。但是，不能保证一个客户端完整的前向-后向-优化器序列会一次执行。这意味着正在应用的梯度可能与给定 worker 上执行的最新前向传递不对应。此外，worker 之间没有保证的顺序。

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

参数

• optimizer_class (optim.Optimizer) – 要在每个 worker 上实例化的优化器的类。

• params_rref (list[RRef]) – 要优化的本地或远程参数的 RRef 列表。

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

执行单个优化步骤。

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

参数

context_id – 我们应为其运行优化器步骤的 autograd 上下文 ID。

class torch.distributed.optim.PostLocalSGDOptimizer(optim, averager)

包装任意 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)

这与 torch.optim.Optimizer load_state_dict() 相同，但也会将模型平均器的步数值恢复为 state_dict 中保存的值。

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

state_dict()

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

step()

执行单个优化步骤（参数更新）。

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

包装任意 optim.Optimizer 并在组中的 rank 之间分片其状态。

共享按照 ZeRO 的描述完成。

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

ZeroRedundancyOptimizer 使用排序贪婪算法在每个 rank 上打包许多参数。每个参数属于单个 rank，并且不在 rank 之间划分。分区是任意的，可能与参数注册或使用顺序不匹配。

参数

params (Iterable) – Iterable 的 torch.Tensor s 或 dict s，提供将跨 rank 分片的所有参数。

关键字参数

• optimizer_class (torch.nn.Optimizer) – 本地优化器的类。

• process_group (ProcessGroup, optional) – torch.distributed ProcessGroup (默认值：由 torch.distributed.init_process_group() 初始化的 dist.group.WORLD)。

• parameters_as_bucket_view (bool, optional) – 如果 True，则参数被打包到 bucket 中以加速通信，并且 param.data 字段指向不同偏移量的 bucket 视图；如果 False，则每个单独的参数都会单独通信，并且每个 params.data 保持不变 (默认值：False)。

• overlap_with_ddp (bool, optional) – 如果 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 使用的梯度 bucketing 策略的信息，如果 static_graph=False，则在第二次前向传递之前不会最终确定，如果 static_graph=True，则在第三次前向传递之前不会最终确定。为了对此进行调整，一种选择是预先添加虚拟输入。

警告

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

add_param_group(param_group)

将参数组添加到 Optimizer 的 param_groups。

当微调预训练网络时，这可能很有用，因为可以将冻结层设为可训练并添加到 Optimizer 中，随着训练的进行。

参数

param_group (dict) – 指定要优化的参数和组特定的优化选项。

警告

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

consolidate_state_dict(to=0)

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

参数

to (int) – 接收优化器状态的 rank（默认值：0）。

Raises

RuntimeError – 如果 overlap_with_ddp=True 并且此方法在此 ZeroRedundancyOptimizer 实例完全初始化之前被调用，这会在 DistributedDataParallel 梯度 bucket 重建后发生。

警告

这需要在所有 rank 上调用。

property join_device: device

返回默认设备。

join_hook(**kwargs)

返回 ZeRO join hook。

它通过在优化器步骤中隐藏集体通信来支持在不均匀输入上进行训练。

梯度必须在此 hook 被调用之前正确设置。

参数

kwargs (dict) – 一个 dict，其中包含任何关键字参数，用于在运行时修改 join hook 的行为；共享相同 join 上下文管理器的所有 Joinable 实例都会转发 kwargs 的相同值。

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

property join_process_group: Any

返回进程组。

load_state_dict(state_dict)

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

参数

state_dict (dict) – 优化器状态；应是从调用 state_dict() 返回的对象。

Raises

RuntimeError – 如果 overlap_with_ddp=True 并且此方法在此 ZeroRedundancyOptimizer 实例完全初始化之前被调用，这会在 DistributedDataParallel 梯度 bucket 重建后发生。

state_dict()

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

Raises

RuntimeError – 如果 overlap_with_ddp=True 并且此方法在此 ZeroRedundancyOptimizer 实例完全初始化之前被调用，这会在 DistributedDataParallel 梯度 bucket 重建后发生；或者如果此方法在没有先前调用 consolidate_state_dict() 的情况下被调用。

返回类型

Dict[str, Any]

step(closure=None, **kwargs)

执行单个优化器步骤并在所有 rank 之间同步参数。

参数

closure (Callable) – 一个重新评估模型并返回损失的闭包；对于大多数优化器是可选的。

返回值

可选的损失，取决于底层的本地优化器。

返回类型

Optional[float]