新加坡元 ¶

class torch.optim.SGD(params, lr=0.001, momentum=0, dampening=0, weight_decay=0, nesterov=False, *, maximize=False, foreach=None, differentiable=False, fused=None)[source][source]¶

实现随机梯度下降（可选带动量）。

\begin{aligned} &\rule{110mm}{0.4pt} \\ &\textbf{input} : \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta) \text{ (objective)}, \: \lambda \text{ (weight decay)}, \\ &\hspace{13mm} \:\mu \text{ (momentum)}, \:\tau \text{ (dampening)}, \:\textit{ nesterov,}\:\textit{ maximize} \\[-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}\textbf{if} \: \lambda \neq 0 \\ &\hspace{10mm} g_t \leftarrow g_t + \lambda \theta_{t-1} \\ &\hspace{5mm}\textbf{if} \: \mu \neq 0 \\ &\hspace{10mm}\textbf{if} \: t > 1 \\ &\hspace{15mm} \textbf{b}_t \leftarrow \mu \textbf{b}_{t-1} + (1-\tau) g_t \\ &\hspace{10mm}\textbf{else} \\ &\hspace{15mm} \textbf{b}_t \leftarrow g_t \\ &\hspace{10mm}\textbf{if} \: \textit{nesterov} \\ &\hspace{15mm} g_t \leftarrow g_{t} + \mu \textbf{b}_t \\ &\hspace{10mm}\textbf{else} \\[-1.ex] &\hspace{15mm} g_t \leftarrow \textbf{b}_t \\ &\hspace{5mm}\textbf{if} \: \textit{maximize} \\ &\hspace{10mm}\theta_t \leftarrow \theta_{t-1} + \gamma g_t \\[-1.ex] &\hspace{5mm}\textbf{else} \\[-1.ex] &\hspace{10mm}\theta_t \leftarrow \theta_{t-1} - \gamma g_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] &\bf{return} \: \theta_t \\[-1.ex] &\rule{110mm}{0.4pt} \\[-1.ex] \end{aligned}

Nesterov 动量基于《深度学习中初始化和动量的重要性》中的公式。

参数:

params（可迭代对象）- 要优化或定义参数组的字典的可迭代对象或命名参数的可迭代对象。当使用命名参数时，所有组中的所有参数都应具有名称
lr（浮点数，张量，可选）- 学习率（默认：1e-3）
momentum（浮点数，可选）- 动量因子（默认：0）
dampening（浮点数，可选）- 动量的阻尼（默认：0）
weight_decay (float, 可选) – 权重衰减（L2 惩罚）（默认：0）
nesterov (布尔值，可选) – 启用 Nesterov 动量。仅当动量非零时适用。（默认：False）
maximize (bool, 可选) – 相对于 params 最大化目标，而不是最小化（默认：False）
foreach (bool, 可选) – 是否使用优化器的 foreach 实现。如果用户未指定（即 foreach 为 None），我们将尝试在 CUDA 上使用 foreach 覆盖 for-loop 实现，因为它通常性能显著更高。请注意，foreach 实现比 for-loop 版本多使用~ sizeof(params)的峰值内存，因为中间结果是一个 tensorlist 而不是只有一个 tensor。如果内存受限，请一次通过优化器批量处理较少的参数，或将此标志设置为 False（默认：None）
可微分的（bool，可选）- 是否在训练过程中通过优化器步骤进行自动微分。否则，step() 函数将在 torch.no_grad() 上下文中运行。设置为 True 可能会降低性能，因此如果不打算通过此实例运行自动微分，请将其保留为 False（默认：False）
混合（bool，可选）- 是否使用混合实现。目前支持 torch.float64、torch.float32、torch.float16 和 torch.bfloat16。（默认：None）

注意

foreach 和混合实现通常比 for-loop 单张张量实现更快，其中混合在理论上最快，具有垂直和水平融合。因此，如果用户没有指定任一标志（即当 foreach = fused = None 时），我们将尝试将默认值设置为 foreach 实现，当所有张量都在 CUDA 上时。为什么不使用混合实现？因为混合实现相对较新，我们希望给它足够的时间进行测试。要指定混合实现，请将 fused 设置为 True。要强制运行 for-loop 实现，请将 foreach 或 fused 设置为 False。

