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}

有关算法的更多详细信息，请参阅自适应学习率的方差及其超越。

此实现提供了一个选项，可以使用 Adam 中的原始 weight_decay 实现（其中 weight_decay 应用于梯度）或 AdamW 中的实现（其中 weight_decay 应用于权重），这可以通过 decoupled_weight_decay 选项实现。当 decoupled_weight_decay 设置为 False（默认）时，它使用原始 Adam 样式的 weight_decay，否则，它使用 AdamW 样式，这更接近于 RAdam 论文中作者的实现。有关解耦权重衰减的更多信息，请参阅解耦权重衰减正则化。

参数

params (iterable) – 要优化的参数的 iterable 或定义参数组的字典
lr (float, Tensor, 可选) – 学习率（默认：1e-3）
betas (Tuple[float, float], 可选) – 用于计算梯度及其平方的运行平均值的系数（默认： (0.9, 0.999)）
eps (float, 可选) – 添加到分母的项，以提高数值稳定性（默认：1e-8）
weight_decay (float, 可选) – 权重衰减（L2 惩罚）（默认：0）
decoupled_weight_decay (bool, 可选) – 是否使用 AdamW 中的解耦权重衰减来获得 RAdamW（默认：False）
foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而不是 for 循环实现，因为它通常性能要高得多。请注意，foreach 实现比 for 循环版本使用大约 sizeof(params) 更多的峰值内存，因为中间结果是张量列表，而不仅仅是一个张量。如果内存有限，请一次通过优化器对更少的参数进行批处理，或将此标志切换为 False（默认：None）
maximize (bool, 可选) – 相对于参数最大化目标函数，而不是最小化（默认：False）
differentiable (bool, 可选) – 是否应在训练期间通过优化器步骤进行自动微分。否则，step() 函数在 torch.no_grad() 上下文中运行。设置为 True 会影响性能，因此，如果你不打算通过此实例运行自动微分，请保持 False（默认：False）
capturable (bool, 可选) – 此实例是否可以在 CUDA 图中安全捕获。将 True 传递可能影响非图化性能，因此，如果您不打算捕获此实例，请将其保留为 False（默认值：False）

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，则提供的后 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

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，则提供的预 hook 将在 load_state_dict 上所有已注册的预挂钩之前触发。否则，提供的 hook 将在所有已注册的预挂钩之后触发。（默认值：False）

返回值

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

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_post_hook(hook, prepend=False)¶

注册一个状态字典后挂钩，该挂钩将在调用 state_dict() 后调用。

它应该具有以下签名

hook(optimizer, state_dict) -> state_dict or None

在 self 上生成 state_dict 后，挂钩将使用参数 self 和 state_dict 调用。挂钩可以在原地修改 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() 之前调用。

它应该具有以下签名

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，则提供的预 hook 将在 state_dict 上所有已注册的预挂钩之前触发。否则，提供的 hook 将在所有已注册的预挂钩之后触发。（默认值：False）

返回值

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

返回类型

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) – 用户定义的要注册的挂钩。
返回值: 一个句柄，可用于通过调用 handle.remove() 来删除添加的挂钩
返回类型: 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) – 用户定义的要注册的挂钩。
返回值: 一个句柄，可用于通过调用 handle.remove() 来删除添加的挂钩
返回类型: torch.utils.hooks.RemovableHandle

state_dict()¶

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

它包含两个条目

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

注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时，优化器将 zip 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]
        },
        {
            'lr': 0.001,
            'weight_decay': 0.5,
            ...
            'params': [1, 2, 3]
        }
    ]
}

返回类型: Dict[str, Any]

step(closure=None)[source]¶

执行单步优化。

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

zero_grad(set_to_none=True)¶

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

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

RAdam¶

文档

教程

资源