快捷键

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

实现 Adadelta 算法。

input:γ (lr),θ0 (params),f(θ) (objective),ρ (decay),λ (weight decay)initialize:v00 (square avg),u00 (accumulate variables)fort=1todogtθft(θt1)ifλ0gtgt+λθt1vtvt1ρ+gt2(1ρ)Δxtut1+ϵvt+ϵgtutut1ρ+Δxt2(1ρ)θtθt1γΔxtreturnθt\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:自适应学习率方法。

参数:
  • params(可迭代对象)- 要优化的参数或 named_parameters 的可迭代对象,或者定义参数组的 dict 的可迭代对象。当使用 named_parameters 时,所有组中的所有参数都应该是命名的

  • lr(浮点数、Tensor,可选)- 在将其应用于参数之前缩放 delta 的系数(默认:1.0)

  • rho(浮点数,可选)- 用于计算平方梯度的移动平均系数(默认:0.9)。rho 的值越高,平均速度越慢,这有助于防止学习过程中的振荡。

  • eps(浮点数,可选)- 添加到分母中以改善数值稳定性(默认:1e-6)。

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

  • foreach(布尔值,可选)- 是否使用 optimizer 的 foreach 实现。如果用户未指定(即 foreach 为 None),我们将尝试在 CUDA 上使用 foreach 而不是 for-loop 实现,因为通常它要显著高效。请注意,foreach 实现由于中间结果为 tensorlist 而不是单个 tensor,因此比 for-loop 版本使用更多的峰值内存。如果内存受限,请一次通过 optimizer 批处理较少的参数,或将此标志设置为 False(默认:None)

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

  • 最大化(bool,可选)- 相对于 params 最大化目标,而不是最小化(默认:False)

  • 可微分的(bool,可选)- 是否应在训练中通过优化器步骤进行自动微分。否则,step()函数将在 torch.no_grad()上下文中运行。将其设置为 True 可能会降低性能,因此如果您不打算通过此实例运行自动微分,请将其保留为 False(默认:False)

添加参数组(param_group)[源]

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

这在微调预训练网络时非常有用,因为冻结的层可以被设置为可训练的,并在训练过程中添加到 Optimizer 中。

参数:

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

load_state_dict(state_dict)[source]

加载优化器状态。

参数:

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

注意

如果参数(如果它们存在于每个参数组的“param_names”键下)的名称存在,则不会影响加载过程。如果要使用参数的名称进行自定义情况(例如,当加载的状态字典中的参数与初始化的优化器中的参数不同时),则需要实现自定义的 register_load_state_dict_pre_hook 以相应地适应加载的字典。如果加载的状态字典中存在 param_names ,则将保存并覆盖优化器状态中当前存在的名称,如果有的话。如果它们在加载的状态字典中不存在,则优化器 param_names 将保持不变。

register_load_state_dict_post_hook(hook, prepend=False)[source]

注册一个在调用 load_state_dict() 之后被调用的 load_state_dict 后钩子。它应该具有以下签名:

hook(optimizer) -> None

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

在对 self 调用 load_state_dict 之后,将使用参数 self 调用钩子。已注册的钩子可以在 load_state_dict 加载 state_dict 之后执行后处理。

参数:
  • hook(可调用对象)- 用户定义的将被注册的钩子。

  • 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_dictstate_dict 的浅拷贝。钩子可以就地修改 state_dict,或者可选地返回一个新的。如果返回了 state_dict,它将被用于加载到优化器中。

在调用 self 上的 load_state_dict 之前,将使用参数 selfstate_dict 调用钩子。已注册的钩子可用于在执行 load_state_dict 调用之前执行预处理。

参数:
  • hook(可调用对象)- 用户定义的将被注册的钩子。

  • 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() 之后被调用。

它应该具有以下签名:

hook(optimizer, state_dict) -> state_dict or None

在生成 self 上的 state_dict 之后,将以参数 selfstate_dict 调用钩子。钩子可以就地修改状态字典或可选地返回一个新的状态字典。已注册的钩子可用于在返回之前对 state_dict 执行后处理。

参数:
  • hook(可调用对象)- 用户定义的将被注册的钩子。

  • 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() 之前被调用的状态字典预钩子。

它应该具有以下签名:

hook(optimizer) -> None

optimizer 参数是正在使用的优化器实例。在调用 self 上的 state_dict 之前,钩子将使用参数 self 被调用。注册的钩子可以在调用 state_dict 之前执行预处理。

参数:
  • hook(可调用对象)- 用户定义的将被注册的钩子。

  • prepend (bool) – 如果为 True,提供的预 hook 将在所有已注册的预钩子 state_dict 之前触发。否则,提供的 hook 将在所有已注册的预钩子之后触发。(默认:False)

返回值:

一个可以用来通过调用 handle.remove() 移除已添加钩子的句柄。

返回类型:

torch.utils.hooks.RemoveableHandle

register_step_post_hook(hook)[source]

注册优化器步骤后钩子,该钩子在优化器步骤之后将被调用。

它应该具有以下签名:

hook(optimizer, args, kwargs) -> None

第 0#个参数是正在使用的优化器实例。

参数:

hook(可调用对象)- 用户定义的将被注册的钩子。

返回值:

一个可以用来通过调用 handle.remove() 移除已添加钩子的句柄。

返回类型:

torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook)[source]

注册优化器步骤预钩子,该钩子将在优化器步骤之前被调用。

它应该具有以下签名:

hook(optimizer, args, kwargs) -> None or modified args and kwargs

第 0#参数是正在使用的优化器实例。如果 args 和 kwargs 被预钩子修改,则返回包含新_args 和新_kwargs 的新值元组。

参数:

hook(可调用对象)- 用户定义的将被注册的钩子。

返回值:

一个可以用来通过调用 handle.remove() 移除已添加钩子的句柄。

返回类型:

torch.utils.hooks.RemovableHandle

state_dict()[source]

返回优化器的状态作为 dict

它包含两个条目:

  • state :一个包含当前优化状态的字典。其内容

    在不同的优化器类之间有所不同,但有一些共同的特征。例如,状态是按参数保存的,而参数本身并未保存。 state 是一个将参数 ID 映射到对应每个参数状态的字典。

  • 包含所有参数组的列表

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

注意:参数 ID 看起来像索引,但它们只是将状态与 param_group 关联的 ID。在从 state_dict 加载时,优化器将 param_group params (整数 ID)和优化器 param_groups (实际的 nn.Parameter s)进行 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)[source][source]

执行单个优化步骤。

参数:

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

zero_grad(set_to_none=True)[source]

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

参数:

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


© 版权所有 PyTorch 贡献者。

使用 Sphinx 构建,并使用 Read the Docs 提供的主题。

文档

PyTorch 的全面开发者文档

查看文档

教程

深入了解初学者和高级开发者的教程

查看教程

资源

查找开发资源并获得您的疑问解答

查看资源