Adafactor

class torch.optim.Adafactor(params, lr=0.01, beta2_decay=-0.8, eps=(None, 0.001), d=1.0, weight_decay=0.0, *, foreach=None, maximize=False)

实现 Adafactor 算法。

$$\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{(lr)}, \: \tau \text{(}\beta_2\text{ decay)}, \: \theta_0 \text{(params)}, \: f(\theta) \text{(objective)}, \\ &\hspace{15mm} \: \epsilon_1, \epsilon_2 \text{ (epsilons)}, \: d \text{(clipping threshold)}, \\ &\hspace{15mm} \: \lambda \text{(weight decay)}, \: \textit{maximize} \\ &\textbf{initialize} : \: R_0 \leftarrow 0 \text{ (second moment row factor)}, \\ &\hspace{23mm} \: C_0 \leftarrow 0 \text{ (second moment col factor)}, \\ &\hspace{23mm} \: \widehat{V}_0 \leftarrow 0 \text{ (second moment for vectors)} \\[-1.ex] &\rule{110mm}{0.4pt} \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{5mm}\textbf{if} \: \textit{maximize}: \\ &\hspace{10mm}G_t \leftarrow -\nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm}\textbf{else} \\ &\hspace{10mm}G_t \leftarrow \nabla_{\theta} f_t (\theta_{t-1}) \\ &\hspace{5mm}\widehat{\beta}_{2_t} \leftarrow 1 - t^{\tau} \\ &\hspace{5mm}\rho_t \leftarrow min(lr, \frac{1}{\sqrt{t}}) \\ &\hspace{5mm}\alpha_t \leftarrow max(\epsilon_2, \text{RMS}(\theta_{t-1}))\rho_t \\ &\hspace{5mm}\theta_t \leftarrow \theta_{t-1} - \gamma \lambda \theta_{t-1} \\ &\hspace{5mm}\textbf{if} \: \text{dim}(G_t) > 1: \\ &\hspace{10mm}R_t \leftarrow \widehat{\beta}_{2_t}R_{t-1}+ (1-\widehat{\beta}_{2_t})(G_t \odot G_t) \cdot 1_m \\ &\hspace{10mm}C_t \leftarrow \widehat{\beta}_{2_t}C_{t-1}+ (1-\widehat{\beta}_{2_t}) 1^\top_n \cdot (G_t \odot G_t) \\ &\hspace{10mm}\widehat{V}_t \leftarrow \frac{R_t \cdot C_t}{max(1^\top_n \cdot R_t, \epsilon_1)} \\ &\hspace{5mm}\textbf{else} \\ &\hspace{10mm}\widehat{V}_t \leftarrow \widehat{\beta}_{2_t}\widehat{V}_{t-1}+ (1-\widehat{\beta}_{2_t}) \cdot (G_t \odot G_t) \\ &\hspace{5mm}U_t \leftarrow \frac{G_t}{max(\sqrt{\widehat{V}_t}, \epsilon_1)} \\ &\hspace{5mm}\widehat{U}_t \leftarrow \frac{U_t}{max(1, \frac{\text{RMS}(U_t)}{d})} \\ &\hspace{5mm}\theta_t \leftarrow \theta_{t-1} - \alpha_t \widehat{U}_t \\ &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}$$

关于该算法的更多细节，请参考 Adafactor: Adaptive Learning Rates with Sublinear Memory Cost。

参数

• params (iterable) – 待优化的参数迭代器或 named_parameters 迭代器，或定义参数组的字典迭代器。使用 named_parameters 时，所有组中的所有参数都应被命名

• lr (float, Tensor, optional) – 与其他优化器不同，Adafactor 不需要学习率，并且 Shazeer, Noam, 和 Mitchell Stern 完全不使用 lr。与论文有所不同，此实现使用 lr 来应用权重衰减，并作为相对步长 rho_t 的最大值。请注意，在论文中，使用常数 0.01 作为相对步长的最大值，因此我们将 0.01 设置为默认值。(default: 1e-2)

• beta2_decay (float, optional) – beta2 的衰减率。beta2 通常指用于计算梯度平方移动平均的系数。(default: -0.8)

• eps (Tuple[float, float], optional) – epsilon1 是添加到更新计算分母中的项，用于提高数值稳定性。此对 epsilon1 的使用与论文中描述的算法有所不同！更多详情请参阅下面的注意事项。epsilon2 是用于避免在应用参数缩放时权重更新过小的项。(default: (None, 1e-3))

• d (float, optional) – 裁剪阈值，用于避免更新值大于期望值。

• weight_decay (float, optional) – 权重衰减系数 (default: 1e-2)

• foreach (bool, optional) – 是否使用 foreach 实现的优化器。请注意，foreach 实现比 for-loop 版本占用更多的峰值内存，大约是 sizeof(params) 的大小，因为中间变量是一个 tensorlist 而不是单个 tensor。由于 Adafactor 通常在内存受限的情况下使用，因此除非明确将此标志设置为 True，否则 Adafactor 将默认使用较慢的单 tensor for-loop 实现。此行为与其他优化器相反，其他优化器在 CUDA 上会尝试默认使用 foreach 以获得更快的运行时性能。(default: None)

