torch_npu.optim.NpuFusedSGD

产品支持情况

产品	是否支持
Atlas A3 训练系列产品	√
Atlas A2 训练系列产品	√
Atlas 训练系列产品	√

功能说明

通过张量融合实现的高性能SGD优化器，核心功能和torch.optim.SGD兼容。

SGD的功能和原理可参考SGD。

函数原型

class torch_npu.optim.NpuFusedSGD(params, lr, momentum=0, dampening=0, weight_decay=0, nesterov=False)

参数说明

• params (iterable)：必选参数，模型参数或模型参数组。
• lr (float)：必选参数，学习率。lr不配置或值小于0时，系统会抛出“ValueError”异常信息。
• momentum (float)：可选参数，动量系数，默认值为0。momentum小于0时，系统会抛出“ValueError”异常信息。
• dampening (float)：可选参数，动量的抑制系数，默认值为0。
• weight_decay (float)：可选参数，权重衰减，默认值为0。weight_decay小于0时，系统会抛出“ValueError”异常信息。
• nesterov (bool)：可选参数，是否使用Nesterov动量，默认值为False。nesterov为True，同时momentum小于0或者dampening不等于0，系统会抛出“TypeError”异常信息。

返回值说明

类型为NpuFusedSGD的对象。

约束说明

NpuFusedSGD的实现机制要求params中的每一个模型参数对象在使用过程中不能被重新申请，否则将导致无法预料的结果。引起模型参数对象被重新申请的操作包括但不限于：

• 将模型或其子Module进行.cpu()操作
• 将模型参数对象指向新的对象
• 将模型参数对象置为None

对模型参数对象进行inplace计算，或者读取参数的值，NpuFusedSGD可正常工作。

调用示例

import torch
from torch_npu.npu.amp import GradScaler, autocast
from torch_npu.optim import NpuFusedSGD

def _create_simple_params_and_grads():
    params = [
        torch.arange(6).reshape(2, 3).float().npu(),
        torch.arange(12).reshape(4, 3).float().npu(),
        torch.arange(6).reshape(2, 3).half().npu(),
        torch.arange(12).reshape(4, 3).half().npu(),
        torch.arange(15).reshape(5, 3).float().npu(),
        torch.arange(18).reshape(6, 3).half().npu(),
        torch.arange(6).reshape(2, 3).float().npu()
    ]

    for i, p in enumerate(params):
        if i < len(params) - 1:
            p.requires_grad = True
            p.grad = p.clone().detach() / 100.

    return params

opt_kwargs = dict(lr=0.01, momentum=0.9, weight_decay=0.001)
params = _create_simple_params_and_grads()
fused_opt = NpuFusedSGD(params, **opt_kwargs)
with torch.no_grad():
    fused_opt.step()