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)[源][源]¶

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

\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动量基于On the importance of initialization and momentum in deep learning这篇论文中的公式。

参数

参数 (可迭代对象) – 用于优化的参数或命名参数的可迭代对象，或定义参数组的字典可迭代对象。当使用命名参数时，所有组中的所有参数都应被命名
学习率 (浮点数, 张量, 可选) – 学习率 (默认值: 1e-3)
动量 (浮点数, 可选) – 动量因子 (默认值: 0)
阻尼 (浮点数, 可选) – 动量的阻尼系数 (默认值: 0)
权重衰减 (浮点数, 可选) – 权重衰减 (L2惩罚) (默认值: 0)
nesterov (布尔值, 可选) – 启用 Nesterov 动量。仅在动量非零时适用。(默认值: False)
最大化 (布尔值, 可选) – 相对于参数最大化目标函数，而非最小化 (默认值: False)
foreach (布尔值, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定 (即 foreach 为 None)，我们将尝试在 CUDA 上优先使用 foreach 实现而非 for 循环实现，因为它通常性能显著更高。请注意，由于中间结果是张量列表而不仅仅是一个张量，foreach 实现比 for 循环版本使用的峰值内存大约多 size(params)。如果内存限制严格，请每次通过优化器处理更少参数或将此标志切换为 False。(默认值: None)
可微分 (bool, 可选) – 在训练过程中，autograd 是否应通过优化器 step 函数进行。否则，step() 函数将在 torch.no_grad() 上下文下运行。将其设置为 True 可能会影响性能，因此如果您不打算通过此实例运行 autograd，请将其保留为 False (默认值: False)。
融合 (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 et al. 和其他框架使用的更新形式不同：

\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)[源代码]¶

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

这在微调预训练网络时非常有用，因为冻结的层可以被设置为可训练并在训练过程中添加到 Optimizer 中。

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

load_state_dict(state_dict)[源代码]¶

加载优化器状态。

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

注意

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

register_load_state_dict_post_hook(hook, prepend=False)[源代码]¶

注册一个 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)[源代码]¶

注册一个 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，它将被用于加载到优化器中。

在对 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)[源代码]¶

注册一个 state dict 后置钩子，它将在调用 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)[源代码]¶

注册一个 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)[源代码]¶

注册一个优化器 step 后置钩子，它将在优化器 step 后被调用。

它应具有以下签名：

hook(optimizer, args, kwargs) -> None

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

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

register_step_pre_hook(hook)[源代码]¶

注册一个优化器 step 前置钩子，它将在优化器 step 之前被调用。

它应具有以下签名：

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()[源代码]¶

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

它包含两个条目：

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

注意：参数 ID 可能看起来像索引，但它们只是将状态与参数组关联起来的 ID。从 state_dict 加载时，优化器将压缩参数组的 params（整数 ID）和优化器的 param_groups（实际的 nn.Parameter）以匹配状态，而无需额外的验证。

返回的状态字典可能类似于：

{
    '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)[源代码][源代码]¶

执行一次优化 step。

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

zero_grad(set_to_none=True)[源代码]¶

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

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

SGD¶

文档

教程

资源