LBFGS¶

class torch.optim.LBFGS(params, lr=1, max_iter=20, max_eval=None, tolerance_grad=1e-07, tolerance_change=1e-09, history_size=100, line_search_fn=None)[源代码]¶

实现 L-BFGS 算法。

在很大程度上受 minFunc 的启发。

警告

此优化器不支持每个参数选项和参数组（只能有一个）。

警告

现在，所有参数都必须在单个设备上。这将在将来得到改进。

注意

这是一个非常占用内存的优化器（它需要额外的 param_bytes * (history_size + 1) 字节）。如果它不适合内存，请尝试减少历史记录大小，或使用其他算法。

参数

params (iterable) – 要优化的参数的可迭代对象。参数必须是实数。
lr (float) – 学习率（默认值：1）
max_iter (int) – 每个优化步骤的最大迭代次数（默认值：20）
max_eval (int) – 每个优化步骤的最大函数评估次数（默认值：max_iter * 1.25）。
tolerance_grad (float) – 一阶最优性终止公差（默认值：1e-7）。
tolerance_change (float) – 函数值/参数变化终止公差（默认值：1e-9）。
history_size (int) – 更新历史记录大小（默认值：100）。
line_search_fn (str) – 可以是 ‘strong_wolfe’ 或 None（默认值：None）。

add_param_group(param_group)¶

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

这在微调预训练网络时很有用，因为可以将冻结层设为可训练的，并在训练进行时将其添加到 Optimizer 中。

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

load_state_dict(state_dict)¶

加载优化器状态。

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

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 加载 state_dict 后执行后处理。

参数

hook (Callable) – 用户定义的要注册的挂钩。
prepend (bool) – 如果为 True，则提供的 post hook 将在 load_state_dict 上所有已注册的 post-hooks 之前触发。否则，提供的 hook 将在所有已注册的 post-hooks 之后触发。（默认：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，它将被用于加载到优化器中。

在 self 上调用 load_state_dict 之前，该挂钩将使用参数 self 和 state_dict 调用。注册的挂钩可用于在执行 load_state_dict 调用之前执行预处理。

参数

hook (Callable) – 用户定义的要注册的挂钩。
prepend (bool) – 如果为 True，则提供的 pre hook 将在 load_state_dict 上所有已注册的 pre-hooks 之前触发。否则，提供的 hook 将在所有已注册的 pre-hooks 之后触发。（默认：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，则提供的 post hook 将在 state_dict 上所有已注册的 post-hooks 之前触发。否则，提供的 hook 将在所有已注册的 post-hooks 之后触发。（默认：False）

返回值

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

返回值类型

torch.utils.hooks.RemoveableHandle

register_state_dict_pre_hook(hook, prepend=False)¶

注册一个 state dict 预挂钩，它将在调用 state_dict() 之前调用。

它应该具有以下签名

hook(optimizer) -> None

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

参数

hook (Callable) – 用户定义的要注册的挂钩。
prepend (bool) – 如果为 True，则提供的 pre hook 将在 state_dict 上所有已注册的 pre-hooks 之前触发。否则，提供的 hook 将在所有已注册的 pre-hooks 之后触发。（默认：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 是一个 Dictionary，将参数 ID 映射到一个 Dict，该 Dict 包含与每个参数相对应状态。
param_groups：一个 List，包含所有参数组，其中每个
参数组是一个 Dict。每个参数组包含特定于优化器的元数据，例如学习率和权重衰减，以及该组中参数的参数 ID List。

注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联的 ID。当从 state_dict 加载时，优化器将使用 param_group params（整数 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]
        },
        {
            'lr': 0.001,
            'weight_decay': 0.5,
            ...
            'params': [1, 2, 3]
        }
    ]
}

返回值类型: Dict[str, Any]

step(closure)[source]¶

执行单个优化步骤。

参数: closure (Callable) – 一个闭包，重新评估模型并返回损失。

zero_grad(set_to_none=True)¶

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

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

LBFGS¶

文档

教程

资源