快捷方式

RMSprop

class torch.optim.RMSprop(params, lr=0.01, alpha=0.99, eps=1e-08, weight_decay=0, momentum=0, centered=False, capturable=False, foreach=None, maximize=False, differentiable=False)[源代码][源代码]

实现 RMSprop 算法。

input:α (alpha),γ (lr),θ0 (params),f(θ) (objective)λ (weight decay),μ (momentum),centered,ϵ (epsilon)initialize:v00 (square average),b00 (buffer),g0ave0fort=1todogtθft(θt1)ifλ0gtgt+λθt1vtαvt1+(1α)gt2vt~vtifcenteredgtavegt1aveα+(1α)gtvt~vt~(gtave)2ifμ>0btμbt1+gt/(vt~+ϵ)θtθt1γbtelseθtθt1γgt/(vt~+ϵ)returnθt\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \alpha \text{ (alpha)}, \: \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)} \\ &\hspace{13mm} \lambda \text{ (weight decay)},\: \mu \text{ (momentum)}, \: centered, \: \epsilon \text{ (epsilon)} \\ &\textbf{initialize} : v_0 \leftarrow 0 \text{ (square average)}, \: \textbf{b}_0 \leftarrow 0 \text{ (buffer)}, \: g^{ave}_0 \leftarrow 0 \\[-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 \alpha v_{t-1} + (1 - \alpha) g^2_t \hspace{8mm} \\ &\hspace{5mm} \tilde{v_t} \leftarrow v_t \\ &\hspace{5mm}if \: centered \\ &\hspace{10mm} g^{ave}_t \leftarrow g^{ave}_{t-1} \alpha + (1-\alpha) g_t \\ &\hspace{10mm} \tilde{v_t} \leftarrow \tilde{v_t} - \big(g^{ave}_{t} \big)^2 \\ &\hspace{5mm}if \: \mu > 0 \\ &\hspace{10mm} \textbf{b}_t\leftarrow \mu \textbf{b}_{t-1} + g_t/ \big(\sqrt{\tilde{v_t}} + \epsilon \big) \\ &\hspace{10mm} \theta_t \leftarrow \theta_{t-1} - \gamma \textbf{b}_t \\ &\hspace{5mm} else \\ &\hspace{10mm}\theta_t \leftarrow \theta_{t-1} - \gamma g_t/ \big(\sqrt{\tilde{v_t}} + \epsilon \big) \hspace{3mm} \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}

有关算法的更多详细信息,请参考 G. Hinton 的讲义和中心化版本《生成带有循环神经网络的序列》。这里的实现是在添加 epsilon 之前取平方梯度平均的平方根(注意 TensorFlow 互换了这两个操作)。因此,有效的学习率是 γ/(v+ϵ)\gamma/(\sqrt{v} + \epsilon),其中 γ\gamma 是计划的学习率,vv 是平方梯度的加权移动平均。

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

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

  • alpha (float, 可选) – 平滑常数 (默认值: 0.99)

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

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

  • momentum (float, 可选) – 动量因子 (默认值: 0)

  • centered (bool, 可选) – 如果 True,则计算中心化的 RMSProp,梯度通过其方差估计进行归一化

  • capturable (bool, 可选) – 此实例是否可以在 CUDA 图中安全捕获。传入 True 可能会影响未作图的性能,因此如果您不打算对此实例进行图捕获,请将其保留为 False (默认值: False)

  • 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)

add_param_group(param_group)[源代码]

Optimizerparam_groups 添加一个参数组。

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

参数

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

load_state_dict(state_dict)[源代码]

加载优化器状态。

参数

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

注意

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

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 加载状态字典后执行后处理。

参数
  • hook (可调用对象) – 要注册的用户定义的钩子。

  • prepend (bool) – 如果为 True,则提供的后钩子将在所有已注册的 load_state_dict 后钩子之前触发。否则,提供的钩子将在所有已注册的后钩子之后触发。(默认值: 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 的状态字典的浅拷贝。该钩子可以就地修改状态字典或可选地返回一个新的。如果返回状态字典,它将被用于加载到优化器中。

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

参数
  • hook (可调用对象) – 要注册的用户定义的钩子。

  • prepend (bool) – 如果为 True,则提供的前钩子将在所有已注册的 load_state_dict 前钩子之前触发。否则,提供的前钩子将在所有已注册的前钩子之后触发。(默认值: 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 生成状态字典后,将使用参数 selfstate_dict 调用该钩子。该钩子可以就地修改状态字典或可选地返回一个新的。注册的钩子可用于在返回状态字典之前对其进行后处理。

参数
  • hook (可调用对象) – 要注册的用户定义的钩子。

  • prepend (bool) – 如果为 True,则提供的后钩子将在所有已注册的 state_dict 后钩子之前触发。否则,提供的钩子将在所有已注册的后钩子之后触发。(默认值: 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 (可调用对象) – 要注册的用户定义的钩子。

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

返回

返回一个句柄,通过调用 handle.remove() 可以移除添加的钩子

返回类型

torch.utils.hooks.RemoveableHandle

register_step_post_hook(hook)[源代码]

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

它应具有以下签名

hook(optimizer, args, kwargs) -> None

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

参数

hook (可调用对象) – 要注册的用户定义的钩子。

返回

返回一个句柄,通过调用 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 (可调用对象) – 要注册的用户定义的钩子。

返回

返回一个句柄,通过调用 handle.remove() 可以移除添加的钩子

返回类型

torch.utils.hooks.RemovableHandle

state_dict()[源代码]

将优化器的状态作为 dict 返回。

它包含两个条目

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

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

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

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

注意:参数 ID 可能看起来像索引,但它们只是将状态与 param_group 关联起来的 ID。从状态字典加载时,优化器会将 param_group 的 params(整数 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 (可调用对象, 可选) – 一个重新评估模型并返回损失的闭包。

zero_grad(set_to_none=True)[源代码]

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

参数

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

文档

访问 PyTorch 的完整开发者文档

查看文档

教程

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

查看教程

资源

查找开发资源并获得问题解答

查看资源