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{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{ (学习率)}, \beta_1, \beta_2 \text{ (beta 参数)},\theta_0 \text{ (参数)},f(\theta) \text{ (目标函数)}, \: \lambda \text{ (权重衰减)}, \\ &\hspace{13mm} \epsilon \text{ (epsilon)} \\ &\textbf{initialize} : m_0 \leftarrow 0 \text{ ( 一阶矩)}, u_0 \leftarrow 0 \text{ ( 无穷范数)} \\[-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}$$

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

参数

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

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

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

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

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

• foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定 (即 foreach 为 None)，在 CUDA 上我们将尝试使用 foreach 实现而非 for-loop 实现，因为它通常性能明显更好。请注意，foreach 实现比 for-loop 版本使用约 sizeof(params) 更多的峰值内存，因为中间量是 tensor list 而不是单个 tensor。如果内存受限，请每次通过优化器处理更少的参数批次，或者将此标志设置为 False (默认值: None)

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

• differentiable (bool, 可选) – 在训练中是否允许 autograd 通过优化器步进发生。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 会影响性能，如果你不打算通过此实例运行 autograd，请将其保留为 False (默认值: False)

• capturable (bool, 可选) – 此实例是否安全地可在 CUDA 图中捕获。传递 True 会影响非图捕获的性能，如果你不打算捕获此实例图，请将其保留为 False (默认值: False)

add_param_group(param_group)

向 Optimizer 的 param_groups 中添加参数组。

在微调预训练网络时这很有用，因为冻结的层可以变得可训练并在训练进行中添加到 Optimizer 中。

参数

param_group (dict) – 指定应该优化哪些 Tensors 以及组特定的优化选项。

load_state_dict(state_dict)

加载优化器状态。

参数

state_dict (dict) – 优化器状态。应该是一个通过调用 state_dict() 返回的对象。

注意

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

register_load_state_dict_post_hook(hook, prepend=False)

注册一个加载状态字典后置钩子，该钩子将在调用 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() 前调用。它应该具有以下签名

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，则提供的前置 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 返回前对其执行后处理。

参数

• 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

调用 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: 一个 Dict，包含当前的优化状态。

  其内容因不同的优化器类而异，但有一些共同点。例如，状态是按参数保存的，但参数本身不被保存。state 是一个将参数 ID 映射到包含对应参数状态的 Dict。

• param_groups: 一个 List，包含所有参数组。

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

注意：参数 ID 可能看起来像索引，但它们只是关联状态和 param_group 的 ID。从状态字典加载时，优化器会将 param_group 的 params (int 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 梯度进行步进，而在后一种情况下它会完全跳过步进)。