Adagrad

class torch.optim.Adagrad(params, lr=0.01, lr_decay=0, weight_decay=0, initial_accumulator_value=0, eps=1e-10, foreach=None, *, maximize=False, differentiable=False, fused=None)

实现 Adagrad 算法。

$$\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)}, \: \lambda \text{ (weight decay)}, \\ &\hspace{12mm} \tau \text{ (initial accumulator value)}, \: \eta\text{ (lr decay)}\\ &\textbf{initialize} : state\_sum_0 \leftarrow \tau \\[-1.ex] &\rule{110mm}{0.4pt} \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{5mm}g_t \leftarrow \nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm} \tilde{\gamma} \leftarrow \gamma / (1 +(t-1) \eta) \\ &\hspace{5mm} \textbf{if} \: \lambda \neq 0 \\ &\hspace{10mm} g_t \leftarrow g_t + \lambda \theta_{t-1} \\ &\hspace{5mm}state\_sum_t \leftarrow state\_sum_{t-1} + g^2_t \\ &\hspace{5mm}\theta_t \leftarrow \theta_{t-1}- \tilde{\gamma} \frac{g_t}{\sqrt{state\_sum_t}+\epsilon} \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}$$

关于该算法的更多细节，请参考 Adaptive Subgradient Methods for Online Learning and Stochastic Optimization。

参数

• params (可迭代对象) – 要优化的参数或命名参数的可迭代对象，或定义参数组的可迭代字典对象。当使用命名参数时，所有组中的所有参数都应命名。

• lr (浮点型, Tensor, 可选) – 学习率 (默认值: 1e-2)

• lr_decay (浮点型, 可选) – 学习率衰减 (默认值: 0)

• weight_decay (浮点型, 可选) – 权重衰减 (L2 惩罚项) (默认值: 0)

• initial_accumulator_value (浮点型, 可选) – 梯度平方和的初始值 (默认值: 0)

• eps (浮点型, 可选) – 添加到分母以提高数值稳定性的项 (默认值: 1e-10)

