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)[source][source]¶

实现 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) – 要优化的参数或 named_parameters 的可迭代对象，或定义参数组的字典的可迭代对象。当使用 named_parameters 时，所有组中的所有参数都应被命名
lr (float, Tensor, optional) – 学习率 (默认值: 1e-2)
lr_decay (float, optional) – 学习率衰减 (默认值: 0)
weight_decay (float, optional) – 权重衰减 (L2 惩罚) (默认值: 0)
initial_accumulator_value (float, optional) – 梯度平方和的初始值 (默认值: 0)
eps (float, optional) – 添加到分母以提高数值稳定性的项 (默认值: 1e-10)
foreach (bool, optional) – 是否使用优化器的 foreach 实现。如果用户未指定 (因此 foreach 为 None)，我们将尝试在 CUDA 上使用 foreach 而不是 for 循环实现，因为它通常性能更高。请注意，由于中间变量是 tensorlist 而不是仅仅一个张量，foreach 实现使用的峰值内存比 for 循环版本多约 sizeof(params)。如果内存受到限制，请减少每次通过优化器的参数批次，或将此标志切换为 False (默认值: None)
maximize (bool, optional) – 相对于 params 最大化目标，而不是最小化 (默认值: False)
differentiable (bool, optional) – 是否应在训练中通过优化器步骤进行 autograd。否则，step() 函数在 torch.no_grad() 上下文中运行。设置为 True 可能会降低性能，因此如果您不打算通过此实例运行 autograd，请将其保留为 False (默认值: False)
fused (bool, optional) – 是否使用融合实现 (仅限 CPU)。目前，支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。(默认值: None)。请注意，融合实现不支持稀疏或复数梯度。

add_param_group(param_group)[source]¶

将参数组添加到 Optimizer 的 param_groups。

当微调预训练网络时，这可能很有用，因为可以使冻结层可训练并添加到 Optimizer 中，随着训练的进行。

参数: param_group (dict) – 指定应优化的张量以及组特定的优化选项。

load_state_dict(state_dict)[source]¶

加载优化器状态。

参数: state_dict (dict) – 优化器状态。应该是从调用 state_dict() 返回的对象。

注意

参数的名称（如果它们存在于 state_dict() 中每个参数组的 “param_names” 键下）不会影响加载过程。要将参数名称用于自定义情况（例如，当加载状态字典中的参数与优化器中初始化的参数不同时），应实现自定义 register_load_state_dict_pre_hook 以相应地调整加载的字典。如果 param_names 存在于加载的 state dict param_groups 中，它们将被保存并覆盖优化器状态中的当前名称（如果存在）。如果它们在加载的 state dict 中不存在，则优化器 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，则提供的 post hook 将在 load_state_dict 上所有已注册的 post-hook 之前触发。否则，提供的 hook 将在所有已注册的 post-hook 之后触发。（默认值：False）

返回值

一个句柄，可用于通过调用 handle.remove() 来移除添加的 hook

返回类型

torch.utils.hooks.RemoveableHandle

register_load_state_dict_pre_hook(hook, prepend=False)[source]¶

注册一个 load_state_dict pre-hook，它将在调用 load_state_dict() 之前被调用。它应该具有以下签名

hook(optimizer, state_dict) -> state_dict or None

optimizer 参数是正在使用的优化器实例，而 state_dict 参数是用户传递给 load_state_dict 的 state_dict 的浅拷贝。hook 可以就地修改 state_dict，或者选择性地返回一个新的 state_dict。如果返回了 state_dict，它将被用于加载到优化器中。

该 hook 将在对 self 调用 load_state_dict 之前，使用参数 self 和 state_dict 调用。注册的 hook 可用于在调用 load_state_dict 之前执行预处理。

参数

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 True，则提供的 pre hook 将在 load_state_dict 上所有已注册的 pre-hook 之前触发。否则，提供的 hook 将在所有已注册的 pre-hook 之后触发。（默认值：False）

返回值

一个句柄，可用于通过调用 handle.remove() 来移除添加的 hook

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_post_hook(hook, prepend=False)[source]¶

注册一个 state dict post-hook，它将在调用 state_dict() 之后被调用。

它应该具有以下签名

hook(optimizer, state_dict) -> state_dict or None

该 hook 将在 self 上生成 state_dict 之后，使用参数 self 和 state_dict 调用。hook 可以就地修改 state_dict，或者选择性地返回一个新的 state_dict。注册的 hook 可用于在返回 state_dict 之前对其执行后处理。

参数

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 True，则提供的 post hook 将在 state_dict 上所有已注册的 post-hook 之前触发。否则，提供的 hook 将在所有已注册的 post-hook 之后触发。（默认值：False）

返回值

一个句柄，可用于通过调用 handle.remove() 来移除添加的 hook

返回类型

torch.utils.hooks.RemoveableHandle

register_state_dict_pre_hook(hook, prepend=False)[source]¶

注册一个 state dict pre-hook，它将在调用 state_dict() 之前被调用。

它应该具有以下签名

hook(optimizer) -> None

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

参数

hook (Callable) – 要注册的用户定义的钩子。
prepend (bool) – 如果为 True，则提供的 pre hook 将在 state_dict 上所有已注册的 pre-hook 之前触发。否则，提供的 hook 将在所有已注册的 pre-hook 之后触发。（默认值：False）

返回值

一个句柄，可用于通过调用 handle.remove() 来移除添加的 hook

返回类型

torch.utils.hooks.RemoveableHandle

register_step_post_hook(hook)[source]¶

注册一个优化器 step post hook，它将在优化器 step 之后被调用。

它应该具有以下签名

hook(optimizer, args, kwargs) -> None

optimizer 参数是正在使用的优化器实例。

参数: hook (Callable) – 要注册的用户定义的钩子。
返回值: 一个句柄，可用于通过调用 handle.remove() 来移除添加的 hook
返回类型: torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook)[source]¶

注册一个优化器 step pre hook，它将在优化器 step 之前被调用。

它应该具有以下签名

hook(optimizer, args, kwargs) -> None or modified args and kwargs

optimizer 参数是正在使用的优化器实例。如果 args 和 kwargs 被 pre-hook 修改，则转换后的值将作为包含 new_args 和 new_kwargs 的元组返回。

参数: hook (Callable) – 要注册的用户定义的钩子。
返回值: 一个句柄，可用于通过调用 handle.remove() 来移除添加的 hook
返回类型: torch.utils.hooks.RemovableHandle

state_dict()[source]¶

以 dict 形式返回优化器的状态。

它包含两个条目

state：一个 Dict，其中保存了当前的优化状态。其内容
在不同的优化器类之间有所不同，但一些共同的特征仍然存在。例如，状态是按参数保存的，而参数本身不被保存。state 是一个字典，将参数 ID 映射到一个字典，其中包含每个参数的状态。
param_groups：一个列表，其中包含所有参数组，其中每个
参数组是一个字典。每个参数组都包含特定于优化器的元数据，例如学习率和权重衰减，以及组中参数的参数 ID 列表。如果参数组是使用 named_parameters() 初始化的，则名称内容也将保存在 state dict 中。

注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 关联的 ID。从 state_dict 加载时，优化器将压缩 param_group 的 params (int IDs) 和优化器的 param_groups (实际的 nn.Parameter s) 以匹配状态，而无需额外的验证。

返回的 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]
            '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)[source][source]¶

执行单个优化步骤。

参数: closure (Callable, 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 执行 step，在另一种情况下，它完全跳过 step）。

Adagrad¶

文档

教程

资源