ASGD#

class torch.optim.ASGD(params, lr=0.01, lambd=0.0001, alpha=0.75, t0=1000000.0, weight_decay=0, foreach=None, maximize=False, differentiable=False, capturable=False)[source]#

实现平均随机梯度下降（Averaged Stochastic Gradient Descent）。

该算法在 Acceleration of stochastic approximation by averaging 中提出。

参数

params (iterable) – 要优化的参数或命名参数的迭代器，或者是定义参数组的字典的迭代器。使用命名参数时，所有组中的所有参数都应该命名。
lr (float, Tensor, optional) – 学习率（默认：1e-2）
lambd (float, optional) – 衰减项（默认：1e-4）
alpha (float, optional) – eta 更新的幂次（默认：0.75）
t0 (float, optional) – 开始平均化的时间点（默认：1e6）
weight_decay (float, 可选) – 权重衰减（L2惩罚）（默认值：0）。
foreach (bool, optional) – 是否使用 foreach 实现优化器。如果用户未指定（因此 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而非 for-loop 实现，因为它通常性能更高。请注意，foreach 实现比 for-loop 版本占用更多的峰值内存（约 sizeof(params)），因为中间结果是 tensorlist 而不是单个 tensor。如果内存限制严格，请分批优化更少的参数，或将此标志设置为 False（默认：None）
maximize (bool, optional) – 最大化相对于 params 的目标，而不是最小化（默认：False）
differentiable (bool, optional) – autograd 是否应通过优化器步骤进行训练。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 可能会影响性能，因此如果您不打算通过此实例运行 autograd，请将其保留为 False（默认：False）
capturable (bool, optional) – 此实例是否可以安全地捕获在图中，无论是 CUDA 图还是 torch.compile 支持。张量仅在支持的加速器上可捕获。传递 True 可能会影响非图捕获性能，因此如果您不打算图捕获此实例，请将其保留为 False（默认：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() 返回的对象。

警告

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

注意

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

注册一个 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，则提供的 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。如果返回了一个 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。注册的钩子可用于在 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：一个包含所有参数组的 List，其中每个
参数组是一个字典。每个参数组包含优化器特有的元数据，例如学习率和权重衰减，以及组内参数的参数 ID 列表。如果参数组使用 named_parameters() 初始化，则名称内容也会保存在 state dict 中。

注意：参数 ID 看起来像索引，但它们只是将状态与参数组关联起来的 ID。从 state_dict 加载时，优化器会将参数组的 params（整数 ID）和优化器的 param_groups（实际的 nn.Parameter）进行 zip 操作，以匹配状态，而不进行额外的验证。

返回的状态字典可能看起来像

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

执行单个优化步骤。

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

zero_grad(set_to_none=True)[source]#

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

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

ASGD#

文档

教程

资源