评价此页
★ ★ ★ ★ ★

SparseAdam#

class torch.optim.SparseAdam(params, lr=0.001, betas=(0.9, 0.999), eps=1e-08, maximize=False)[source]#

SparseAdam 实现了一个 Adam 算法的掩码版本，适用于稀疏梯度。目前，由于实现限制（如下文所述），SparseAdam 仅适用于一小部分用例，特别是具有密集布局但梯度为稀疏布局的参数。这种情况发生在模块反向传播生成稀疏布局梯度的特殊情况下。一个示例 NN 模块就是 nn.Embedding(sparse=True)。

SparseAdam 通过掩码（masking out）掉梯度中零值对应的参数和动量更新来近似 Adam 算法。虽然 Adam 算法会根据梯度中的所有值更新一阶动量、二阶动量和参数，但 SparseAdam 只更新对应梯度中非零值的动量和参数。

一种理解该 预期 实现的简化方法是这样的：

  1. 创建一个掩码，标记出稀疏梯度中非零值的位置。例如，如果你的梯度是 [0, 5, 0, 0, 9]，那么掩码就是 [0, 1, 0, 0, 1]。

  2. 将此掩码应用于运行中的动量，并仅对非零值进行计算。

  3. 将此掩码应用于参数，并仅对非零值应用更新。

实际上，我们使用稀疏布局的 Tensor 来优化这种近似，这意味着梯度被掩码（未具体化）的越多，优化就越高效。由于我们依赖于使用稀疏布局的 Tensor，我们推断稀疏布局中的任何具体化值都是非零的，并且我们实际上并不验证所有值是否都非零！重要的是不要将语义上稀疏的 Tensor（其中许多值为零的 Tensor）与稀疏布局的 Tensor（其中 .is_sparse 返回 True 的 Tensor）混淆。SparseAdam 近似是为了 语义上 稀疏的 Tensor 而设计的，稀疏布局只是一个实现细节。一个更清晰的实现将是使用 MaskedTensors，但它们还在实验阶段。

注意

如果你怀疑你的梯度在语义上是稀疏的（但没有稀疏布局），那么这个变种可能不适合你。理想情况下，你应该尽量避免首先具体化任何被认为是稀疏的值，因为将所有梯度从密集布局转换为稀疏布局的开销可能会抵消性能提升。在这种情况下，使用 Adam 可能是最佳选择，除非你能轻松地调整你的模块以输出稀疏梯度，类似于 nn.Embedding(sparse=True)。如果你坚持要转换梯度，你可以通过在调用 .step() 之前手动覆盖参数的 .grad 字段并用其稀疏等价物替换来完成。

参数

  • params (iterable) – 要优化的参数或命名参数的迭代器，或者是定义参数组的字典的迭代器。使用命名参数时，所有组中的所有参数都应该命名。

  • lr (float, Tensor, optional) – 学习率 (默认: 1e-3)

  • betas (Tuple[float, float], optional) – 用于计算梯度及其平方的运行平均值的系数 (默认: (0.9, 0.999))

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

  • maximize (bool, optional) – 最大化目标函数相对于 params，而不是最小化 (默认: False)

add_param_group(param_group)[source]#

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

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

参数

param_group (dict) – 指定哪些 Tensor 应该被优化，以及组特定的优化选项。

load_state_dict(state_dict)[source]#

加载优化器状态。

参数

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

警告

请确保在初始化 torch.optim.lr_scheduler.LRScheduler 后调用此方法，因为在此之前调用会覆盖加载的学习率。

注意

参数的名称（如果它们存在于 state_dict() 中每个参数组的“param_names”键下）不会影响加载过程。要使用参数名称进行自定义情况（例如，当加载的 state_dict 中的参数与优化器中初始化的参数不同时），应实现自定义的 register_load_state_dict_pre_hook 来相应地调整加载的 dict。如果 param_names 存在于加载的 state_dict param_groups 中，它们将被保存并覆盖优化器状态中当前的名称（如果存在）。如果它们不存在于加载的 state_dict 中，则优化器的 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 是正在使用的优化器实例。

调用 load_state_dict 到 self 上后，钩子将使用参数 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 和 state_dict 调用，在调用 load_state_dict 到 self 上之前。注册的钩子可用于在调用 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 后置钩子，它将在调用 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 前置钩子，它将在调用 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（int 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)[source]#

执行单个优化步骤。

参数

closure (Callable, 可选) – 一个重新评估模型并返回损失的闭包。

zero_grad(set_to_none=True)[source]#

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

参数

set_to_none (bool, optional) –

将梯度设置为 None，而不是设置为零。默认值：True

这通常会降低内存占用，并能适度提高性能。但是，它会改变某些行为。例如：

  1. 当用户尝试访问梯度并对其进行手动运算时，None 属性或全零的 Tensor 会产生不同的行为。

  2. 如果用户请求 zero_grad(set_to_none=True) 然后执行 backward，对于未收到梯度的参数，其 .grad 保证为 None。

  3. torch.optim 优化器在梯度为 0 或 None 时行为不同（一种情况是以 0 梯度执行步长，另一种情况是跳过该步长）。

在此页面上
显示源代码
PyTorch 库