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 Momentum 融入 Adam。
- 参数
params (iterable) – 要优化的参数或命名参数的迭代器，或者是定义参数组的字典的迭代器。使用命名参数时，所有组中的所有参数都应该命名。
betas (Tuple[float, float], optional) – 用于计算梯度及其平方的移动平均值的系数 (默认值: (0.9, 0.999))
eps (float, optional) – 加到分母中的项，以提高数值稳定性 (默认值: 1e-8)
weight_decay (float, 可选) – 权重衰减（L2惩罚）（默认值：0）。
momentum_decay (float, optional) – 动量 decay (默认值: 4e-3)
decoupled_weight_decay (bool, optional) – 是否解耦权重衰减，就像 AdamW 一样，以获得 NAdamW。如果为 True，则算法不会在动量或方差中累积权重衰减。(默认值: False)
foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定 (因此 foreach 为 None)，我们将尝试在 CUDA 上使用 foreach 而非 for-loop 实现，因为它通常性能显著更高。请注意，foreach 实现由于中间变量是 tensorlist 而非单个 tensor，因此比 for-loop 版本占用更多的峰值内存（约 params 的 sizeof 倍）。如果内存限制，请一次性处理更少的参数，或将此标志切换为 False (默认值: None)
maximize (bool, optional) – 最大化相对于 params 的目标，而不是最小化 (默认值: False)
capturable (bool, optional) – 该实例是否可以安全地捕获到图中，无论是用于 CUDA 图还是 torch.compile 支持。Tensor 仅在支持的 加速器 上才可捕获。设置为 True 可能会影响非图捕获的性能，因此如果您不打算对该实例进行图捕获，请将其保留为 False (默认值: False)
differentiable (bool, optional) – 在训练中，autograd 是否应该贯穿优化器步骤。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 可能会影响性能，因此如果您不打算通过此实例运行 autograd，请将其保留为 False (默认值: False)
- add_param_group(param_group)[source]#
将参数组添加到
Optimizer的 param_groups 中。这在微调预训练网络时可能很有用，因为随着训练的进行，可以使冻结的层可训练并将其添加到
Optimizer中。- 参数
param_group (dict) – 指定哪些 Tensor 应该被优化，以及特定于组的优化选项。
- 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_groups中存在param_names，它们将被保存并覆盖优化器状态中当前的名称。如果它们在加载的状态字典中不存在，优化器的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是正在使用的优化器实例。该钩子将在调用
self上的load_state_dict后，并附带参数self被调用。注册的钩子可用于在load_state_dict加载state_dict后执行后处理。- 参数
hook (Callable) – 用户定义的待注册钩子。
prepend (bool) – 如果为 True，则提供的 post
hook将在load_state_dict上所有已注册的 post-hooks 之前触发。否则，提供的hook将在所有已注册的 post-hooks 之后触发。（默认为 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，则提供的 pre
hook将在load_state_dict上所有已注册的 pre-hooks 之前触发。否则，提供的hook将在所有已注册的 pre-hooks 之后触发。（默认为 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，则提供的 post
hook将在state_dict上所有已注册的 post-hooks 之前触发。否则，提供的hook将在所有已注册的 post-hooks 之后触发。（默认为 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，则提供的 pre
hook将在state_dict上所有已注册的 pre-hooks 之前触发。否则，提供的hook将在所有已注册的 pre-hooks 之后触发。（默认为 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) } ] }
- 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 进行步进，另一种情况是跳过步进）。