SparseAdam#

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

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

SparseAdam 通过掩盖与梯度中零值对应的参数和动量更新来近似 Adam 算法。而 Adam 算法会根据梯度的所有值来更新一阶动量、二阶动量和参数，SparseAdam 只更新与梯度中非零值对应的动量和参数。

一个简化的思考方式是，这个实现是有意为之的

创建一个稀疏梯度中非零值的掩码。例如，如果你的梯度看起来像 [0, 5, 0, 0, 9]，那么掩码将是 [0, 1, 0, 0, 1]。
将此掩码应用于运行动量，并仅对非零值进行计算。
将此掩码应用于参数，并且仅对非零值进行更新。

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

注意

如果你认为你的梯度在语义上是稀疏的（但没有稀疏布局），那么这个变体可能不适合你。理想情况下，你希望避免首先具体化任何被认为是稀疏的值，因为将所有 grad 从密集布局转换为稀疏布局的开销可能抵消性能的提升。在这种情况下，使用 Adam 可能是最佳选择，除非你能轻松地修改你的模块以输出类似 nn.Embedding(sparse=True) 的稀疏 grad。如果你坚持转换你的 grad，你可以在调用 .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)[源代码]#

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

这在微调预训练网络时非常有用，因为在训练过程中，可以使冻结的层可训练，并将其添加到 Optimizer 中。

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

load_state_dict(state_dict)[源代码]#

加载优化器状态。

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

警告

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

注意

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

注册一个 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)[源代码]#

注册一个 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)[源代码]#

注册一个 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)[源代码]#

注册一个 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)[源代码]#

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

它应具有以下签名

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 是一个映射参数 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)[源代码]#

执行单个优化步骤。

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

zero_grad(set_to_none=True)[源代码]#

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

参数

set_to_none (bool, optional) –

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

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

当用户尝试访问梯度并对其进行手动运算时，None 属性或全零的 Tensor 会产生不同的行为。
如果用户请求 zero_grad(set_to_none=True) 然后执行 backward，对于未收到梯度的参数，其 .grad 保证为 None。
torch.optim 优化器在梯度为 0 或 None 时行为不同（一种情况是以 0 梯度执行步长，另一种情况是跳过该步长）。

SparseAdam#

文档

教程

资源