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 通过掩盖与梯度中零值对应的参数和矩更新来近似 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) – 要优化的参数的迭代器或定义参数组的字典
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)¶

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

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

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

load_state_dict(state_dict)¶

加载优化器状态。

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

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 (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调用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)¶

注册一个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调用该挂钩，然后对self调用state_dict。注册的挂钩可用于在进行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：一个字典，保存当前优化状态。其内容
在不同的优化器类之间有所不同，但一些常见特征仍然存在。例如，状态是针对每个参数保存的，参数本身不会被保存。state是一个字典，将参数 ID 映射到一个字典，其中包含与每个参数相对应状态。
param_groups：一个列表，包含所有参数组，其中每个
参数组都是一个字典。每个参数组都包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。

注意：参数 ID 可能看起来像索引，但它们只是将状态与param_group关联的 ID。从state_dict加载时，优化器将压缩param_group params（整数 ID）和优化器 param_groups（实际的nn.Parameters）以匹配状态，而无需额外的验证。

返回的state dict可能如下所示

{
    '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]
        }
    ]
}

返回类型: Dict[str, Any]

step(closure=None)[source]¶

执行单个优化步骤。

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

zero_grad(set_to_none=True)¶

重置所有已优化torch.Tensors的梯度。

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

SparseAdam¶

文档

教程

资源