SGD#

class torch.optim.SGD(params, lr=0.001, momentum=0, dampening=0, weight_decay=0, nesterov=False, *, maximize=False, foreach=None, differentiable=False, fused=None)[source]#

实现随机梯度下降（可选带有动量）。

\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)}, \: \lambda \text{ (weight decay)}, \\ &\hspace{13mm} \:\mu \text{ (momentum)}, \:\tau \text{ (dampening)}, \:\textit{ nesterov,}\:\textit{ maximize} \\[-1.ex] &\rule{110mm}{0.4pt} \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{5mm}\textbf{if} \: \textit{maximize}: \\ &\hspace{10mm}g_t \leftarrow -\nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm}\textbf{else} \\ &\hspace{10mm}g_t \leftarrow \nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm}\textbf{if} \: \lambda \neq 0 \\ &\hspace{10mm} g_t \leftarrow g_t + \lambda \theta_{t-1} \\ &\hspace{5mm}\textbf{if} \: \mu \neq 0 \\ &\hspace{10mm}\textbf{if} \: t > 1 \\ &\hspace{15mm} \textbf{b}_t \leftarrow \mu \textbf{b}_{t-1} + (1-\tau) g_t \\ &\hspace{10mm}\textbf{else} \\ &\hspace{15mm} \textbf{b}_t \leftarrow g_t \\ &\hspace{10mm}\textbf{if} \: \textit{nesterov} \\ &\hspace{15mm} g_t \leftarrow g_{t} + \mu \textbf{b}_t \\ &\hspace{10mm}\textbf{else} \\[-1.ex] &\hspace{15mm} g_t \leftarrow \textbf{b}_t \\ &\hspace{5mm}\theta_t \leftarrow \theta_{t-1} - \gamma g_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}

Nesterov 动量是基于论文《深度学习中初始化和动量的重要性》中的公式。

参数

params (iterable) – 要优化的参数或命名参数的迭代器，或者是定义参数组的字典的迭代器。使用命名参数时，所有组中的所有参数都应该命名。
lr (float, Tensor, 可选) – 学习率 (默认: 1e-3)
momentum (float, 可选) – 动量因子 (默认: 0)
dampening (float, 可选) – 动量的阻尼因子 (默认: 0)
weight_decay (float, 可选) – 权重衰减（L2惩罚）（默认值：0）。
nesterov (bool, 可选) – 启用 Nesterov 动量。仅当动量非零时适用。(默认: False)
maximize (bool, 可选) – 相对于参数最大化目标函数，而不是最小化 (默认: False)
foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定（即 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而不是 for-loop 实现，因为它通常性能显著更高。请注意，foreach 实现由于中间结果是张量列表而不是单个张量，因此比 for-loop 版本多占用约 sizeof(params) 的峰值内存。如果内存限制，请每次通过优化器批量处理更少的参数，或将此标志设置为 False (默认: None)
differentiable (bool, 可选) – 训练过程中是否在优化器步长中进行自动求导。否则，step() 函数在 torch.no_grad() 上下文中运行。设置为 True 可能会影响性能，因此如果您不打算通过此实例运行自动求导，请将其保留为 False (默认: False)
fused (bool, 可选) – 是否使用融合实现。目前支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。(默认: None)

注意

foreach 和 fused 实现通常比 for-loop 单张量实现更快，其中 fused 在理论上结合垂直和水平融合时速度最快。因此，如果用户未指定任何标志（即 foreach = fused = None），当所有张量都在 CUDA 上时，我们将尝试默认使用 foreach 实现。为什么不是 fused？因为 fused 实现相对较新，我们希望给它足够长的验证时间。要指定 fused，请将 fused 设为 True。要强制运行 for-loop 实现，请将 foreach 或 fused 设为 False。

示例

>>> optimizer = torch.optim.SGD(model.parameters(), lr=0.1, momentum=0.9)
>>> optimizer.zero_grad()
>>> loss_fn(model(input), target).backward()
>>> optimizer.step()

注意

带动量/Nesterov 的 SGD 实现与 Sutskever 等人以及其他一些框架中的实现略有不同。

考虑动量的具体情况，更新可以写成：

\begin{aligned} v_{t+1} & = \mu * v_{t} + g_{t+1}, \\ p_{t+1} & = p_{t} - \text{lr} * v_{t+1}, \end{aligned}

其中 $p$ 、 $g$ 、 $v$ 和 $\mu$ 分别表示参数、梯度、速度和动量。

这与 Sutskever 等人和其他框架中采用的更新形式不同：

