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}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 (iterable) – 要优化的参数的迭代器或定义参数组的字典
lr (float, Tensor, optional) – 学习率（默认值：1e-3）
momentum (float, optional) – 动量因子（默认值：0）
weight_decay (float, optional) – 权重衰减（L2 惩罚）（默认值：0）
dampening (float, optional) – 动量的阻尼（默认值：0）
nesterov (bool, optional) – 启用 Nesterov 动量（默认值：False）
maximize (bool, optional) – 相对于参数最大化目标函数，而不是最小化（默认值：False）
foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而不是 for 循环实现，因为 foreach 通常性能更高。请注意，foreach 实现比 for 循环版本使用大约 sizeof(params) 更多的峰值内存，因为中间结果是张量列表，而不是单个张量。如果内存不足，请一次对更少的参数进行批处理，或将此标志切换为 False（默认值：None）
differentiable (bool, optional) – 是否在训练过程中对优化器步长执行自动微分。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 会降低性能，因此如果您不打算对该实例运行自动微分，请将其保留为 False（默认值：False）
fused (bool, optional) – 是否使用融合实现。目前，支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。（默认值：None）

注意

foreach 和融合实现通常比 for 循环、单张量实现更快，理论上融合实现通过垂直和水平融合速度最快。因此，如果用户未指定任何标志（即，当 foreach = fused = None 时），我们将在所有张量都在 CUDA 上时尝试默认使用 foreach 实现。为什么不使用融合？由于融合实现是比较新的，我们希望给它足够的时间来验证。要指定融合，请将 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()

注意

使用动量/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)¶

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

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

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

load_state_dict(state_dict)¶

加载优化器状态。

参数: state_dict (dict) – 优化器状态。应该是一个由调用 state_dict() 返回的对象。

register_load_state_dict_post_hook(hook, prepend=False)¶

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

hook(optimizer) -> None

The optimizer argument is the optimizer instance being used.

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

参数

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

Returns

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

Return type

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

The optimizer argument is the optimizer instance being used and the state_dict argument is a shallow copy of the state_dict the user passed in to load_state_dict. The hook may modify the state_dict inplace or optionally return a new one. If a state_dict is returned, it will be used to be loaded into the optimizer.

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

参数

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

Returns

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

Return type

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。注册的挂钩可用于在返回 state_dict 之前对其进行后处理。

参数

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

Returns

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

Return type

torch.utils.hooks.RemoveableHandle

register_state_dict_pre_hook(hook, prepend=False)¶

注册一个 state dict 前挂钩，它将在调用 state_dict() 之前被调用。

它应该具有以下签名

hook(optimizer) -> None

The optimizer argument is the optimizer instance being used. The hook will be called with argument self before calling state_dict on self. The registered hook can be used to perform pre-processing before the state_dict call is made.

参数

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

Returns

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

Return type

torch.utils.hooks.RemoveableHandle

register_step_post_hook(hook)¶

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

它应该具有以下签名

hook(optimizer, args, kwargs) -> None

The optimizer argument is the optimizer instance being used.

参数: hook (Callable) – 要注册的用户定义挂钩。
Returns: 一个句柄，可通过调用 handle.remove() 来删除添加的挂钩
Return type: torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook)¶

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

它应该具有以下签名

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

The optimizer argument is the optimizer instance being used. If args and kwargs are modified by the pre-hook, then the transformed values are returned as a tuple containing the new_args and new_kwargs.

参数: hook (Callable) – 要注册的用户定义挂钩。
Returns: 一个句柄，可通过调用 handle.remove() 来删除添加的挂钩
Return type: torch.utils.hooks.RemovableHandle

state_dict()¶

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

它包含两个条目

state: 保存当前优化状态的 Dict。其内容
在不同的优化器类之间有所不同，但一些共同特征保持不变。例如，状态是为每个参数保存的，参数本身没有保存。 state 是一个 Dictionary，将参数 ID 映射到一个 Dict，其中包含与每个参数对应的状态。
param_groups: 包含所有参数组的 List，其中每个
参数组是一个 Dict。每个参数组都包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。

注意：参数 ID 可能看起来像索引，但它们只是与参数组关联状态的 ID。从 state_dict 加载时，优化器将拉链 param_group params (int ID) 和优化器 param_groups (实际 nn.Parameter s) 为了匹配状态，无需额外验证。

返回的 state dict 可能类似于

{
    '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]
        },
        {
            'lr': 0.001,
            'weight_decay': 0.5,
            ...
            'params': [1, 2, 3]
        }
    ]
}

Return type: Dict[str, Any]

step(closure=None)[source]¶

执行单个优化步骤。

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

zero_grad(set_to_none=True)¶

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

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

SGD¶

文档

教程

资源