AdamW

class torch.optim.AdamW(params, lr=0.001, betas=(0.9, 0.999), eps=1e-08, weight_decay=0.01, amsgrad=False, *, maximize=False, foreach=None, capturable=False, differentiable=False, fused=None)

实现 AdamW 算法。

$$\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)}, \: \epsilon \text{ (epsilon)} \\ &\hspace{13mm} \lambda \text{(weight decay)}, \: \textit{amsgrad}, \: \textit{maximize} \\ &\textbf{initialize} : m_0 \leftarrow 0 \text{ (first moment)}, v_0 \leftarrow 0 \text{ ( second moment)}, \: \widehat{v_0}^{max}\leftarrow 0 \\[-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} - \gamma \lambda \theta_{t-1} \\ &\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 m_t/\big(1-\beta_1^t \big) \\ &\hspace{5mm}\widehat{v_t} \leftarrow v_t/\big(1-\beta_2^t \big) \\ &\hspace{5mm}\textbf{if} \: amsgrad \\ &\hspace{10mm}\widehat{v_t}^{max} \leftarrow \mathrm{max}(\widehat{v_t}^{max}, \widehat{v_t}) \\ &\hspace{10mm}\theta_t \leftarrow \theta_t - \gamma \widehat{m_t}/ \big(\sqrt{\widehat{v_t}^{max}} + \epsilon \big) \\ &\hspace{5mm}\textbf{else} \\ &\hspace{10mm}\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}$$

有关算法的更多详细信息，请参阅 去耦权重衰减正则化。

参数

• params (可迭代对象) – 要优化的参数的可迭代对象或定义参数组的字典

• lr (浮点数, 张量, 可选) – 学习率（默认值：1e-3）。对于我们的所有实现，尚未支持张量 LR。如果您没有指定 fused=True 或 capturable=True，请使用浮点数 LR。

• betas (元组[浮点数, 浮点数], 可选) – 用于计算梯度及其平方的运行平均值的系数（默认值： (0.9, 0.999)）

• eps (浮点数, 可选) – 添加到分母中的项，以提高数值稳定性（默认值：1e-8）

• weight_decay (浮点数, 可选) – 权重衰减系数（默认值：1e-2）

• amsgrad (布尔值, 可选) – 是否使用来自论文 关于 Adam 收敛及其超越 的此算法的 AMSGrad 变体（默认值：False）

• maximize (布尔值, 可选) – 相对于参数最大化目标，而不是最小化（默认值：False）

• foreach (布尔值, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而不是 for 循环实现，因为它通常明显更高效。请注意，foreach 实现比 for 循环版本使用 ~ sizeof(params) 更多的峰值内存，因为中间结果是张量列表，而不仅仅是一个张量。如果内存不足，请一次对更少的参数进行批处理或将此标志切换为 False（默认值：None）

• capturable (布尔值, 可选) – 此实例是否可以安全地捕获在 CUDA 图中。传递 True 可能会损害非图性能，因此，如果您不打算捕获此实例，请将其保留为 False（默认值：False）

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

• fused (bool, optional) – 是否使用融合实现。目前支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。 (默认: None)

注意

foreach 和 fused 实现通常比 for 循环、单张量实现更快，其中 fused 在理论上具有垂直和水平融合方面的最快速度。因此，如果用户没有指定任何标志（即，当 foreach = fused = None 时），我们将在所有张量都在 CUDA 上时尝试默认使用 foreach 实现。为什么不是 fused？由于 fused 实现比较新，我们希望为其提供足够的适应时间。要指定 fused，请将 True 传递给 fused。要强制运行 for 循环实现，请将 False 传递给 foreach 或 fused。

注意

MPS 上 Adam 和 AdamW 的原型实现支持 torch.float32 和 torch.float16。

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

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

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

参数

• hook (Callable) – 用户定义的要注册的挂钩。

• prepend (bool) – 如果为 True，则在对 load_state_dict 上已经注册的所有后挂钩之前，将触发提供的后挂钩 hook。否则，将触发提供的 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，则在对 load_state_dict 上已经注册的所有前挂钩之前，将触发提供的后挂钩 hook。否则，将触发提供的 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，则在对 state_dict 上已经注册的所有后挂钩之前，将触发提供的后挂钩 hook。否则，将触发提供的 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 在对 self 调用 state_dict 之前被调用。注册的挂钩可用于在进行 state_dict 调用之前执行预处理。

参数

• hook (Callable) – 用户定义的要注册的挂钩。

• prepend (bool) – 如果为 True，则在对 state_dict 上已经注册的所有前挂钩之前，将触发提供的后挂钩 hook。否则，将触发提供的 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 列表。

注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联的 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]
        }
    ]
}

返回类型

Dict[str, Any]

step(closure=None)

执行单个优化步骤。

参数

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

zero_grad(set_to_none=True)

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

参数

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