Adamax

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

实现 Adamax 算法（Adam 的一个变种，基于无穷范数）。

$$\begin{array}{rl}{\displaystyle }& {\displaystyle }\\ {\displaystyle }& {\displaystyle \mathbf{\text{输入}}:\gamma \text{ (学习率)},{\beta }_1,{\beta }_2\text{ (beta值)},{\theta }_0\text{ (参数)},f(\theta )\text{ (目标函数)},\lambda \text{ (权重衰减)},}\end{array}$$

ϵ (epsilon值)初始化:m0←0 (一阶矩),u0←0 (无穷范数)对于 t=1 到 … 执行gt←∇θft(θt−1)if λ≠0gt←gt+λθt−1mt←β1mt−1+(1−β1)gtut←max(β2ut−1,∣gt∣+ϵ)θt←θt−1−γmt(1−β1t)ut返回 θt\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{ (weight decay)}, \\ &\hspace{13mm} \epsilon \text{ (epsilon)} \\ &\textbf{initialize} : m_0 \leftarrow 0 \text{ ( first moment)}, u_0 \leftarrow 0 \text{ ( infinity norm)} \\[-1.ex] &\rule{110mm}{0.4pt} \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{5mm}g_t \leftarrow \nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm}if \: \lambda \neq 0 \\ &\hspace{10mm} g_t \leftarrow g_t + \lambda \theta_{t-1} \\ &\hspace{5mm}m_t \leftarrow \beta_1 m_{t-1} + (1 - \beta_1) g_t \\ &\hspace{5mm}u_t \leftarrow \mathrm{max}(\beta_2 u_{t-1}, |g_{t}|+\epsilon) \\ &\hspace{5mm}\theta_t \leftarrow \theta_{t-1} - \frac{\gamma m_t}{(1-\beta^t_1) u_t} \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned} ​输入:γ (学习率),β1​,β2​ (beta值),θ0​ (参数),f(θ) (目标函数),λ (权重衰减),ϵ (epsilon值)初始化:m0​←0 (一阶矩),u0​←0 (无穷范数)对于t=1到…执行gt​←∇θ​ft​(θt−1​)ifλ=0gt​←gt​+λθt−1​mt​←β1​mt−1​+(1−β1​)gt​ut​←β2​ut−1​,∣gt​∣+ϵ)θt​←θt−1​−(1−β1t​)ut​γmt​​返回θt​​

有关该算法的更多详细信息，请参阅 Adam: A Method for Stochastic Optimization。

参数

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

• lr (float, Tensor, optional) – 学习率（默认为 2e-3）

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

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

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

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

• maximize (bool, optional) – 最大化关于参数的目标函数，而不是最小化（默认为 False）

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

• capturable (bool, optional) – 此实例是否可以安全地捕获到图中，无论是用于 CUDA 图还是用于 torch.compile 支持。张量仅在支持的 加速器 上才能被捕获。将此设置为 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() 返回的对象。

警告

请确保在初始化 torch.optim.lr_scheduler.LRScheduler 后调用此方法，因为在此之前调用它会覆盖加载的学习率。

注意

参数的名称（如果它们存在于 state_dict() 中每个参数组的“param_names”键下）不会影响加载过程。要使用参数名称处理自定义情况（例如，当加载的状态字典中的参数与优化器中初始化的参数不同时），应实现自定义的 register_load_state_dict_pre_hook 来相应地调整加载的字典。如果加载的状态字典中存在 param_names，则会保存它们并覆盖优化器状态中当前的名称。如果它们不存在于加载的状态字典中，优化器 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 将在所有已注册的后置钩子之前执行。否则，提供的 hook 将在所有已注册的后置钩子之后执行。（默认为 False）

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

register_load_state_dict_pre_hook(hook, prepend=False)

注册一个load_state_dict pre-hook，它将在调用 load_state_dict() 之前被调用。它应该具有以下签名

hook(optimizer, state_dict) -> state_dict or None

optimizer 参数是正在使用的优化器实例，state_dict 参数是用户传递给 load_state_dict 的 state_dict 的一个浅拷贝。hook 可以就地修改 state_dict，或者可以选择返回一个新的。如果返回了一个 state_dict，它将被用于加载到优化器中。

在调用 self 上的 load_state_dict 之前，hook 将使用参数 self 和 state_dict 来调用。注册的 hook 可用于在调用 load_state_dict 之前执行预处理。

参数

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

• prepend (bool) – 如果为 True，则提供的预 hook 将在 load_state_dict 上所有已注册的预-hook 之前触发。否则，提供的 hook 将在所有已注册的预-hook 之后触发。(默认: False)

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_post_hook(hook, prepend=False)

注册一个 state dict post-hook，它将在调用 state_dict() 之后被调用。

它应具有以下签名

hook(optimizer, state_dict) -> state_dict or None

在 `self` 上生成 `state_dict` 后，hook 将使用参数 `self` 和 `state_dict` 来调用。hook 可以就地修改 state_dict，或者可以选择返回一个新的。注册的 hook 可用于在返回 `state_dict` 之前对其进行后处理。

参数

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

• prepend (bool) – 如果为 True，则提供的 post hook 将在 state_dict 上所有已注册的 post-hook 之前触发。否则，提供的 hook 将在所有已注册的 post-hook 之后触发。(默认: False)

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_pre_hook(hook, prepend=False)

注册一个 state dict pre-hook，它将在调用 state_dict() 之前被调用。

它应具有以下签名

hook(optimizer) -> None

optimizer 参数是正在使用的优化器实例。在调用 `self` 上的 `state_dict` 之前，hook 将使用参数 `self` 来调用。注册的 hook 可用于在调用 `state_dict` 之前执行预处理。

参数

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

• prepend (bool) – 如果为 True，则提供的预 hook 将在 state_dict 上所有已注册的预-hook 之前触发。否则，提供的 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 被 pre-hook 修改，那么转换后的值将作为包含 new_args 和 new_kwargs 的元组返回。

参数

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

返回

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

返回类型

torch.utils.hooks.RemovableHandle

state_dict()

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

它包含两个条目

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

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

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

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

注意：参数 ID 看起来可能像索引，但它们只是将状态与参数组关联起来的 ID。从 state_dict 加载时，优化器会将参数组 params（整数 ID）和优化器 param_groups（实际的 nn.Parameter）进行 zip 以匹配状态，而无需额外的验证。

返回的状态字典可能看起来像

{
    '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) – 在设置为零而不是设置 None。这通常会占用更少的内存，并能适度提高性能。但是，它会改变某些行为。例如：1. 当用户尝试访问梯度并对其执行手动操作时，None 属性或全为 0 的 Tensor 的行为将不同。2. 如果用户请求 zero_grad(set_to_none=True) 然后进行反向传播，对于未获得梯度的参数，.grad 将保证为 None。3. torch.optim 优化器在梯度为 0 或 None 时具有不同的行为（一种情况是使用梯度 0 进行步进，另一种情况是跳过步进）。