SparseAdam¶

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

SparseAdam 实现了 Adam 算法的掩码版本，适用于稀疏梯度。目前，由于实现上的限制（如下所述），SparseAdam 仅适用于狭窄的用例子集，特别是具有密集布局参数和稀疏布局梯度的参数。这种情况发生在模块反向传播产生稀疏布局梯度的一种特殊情况下。一个表现如此的 NN 模块示例是 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 字段来做到这一点。

参数

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

add_param_group(param_group)[source]¶

向 Optimizer 的 param_groups 添加参数组。

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

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

load_state_dict(state_dict)[source]¶

加载优化器状态。

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

注意

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

register_load_state_dict_post_hook(hook, prepend=False)[source]¶

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

hook(optimizer) -> None

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

钩子将在调用 self 上的 load_state_dict 后使用参数 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 上的 load_state_dict 之前使用参数 self 和 state_dict 调用。注册的钩子可用于在 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 映射到包含与每个参数对应的状态的字典。
param_groups：一个列表，包含所有参数组，其中每个
参数组是一个字典。每个参数组都包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 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][source]¶

执行单个优化步骤。

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

zero_grad(set_to_none=True)[source]¶

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

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

SparseAdam¶

文档

教程

资源