Adadelta

class torch.optim.Adadelta(params, lr=1.0, rho=0.9, eps=1e-06, weight_decay=0, foreach=None, *, capturable=False, maximize=False, differentiable=False)

实现了 Adadelta 算法。

$$\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)}, \: \rho \text{ (decay)}, \: \lambda \text{ (weight decay)} \\ &\textbf{initialize} : v_0 \leftarrow 0 \: \text{ (square avg)}, \: u_0 \leftarrow 0 \: \text{ (accumulate variables)} \\[-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} v_t \leftarrow v_{t-1} \rho + g^2_t (1 - \rho) \\ &\hspace{5mm}\Delta x_t \leftarrow \frac{\sqrt{u_{t-1} + \epsilon }}{ \sqrt{v_t + \epsilon} }g_t \hspace{21mm} \\ &\hspace{5mm} u_t \leftarrow u_{t-1} \rho + \Delta x^2_t (1 - \rho) \\ &\hspace{5mm}\theta_t \leftarrow \theta_{t-1} - \gamma \Delta x_t \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}$$

有关该算法的更多详细信息，请参阅 ADADELTA: An Adaptive Learning Rate Method。

参数

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

• lr (float, Tensor, optional) – 应用于参数之前对 delta 进行缩放的系数（默认值：1.0）

• rho (float, optional) – 用于计算平方梯度的累积平均值的系数（默认值：0.9）。rho 值越高，平均值越慢，这有助于防止学习过程中的振荡。

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

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

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

• capturable (bool, optional) – 此实例是否可以安全地捕获到图中，无论是用于 CUDA 图还是用于 torch.compile 支持。Tensor 仅在支持的 加速器 上才可捕获。设置为 True 可能会损害非图模式下的性能，因此如果您不打算捕获此实例到图中，请将其保留为 False（默认值：False）

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

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

add_param_group(param_group)

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

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

参数

param_group (dict) – 指定要优化哪些 Tensor，以及组特定的优化选项。

load_state_dict(state_dict)

加载优化器状态。

参数

state_dict (dict) – 优化器状态。应为调用 state_dict() 返回的对象。

警告

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

注意

参数的名称（如果它们存在于 state_dict() 中每个参数组的“param_names”键下）不会影响加载过程。要为自定义情况使用参数名称（例如，当加载的 state dict 中的参数与优化器中初始化的参数不同时），应实现自定义 register_load_state_dict_pre_hook 以相应地调整加载的 dict。如果加载的 state dict 中存在 param_names，则它们将被保存并覆盖优化器状态中当前的名称。如果它们不存在于加载的 state dict 中，则优化器的 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 调用该钩子。注册的钩子可用于在 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 前置钩子，将在调用 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 后置钩子，在调用 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 前置钩子，将在调用 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)

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

它应具有以下签名

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 到一个包含每个参数状态的字典。

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

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

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

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

{
    '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 执行步长，另一种情况是完全跳过步长）。