\begin{aligned} v_{t+1} & = \mu * v_{t} + \text{lr} * g_{t+1}, \\ p_{t+1} & = p_{t} - v_{t+1}. \end{aligned}

Nesterov 版本也进行了类似的修改。

此外，动量缓冲区的初始值被设置为第一步的梯度值。这与某些其他框架将其初始化为全零不同。此决策的一个显著副作用是，第一个动量值将不会被阻尼因子缩放。阻尼将在第二步开始应用。

add_param_group(param_group)[source]#

向 Optimizer 的 param_groups 添加一个参数组。

这在微调预训练网络时非常有用，因为冻结层可以变得可训练，并随着训练的进行添加到 Optimizer 中。

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

load_state_dict(state_dict)[source]#

加载优化器状态。

参数: state_dict (dict) – 优化器状态。应为调用 state_dict() 返回的对象。

警告

确保此方法在初始化 torch.optim.lr_scheduler.LRScheduler 之后调用，因为在此之前调用会覆盖已加载的学习率。

注意

参数名称（如果它们存在于 state_dict() 中每个参数组的“param_names”键下）不会影响加载过程。要将参数名称用于自定义情况（例如，当加载状态字典中的参数与优化器中初始化的参数不同时），应实现自定义的 register_load_state_dict_pre_hook 以相应地调整加载的字典。如果加载状态字典 param_groups 中存在 param_names，它们将被保存并覆盖优化器状态中当前存在的名称。如果加载状态字典中不存在，优化器的 param_names 将保持不变。

示例

>>> model = torch.nn.Linear(10, 10)
>>> optim = torch.optim.SGD(model.parameters(), lr=3e-4)
>>> scheduler1 = torch.optim.lr_scheduler.LinearLR(
...     optim,
...     start_factor=0.1,
...     end_factor=1,
...     total_iters=20,
... )
>>> scheduler2 = torch.optim.lr_scheduler.CosineAnnealingLR(
...     optim,
...     T_max=80,
...     eta_min=3e-5,
... )
>>> lr = torch.optim.lr_scheduler.SequentialLR(
...     optim,
...     schedulers=[scheduler1, scheduler2],
...     milestones=[20],
... )
>>> lr.load_state_dict(torch.load("./save_seq.pt"))
>>> # now load the optimizer checkpoint after loading the LRScheduler
>>> optim.load_state_dict(torch.load("./save_optim.pt"))

register_load_state_dict_post_hook(hook, prepend=False)[source]#

注册一个 load_state_dict 后钩子，它将在调用 load_state_dict() 后被调用。它应具有以下签名：

hook(optimizer) -> None

参数 optimizer 是正在使用的优化器实例。

在对 self 调用 load_state_dict 后，将使用参数 self 调用此钩子。注册的钩子可用于在 load_state_dict 加载 state_dict 后执行后处理。

参数

hook (Callable) – 用户定义的待注册钩子。
prepend (bool) – 如果为 True，则提供的后 hook 将在所有已注册的 load_state_dict 后钩子之前触发。否则，提供的 hook 将在所有已注册的后钩子之后触发。(默认: False)

返回

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型

torch.utils.hooks.RemoveableHandle

register_load_state_dict_pre_hook(hook, prepend=False)[source]#

注册一个 load_state_dict 前钩子，它将在调用 load_state_dict() 之前被调用。它应具有以下签名：

hook(optimizer, state_dict) -> state_dict or None

optimizer 参数是正在使用的优化器实例，state_dict 参数是用户传递给 load_state_dict 的 state_dict 的浅拷贝。该钩子可以原地修改 state_dict，或者选择返回一个新的 state_dict。如果返回 state_dict，它将用于加载到优化器中。

在对 self 调用 load_state_dict 之前，将使用参数 self 和 state_dict 调用此钩子。注册的钩子可用于在进行 load_state_dict 调用之前执行预处理。

参数

hook (Callable) – 用户定义的待注册钩子。
prepend (bool) – 如果为 True，则提供的前 hook 将在所有已注册的 load_state_dict 前钩子之前触发。否则，提供的前 hook 将在所有已注册的前钩子之后触发。(默认: False)

返回

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_post_hook(hook, prepend=False)[source]#

注册一个状态字典后钩子，它将在调用 state_dict() 后被调用。

它应具有以下签名

hook(optimizer, state_dict) -> state_dict or None

