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][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}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}\textbf{if} \: \textit{maximize} \\ &\hspace{10mm}\theta_t \leftarrow \theta_{t-1} + \gamma g_t \\[-1.ex] &\hspace{5mm}\textbf{else} \\[-1.ex] &\hspace{10mm}\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 (可迭代对象) – 用于优化的参数或 named_parameters 的可迭代对象，或定义参数组的字典的可迭代对象。当使用 named_parameters 时，所有组中的所有参数都应被命名
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 循环实现，因为它通常性能更高。请注意，由于中间值是张量列表而不是单个张量，foreach 实现使用的峰值内存比 for 循环版本多约 ~ 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 循环、单张量实现更快，其中 fused 在理论上是垂直和水平融合最快的。因此，如果用户未指定任何标志 (即，当 foreach = fused = None 时)，当张量都位于 CUDA 上时，我们将尝试默认使用 foreach 实现。为什么不是 fused？由于 fused 实现相对较新，我们希望给它足够的预热时间。要指定 fused，请为 fused 传递 True。要强制运行 for 循环实现，请为 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()

注意

带有 Momentum/Nesterov 的 SGD 的实现与其他一些框架中的 Sutskever et al. 和实现略有不同。

考虑到 Momentum 的具体情况，更新可以写成

\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() 返回的对象。

注意

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

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 后置钩子，它将在调用 state_dict() 后被调用。

它应具有以下签名

hook(optimizer, state_dict) -> state_dict or None

在 self 上生成 state_dict 后，将使用参数 self 和 state_dict 调用钩子。钩子可能会就地修改 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 前置钩子，它将在调用 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 参数是正在使用的优化器实例。如果 pre-hook 修改了 args 和 kwargs，则转换后的值将作为包含 new_args 和 new_kwargs 的元组返回。

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

state_dict()[source]¶

以 dict 形式返回优化器的状态。

它包含两个条目

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

注意：参数 ID 可能看起来像索引，但它们只是将状态与参数组关联的 ID。从 state_dict 加载时，优化器将压缩 param_group params（int 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][source]¶

执行单个优化步骤。

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

zero_grad(set_to_none=True)[source]¶

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

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

SGD¶

文档

教程

资源