快捷方式

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)[源代码]

实现平均随机梯度下降。

它在 通过平均加速随机逼近 中被提出。

参数
  • params (iterable) – 要优化的参数的迭代器或定义参数组的字典

  • lr (float, Tensor, 可选) – 学习率 (默认值:1e-2)

  • lambd (float, 可选) – 衰减项 (默认值:1e-4)

  • alpha (float, 可选) – eta 更新的幂 (默认值:0.75)

  • t0 (float, 可选) – 开始平均的点 (默认值:1e6)

  • weight_decay (float, 可选) – 权重衰减 (L2 惩罚) (默认值:0)

  • foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定(因此 foreach 为 None),我们将尝试在 CUDA 上使用 foreach 而不是 for 循环实现,因为它通常性能更高。请注意,由于中间结果是张量列表而不是单个张量,因此 foreach 实现比 for 循环版本使用了约 sizeof(params) 更多的峰值内存。如果内存不足,请一次通过优化器批处理较少的参数,或将此标志切换为 False(默认值:None)

  • maximize (bool, 可选) – 相对于 params 最大化目标,而不是最小化 (默认值:False)

  • differentiable (bool, 可选) – 在训练中是否应通过优化器步骤进行自动梯度。否则,step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 会影响性能,因此如果您不打算在此实例中运行自动梯度,请将其保留为 False(默认值:False)

  • capturable (bool, 可选) – 此实例是否可以在 CUDA 图中安全捕获。传递 True 会影响非图性能,因此,如果您不打算图捕获此实例,请将其保留为 False(默认值:False)

add_param_group(param_group)

将参数组添加到 Optimizerparam_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_dictstate_dict 的浅拷贝。钩子可以就地修改 state_dict 或选择性地返回一个新的 state_dict。如果返回了 state_dict,则将使用它加载到优化器中。

在对 self 调用 load_state_dict 之前,将使用参数 selfstate_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 后,将使用参数 selfstate_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)

注册一个 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)

注册一个优化器步骤后置钩子,该钩子将在优化器步骤之后被调用。

它应该具有以下签名

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:一个 Dict,保存当前优化状态。其内容

    在不同的优化器类之间有所不同,但一些共同的特征仍然存在。例如,state 是针对每个参数保存的,并且参数本身不会被保存。 state 是一个 Dictionary,将参数 ID 映射到一个 Dict,其中包含与每个参数对应的状态。

  • param_groups:一个 List,包含所有参数组,其中每个

    参数组都是一个 Dict。每个参数组包含特定于优化器的元数据,例如学习率和权重衰减,以及该组中参数的参数 ID 列表。

注意:参数 ID 看起来像索引,但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时,优化器将 zip param_group params(整数 ID)和优化器 param_groups(实际的 nn.Parameter)以匹配状态,无需额外的验证。

返回的 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.Tensor 的梯度。

参数

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

文档

访问 PyTorch 的全面开发者文档

查看文档

教程

获取针对初学者和高级开发人员的深入教程

查看教程

资源

查找开发资源并获得问题的解答

查看资源