Table of Contents
Shortcuts

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) 字节）。如果它不适合内存，请尝试减少历史大小，或者使用不同的算法。

Parameters

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

向 Optimizer 的 param_groups 添加一个参数组。

这在微调预训练网络时非常有用，因为冻结的层可以变为可训练的，并随着训练的进行添加到优化器中。

Parameters

param_group (字典) – 指定应与组特定优化选项一起优化的张量。

load_state_dict(state_dict)

加载优化器状态。

Parameters

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

register_load_state_dict_post_hook(hook, prepend=False)

注册一个在调用load_state_dict()之后将被调用的加载状态字典后钩子。它应具有以下签名：

hook(optimizer) -> None

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

钩子将在调用 self 上的 load_state_dict 之后，使用参数 self 被调用。注册的钩子可以用于在 load_state_dict 加载了 state_dict 之后执行后处理。

Parameters

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

  • prepend (bool) – 如果为True，提供的post hook将在所有已注册的post-hooks之前触发load_state_dict。否则，提供的hook将在所有已注册的post-hooks之后触发。(默认值: False)

Returns

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

Return type

torch.utils.hooks.RemoveableHandle

register_load_state_dict_pre_hook(hook, prepend=False)

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

hook(optimizer, state_dict) -> state_dict 或 None

参数 optimizer 是正在使用的优化器实例，而参数 state_dict 是用户传入的 state_dict 的浅拷贝。钩子可以就地修改 state_dict，或者选择返回一个新的 state_dict。如果返回了 state_dict，它将被用于加载到优化器中。

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

Parameters

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

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

Returns

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

Return type

torch.utils.hooks.RemoveableHandle

register_state_dict_post_hook(hook, prepend=False)

注册一个状态字典的后处理钩子，该钩子将在调用 state_dict() 之后被调用。它应具有以下签名：

hook(optimizer, state_dict) -> state_dict 或 None

钩子将在生成 state_dict 后，使用参数 self 和 state_dict 被调用。钩子可以就地修改 state_dict，或者选择性地返回一个新的 state_dict。注册的钩子可以用于在返回 state_dict 之前对其进行后处理。

Parameters

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

  • 前置 (布尔值) – 如果为True，提供的钩子将在所有已注册的状态字典后置钩子之前触发。否则，提供的钩子将在所有已注册的后置钩子之后触发。(默认值: False)

Returns

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

Return type

torch.utils.hooks.RemoveableHandle

register_state_dict_pre_hook(hook, prepend=False)

注册一个状态字典预钩子，该钩子将在调用 state_dict() 之前被调用。它应具有以下签名：

hook(optimizer) -> None

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

Parameters

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

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

Returns

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

Return type

torch.utils.hooks.RemoveableHandle

register_step_post_hook(hook)

注册一个优化器步骤后钩子，该钩子将在优化器步骤之后被调用。 它应具有以下签名：

hook(optimizer, args, kwargs) -> None

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

Parameters

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

Returns

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

Return type

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 的元组。

Parameters

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

Returns

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

Return type

torch.utils.hooks.RemovableHandle

state_dict()

返回优化器的状态为一个dict。

它包含两个条目：

  • state: a Dict holding current optimization state. Its content

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

  • param_groups: a List containing all parameter groups where each

    参数组是一个字典。每个参数组包含特定于优化器的元数据，例如学习率和权重衰减，以及该组中参数的参数ID列表。

注意：参数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]
        },
        {
            'lr': 0.001,
            'weight_decay': 0.5,
            ...
            'params': [1, 2, 3]
        }
    ]
}
Return type

字典[字符串, 任意]

step(closure)[源代码]

执行单个优化步骤。

Parameters

闭包 (可调用对象) – 一个重新评估模型并返回损失的闭包。

zero_grad(set_to_none=True)

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

Parameters

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