Adam¶
- class torch.optim.Adam(params, lr=0.001, betas=(0.9, 0.999), eps=1e-08, weight_decay=0, amsgrad=False, *, foreach=None, maximize=False, capturable=False, differentiable=False, fused=None, decoupled_weight_decay=False)[source][source]¶
实现了 Adam 算法。
有关该算法的更多详细信息，请参阅 Adam: A Method for Stochastic Optimization。
- 参数
params (iterable) – 要优化的参数的可迭代对象或命名参数的可迭代对象，或定义参数组的字典的可迭代对象。使用命名参数时，所有组中的所有参数都应命名
lr (float, Tensor, optional) – 学习率（默认值：1e-3）。并非所有实现都支持 Tensor 类型的学习率。如果您未同时指定 fused=True 或 capturable=True，请使用浮点数类型的学习率。
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) – 如果为 True，则此优化器等同于 AdamW，并且算法不会在动量或方差中累积权重衰减。（默认值：False）
amsgrad (bool, optional) – 是否使用来自论文 On the Convergence of Adam and Beyond 的 AMSGrad 变体算法（默认值：False）
foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定（即 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而非 for 循环实现，因为它通常性能显著更高。请注意，foreach 实现比 for 循环实现使用大约 sizeof(params) 更多的峰值内存，因为中间结果是 TensorList 而不是单个 Tensor。如果内存受限，请每次通过优化器处理较少的参数，或者将此标志设置为 False（默认值：None）
maximize (bool, optional) – 相对于参数最大化目标，而不是最小化（默认值：False）
capturable (bool, optional) – 此实例是否可以安全地在 CUDA 图中捕获。传递 True 可能会损害未图化时的性能，因此如果您不打算捕获此实例的图，请将其保留为 False（默认值：False）
differentiable (bool, optional) – 训练中是否通过优化器 step 发生自动求导。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 可能会损害性能，因此如果您不打算通过此实例运行自动求导，请将其保留为 False（默认值：False）
fused (bool, optional) – 是否使用融合实现。目前支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。（默认值：None）
注意
foreach 和 fused 实现通常比 for 循环的单 Tensor 实现更快，其中 fused 实现理论上在垂直和水平融合方面是最快的。因此，如果用户未指定任何标志（即 foreach = fused = None 时），当所有 Tensor 都在 CUDA 上时，我们将尝试默认使用 foreach 实现。为什么不使用 fused？由于 fused 实现相对较新，我们希望给予其足够的验证时间。要指定 fused，请为 fused 传递 True。要强制运行 for 循环实现，请为 foreach 或 fused 传递 False。
注意
MPS 版本的 Adam 和 AdamW 原型实现支持 torch.float32 和 torch.float16。
- 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将保持不变。
- 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]¶
注册一个优化器 step 后置钩子，它将在优化器 step 后调用。
它应具有以下签名
hook(optimizer, args, kwargs) -> None
optimizer 参数是正在使用的优化器实例。
- 参数
hook (Callable) – 要注册的用户定义的钩子。
- 返回
一个句柄，可以通过调用
handle.remove()来移除添加的钩子- 返回类型
torch.utils.hooks.RemovableHandle
- register_step_pre_hook(hook)[source]¶
注册一个优化器 step 前置钩子，它将在优化器 step 之前调用。
它应具有以下签名
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 映射到包含每个参数对应状态的 Dict。
param_groups: 一个 List，包含所有参数组，其中每个参数组是一个 Dict。每个参数组包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。如果参数组是使用
named_parameters()初始化的，则名称内容也将保存在状态字典中。
注意：参数 ID 可能看起来像索引，但它们只是将状态与参数组关联起来的 ID。从 state_dict 加载时，优化器将把参数组
params（int 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. 如果梯度为 0 或 None，torch.optim优化器会有不同的行为（在前一种情况下，它会以梯度 0 执行步骤，在后一种情况下，它会完全跳过该步骤）。
