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)[source]¶
实现了 Adam 算法。
有关该算法的更多详细信息，请参阅 Adam: A Method for Stochastic Optimization。
- 参数
params (iterable) – 要优化的参数的迭代器或定义参数组的字典
lr (float, Tensor, 可选) – 学习率（默认值：1e-3）。并非所有实现都支持张量 LR。如果您没有指定 fused=True 或 capturable=True，请使用浮点型 LR。
betas (Tuple[float, float], 可选) – 用于计算梯度及其平方运行平均值的系数（默认值：(0.9, 0.999)）
eps (float, 可选) – 添加到分母中的项，以提高数值稳定性（默认值：1e-8）
weight_decay (float, 可选) – 权重衰减（L2 正则化）（默认值：0）
amsgrad (bool, 可选) – 是否使用该算法的 AMSGrad 变体，来自论文 On the Convergence of Adam and Beyond（默认值：False）
foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而不是 for 循环实现，因为它通常性能更高。请注意，由于中间结果是张量列表而不是单个张量，因此 foreach 实现比 for 循环版本使用大约 sizeof(params) 更多的峰值内存。如果内存有限，请一次对较少的参数进行批处理，或将此标志切换为 False（默认值：None）
maximize (bool, 可选) – 对 params 最大化目标，而不是最小化（默认值：False）
capturable (bool, 可选) – 此实例是否可以在 CUDA 图中安全捕获。将此值设置为 True 可能会影响非图化性能，因此，如果您不打算图化捕获此实例，请将其保留为 False（默认值：False）
differentiable (bool, 可选) – 在训练中是否应通过优化器步骤进行自动微分。否则，step() 函数在 torch.no_grad() 上下文中运行。设置为 True 可能会影响性能，因此，如果您不打算通过此实例运行自动微分，请将其保留为 False（默认值：False）
fused (bool, 可选) – 是否使用融合实现。目前，支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。（默认值：None）
注意
与 for 循环、单张量实现相比，foreach 和 fused 实现通常更快，其中 fused 在理论上具有垂直和水平融合时最快。因此，如果用户未指定任何标志（即，当 foreach = fused = None 时），当所有张量都在 CUDA 上时，我们将尝试默认为 foreach 实现。为什么不使用 fused？由于 fused 实现相对较新，我们希望给它足够的时间进行磨合。要指定 fused，请将 fused 设置为 True。要强制运行 for 循环实现，请将 foreach 或 fused 设置为 False。
注意
MPS 上 Adam 和 AdamW 的原型实现支持 torch.float32 和 torch.float16。
- add_param_group(param_group)¶
将一个参数组添加到
Optimizer的 param_groups 中。这在微调预训练网络时非常有用，因为可以将冻结的层设为可训练的，并在训练过程中添加到
Optimizer中。- 参数
param_group (dict) – 指定哪些张量应该被优化，以及特定于组的优化选项。
- load_state_dict(state_dict)¶
加载优化器状态。
- 参数
state_dict (dict) – 优化器状态。应该是
state_dict()调用返回的对象。
- 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：一个保存当前优化状态的字典。其内容在不同的优化器类之间有所不同，但一些共同特征仍然存在。例如，状态是针对每个参数保存的，参数本身不会被保存。
state是一个字典，将参数 ID 映射到一个字典，其中包含与每个参数对应的状态。
param_groups：一个列表，包含所有参数组，其中每个参数组都是一个字典。每个参数组包含特定于优化器的元数据，例如学习率和权重衰减，以及该组中参数的参数 ID 列表。
注意：参数 ID 可能看起来像索引，但它们只是将状态与参数组关联的 ID。从 state_dict 加载时，优化器将压缩参数组
params（整数 ID）和优化器param_groups（实际的nn.Parameter）以匹配状态，而无需额外的验证。返回的 state_dict 可能看起来像
{ '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] }, { 'lr': 0.001, 'weight_decay': 0.5, ... 'params': [1, 2, 3] } ] }
- zero_grad(set_to_none=True)¶
重置所有优化
torch.Tensor的梯度。- 参数
set_to_none (bool) – 而不是设置为零，将梯度设置为 None。这通常会降低内存占用，并可以适度提高性能。但是，它会改变某些行为。例如：1. 当用户尝试访问梯度并在其上执行手动操作时，None 属性或全为 0 的张量将表现出不同的行为。2. 如果用户请求
zero_grad(set_to_none=True)后跟反向传播，则对于未接收梯度的参数，.grad保证为 None。3.torch.optim优化器在梯度为 0 或 None 时具有不同的行为（在一种情况下，它使用梯度 0 执行步骤，而在另一种情况下，它完全跳过该步骤）。
