NAdam¶
- class torch.optim.NAdam(params, lr=0.002, betas=(0.9, 0.999), eps=1e-08, weight_decay=0, momentum_decay=0.004, decoupled_weight_decay=False, *, foreach=None, maximize=False, capturable=False, differentiable=False)[source]¶
实现 NAdam 算法。
有关该算法的更多详细信息,请参阅 将 Nesterov 动量整合到 Adam 中。
- 参数
params (iterable) – 要优化的参数的迭代器或定义参数组的字典
betas (Tuple[float, float], 可选) – 用于计算梯度及其平方运行平均值的系数 (默认值: (0.9, 0.999))
eps (float, 可选) – 添加到分母中的项,以提高数值稳定性 (默认值:1e-8)
weight_decay (float, 可选) – 权重衰减 (L2 惩罚) (默认值:0)
momentum_decay (float, 可选) – 动量衰减 (默认值:4e-3)
decoupled_weight_decay (bool, 可选) – 是否使用 AdamW 中的解耦权重衰减来获得 NAdamW (默认值:False)
foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定(因此 foreach 为 None),我们将尝试在 CUDA 上使用 foreach 而不是 for 循环实现,因为它通常性能更好。请注意,由于中间变量是张量列表而不是单个张量,因此 foreach 实现比 for 循环版本使用大约 sizeof(params) 更多的峰值内存。如果内存不足,请一次通过优化器批处理更少的参数,或将此标志切换为 False (默认值:None)
maximize (bool, 可选) – 相对于参数最大化目标,而不是最小化 (默认值:False)
capturable (bool, 可选) – 此实例是否可以安全地捕获在 CUDA 图中。将 True 传递给此参数可能会损害非图形化性能,因此,如果您不打算图形化捕获此实例,请将其保留为 False (默认值:False)
differentiable (bool, 可选) – 在训练期间是否应通过优化器步骤进行自动梯度计算。否则,step() 函数在 torch.no_grad() 上下文中运行。设置为 True 可能会损害性能,因此,如果您不打算通过此实例运行自动梯度计算,请将其保留为 False (默认值: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。如果返回了 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。注册的挂钩可用于在返回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
:一个保存当前优化状态的字典。其内容在不同的优化器类之间有所不同,但一些共同的特征仍然存在。例如,状态是为每个参数保存的,参数本身不会被保存。
state
是一个字典,它将参数 ID 映射到一个字典,该字典包含与每个参数相对应状态。
param_groups
:一个列表,包含所有参数组,其中每个参数组都是一个字典。每个参数组都包含特定于优化器的元数据,例如学习率和权重衰减,以及组中参数的参数 ID 列表。
注意:参数 ID 可能看起来像索引,但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时,优化器将压缩 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] } ] }
- 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执行步骤,而在另一个情况下,它完全跳过该步骤)。