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][source]¶
实现 NAdam 算法。
有关该算法的更多详细信息，请参阅 Incorporating Nesterov Momentum into Adam。
- 参数
params (iterable) – 要优化的参数或 named_parameters 的可迭代对象，或定义参数组的字典的可迭代对象。当使用 named_parameters 时，所有组中的所有参数都应命名
betas (Tuple[float, float], optional) – 用于计算梯度及其平方的运行平均值的系数（默认值：(0.9, 0.999)）
eps (float, optional) – 添加到分母以提高数值稳定性的项（默认值：1e-8）
weight_decay (float, optional) – 权重衰减（L2 惩罚）（默认值：0）
momentum_decay (float, optional) – 动量衰减（默认值：4e-3）
decoupled_weight_decay (bool, optional) – 是否使用 AdamW 中的解耦权重衰减来获得 NAdamW（默认值：False）
foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将尝试在 CUDA 上使用 foreach 而不是 for 循环实现，因为通常性能会显着提高。请注意，foreach 实现使用的峰值内存比 for 循环版本多约 ~ sizeof(params)，因为中间值是张量列表而不是单个张量。如果内存受限，请一次批量处理较少的参数通过优化器，或将此标志切换为 False（默认值：None）
maximize (bool, optional) – 最大化相对于参数的目标，而不是最小化（默认值：False）
capturable (bool, optional) – 此实例是否可以安全地在 CUDA 图中捕获。传递 True 可能会损害未图形化的性能，因此如果您不打算图形捕获此实例，请将其保留为 False（默认值：False）
differentiable (bool, optional) – 是否应在训练中通过优化器步骤进行自动微分。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 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_names存在于加载的状态字典param_groups中，它们将被保存并覆盖优化器状态中的当前名称（如果存在）。如果它们在加载的状态字典中不存在，则优化器param_names将保持不变。
- 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，则提供的后置
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。如果返回了 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：一个字典，用于保存当前优化状态。其内容因优化器类而异，但一些共同特征保持不变。例如，状态是按参数保存的，并且不保存参数本身。
state是将参数 ID 映射到字典的字典，其中包含与每个参数对应的状态。
param_groups：一个列表，其中包含所有参数组，其中每个参数组都是一个字典。每个参数组都包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。如果参数组使用
named_parameters()初始化，则名称内容也将保存在状态字典中。
注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时，优化器将压缩 param_group
params（int 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) } ] }
- zero_grad(set_to_none=True)[source]¶
重置所有优化
torch.Tensor的梯度。- 参数
set_to_none (bool) – 将 grads 设置为 None 而不是设置为零。这通常会减少内存占用，并可以适度提高性能。但是，它会更改某些行为。例如：1. 当用户尝试访问梯度并对其执行手动操作时，None 属性或充满 0 的张量的行为会有所不同。2. 如果用户请求
zero_grad(set_to_none=True)，然后进行反向传递，则对于未接收到梯度的参数，.grad保证为 None。3. 如果梯度为 0 或 None，则torch.optim优化器的行为会有所不同（在一种情况下，它以梯度 0 执行步骤，在另一种情况下，它完全跳过该步骤）。
