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][source]¶
实现 RAdam 算法。
有关算法的更多详细信息，请参阅 On the variance of the adaptive learning rate and beyond。
此实现提供了一个选项，可以使用 Adam 中原生的 weight_decay 实现（weight_decay 应用于梯度），或者通过 decoupled_weight_decay 选项使用 AdamW 中的 weight_decay 实现（weight_decay 应用于权重）。当 decoupled_weight_decay 设置为 False（默认）时，它使用原始的 Adam 风格 weight decay；否则，它使用 AdamW 风格的 weight decay，这与 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, optional) – 权重衰减 (L2 范数惩罚) (默认值: 0)
decoupled_weight_decay (bool, optional) – 是否像 AdamW 中那样解耦 weight decay 以获得 RAdamW。如果为 True，算法将不在动量或方差中累积 weight decay。(默认值: False)
foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定 (即 foreach 为 None)，我们将尝试在 CUDA 上使用 foreach 而不是 for-loop 实现，因为它通常性能显著更高。请注意，由于中间变量是 tensor list 而不是单个 tensor，foreach 实现比 for-loop 版本多占用约 sizeof(params) 的峰值内存。如果内存不足，请每次通过优化器处理较少的参数，或将此标志切换为 False (默认值: None)
maximize (bool, optional) – 相对于参数最大化目标函数，而不是最小化 (默认值: False)
capturable (bool, optional) – 此实例是否可以在 CUDA 图中安全捕获。传入 True 可能会损害非图捕获的性能，因此如果您不打算图捕获此实例，请将其保留为 False (默认值: False)
differentiable (bool, optional) – 在训练过程中，是否通过优化器 step 进行 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()返回的对象。
注意
参数的名称（如果它们存在于
state_dict()中每个参数组的 “param_names” 键下）不会影响加载过程。要将参数名称用于自定义情况（例如加载的状态字典中的参数与优化器中初始化的参数不同时），应实现一个自定义的register_load_state_dict_pre_hook以相应调整加载的字典。如果加载的状态字典param_groups中存在param_names，它们将被保存并覆盖优化器状态中当前的名称（如果存在）。如果加载的状态字典中不存在param_names，则优化器的param_names将保持不变。
- register_load_state_dict_post_hook(hook, prepend=False)[source]¶
注册一个 load_state_dict 后置 hook，它将在调用
load_state_dict()后被调用。它应该具有以下签名hook(optimizer) -> None
optimizer参数是正在使用的优化器实例。hook 将在调用
load_state_dict在self上后，以参数self调用。注册的 hook 可用于在load_state_dict加载完state_dict后执行后处理。- 参数
hook (Callable) – 要注册的用户定义的 hook。
prepend (bool) – 如果为 True，提供的后置
hook将在所有已注册的 load_state_dict 后置 hook 之前触发。否则，提供的hook将在所有已注册的后置 hook 之后触发。(默认值: False)
- 返回
一个句柄，可以通过调用
handle.remove()来移除添加的 hook- 返回类型
torch.utils.hooks.RemoveableHandle
- register_load_state_dict_pre_hook(hook, prepend=False)[source]¶
注册一个 load_state_dict 前置 hook，它将在调用
load_state_dict()前被调用。它应该具有以下签名hook(optimizer, state_dict) -> state_dict or None
optimizer参数是正在使用的优化器实例，state_dict参数是用户传递给load_state_dict的state_dict的浅拷贝。hook 可以原地修改 state_dict，或者可选地返回一个新的 state_dict。如果返回了 state_dict，它将用于加载到优化器中。hook 将在调用
load_state_dict在self上前，以参数self和state_dict调用。注册的 hook 可用于在调用load_state_dict前执行预处理。- 参数
hook (Callable) – 要注册的用户定义的 hook。
prepend (bool) – 如果为 True，提供的前置
hook将在所有已注册的 load_state_dict 前置 hook 之前触发。否则，提供的前置hook将在所有已注册的前置 hook 之后触发。(默认值: False)
- 返回
一个句柄，可以通过调用
handle.remove()来移除添加的 hook- 返回类型
torch.utils.hooks.RemoveableHandle
- register_state_dict_post_hook(hook, prepend=False)[source]¶
注册一个 state dict 后置 hook，它将在调用
state_dict()后被调用。它应该具有以下签名
hook(optimizer, state_dict) -> state_dict or None
在
self上生成state_dict后，hook 将以参数self和state_dict调用。hook 可以原地修改 state_dict，或者可选地返回一个新的 state_dict。注册的 hook 可用于在返回state_dict前执行后处理。- 参数
hook (Callable) – 要注册的用户定义的 hook。
prepend (bool) – 如果为 True，提供的后置
hook将在所有已注册的 state_dict 后置 hook 之前触发。否则，提供的后置hook将在所有已注册的后置 hook 之后触发。(默认值: False)
- 返回
一个句柄，可以通过调用
handle.remove()来移除添加的 hook- 返回类型
torch.utils.hooks.RemoveableHandle
- register_state_dict_pre_hook(hook, prepend=False)[source]¶
注册一个 state dict 前置 hook，它将在调用
state_dict()前被调用。它应该具有以下签名
hook(optimizer) -> None
optimizer参数是正在使用的优化器实例。在self上调用state_dict前，hook 将以参数self调用。注册的 hook 可用于在调用state_dict前执行预处理。- 参数
hook (Callable) – 要注册的用户定义的 hook。
prepend (bool) – 如果为 True，提供的前置
hook将在所有已注册的 state_dict 前置 hook 之前触发。否则，提供的前置hook将在所有已注册的前置 hook 之后触发。(默认值: False)
- 返回
一个句柄，可以通过调用
handle.remove()来移除添加的 hook- 返回类型
torch.utils.hooks.RemoveableHandle
- register_step_post_hook(hook)[source]¶
注册一个优化器 step 后置 hook，它将在优化器 step 后被调用。
它应该具有以下签名
hook(optimizer, args, kwargs) -> None
optimizer参数是正在使用的优化器实例。- 参数
hook (Callable) – 要注册的用户定义的 hook。
- 返回
一个句柄，可以通过调用
handle.remove()来移除添加的 hook- 返回类型
torch.utils.hooks.RemovableHandle
- register_step_pre_hook(hook)[source]¶
注册一个优化器 step 前置 hook，它将在优化器 step 前被调用。
它应该具有以下签名
hook(optimizer, args, kwargs) -> None or modified args and kwargs
optimizer参数是正在使用的优化器实例。如果 args 和 kwargs 被前置 hook 修改，则将转换后的值作为包含 new_args 和 new_kwargs 的元组返回。- 参数
hook (Callable) – 要注册的用户定义的 hook。
- 返回
一个句柄，可以通过调用
handle.remove()来移除添加的 hook- 返回类型
torch.utils.hooks.RemovableHandle
- state_dict()[source]¶
以
dict的形式返回优化器的状态。它包含两个条目
state: 一个 Dict，保存当前的优化状态。其内容因优化器类而异，但有一些共同特征。例如，状态是按参数保存的，而参数本身不被保存。
state是一个 Dictionary，将参数 ID 映射到包含与每个参数对应的状态的 Dict。
param_groups: 一个 List，包含所有参数组，其中每个参数组是一个 Dict。每个参数组包含特定于优化器的元数据，例如学习率和权重衰减，以及该组中参数的参数 ID 列表。如果参数组是使用
named_parameters()初始化的，则名称内容也会保存在状态字典中。
注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时，优化器将打包 param_group
params(整型 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) – 将梯度设置为 None 而不是设置为零。这通常会降低内存占用，并适度提高性能。但是，它会改变某些行为。例如：1. 当用户尝试访问梯度并对其执行手动操作时，None 属性与全零的 Tensor 行为不同。2. 如果用户请求
zero_grad(set_to_none=True)后接着反向传播，则对于未接收梯度的参数，.grad保证为 None。3.torch.optim优化器在梯度为 0 或 None 时行为不同（一种情况下使用梯度 0 执行 step，另一种情况下完全跳过 step）。