示例

>>> optimizer = torch.optim.SGD(model.parameters(), lr=0.1, momentum=0.9)
>>> optimizer.zero_grad()
>>> loss_fn(model(input), target).backward()
>>> optimizer.step()

注意

SGD 带动量/Nesterov 的实现与 Sutskever 等人以及某些其他框架中的实现略有不同。

考虑动量的具体情况，更新可以表示为

\begin{aligned} v_{t+1} & = \mu * v_{t} + g_{t+1}, \\ p_{t+1} & = p_{t} - \text{lr} * v_{t+1}, \end{aligned}

其中 $p$ ， $g$ ， $v$ 和 $\mu$ 分别表示参数、梯度、速度和动量。

这与 Sutskever 等人以及采用类似更新的其他框架形成对比。

\begin{aligned} v_{t+1} & = \mu * v_{t} + \text{lr} * g_{t+1}, \\ p_{t+1} & = p_{t} - v_{t+1}. \end{aligned}

Nesterov 版本被相应地修改。

此外，动量缓冲区的初始值被设置为第一步的梯度值。这与一些其他框架将其初始化为零形成对比。

add_param_group(param_group)[source]

向 Optimizer s 的 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 ，则将保存并覆盖优化器状态中当前存在的名称。如果它们不在加载的状态字典中，则优化器的 param_names 将保持不变。

register_load_state_dict_post_hook(hook, prepend=False)[source]

注册一个在调用 load_state_dict() 之后调用的 load_state_dict 后钩子。它应该具有以下签名：

hook(optimizer) -> None

第 0#个参数是正在使用的优化器实例。

在对 self 调用 load_state_dict 之后，将使用参数 self 调用钩子。已注册的钩子可以在 load_state_dict 加载 state_dict 之后执行后处理。

参数:

hook（可调用对象）- 用户定义的将被注册的钩子。
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，它将被用于加载到优化器中。

在调用 self 上的 load_state_dict 之前，将使用参数 self 和 state_dict 调用钩子。已注册的钩子可用于在执行 load_state_dict 调用之前执行预处理。

参数:

hook（可调用对象）- 用户定义的将被注册的钩子。
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 执行后处理。

参数:

hook（可调用对象）- 用户定义的将被注册的钩子。
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

The optimizer argument is the optimizer instance being used. The hook will be called with argument self before calling state_dict on self. The registered hook can be used to perform pre-processing before the state_dict call is made.

参数:

hook（可调用对象）- 用户定义的将被注册的钩子。
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

第 0#个参数是正在使用的优化器实例。

参数:: hook（可调用对象）- 用户定义的将被注册的钩子。
返回值:: 一个可以用来通过调用 handle.remove() 移除已添加钩子的句柄。
返回类型:: torch.utils.hooks.RemovableHandle

register_step_pre_hook(hook)[source]¶

注册优化器步骤预钩子，该钩子将在优化器步骤之前被调用。

它应该具有以下签名：

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

第 0#参数是正在使用的优化器实例。如果 args 和 kwargs 被预钩子修改，则返回包含新_args 和新_kwargs 的新值元组。

参数:: hook（可调用对象）- 用户定义的将被注册的钩子。
返回值:: 一个可以用来通过调用 handle.remove() 移除已添加钩子的句柄。
返回类型:: torch.utils.hooks.RemovableHandle

state_dict()[source]¶

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

它包含两个条目：

state ：一个字典，包含当前的优化状态。其内容
优化器类之间有所不同，但有一些共同特征。例如，状态是按参数保存的，而参数本身不保存。 state 是一个字典，将参数 ID 映射到与每个参数对应的状态的字典。

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

注意：参数 ID 看起来像索引，但它们只是将状态与 param_group 关联的 ID。在从 state_dict 加载时，优化器将 param_group params （整数 ID）和优化器 param_groups （实际的 nn.Parameter s）进行 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)[source][source]¶

执行单个优化步骤。

参数:: closure (Callable, 可选) – 一个闭包，用于重新评估模型并返回损失。

zero_grad(set_to_none=True)[source]

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

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

新加坡元 ¶

文档

教程

资源