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

实现 L-BFGS 算法。

深受 minFunc 的启发。

警告

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

警告

目前所有参数必须位于单个设备上。这将在未来得到改进。

注意

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

参数:

params (iterable) – 可优化参数的迭代序列。参数必须是实数。
lr (float, optional) – 学习率（默认：1）
max_iter (int, optional) – 每个优化步骤的最大迭代次数（默认：20）
max_eval (int, optional) – 每个优化步骤中函数评估的最大次数（默认：max_iter * 1.25）。
tolerance_grad (浮点数，可选) – 第一阶最优性的终止容差（默认：1e-7）。
tolerance_change (浮点数，可选) – 函数值/参数变化的终止容差（默认：1e-9）。
history_size (整数，可选) – 更新历史大小（默认：100）。
line_search_fn (字符串，可选) – “strong_wolfe”或 None（默认：None）。

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

在调用 self 上的 load_state_dict 之前，将使用参数 self 和 state_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 之后，将以参数 self 和 state_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

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

参数:: 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)[source][source]¶

执行单个优化步骤。

参数:: 闭包（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¶

文档

教程

资源