AdamW

类 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)}, \: 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}\textbf{if} \: amsgrad \\ &\hspace{10mm} v_t^{max} \leftarrow \mathrm{max}(v_{t-1}^{max},v_t) \\ &\hspace{10mm}\widehat{v_t} \leftarrow v_t^{max}/\big(1-\beta_2^t \big) \\ &\hspace{5mm}\textbf{else} \\ &\hspace{10mm}\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}$$

有关该算法的更多详细信息，请参阅 Decoupled Weight Decay Regularization。

参数

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

• lr (float, Tensor, optional) – 学习率 (默认值: 1e-3)。目前并非所有实现都支持张量学习率。如果您未指定 fused=True 或 capturable=True，请使用浮点型学习率。

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

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

• weight_decay (float, optional) – 权重衰减系数 (默认值: 1e-2)

• amsgrad (bool, optional) – 是否使用来自论文 On the Convergence of Adam and Beyond 的 AMSGrad 变体算法 (默认值: False)

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

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

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

• differentiable (bool, optional) – 训练期间是否应通过优化器 step 进行自动求导。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 可能会损害性能，因此如果您不打算在此实例中运行自动求导，请将其保留为 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，请为 fused 传递 True。要强制运行 for 循环实现，请为 foreach 或 fused 传递 False。

注意

Adam 和 AdamW 的一个 MPS 原型实现支持 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() 返回的对象。

注意

参数的名称（如果它们存在于 state_dict() 中每个参数组的“param_names”键下）不会影响加载过程。要在自定义情况（例如加载的状态字典中的参数与优化器中初始化的参数不同时）下使用参数名称，应实现自定义的 register_load_state_dict_pre_hook 来相应地调整加载的字典。如果 param_names 存在于加载的状态字典的 param_groups 中，它们将被保存并覆盖优化器状态中（如果存在）当前的名称。如果它们不存在于加载的状态字典中，优化器的 param_names 将保持不变。

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 上所有已注册的后置钩子之前触发。否则，提供的钩子将在所有已注册的后置钩子之后触发。(默认值: 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 上所有已注册的前置钩子之前触发。否则，提供的前置钩子将在所有已注册的前置钩子之后触发。(默认值: 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 上所有已注册的后置钩子之前触发。否则，提供的后置钩子将在所有已注册的后置钩子之后触发。(默认值: 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，则提供的前置钩子将在 state_dict 上所有已注册的前置钩子之前触发。否则，提供的前置钩子将在所有已注册的前置钩子之后触发。(默认值: False)

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

register_step_post_hook(hook)

注册一个优化器 step 后置钩子，它将在优化器 step 后被调用。

它应具有以下签名：

hook(optimizer, args, kwargs) -> None

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

参数

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

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

register_step_pre_hook(hook)

注册一个优化器 step 前置钩子，它将在优化器 step 前被调用。

它应具有以下签名：

hook(optimizer, args, kwargs) -> None or modified args and kwargs

optimizer 参数是正在使用的优化器实例。如果 args 和 kwargs 被前置钩子修改，则转换后的值将作为包含 new_args 和 new_kwargs 的元组返回。

参数

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

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

state_dict()

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

它包含两个条目：

• state: 一个包含当前优化状态的 Dict。其内容

  在不同的优化器类之间有所不同，但有一些共同的特点。例如，状态是按参数保存的，参数本身不会被保存。state 是一个将参数 ID 映射到包含每个参数对应状态的 Dict。

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

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

注意：参数 ID 可能看起来像索引，但它们只是将状态与参数组关联起来的 ID。从 state_dict 加载时，优化器会将参数组的参数（整数 ID）与优化器的参数组（实际的 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, 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 的梯度执行步进，另一种情况是完全跳过该步）。