RAdam#
- class torch.optim.RAdam(params, lr=0.001, betas=(0.9, 0.999), eps=1e-08, weight_decay=0, decoupled_weight_decay=False, *, foreach=None, maximize=False, capturable=False, differentiable=False)[source]#
实现 RAdam 算法。
有关该算法的更多详细信息，请参阅 On the variance of the adaptive learning rate and beyond。
此实现提供了选项，可以通过 `decoupled_weight_decay` 选项使用 Adam 中的原始 weight_decay 实现（其中 weight_decay 应用于梯度）或 AdamW 中的实现（其中 weight_decay 应用于权重）。当 `decoupled_weight_decay` 设置为 False（默认值）时，它使用原始 Adam 风格的 weight decay；否则，它使用 AdamW 风格，这更接近 RAdam 论文中的 作者实现。有关解耦 weight decay 的更多信息，请参阅 Decoupled Weight Decay Regularization。
- 参数
params (iterable) – 要优化的参数或命名参数的迭代器，或者是定义参数组的字典的迭代器。使用命名参数时，所有组中的所有参数都应该命名。
betas (Tuple[float, float], optional) – 用于计算梯度及其平方的移动平均值的系数（默认值：(0.9, 0.999)）
eps (float, optional) – 添加到分母中的项，以提高数值稳定性（默认值：1e-8）
weight_decay (float, 可选) – 权重衰减（L2惩罚）（默认值：0）。
decoupled_weight_decay (bool, optional) – 是否像 AdamW 中那样解耦 weight decay 以获得 RAdamW。如果为 True，则算法不会在动量或方差中累积 weight decay。（默认值：False）
foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而不是 for 循环实现，因为它通常性能显著更高。请注意，foreach 实现由于中间变量是 TensorList 而不是单个 Tensor，因此会比 for 循环版本使用多约 sizeof(params) 的峰值内存。如果内存容量不足，请一次通过较少的参数进行优化，或将此标志切换为 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之后调用此方法，因为在此之前调用它会覆盖加载的学习率。注意
参数的名称（如果存在于每个参数组的“param_names”键下，在
state_dict()中）不会影响加载过程。要为自定义情况（例如，当加载的状态字典中的参数与优化器中初始化的参数不同时）使用参数名称，应实现自定义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)[源代码]#
注册一个
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：一个包含当前优化状态的 Dict。其内容在不同优化器类之间有所不同，但有一些共同的特征。例如，状态是按参数保存的，而参数本身不保存。
state是一个字典，将参数 ID 映射到包含对应于每个参数的状态的字典。
param_groups：一个包含所有参数组的 List，其中每个参数组是一个字典。每个参数组包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。如果一个参数组使用
named_parameters()初始化，那么名称内容也将保存在状态字典中。
注意：参数 ID 可能看起来像索引，但它们只是将状态与参数组关联的 ID。从状态字典加载时，优化器将把参数组
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)[源代码]#
重置所有优化过的
torch.Tensor的梯度。- 参数
set_to_none (bool) – 设置为 None 而不是设置为零。这通常会降低内存占用，并可能适度提高性能。但是，它会改变某些行为。例如：1.当用户尝试访问梯度并对其执行手动操作时，None 属性或全零张量会表现不同。2.如果用户请求
zero_grad(set_to_none=True)然后进行反向传播，则未接收到梯度的参数的.grad将保证为 None。3.torch.optim优化器在梯度为 0 或 None 时具有不同的行为（一种情况是使用梯度 0 执行步进，另一种情况是完全跳过步进）。