评价此页
★ ★ ★ ★ ★

Adagrad#

class torch.optim.Adagrad(params, lr=0.01, lr_decay=0, weight_decay=0, initial_accumulator_value=0, eps=1e-10, foreach=None, *, maximize=False, differentiable=False, fused=None)[source]#

Implements Adagrad algorithm.

输入:γ (学习率), θ0 (参数), f(θ) (目标函数), λ (权重衰减),τ (初始累加器值), η (学习率衰减)初始化:state_sum0←τ对于 t=1 到 … 执行gt←∇θft(θt−1)γ~←γ/(1+(t−1)η)如果 λ≠0gt←gt+λθt−1state_sumt←state_sumt−1+gt2θt←θt−1−γ~gtstate_sumt+ϵ返回 θt\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)}, \: \lambda \text{ (weight decay)}, \\ &\hspace{12mm} \tau \text{ (initial accumulator value)}, \: \eta\text{ (lr decay)}\\ &\textbf{initialize} : state\_sum_0 \leftarrow \tau \\[-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} \tilde{\gamma} \leftarrow \gamma / (1 +(t-1) \eta) \\ &\hspace{5mm} \textbf{if} \: \lambda \neq 0 \\ &\hspace{10mm} g_t \leftarrow g_t + \lambda \theta_{t-1} \\ &\hspace{5mm}state\_sum_t \leftarrow state\_sum_{t-1} + g^2_t \\ &\hspace{5mm}\theta_t \leftarrow \theta_{t-1}- \tilde{\gamma} \frac{g_t}{\sqrt{state\_sum_t}+\epsilon} \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}

有关算法的更多详细信息，请参阅《在线学习和随机优化的自适应子梯度方法》。

参数

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

  • lr (float, Tensor, 可选) – 学习率 (默认值: 1e-2)

  • lr_decay (float, 可选) – 学习率衰减 (默认值: 0)

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

  • initial_accumulator_value (float, 可选) – 梯度平方和的初始值 (默认值: 0)

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

  • foreach (bool, 可选) – 是否使用优化器的foreach实现。如果用户未指定 (所以foreach为None)，我们将尝试在CUDA上使用foreach而不是for-loop实现，因为它通常性能明显更好。请注意，由于foreach实现使用了比for-loop版本多约 sizeof(params) 的峰值内存（因为中间量是tensorlist而不是单个tensor），因此内存限制会更严格。如果内存是问题，请尝试一次将更少的参数传递给优化器，或将此标志切换为False (默认值: None)

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

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

  • fused (bool, 可选) – 是否使用融合实现 (仅CPU)。当前支持torch.float64、torch.float32、torch.float16和torch.bfloat16。(默认值: None)。请注意，融合实现不支持稀疏或复数梯度。

add_param_group(param_group)[source]#

将参数组添加到Optimizer的param_groups中。

当微调预训练网络时，这可能很有用，因为在训练过程中，冻结的层可以被设为可训练并添加到Optimizer中。

参数

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

load_state_dict(state_dict)[source]#

加载优化器状态。

参数

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)[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和state_dict调用，并在self上调用load_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调用，并在self上调用state_dict之前执行。注册的钩子可用于在调用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 被预-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 可能看起来像索引，但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时，优化器将 param_group 的 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 进行步进，另一种情况是完全跳过步进）。

在此页面上
显示源代码
PyTorch 库