快捷方式

NAdam

class torch.optim.NAdam(params, lr=0.002, betas=(0.9, 0.999), eps=1e-08, weight_decay=0, momentum_decay=0.004, decoupled_weight_decay=False, *, foreach=None, maximize=False, capturable=False, differentiable=False)[source]

实现 NAdam 算法。

input:γt (lr),β1,β2 (betas),θ0 (params),f(θ) (objective)λ (weight decay),ψ (momentum decay)decoupled_weight_decay,maximizeinitialize:m00 ( first moment),v00 ( second moment)fort=1todoifmaximize:gtθft(θt1)elsegtθft(θt1)θtθt1ifλ0ifdecoupled_weight_decayθtθt1γλθt1elsegtgt+λθt1μtβ1(1120.96tψ)μt+1β1(1120.96(t+1)ψ)mtβ1mt1+(1β1)gtvtβ2vt1+(1β2)gt2mt^μt+1mt/(1i=1t+1μi)+(1μt)gt/(1i=1tμi)vt^vt/(1β2t)θtθtγmt^/(vt^+ϵ)returnθt\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma_t \text{ (lr)}, \: \beta_1,\beta_2 \text{ (betas)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)} \\ &\hspace{13mm} \: \lambda \text{ (weight decay)}, \:\psi \text{ (momentum decay)} \\ &\hspace{13mm} \: \textit{decoupled\_weight\_decay}, \:\textit{maximize} \\ &\textbf{initialize} : m_0 \leftarrow 0 \text{ ( first moment)}, v_0 \leftarrow 0 \text{ ( second moment)} \\[-1.ex] &\rule{110mm}{0.4pt} \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{5mm}\textbf{if} \: \textit{maximize}: \\ &\hspace{10mm}g_t \leftarrow -\nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm}\textbf{else} \\ &\hspace{10mm}g_t \leftarrow \nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm} \theta_t \leftarrow \theta_{t-1} \\ &\hspace{5mm} \textbf{if} \: \lambda \neq 0 \\ &\hspace{10mm}\textbf{if} \: \textit{decoupled\_weight\_decay} \\ &\hspace{15mm} \theta_t \leftarrow \theta_{t-1} - \gamma \lambda \theta_{t-1} \\ &\hspace{10mm}\textbf{else} \\ &\hspace{15mm} g_t \leftarrow g_t + \lambda \theta_{t-1} \\ &\hspace{5mm} \mu_t \leftarrow \beta_1 \big(1 - \frac{1}{2} 0.96^{t \psi} \big) \\ &\hspace{5mm} \mu_{t+1} \leftarrow \beta_1 \big(1 - \frac{1}{2} 0.96^{(t+1)\psi}\big)\\ &\hspace{5mm}m_t \leftarrow \beta_1 m_{t-1} + (1 - \beta_1) g_t \\ &\hspace{5mm}v_t \leftarrow \beta_2 v_{t-1} + (1-\beta_2) g^2_t \\ &\hspace{5mm}\widehat{m_t} \leftarrow \mu_{t+1} m_t/(1-\prod_{i=1}^{t+1}\mu_i)\\[-1.ex] & \hspace{11mm} + (1-\mu_t) g_t /(1-\prod_{i=1}^{t} \mu_{i}) \\ &\hspace{5mm}\widehat{v_t} \leftarrow v_t/\big(1-\beta_2^t \big) \\ &\hspace{5mm}\theta_t \leftarrow \theta_t - \gamma \widehat{m_t}/ \big(\sqrt{\widehat{v_t}} + \epsilon \big) \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}

有关该算法的更多详细信息,请参阅 将 Nesterov 动量整合到 Adam 中

参数
  • params (iterable) – 要优化的参数的迭代器或定义参数组的字典

  • lr (float, Tensor, 可选) – 学习率 (默认值:2e-3)

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

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

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

  • momentum_decay (float, 可选) – 动量衰减 (默认值:4e-3)

  • decoupled_weight_decay (bool, 可选) – 是否使用 AdamW 中的解耦权重衰减来获得 NAdamW (默认值:False)

  • foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定(因此 foreach 为 None),我们将尝试在 CUDA 上使用 foreach 而不是 for 循环实现,因为它通常性能更好。请注意,由于中间变量是张量列表而不是单个张量,因此 foreach 实现比 for 循环版本使用大约 sizeof(params) 更多的峰值内存。如果内存不足,请一次通过优化器批处理更少的参数,或将此标志切换为 False (默认值:None)

  • maximize (bool, 可选) – 相对于参数最大化目标,而不是最小化 (默认值:False)

  • capturable (bool, 可选) – 此实例是否可以安全地捕获在 CUDA 图中。将 True 传递给此参数可能会损害非图形化性能,因此,如果您不打算图形化捕获此实例,请将其保留为 False (默认值:False)

  • differentiable (bool, 可选) – 在训练期间是否应通过优化器步骤进行自动梯度计算。否则,step() 函数在 torch.no_grad() 上下文中运行。设置为 True 可能会损害性能,因此,如果您不打算通过此实例运行自动梯度计算,请将其保留为 False (默认值:False)

add_param_group(param_group)

将参数组添加到 Optimizerparam_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

参数 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_dictstate_dict 的浅拷贝。挂钩可以就地修改 state_dict 或选择性地返回一个新的 state_dict。如果返回了 state_dict,它将被用于加载到优化器中。

在对 self 调用 load_state_dict 之前,将使用参数 selfstate_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 后,将使用参数 selfstate_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:一个保存当前优化状态的字典。其内容

    在不同的优化器类之间有所不同,但一些共同的特征仍然存在。例如,状态是为每个参数保存的,参数本身不会被保存。state 是一个字典,它将参数 ID 映射到一个字典,该字典包含与每个参数相对应状态。

  • param_groups:一个列表,包含所有参数组,其中每个

    参数组都是一个字典。每个参数组都包含特定于优化器的元数据,例如学习率和权重衰减,以及组中参数的参数 ID 列表。

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

返回的 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]
        }
    ]
}
返回类型

Dict[str, Any]

step(closure=None)[source]

执行单个优化步骤。

参数

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

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执行步骤,而在另一个情况下,它完全跳过该步骤)。

文档

访问 PyTorch 的全面开发者文档

查看文档

教程

获取针对初学者和高级开发人员的深入教程

查看教程

资源

查找开发资源并获得问题的解答

查看资源