• maximize (bool, optional) – 相对于参数最大化目标，而不是最小化 (default: False)

注意

Adafactor 的实现与 Shazeer, Noam, 和 Mitchell Stern 以及其他一些框架中的实现在使用学习率和 $\epsilon_1$ 方面略有不同。

关于学习率超参数：Shazeer, Noam, 和 Mitchell Stern 完全不使用 lr，因为其提出的算法使用 $\rho_t$ 和更新裁剪来影响步长。

此实现允许 lr 影响 $\rho_t$ 的最大值

$$\begin{aligned} &\hspace{5mm}\rho_t \leftarrow min(lr, \frac{1}{\sqrt{t}}) \end{aligned}$$

这与 Shazeer, Noam, 和 Mitchell Stern 不同，他们使用常数 0.01 作为 $\rho_t$ 的最大值

$$\begin{aligned} &\hspace{5mm}\rho_t \leftarrow min(0.01, \frac{1}{\sqrt{t}}) \end{aligned}$$

Shazeer, Noam, 和 Mitchell Stern 没有对如何计算权重衰减给出明确意见，因此我们使用学习率作为解耦权重衰减的系数，这类似于 Decoupled Weight Decay Regularization 中建议的做法。

关于使用 $\epsilon_1$：此实现试图复制 Shazeer, Noam, 和 Mitchell Stern 在梯度平方变小时使用 $\epsilon_1$ 作为稳定项的预期意图。

此稳定化可以写为

$$\begin{aligned} &\hspace{5mm}R_t \leftarrow \widehat{\beta}_{2_t}R_{t-1}+ (1-\widehat{\beta}_{2_t})(G_t \odot G_t + 1_n \cdot 1^\top_m) \cdot 1_m \\ &\hspace{5mm}C_t \leftarrow \widehat{\beta}_{2_t}C_{t-1}+ (1-\widehat{\beta}_{2_t}) 1^\top_n \cdot (G_t \odot G_t + 1_n \cdot 1^\top_m) \\ &\hspace{5mm}\widehat{V}_t \leftarrow \frac{R_t \cdot C_t}{max(1^\top_n \cdot R_t, \epsilon_1)} \\ &\hspace{5mm}U_t \leftarrow \frac{G_t}{max(\sqrt{\widehat{V}_t}, \epsilon_1)} \\ \end{aligned}$$

其中，梯度平方的行因子 $R_t$ 和列因子 $C_t$ 被单独处理，并且我们在方差估计值 $\widehat{V}_t$ 的最终计算和更新 $U_t$ 中应用了 $\epsilon_1$。

这与 Shazeer、Noam 和 Mitchell Stern 等将 $\epsilon_1$ 应用于梯度平方的行因子和列因子，但不应用于之后的计算中的其他框架不同。

$$\begin{aligned} &\hspace{5mm}R_t \leftarrow \widehat{\beta}_{2_t}R_{t-1}+ (1-\widehat{\beta}_{2_t})(G_t \odot G_t + \epsilon_1 1_n \cdot 1^\top_m) \cdot 1_m \\ &\hspace{5mm}C_t \leftarrow \widehat{\beta}_{2_t}C_{t-1}+ (1-\widehat{\beta}_{2_t}) 1^\top_n \cdot (G_t \odot G_t + \epsilon_1 1_n \cdot 1^\top_m) \\ &\hspace{5mm}\widehat{V}_t \leftarrow \frac{R_t \cdot C_t}{1^\top_n \cdot R_t} \\ &\hspace{5mm}U_t \leftarrow \frac{G_t}{\sqrt{\widehat{V}_t}} \\ \end{aligned}$$

add_param_group(param_group)

添加一个参数组到 Optimizer 的 param_groups 中。

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

参数

param_group (dict) – 指定应该与组特定的优化选项一起优化的张量。

load_state_dict(state_dict)

加载优化器状态。

参数

state_dict (dict) – 优化器状态。它应该是一个调用 state_dict() 返回的对象。

注意

参数的名称（如果它们存在于 state_dict() 中每个参数组的“param_names”键下）不会影响加载过程。对于自定义情况（例如，加载的状态字典中的参数与优化器中初始化的参数不同时），应该实现一个自定义的 register_load_state_dict_pre_hook 来相应地调整加载的字典。如果加载的状态字典的 param_groups 中存在 param_names，它们将被保存并覆盖优化器状态中当前的名称（如果存在的话）。如果加载的状态字典中不存在 param_names，优化器的 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 (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() 之后被调用。

它应该具有以下签名

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` 调用 `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: 一个 holding 当前优化状态的 Dict。其内容

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

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

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

注意：参数 ID 可能看起来像索引，但它们只是将状态与 param_group 相关联的 ID。从 state_dict 加载时，优化器将打包 param_group 的 `params`（int 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]
            '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 (可调用对象, 可选) – 一个重新评估模型并返回损失的闭包。

zero_grad(set_to_none=True)

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

参数

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