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][source]¶

实现平均随机梯度下降。

它在 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, optional) – 权重衰减 (L2 正则化) (默认值: 0)
foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定 (即 foreach 为 None)，我们将尝试在 CUDA 上使用 foreach 实现而非 for-loop 实现，因为它通常性能显著更优。请注意，由于中间结果是一个 tensorlist 而不是单个张量，foreach 实现比 for-loop 版本占用大约 sizeof(params) 更多的峰值内存。如果内存受限，请每次通过优化器批量处理较少的参数，或将此标志切换为 False (默认值: None)
maximize (bool, optional) – 相对于参数最大化目标函数，而不是最小化 (默认值: False)
differentiable (bool, optional) – 训练过程中是否应该通过优化器步骤进行自动微分。否则，step() 函数将在 torch.no_grad() 上下文下运行。设置为 True 可能会影响性能，因此如果您不打算通过此实例运行自动微分，请将其保留为 False (默认值: False)
capturable (bool, optional) – 此实例是否可以在 CUDA 图中安全捕获。传递 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() 返回的对象。

注意

参数的名称（如果它们存在于 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)[source]¶

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

hook(optimizer) -> None

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

在调用 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，它将被用于加载到优化器中。

在调用 load_state_dict 的 self 之前，将以 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 参数是正在使用的优化器实例。在调用 state_dict 的 self 之前，将以 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，包含所有参数组，其中每个
参数组都是一个 Dict。每个参数组都包含优化器特定的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。如果参数组是使用 named_parameters() 初始化的，则名称内容也将保存在状态字典中。




注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联起来的 ID。从状态字典加载时，优化器将压缩参数组的 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)[source][source]¶
执行一个优化步骤。

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






zero_grad(set_to_none=True)[source]¶
重置所有优化的 torch.Tensor 的梯度。

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

ASGD¶

文档

教程

资源