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

实现 L-BFGS 算法。

主要受到 minFunc 的启发。

警告

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

警告

目前所有参数都必须在单个设备上。将来会改进这一点。

注意

这是一个内存密集型优化器（它需要额外的 param_bytes * (history_size + 1) 字节）。如果内存不足，请尝试减小历史大小，或使用不同的算法。

参数

params (可迭代对象) – 要优化的参数可迭代对象。参数必须是实数。
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)[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_groups 中，它们将被保存并覆盖优化器状态中当前存在的名称。如果它们不存在于加载的状态字典中，优化器 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，它将用于加载到优化器中。

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

注册一个状态字典后钩子，它将在调用 state_dict() 之后被调用。

它应具有以下签名

hook(optimizer, state_dict) -> state_dict or None

在对 self 生成 state_dict 之后，将使用参数 self 和 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() 之前被调用。

它应具有以下签名

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

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

它应具有以下签名

hook(optimizer, args, kwargs) -> None

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

参数: hook (Callable) – 用户定义的待注册钩子。
返回: 一个句柄，可用于通过调用 handle.remove() 来移除添加的钩子
返回类型: torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook)[source]#

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

它应具有以下签名

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

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

它包含两个条目

state：一个包含当前优化状态的 Dict。其内容
在不同的优化器类之间有所不同，但有一些共同的特征。例如，状态是按参数保存的，参数本身不会被保存。state 是一个将参数 ID 映射到包含每个参数对应状态的 Dict 的字典。
param_groups：一个包含所有参数组的 List，其中每个
参数组都是一个 Dict。每个参数组包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。如果参数组使用 named_parameters() 初始化，则名称内容也将保存在状态字典中。

注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时，优化器将打包 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)[source]#

执行单个优化步骤。

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

zero_grad(set_to_none=True)[source]#

重置所有优化过的 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 进行步进，另一种情况下它完全跳过该步）。

LBFGS#

文档

教程

资源