SparseAdam¶

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

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

SparseAdam 通过屏蔽梯度中零值对应的参数和动量更新来近似 Adam 算法。而 Adam 算法会基于梯度的所有值更新第一动量、第二动量和参数，SparseAdam 仅更新与梯度中非零值对应的动量和参数。

关于预期实现的简化思考方式如下：

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

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

注意

如果你怀疑你的梯度在语义上是稀疏的（但没有稀疏布局），这种变体可能不适合你。理想情况下，你希望避免首先实现任何被怀疑是稀疏的东西，因为需要将所有梯度从密集布局转换为稀疏布局可能会超过性能增益。在这里，使用Adam可能是最好的替代方案，除非你可以轻松地设置你的模块以输出类似于nn.Embedding(sparse=True)的稀疏梯度。如果你坚持转换你的梯度，你可以通过在调用.step()之前手动覆盖你的参数的.grad字段为其稀疏等价物来实现。

Parameters

参数 (可迭代对象) – 要优化的参数的可迭代对象或定义参数组的字典
lr (float, 可选) – 学习率 (默认值: 1e-3)
betas (元组[float, float], 可选) – 用于计算梯度和其平方的运行平均值的系数（默认值：(0.9, 0.999)）
eps (float, 可选) – 添加到分母中的项，以提高数值稳定性（默认值：1e-8）
最大化 (bool, 可选) – 相对于参数最大化目标，而不是最小化（默认值：False）

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=None)[源代码]¶

执行单个优化步骤。

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进行步骤，而在另一种情况下，它完全跳过步骤）。