目录
快捷方式

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

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

input:γ (lr),β1,β2 (betas),θ0 (params),f(θ) (objective), λ (weight decay),ϵ (epsilon)initialize:m0←0 ( first moment),u0←0 ( infinity norm)for t=1 to … dogt←∇θft(θt−1)if λ≠0gt←gt+λθt−1mt←β1mt−1+(1−β1)gtut←max(β2ut−1,∣gt∣+ϵ)θt←θt−1−γmt(1−β1t)utreturn θ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}

有关该算法的更多详细信息，请参阅Adam: 一种随机优化方法。

参数

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

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

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

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

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

  • foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将尝试在 CUDA 上使用 foreach 而不是 for 循环实现，因为通常性能会显着提高。请注意，由于中间值是 tensorlist 而不是仅一个张量，因此 foreach 实现使用的峰值内存比 for 循环版本多约 sizeof(params)。如果内存受到限制，请一次通过优化器批量处理较少的参数，或将此标志切换为 False（默认值：None）

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

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

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

add_param_group(param_group)[source]

将参数组添加到 Optimizer 的 param_groups。

当微调预训练网络时，这可能很有用，因为可以使冻结层可训练并添加到 Optimizer 中，随着训练的进行。

参数

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

load_state_dict(state_dict)[source]

加载优化器状态。

参数

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

注册一个 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，则提供的后 hook 将在 load_state_dict 上所有已注册的后钩子之前触发。否则，提供的 hook 将在所有已注册的后钩子之后触发。（默认值：False）

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

register_load_state_dict_pre_hook(hook, prepend=False)[source]

注册一个 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，则提供的预 hook 将在 load_state_dict 上所有已注册的预钩子之前触发。否则，提供的 hook 将在所有已注册的预钩子之后触发。（默认值：False）

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_post_hook(hook, prepend=False)[source]

注册一个 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，则提供的后 hook 将在 state_dict 上所有已注册的后钩子之前触发。否则，提供的 hook 将在所有已注册的后钩子之后触发。（默认值：False）

返回

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

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_pre_hook(hook, prepend=False)[source]

注册一个 state_dict 预钩子，它将在 state_dict() 被调用之前被调用。

它应该具有以下签名

hook(optimizer) -> None

optimizer 参数是正在使用的优化器实例。在对 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)[source]

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

它应该具有以下签名

hook(optimizer, args, kwargs) -> None

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

参数

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

返回

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

返回类型

torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook)[source]

注册一个优化器 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.RemovableHandle

state_dict()[source]

以 dict 的形式返回优化器的状态。

它包含两个条目

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

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

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

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

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

执行单个优化步骤。

参数

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

zero_grad(set_to_none=True)[source]

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

参数

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

文档

访问 PyTorch 的综合开发者文档

查看文档

教程

获取面向初学者和高级开发者的深度教程

查看教程

资源

查找开发资源并获取您的问题解答

查看资源

为了分析流量和优化您的体验，我们在本网站上使用 Cookie。通过单击或导航，您同意允许我们使用 Cookie。作为本网站的当前维护者，Facebook 的 Cookie 政策适用。了解更多信息，包括有关可用控件的信息：Cookie 政策。