RAdam

class torch.optim.RAdam(params, lr=0.001, betas=(0.9, 0.999), eps=1e-08, weight_decay=0, decoupled_weight_decay=False, *, foreach=None, maximize=False, capturable=False, differentiable=False)

实现了 RAdam 算法。

$$\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{ (lr)}, \: \beta_1, \beta_2 \text{ (betas)}, \: \theta_0 \text{ (params)}, \:f(\theta) \text{ (objective)}, \: \lambda \text{ (weightdecay)}, \:\textit{maximize} \\ &\hspace{13mm} \epsilon \text{ (epsilon)}, \textit{decoupled\_weight\_decay} \\ &\textbf{initialize} : m_0 \leftarrow 0 \text{ ( first moment)}, v_0 \leftarrow 0 \text{ ( second moment)}, \\ &\hspace{18mm} \rho_{\infty} \leftarrow 2/(1-\beta_2) -1 \\[-1.ex] &\rule{110mm}{0.4pt} \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{6mm}\textbf{if} \: \textit{maximize}: \\ &\hspace{12mm}g_t \leftarrow -\nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{6mm}\textbf{else} \\ &\hspace{12mm}g_t \leftarrow \nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{6mm} \theta_t \leftarrow \theta_{t-1} \\ &\hspace{6mm} \textbf{if} \: \lambda \neq 0 \\ &\hspace{12mm}\textbf{if} \: \textit{decoupled\_weight\_decay} \\ &\hspace{18mm} \theta_t \leftarrow \theta_{t} - \gamma \lambda \theta_{t} \\ &\hspace{12mm}\textbf{else} \\ &\hspace{18mm} g_t \leftarrow g_t + \lambda \theta_{t} \\ &\hspace{6mm}m_t \leftarrow \beta_1 m_{t-1} + (1 - \beta_1) g_t \\ &\hspace{6mm}v_t \leftarrow \beta_2 v_{t-1} + (1-\beta_2) g^2_t \\ &\hspace{6mm}\widehat{m_t} \leftarrow m_t/\big(1-\beta_1^t \big) \\ &\hspace{6mm}\rho_t \leftarrow \rho_{\infty} - 2 t \beta^t_2 /\big(1-\beta_2^t \big) \\[0.1.ex] &\hspace{6mm}\textbf{if} \: \rho_t > 5 \\ &\hspace{12mm} l_t \leftarrow \frac{\sqrt{ (1-\beta^t_2) }}{ \sqrt{v_t} +\epsilon } \\ &\hspace{12mm} r_t \leftarrow \sqrt{\frac{(\rho_t-4)(\rho_t-2)\rho_{\infty}}{(\rho_{\infty}-4)(\rho_{\infty}-2) \rho_t}} \\ &\hspace{12mm}\theta_t \leftarrow \theta_t - \gamma \widehat{m_t} r_t l_t \\ &\hspace{6mm}\textbf{else} \\ &\hspace{12mm}\theta_t \leftarrow \theta_t - \gamma \widehat{m_t} \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}$$

有关该算法的更多详细信息，请参阅 On the variance of the adaptive learning rate and beyond。

此实现通过 `decoupled_weight_decay` 选项，可以选择使用 Adam 中的原始 `weight_decay` 实现（其中 `weight_decay` 应用于梯度），或者使用 AdamW 中的实现（其中 `weight_decay` 应用于权重）。当 `decoupled_weight_decay` 设置为 `False`（默认值）时，它使用原始的 Adam 风格权重衰减；否则，它使用 AdamW 风格，这更接近 RAdam 论文中 作者的实现。有关解耦权重衰减的更多信息，请参阅 Decoupled Weight Decay Regularization。

参数

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

• lr (float, Tensor, optional) – 学习率 (默认: 1e-3)

• betas (Tuple[float, float], optional) – 用于计算梯度及其平方的运行平均值的系数 (默认: (0.9, 0.999))

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

• weight_decay (float, optional) – 权重衰减 (L2 惩罚) (默认: 0)

• decoupled_weight_decay (bool, optional) – 是否解耦权重衰减，如 AdamW 中所做的那样，以获得 RAdamW。如果为 `True`，算法不会在动量或方差中累积权重衰减。（默认值：`False`）

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

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

• capturable (bool, optional) – 此实例是否可以安全地捕获到图中，用于 CUDA 图或 torch.compile 支持。Tensors 只有在受支持的 加速器 上才可捕获。设置为 True 可能会损害未图捕获时的性能，因此如果您不打算图捕获此实例，请将其保留为 False (默认: 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) – 指定哪些 Tensor 应该被优化，以及组特定的优化选项。

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_names` 并且在 `param_groups` 中，则它们将被保存并覆盖优化器状态中当前存在的名称。如果它们在加载的状态字典中不存在，则优化器的 `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 是正在使用的优化器实例。

调用 load_state_dict 到 self 上后，钩子将使用参数 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 和 state_dict 调用，在调用 load_state_dict 到 self 上之前。注册的钩子可用于在调用 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)

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

它应具有以下签名

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

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

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

注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时，优化器会按顺序匹配 param_group 的 params（int 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)

执行单个优化步骤。

参数

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

zero_grad(set_to_none=True)

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

参数

set_to_none (bool, optional) –

将梯度设置为 None，而不是设置为零。默认值：True

这通常会降低内存占用，并能适度提高性能。但是，它会改变某些行为。例如：

1. 当用户尝试访问梯度并对其进行手动运算时，None 属性或全零的 Tensor 会产生不同的行为。

2. 如果用户请求 zero_grad(set_to_none=True) 然后执行 backward，对于未收到梯度的参数，其 .grad 保证为 None。

3. torch.optim 优化器在梯度为 0 或 None 时行为不同（一种情况是以 0 梯度执行步长，另一种情况是跳过该步长）。