• foreach (布尔型, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定 (即 foreach 为 None)，我们将尝试在 CUDA 上使用 foreach 实现而非 for-loop 实现，因为前者通常性能显著更高。请注意，由于中间变量是一个 tensorlist 而非单个张量，foreach 实现比 for-loop 版本多占用约 sizeof(params) 的峰值内存。如果内存占用过高，可以一次通过优化器的参数数量减少，或者将此标志设置为 False。(默认值: None)

• maximize (布尔型, 可选) – 相对于参数最大化目标函数，而不是最小化 (默认值: False)

• differentiable (布尔型, 可选) – 在训练中是否应通过优化器步长进行自动求导。否则，step() 函数在 torch.no_grad() 上下文中运行。将其设置为 True 可能会影响性能，因此如果您不打算通过此实例运行自动求导，请将其保留为 False。(默认值: False)

• fused (布尔型, 可选) – 是否使用 fused 实现 (仅限 CPU)。当前支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。(默认值: None)。请注意，fused 实现不支持稀疏或复数梯度。

add_param_group(param_group)

将参数组添加到 Optimizer 的 param_groups 中。

这在微调预训练网络时很有用，因为可以在训练过程中将冻结的层设为可训练并添加到 Optimizer 中。

参数

param_group (字典) – 指定哪些张量应该被优化，以及组特定的优化选项。

load_state_dict(state_dict)

加载优化器状态。

参数

state_dict (字典) – 优化器状态。应为调用 state_dict() 返回的对象。

注意

参数的名称 (如果它们存在于 state_dict() 中每个参数组的 “param_names” 键下) 不会影响加载过程。要在自定义情况下使用参数名称 (例如当加载状态字典中的参数与优化器中初始化的参数不同时)，应实现一个自定义的 register_load_state_dict_pre_hook 来相应地调整加载的字典。如果 param_names 存在于加载的状态字典 param_groups 中，它们将被保存并覆盖优化器状态中当前的名称 (如果存在)。如果它们不存在于加载的状态字典中，优化器的 param_names 将保持不变。

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 (可调用对象) – 要注册的用户定义的钩子。

• prepend (布尔型) – 如果为 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 (可调用对象) – 要注册的用户定义的钩子。

• prepend (布尔型) – 如果为 True，提供的前置 hook 将在所有已注册的 load_state_dict 前置钩子之前触发。否则，提供的前置 hook 将在所有已注册的前置钩子之后触发。(默认值: False)

返回值

一个可以通过调用 handle.remove() 来移除添加的钩子的句柄。

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_post_hook(hook, prepend=False)

注册一个状态字典后置钩子，它将在调用 state_dict() 后被调用。

它应具有以下签名

hook(optimizer, state_dict) -> state_dict or None

该钩子将在为 self 生成 state_dict 后被调用，参数包括 self 和 state_dict。该钩子可以就地修改 state_dict，或者选择返回一个新的。注册的钩子可用于在 state_dict 返回之前对其进行后处理。

参数

• hook (可调用对象) – 要注册的用户定义的钩子。

• prepend (bool) – 如果为 True，则提供的后置 hook 将在所有已注册的 state_dict 后置钩子之前触发。否则，提供的 hook 将在所有已注册的后置钩子之后触发。(默认值: False)

返回值

一个可以通过调用 handle.remove() 来移除添加的钩子的句柄。

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_pre_hook(hook, prepend=False)

注册一个状态字典前置钩子，它将在调用 state_dict() 前被调用。

它应具有以下签名

hook(optimizer) -> None

参数 optimizer 是正在使用的优化器实例。该钩子将在对 self 调用 state_dict 之前被调用，参数为 self。注册的钩子可用于在进行 state_dict 调用之前执行预处理。

参数

• hook (可调用对象) – 要注册的用户定义的钩子。

• 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 (可调用对象) – 要注册的用户定义的钩子。

返回值

一个可以通过调用 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 (可调用对象) – 要注册的用户定义的钩子。

返回值

一个可以通过调用 handle.remove() 来移除添加的钩子的句柄。

返回类型

torch.utils.hooks.RemovableHandle

state_dict()

返回优化器的状态作为 dict。

它包含两个条目

• state：一个存储当前优化状态的 Dict。其内容

  在不同的优化器类之间有所不同，但有一些共同的特征。例如，状态是按参数保存的，而参数本身并*未*保存。state 是一个将参数 ID 映射到包含对应每个参数状态的 Dict。

• param_groups：一个 List，包含所有参数组，其中每个

  参数组都是一个 Dict。每个参数组都包含特定于优化器的元数据，例如学习率和权重衰减，以及该组中参数的参数 ID 列表。如果参数组是使用 named_parameters() 初始化的，则参数名称的内容也将保存在状态字典中。

注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联起来的 ID。从 state_dict 加载时，优化器会将 param_group 中的 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)
        }
    ]
}

返回类型

dict[str, Any]

step(closure=None)

执行一次优化步骤。

参数

closure (Callable, optional) – 一个闭包（closure），用于重新评估模型并返回损失。

zero_grad(set_to_none=True)

重置所有已优化 torch.Tensor 的梯度。

参数

set_to_none (bool) – 不将梯度设置为零，而是设置为 None。这通常会降低内存占用，并能适度提升性能。但是，它会改变某些行为。例如：1. 当用户尝试访问梯度并对其执行手动操作时，None 属性或全零的 Tensor 会有不同的行为。2. 如果用户请求 zero_grad(set_to_none=True) 后跟一个反向传播（backward pass），则对于未接收到梯度的参数，.grad 保证为 None。3. torch.optim 优化器在梯度为 0 或 None 时有不同的行为（一种情况下，它会以梯度 0 执行步骤，另一种情况下，它会完全跳过该步骤）。