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}$$

有关算法的更多详细信息，请参阅 在线学习和随机优化的自适应次梯度方法.

参数

• params (iterable) – 要优化的参数的可迭代对象或定义参数组的字典

• lr (float, 张量, 可选) – 学习率（默认值：1e-2）

• lr_decay (float, 可选) – 学习率衰减（默认值：0）

• weight_decay (float, 可选) – 权重衰减（L2 惩罚）（默认值：0）

• initial_accumulator_value (float, 可选) – 梯度平方和的初始值（默认值：0）

• eps (float, 可选) – 添加到分母的项，以提高数值稳定性（默认值：1e-10）

• foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定（因此 foreach 为 None），我们将在 CUDA 上尝试使用 foreach 而不是 for 循环实现，因为它通常明显更高效。请注意，foreach 实现比 for 循环版本使用约 sizeof(params) 更多的峰值内存，因为中间结果是张量列表，而不是单个张量。如果内存有限，请一次通过优化器批处理更少的参数，或将此标志切换为 False（默认值：None）

• maximize (bool, 可选) – 相对于 params 最大化目标，而不是最小化（默认值：False）

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

• fused (bool, 可选) – 是否使用融合实现（仅限 CPU）。目前，支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。（默认值：None）。请注意，融合实现不支持稀疏或复数梯度。

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`，它将被用于加载到优化器中。

在调用 `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() 后被调用。

它应该具有以下签名

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() 之前被调用。

它应该具有以下签名

hook(optimizer) -> None

`optimizer` 参数是正在使用的优化器实例。钩子将使用参数 `self` 被调用，然后在 `self` 上调用 `state_dict`。注册的钩子可用于在执行 `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: 一个包含当前优化状态的 `Dict`。其内容

  在不同的优化器类之间有所不同，但一些共同特征保持不变。例如，状态按参数保存，参数本身没有保存。`state` 是一个字典，它将参数 ID 映射到一个包含与每个参数对应状态的 `Dict`。

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

  参数组都是一个 `Dict`。每个参数组都包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。

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

返回类型

Dict[str, Any]

step(closure=None)

执行单个优化步骤。

参数

closure (Callable, optional) – 一个重新评估模型并返回损失的闭包。

zero_grad(set_to_none=True)

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

参数

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