在对 self 生成 state_dict 后，将使用参数 self 和 state_dict 调用此钩子。钩子可以原地修改 state_dict，也可以选择返回一个新的。注册的钩子可用于在返回 state_dict 之前对其执行后处理。

参数

hook (Callable) – 用户定义的待注册钩子。
prepend (bool) – 如果为 True，则提供的后 hook 将在所有已注册的 state_dict 后钩子之前触发。否则，提供的 hook 将在所有已注册的后钩子之后触发。(默认: False)

返回

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_pre_hook(hook, prepend=False)[source]#

注册一个状态字典前钩子，它将在调用 state_dict() 之前被调用。

它应具有以下签名

hook(optimizer) -> None

optimizer 参数是正在使用的优化器实例。在对 self 调用 state_dict 之前，将使用参数 self 调用此钩子。注册的钩子可用于在进行 state_dict 调用之前执行预处理。

参数

hook (Callable) – 用户定义的待注册钩子。
prepend (bool) – 如果为 True，则提供的前 hook 将在所有已注册的 state_dict 前钩子之前触发。否则，提供的前 hook 将在所有已注册的前钩子之后触发。(默认: False)

返回

一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子

返回类型

torch.utils.hooks.RemoveableHandle

register_step_post_hook(hook)[source]#

注册一个优化器步骤后钩子，它将在优化器步骤之后被调用。

它应具有以下签名

hook(optimizer, args, kwargs) -> None

参数 optimizer 是正在使用的优化器实例。

参数: hook (Callable) – 用户定义的待注册钩子。
返回: 一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子
返回类型: torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook)[source]#

注册一个优化器步骤预钩子，它将在优化器步骤之前被调用。

它应具有以下签名

hook(optimizer, args, kwargs) -> None or modified args and kwargs

optimizer 参数是正在使用的优化器实例。如果 args 和 kwargs 被前钩子修改，则转换后的值将作为包含 new_args 和 new_kwargs 的元组返回。

参数: hook (Callable) – 用户定义的待注册钩子。
返回: 一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子
返回类型: torch.utils.hooks.RemovableHandle

state_dict()[source]#

将优化器的状态作为 dict 返回。

它包含两个条目

state：一个包含当前优化状态的 Dict。其内容
不同优化器类之间存在差异，但有一些共同的特点。例如，状态按参数保存，但参数本身不保存。state 是一个字典，将参数 ID 映射到包含每个参数对应状态的字典。
param_groups：一个包含所有参数组的 List，其中每个
参数组是一个字典。每个参数组包含优化器特有的元数据，如学习率和权重衰减，以及组中参数的参数 ID 列表。如果参数组使用 named_parameters() 初始化，则名称内容也将保存在状态字典中。

注意：参数 ID 看起来像索引，但它们只是将状态与参数组关联的 ID。从 state_dict 加载时，优化器会将 param_group params（整数 ID）与优化器 param_groups（实际 nn.Parameter s）打包在一起，以便在不进行额外验证的情况下匹配状态。

返回的状态字典可能看起来像

{
    'state': {
        0: {'momentum_buffer': tensor(...), ...},
        1: {'momentum_buffer': tensor(...), ...},
        2: {'momentum_buffer': tensor(...), ...},
        3: {'momentum_buffer': tensor(...), ...}
    },
    'param_groups': [
        {
            'lr': 0.01,
            'weight_decay': 0,
            ...
            'params': [0]
            'param_names' ['param0']  (optional)
        },
        {
            'lr': 0.001,
            'weight_decay': 0.5,
            ...
            'params': [1, 2, 3]
            'param_names': ['param1', 'layer.weight', 'layer.bias'] (optional)
        }
    ]
}

返回类型: dict[str, Any]

step(closure=None)[source]#

执行单个优化步骤。

参数: closure (Callable, 可选) – 一个重新评估模型并返回损失的闭包。

zero_grad(set_to_none=True)[source]#

重置所有优化过的 torch.Tensor 的梯度。

参数: set_to_none (bool) – 不将梯度设置为零，而是将其设置为 None。这通常会降低内存占用，并能适度提高性能。但是，它会改变某些行为。例如：1. 当用户尝试访问梯度并对其执行手动操作时，None 属性或填充 0 的张量将表现不同。2. 如果用户请求 zero_grad(set_to_none=True)，然后进行反向传播，则对于未收到梯度的参数，其 .grad 将保证为 None。3. torch.optim 优化器在梯度为 0 或 None 时具有不同的行为（一种情况下它会以 0 梯度执行步长，另一种情况下它会完全跳过该步）。

SGD#

文档

教程

资源