RMSprop

class torch.optim.RMSprop(params, lr=0.01, alpha=0.99, eps=1e-08, weight_decay=0, momentum=0, centered=False, capturable=False, foreach=None, maximize=False, differentiable=False)

实现 RMSprop 算法。

$$\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \alpha \text{ (alpha)}, \: \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)} \\ &\hspace{13mm} \lambda \text{ (weight decay)},\: \mu \text{ (momentum)}, \: centered, \: \epsilon \text{ (epsilon)} \\ &\textbf{initialize} : v_0 \leftarrow 0 \text{ (square average)}, \: \textbf{b}_0 \leftarrow 0 \text{ (buffer)}, \: g^{ave}_0 \leftarrow 0 \\[-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}if \: \lambda \neq 0 \\ &\hspace{10mm} g_t \leftarrow g_t + \lambda \theta_{t-1} \\ &\hspace{5mm}v_t \leftarrow \alpha v_{t-1} + (1 - \alpha) g^2_t \hspace{8mm} \\ &\hspace{5mm} \tilde{v_t} \leftarrow v_t \\ &\hspace{5mm}if \: centered \\ &\hspace{10mm} g^{ave}_t \leftarrow g^{ave}_{t-1} \alpha + (1-\alpha) g_t \\ &\hspace{10mm} \tilde{v_t} \leftarrow \tilde{v_t} - \big(g^{ave}_{t} \big)^2 \\ &\hspace{5mm}if \: \mu > 0 \\ &\hspace{10mm} \textbf{b}_t\leftarrow \mu \textbf{b}_{t-1} + g_t/ \big(\sqrt{\tilde{v_t}} + \epsilon \big) \\ &\hspace{10mm} \theta_t \leftarrow \theta_{t-1} - \gamma \textbf{b}_t \\ &\hspace{5mm} else \\ &\hspace{10mm}\theta_t \leftarrow \theta_{t-1} - \gamma g_t/ \big(\sqrt{\tilde{v_t}} + \epsilon \big) \hspace{3mm} \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}$$

有关该算法的更多详情，请参考 G. Hinton 的讲义。以及中心化版本 Generating Sequences With Recurrent Neural Networks。此处的实现是在 epsilon 之前对梯度平均值进行平方根运算（请注意，TensorFlow 互换了这两个操作）。因此，有效学习率是 $\gamma/(\sqrt{v} + \epsilon)$，其中 $\gamma$ 是计划学习率，而 $v$ 是梯度平方的加权移动平均。

参数

• params (iterable) – 要优化的参数或命名参数的迭代器，或者是定义参数组的字典的迭代器。使用命名参数时，所有组中的所有参数都应该命名。

• lr （float, Tensor, optional）– 学习率 (默认值: 1e-2)

• alpha （float, optional）– 平滑常数 (默认值: 0.99)

• eps （float, optional）– 添加到分母中的项，以提高数值稳定性 (默认值: 1e-8)

• weight_decay (float, 可选) – 权重衰减（L2惩罚）（默认值：0）。

• momentum （float, optional）– 动量因子 (默认值: 0)

• centered （bool, optional）– 如果为 True，则计算中心化 RMSprop，梯度根据其方差的估计进行归一化

• capturable （bool, optional）– 此实例是否可以安全地捕获到图中，用于 CUDA 图或 torch.compile 支持。张量仅在支持的 加速器 上才可捕获。将此参数设置为 True 可能会影响未图捕获的性能，因此如果您不打算对此实例进行图捕获，请将其保留为 False (默认值: False)

• foreach （bool, optional）– 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将尝试在 CUDA 上使用 foreach 而不是 for-loop 实现，因为它通常性能显著优于后者。请注意，foreach 实现会比 for-loop 版本多占用约 sizeof(params) 的峰值内存，因为中间值是张量列表而不是单个张量。如果内存过高，请尝试减少一次通过优化器处理的参数数量，或者将此标志设置为 False (默认值: None)

• maximize （bool, optional）– 最大化相对于 params 的目标，而不是最小化 (默认值: False)

• differentiable （bool, optional）– 在训练期间，autograd 是否应该通过优化器步骤。否则，step() 函数将在 torch.no_grad() 上下文中运行。将其设置为 True 可能会影响性能，因此如果您不打算通过此实例运行 autograd，请将其保留为 False (默认值: False)

add_param_group(param_group)

将一个参数组添加到 Optimizer 的 param_groups 中。

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

参数

param_group （dict）– 指定应优化哪些张量，以及特定于组的优化选项。

load_state_dict(state_dict)

加载优化器状态。

参数

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)

注册一个 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。如果返回了一个 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。注册的钩子可用于在 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)

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

它应具有以下签名

hook(optimizer, args, kwargs) -> None

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

参数

hook (Callable) – 用户定义的待注册钩子。

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook)

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

它应具有以下签名

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 映射到一个包含与每个参数对应的状态的字典。

• param_groups：一个包含所有参数组的 List，其中每个

  参数组是一个字典。每个参数组包含优化器特定的元数据，例如学习率和权重衰减，以及该组中参数 ID 的列表。如果参数组是使用 named_parameters() 初始化，那么名称内容也将保存在 state_dict 中。

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

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

{
    '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)

执行单个优化步骤。

参数

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 时行为不同（一种情况是它执行带有零梯度的步长，另一种情况是它完全跳过该步长）。