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)[source]¶

实现 Adamax 算法（基于无穷范数的 Adam 变体）。

\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}

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

参数

params (iterable) – 要优化的参数的迭代器或定义参数组的字典
lr (float, Tensor, 可选) – 学习率（默认值：2e-3）
betas (Tuple[float, float], 可选) – 用于计算梯度及其平方的运行平均值的系数
eps (float, 可选) – 添加到分母的项，以提高数值稳定性（默认值：1e-8）
weight_decay (float, 可选) – 权重衰减（L2 惩罚）（默认值：0）
foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将尝试在 CUDA 上使用 foreach 而不是 for 循环实现，因为它通常在性能方面有显着提升。请注意，foreach 实现比 for 循环版本使用约 sizeof(params) 的峰值内存，因为中间结果是张量列表而不是单个张量。如果内存不足，请一次通过优化器对更少的参数进行批处理或将此标志切换为 False（默认值：None）
maximize (bool, 可选) – 相对于参数最大化目标，而不是最小化（默认值：False）
differentiable (bool, 可选) – 是否应在训练期间通过优化器步骤进行自动微分。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 会损害性能，因此如果您不打算通过此实例运行自动微分，请将其保留为 False（默认值：False）
capturable (bool, 可选) – 此实例是否可以在 CUDA 图中安全捕获。设置为 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() 调用返回的对象。

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，则提供的 post hook 将在 load_state_dict 上所有已注册的 post 挂钩之前触发。否则，提供的 hook 将在所有已注册的 post 挂钩之后触发。（默认：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，它将被用于加载到优化器中。

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

参数

hook (Callable) – 要注册的用户定义挂钩。
prepend (bool) – 如果为 True，则提供的 pre hook 将在 load_state_dict 上所有已注册的 pre 挂钩之前触发。否则，提供的 hook 将在所有已注册的 pre 挂钩之后触发。（默认：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 执行后处理。

参数

hook (Callable) – 要注册的用户定义挂钩。
prepend (bool) – 如果为 True，则提供的 post hook 将在 state_dict 上所有已注册的 post 挂钩之前触发。否则，提供的 hook 将在所有已注册的 post 挂钩之后触发。（默认：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，则提供的 pre hook 将在 state_dict 上所有已注册的 pre 挂钩之前触发。否则，提供的 hook 将在所有已注册的 pre 挂钩之后触发。（默认：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 是一个 Dictionary，它将参数 ID 映射到一个 Dict，其中包含与每个参数相对应的状态。
param_groups：一个包含所有参数组的 List，其中每个
参数组是 Dict。每个参数组包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID List。

注意：参数 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)[source]¶

执行一次优化步骤。

参数: closure (Callable, optional) – 一个闭包，重新评估模型并返回损失。

zero_grad(set_to_none=True)¶

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

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

Adamax¶

文档

教程

资源