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 只更新梯度中非零值对应的动量和参数。

一种简化的、关于其 intended 实现方式的思考方法如下：

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

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

注意

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

参数

params (可迭代对象) – 要优化的参数或 named_parameters 的可迭代对象，或定义参数组的字典的可迭代对象。使用 named_parameters 时，所有组中的所有参数都应命名
lr (浮点数, 张量, 可选) – 学习率 (默认值: 1e-3)
betas (元组[浮点数, 浮点数], 可选) – 用于计算梯度及其平方的运行平均值的系数 (默认值: (0.9, 0.999))
eps (浮点数, 可选) – 添加到分母以提高数值稳定性的项 (默认值: 1e-8)
maximize (布尔值, 可选) – 相对于参数最大化目标，而不是最小化 (默认值: False)

add_param_group(param_group)[源代码]¶

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

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

参数: param_group (字典) – 指定应优化哪些张量以及组特定的优化选项。

load_state_dict(state_dict)[源代码]¶

加载优化器状态。

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

注意

参数的名称（如果它们存在于 state_dict() 中每个参数组的“param_names”键下）不会影响加载过程。对于自定义用例（例如，加载的状态字典中的参数与优化器中初始化的参数不同），应实现自定义的 register_load_state_dict_pre_hook 以相应地调整加载的字典。如果加载的状态字典 param_groups 中存在 param_names，它们将被保存并覆盖优化器状态中当前存在的名称（如果存在）。如果它们不存在于加载的状态字典中，优化器的 param_names 将保持不变。

register_load_state_dict_post_hook(hook, prepend=False)[源代码]¶

注册一个 load_state_dict 后置钩子，该钩子将在 load_state_dict() 调用后被调用。它应具有以下签名

hook(optimizer) -> None

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

钩子将在对 self 调用 load_state_dict 后以 self 为参数被调用。注册的钩子可用于在 load_state_dict 加载 state_dict 后执行后处理。

参数

hook (可调用对象) – 要注册的用户定义的钩子。
prepend (布尔值) – 如果为 True，提供的后置钩子将在所有已注册的 load_state_dict 后置钩子之前触发。否则，提供的钩子将在所有已注册的后置钩子之后触发。(默认值: 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 调用 load_state_dict 之前以 self 和 state_dict 为参数被调用。注册的钩子可用于在进行 load_state_dict 调用之前执行预处理。

参数

hook (可调用对象) – 要注册的用户定义的钩子。
prepend (布尔值) – 如果为 True，提供的前置钩子将在所有已注册的 load_state_dict 前置钩子之前触发。否则，提供的前置钩子将在所有已注册的前置钩子之后触发。(默认值: 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 (可调用对象) – 要注册的用户定义的钩子。
prepend (布尔值) – 如果为 True，提供的后置钩子将在所有已注册的 state_dict 后置钩子之前触发。否则，提供的后置钩子将在所有已注册的后置钩子之后触发。(默认值: 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 (可调用对象) – 要注册的用户定义的钩子。
prepend (布尔值) – 如果为 True，提供的前置钩子将在所有已注册的 state_dict 前置钩子之前触发。否则，提供的前置钩子将在所有已注册的前置钩子之后触发。(默认值: False)

返回值

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

返回类型

torch.utils.hooks.RemoveableHandle

register_step_post_hook(hook)[源代码]¶

注册一个优化器步进后置钩子，该钩子将在优化器步进后被调用。

它应具有以下签名

hook(optimizer, args, kwargs) -> None

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

参数: hook (可调用对象) – 要注册的用户定义的钩子。
返回值: 一个句柄，可以通过调用 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 (可调用对象) – 要注册的用户定义的钩子。
返回值: 一个句柄，可以通过调用 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 (整数 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 (可调用对象, 可选) – 一个闭包，用于重新评估模型并返回损失。

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

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

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

SparseAdam¶

文档

教程

资源