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]#
实现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）。
decoupled_weight_decay (bool, 可选) – 如果为True，此优化器等同于AdamW，算法将不会在动量或方差中累积权重衰减。（默认值：False）。
amsgrad (bool, 可选) – 是否使用论文 On the Convergence of Adam and Beyond 中的AMSGrad变体算法（默认值：False）。
foreach (bool, 可选) – 是否使用优化器的foreach实现。如果用户未指定（即foreach为None），我们将在CUDA上尝试使用foreach而不是for-loop实现，因为它通常性能显著更优。请注意，由于中间结果是张量列表而不是单个张量，foreach实现比for-loop版本多占用约 sizeof(params) 的峰值内存。如果内存限制严格，请每次通过优化器批量处理更少的参数，或者将此标志设置为False（默认值：None）。
maximize (bool, 可选) – 相对于参数最大化目标，而不是最小化（默认值：False）。
capturable (bool, 可选) – 此实例是否可以在图中安全捕获，无论是用于CUDA图还是torch.compile支持。张量仅在受支持的 加速器 上可捕获。传递True可能会损害未图化性能，因此如果您不打算捕获此实例，请将其保留为False（默认值：False）。
differentiable (bool, 可选) – 在训练过程中是否应通过优化器步骤进行自动求导。否则，step() 函数在torch.no_grad() 上下文中运行。设置为True可能会损害性能，因此如果您不打算通过此实例运行自动求导，请将其保留为False（默认值：False）。
fused (bool, 可选) – 是否使用融合实现。目前支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。（默认值：None）。
注意
foreach 和 fused 实现通常比 for-loop、单张量实现更快，其中 fused 在理论上通过垂直和水平融合速度最快。因此，如果用户未指定任何标志（即当 foreach = fused = None 时），当所有张量都在 CUDA 上时，我们将尝试默认使用 foreach 实现。为什么不使用 fused？因为 fused 实现相对较新，我们希望给予其足够的成熟时间。要指定 fused，请将 fused 传递为 True。要强制运行 for-loop 实现，请将 foreach 或 fused 传递为 False。
注意
Adam 和 AdamW 的 MPS 原型实现支持 torch.float32 和 torch.float16。
- add_param_group(param_group)[source]#
向
Optimizer的 param_groups 添加一个参数组。当微调预训练网络时，这可能很有用，因为冻结层可以变得可训练并随着训练的进行添加到
Optimizer中。- 参数
param_group (dict) – 指定应优化的张量以及组特定的优化选项。
- load_state_dict(state_dict)[source]#
加载优化器状态。
- 参数
state_dict (dict) – 优化器状态。应为调用
state_dict()返回的对象。
警告
请确保在初始化
torch.optim.lr_scheduler.LRScheduler之后调用此方法，因为在此之前调用它将覆盖加载的学习率。注意
参数的名称（如果它们存在于
state_dict()中每个参数组的“param_names”键下）不会影响加载过程。要将参数名称用于自定义情况（例如当加载的状态字典中的参数与优化器中初始化的参数不同时），应实现自定义的register_load_state_dict_pre_hook以相应地调整加载的字典。如果param_names存在于加载的状态字典param_groups中，它们将被保存并覆盖优化器状态中当前存在的名称。如果它们不存在于加载的状态字典中，优化器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)[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()后被调用。它应具有以下签名
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()之前被调用。它应具有以下签名
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参数是正在使用的优化器实例。如果参数和关键字参数被前置钩子修改，则转换后的值将作为包含 new_args 和 new_kwargs 的元组返回。- 参数
hook (Callable) – 用户定义的待注册钩子。
- 返回
一个句柄，可用于通过调用
handle.remove()来移除添加的钩子- 返回类型
torch.utils.hooks.RemovableHandle
- state_dict()[source]#
将优化器的状态作为
dict返回。它包含两个条目
state：一个包含当前优化状态的 Dict。其内容不同优化器类之间的状态字典存在差异，但有一些共同的特性。例如，状态按参数保存，但参数本身不保存。
state是一个字典，将参数 ID 映射到包含与每个参数对应的状态的字典。
param_groups：一个包含所有参数组的 List，其中每个参数组是一个字典。每个参数组都包含优化器特有的元数据，例如学习率和权重衰减，以及该组中参数的参数 ID 列表。如果参数组是使用
named_parameters()初始化的，则名称内容也将保存在状态字典中。
注意：参数 ID 可能看起来像索引，但它们只是将状态与参数组关联起来的 ID。从状态字典加载时，优化器会将参数组
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 属性或填充 0 的张量将表现不同。2. 如果用户请求
zero_grad(set_to_none=True)，然后进行反向传播，则未接收到梯度的参数的.grad将保证为 None。3.torch.optim优化器在梯度为 0 或 None 时有不同的行为（在前一种情况下，它以梯度为 0 执行步骤，在后一种情况下，它完全跳过该步骤）。