自动混合精度示例

通常，“自动混合精度训练”是指同时使用 torch.autocast 和 torch.amp.GradScaler 进行训练。

torch.autocast 的实例为选定的区域启用自动转换。自动转换会自动选择 GPU 运算的精度，以提高性能并保持准确性。

torch.amp.GradScaler 的实例有助于方便地执行梯度缩放步骤。梯度缩放通过最小化梯度下溢来提高具有 float16 梯度（在 CUDA 和 XPU 上默认）的网络的收敛性，如此处所述。

torch.autocast 和 torch.amp.GradScaler 是模块化的。在以下示例中，每个示例的使用方式均与其各自的文档建议一致。

（此处的示例仅供说明。有关可运行的演练，请参阅自动混合精度案例。）

典型的混合精度训练

# Creates model and optimizer in default precision
model = Net().cuda()
optimizer = optim.SGD(model.parameters(), ...)

# Creates a GradScaler once at the beginning of training.
scaler = GradScaler()

for epoch in epochs:
    for input, target in data:
        optimizer.zero_grad()

        # Runs the forward pass with autocasting.
        with autocast(device_type='cuda', dtype=torch.float16):
            output = model(input)
            loss = loss_fn(output, target)

        # Scales loss.  Calls backward() on scaled loss to create scaled gradients.
        # Backward passes under autocast are not recommended.
        # Backward ops run in the same dtype autocast chose for corresponding forward ops.
        scaler.scale(loss).backward()

        # scaler.step() first unscales the gradients of the optimizer's assigned params.
        # If these gradients do not contain infs or NaNs, optimizer.step() is then called,
        # otherwise, optimizer.step() is skipped.
        scaler.step(optimizer)

        # Updates the scale for next iteration.
        scaler.update()

使用未缩放的梯度

scaler.scale(loss).backward() 生成的所有梯度都已缩放。如果您希望在 backward() 和 scaler.step(optimizer) 之间修改或检查参数的 .grad 属性，则应先取消缩放。例如，梯度裁剪会操纵一组梯度，使其全局范数（请参阅 torch.nn.utils.clip_grad_norm_()）或最大幅度（请参阅 torch.nn.utils.clip_grad_value_()）$<=$ 某个用户指定的阈值。如果您尝试在*不*取消缩放的情况下进行裁剪，则梯度的范数/最大幅度也会被缩放，因此您请求的阈值（该阈值原本是指*未缩放*梯度的阈值）将无效。

scaler.unscale_(optimizer) 取消缩放 optimizer 分配的参数所持有的梯度。如果您的模型包含分配给另一个优化器（例如 optimizer2）的其他参数，则可以单独调用 scaler.unscale_(optimizer2) 来取消缩放这些参数的梯度。

梯度裁剪

在裁剪之前调用 scaler.unscale_(optimizer) 使您能够像往常一样裁剪未缩放的梯度

scaler = GradScaler()

for epoch in epochs:
    for input, target in data:
        optimizer.zero_grad()
        with autocast(device_type='cuda', dtype=torch.float16):
            output = model(input)
            loss = loss_fn(output, target)
        scaler.scale(loss).backward()

        # Unscales the gradients of optimizer's assigned params in-place
        scaler.unscale_(optimizer)

        # Since the gradients of optimizer's assigned params are unscaled, clips as usual:
        torch.nn.utils.clip_grad_norm_(model.parameters(), max_norm)

        # optimizer's gradients are already unscaled, so scaler.step does not unscale them,
        # although it still skips optimizer.step() if the gradients contain infs or NaNs.
        scaler.step(optimizer)

        # Updates the scale for next iteration.
        scaler.update()

scaler 记录在此迭代中已为此优化器调用了 scaler.unscale_(optimizer)，因此 scaler.step(optimizer) 知道在（内部）调用 optimizer.step() 之前不会重复取消缩放梯度。

警告

每个 step 调用，每个优化器只能调用一次 unscale_，并且只能在累积了该优化器分配的所有参数的梯度之后调用。如果在每个 step 之间对给定优化器调用两次 unscale_，则会触发 RuntimeError。

使用缩放的梯度

梯度累积

梯度累积在大小为 batch_per_iter * iters_to_accumulate（如果分布式，则为 * num_procs）的有效批次上累积梯度。应该针对有效批次校准规模，这意味着应该以有效批次粒度执行 inf/NaN 检查、如果发现 inf/NaN 梯度则跳过步骤，以及进行规模更新。此外，在累积给定有效批次的梯度时，梯度应保持缩放，并且缩放因子应保持不变。如果在累积完成之前对梯度进行取消缩放（或缩放因子发生变化），则下一次反向传播将把缩放后的梯度添加到未缩放的梯度（或按不同因子缩放的梯度）中，之后将无法恢复累积的未缩放梯度，step 必须应用。

因此，如果您要对梯度进行 unscale_ 操作（例如，允许裁剪未缩放的梯度），请在累积即将执行 step 的所有（缩放的）梯度之后，在调用 step 之前调用 unscale_。此外，仅在您为完整的有效批次调用 step 的迭代结束时才调用 update

scaler = GradScaler()

for epoch in epochs:
    for i, (input, target) in enumerate(data):
        with autocast(device_type='cuda', dtype=torch.float16):
            output = model(input)
            loss = loss_fn(output, target)
            loss = loss / iters_to_accumulate

        # Accumulates scaled gradients.
        scaler.scale(loss).backward()

        if (i + 1) % iters_to_accumulate == 0:
            # may unscale_ here if desired (e.g., to allow clipping unscaled gradients)

            scaler.step(optimizer)
            scaler.update()
            optimizer.zero_grad()

梯度惩罚

梯度惩罚实现通常使用 torch.autograd.grad() 创建梯度，将它们组合起来创建惩罚值，并将惩罚值添加到损失中。

以下是不使用梯度缩放或自动混合精度的 L2 惩罚的普通示例

for epoch in epochs:
    for input, target in data:
        optimizer.zero_grad()
        output = model(input)
        loss = loss_fn(output, target)

        # Creates gradients
        grad_params = torch.autograd.grad(outputs=loss,
                                          inputs=model.parameters(),
                                          create_graph=True)

        # Computes the penalty term and adds it to the loss
        grad_norm = 0
        for grad in grad_params:
            grad_norm += grad.pow(2).sum()
        grad_norm = grad_norm.sqrt()
        loss = loss + grad_norm

        loss.backward()

        # clip gradients here, if desired

        optimizer.step()

要实现使用梯度缩放的梯度惩罚，传递给 torch.autograd.grad() 的 outputs 张量应该进行缩放。因此，生成的梯度将被缩放，并且在组合以创建惩罚值之前应该取消缩放。

此外，惩罚项计算是前向传递的一部分，因此应该在 autocast 上下文中。

以下是相同的 L2 惩罚的示例

scaler = GradScaler()

for epoch in epochs:
    for input, target in data:
        optimizer.zero_grad()
        with autocast(device_type='cuda', dtype=torch.float16):
            output = model(input)
            loss = loss_fn(output, target)

        # Scales the loss for autograd.grad's backward pass, producing scaled_grad_params
        scaled_grad_params = torch.autograd.grad(outputs=scaler.scale(loss),
                                                 inputs=model.parameters(),
                                                 create_graph=True)

        # Creates unscaled grad_params before computing the penalty. scaled_grad_params are
        # not owned by any optimizer, so ordinary division is used instead of scaler.unscale_:
        inv_scale = 1./scaler.get_scale()
        grad_params = [p * inv_scale for p in scaled_grad_params]

        # Computes the penalty term and adds it to the loss
        with autocast(device_type='cuda', dtype=torch.float16):
            grad_norm = 0
            for grad in grad_params:
                grad_norm += grad.pow(2).sum()
            grad_norm = grad_norm.sqrt()
            loss = loss + grad_norm

        # Applies scaling to the backward call as usual.
        # Accumulates leaf gradients that are correctly scaled.
        scaler.scale(loss).backward()

        # may unscale_ here if desired (e.g., to allow clipping unscaled gradients)

        # step() and update() proceed as usual.
        scaler.step(optimizer)
        scaler.update()

使用多个模型、损失和优化器

如果您的网络有多个损失，则必须分别在每个损失上调用 scaler.scale。如果您的网络有多个优化器，则可以分别在任何一个优化器上调用 scaler.unscale_，并且必须分别在每个优化器上调用 scaler.step。

但是，scaler.update 应该只调用一次，在所有在本轮迭代中使用的优化器都已执行步骤之后

scaler = torch.amp.GradScaler()

for epoch in epochs:
    for input, target in data:
        optimizer0.zero_grad()
        optimizer1.zero_grad()
        with autocast(device_type='cuda', dtype=torch.float16):
            output0 = model0(input)
            output1 = model1(input)
            loss0 = loss_fn(2 * output0 + 3 * output1, target)
            loss1 = loss_fn(3 * output0 - 5 * output1, target)

        # (retain_graph here is unrelated to amp, it's present because in this
        # example, both backward() calls share some sections of graph.)
        scaler.scale(loss0).backward(retain_graph=True)
        scaler.scale(loss1).backward()

        # You can choose which optimizers receive explicit unscaling, if you
        # want to inspect or modify the gradients of the params they own.
        scaler.unscale_(optimizer0)

        scaler.step(optimizer0)
        scaler.step(optimizer1)

        scaler.update()

每个优化器都会检查其梯度中是否存在 inf/NaN，并独立决定是否跳过该步骤。这可能会导致一个优化器跳过该步骤，而另一个优化器没有跳过。由于步骤跳过很少发生（每几百次迭代发生一次），因此这不应妨碍收敛。如果在将梯度缩放添加到多优化器模型后观察到收敛性较差，请报告错误。

使用多个 GPU

此处描述的问题仅影响 autocast。 GradScaler 的用法不变。

单进程中的 DataParallel

即使 torch.nn.DataParallel 生成线程以在每个设备上运行前向传递，自动混合精度状态也会在每个线程中传播，以下代码将正常工作

model = MyModel()
dp_model = nn.DataParallel(model)

# Sets autocast in the main thread
with autocast(device_type='cuda', dtype=torch.float16):
    # dp_model's internal threads will autocast.
    output = dp_model(input)
    # loss_fn also autocast
    loss = loss_fn(output)

DistributedDataParallel，每个进程一个 GPU

torch.nn.parallel.DistributedDataParallel 的文档建议每个进程使用一个 GPU 以获得最佳性能。在这种情况下，DistributedDataParallel 不会在内部生成线程，因此 autocast 和 GradScaler 的用法不受影响。

DistributedDataParallel，每个进程多个 GPU

在这里，torch.nn.parallel.DistributedDataParallel 可能会像 torch.nn.DataParallel 一样生成一个侧线程以在每个设备上运行前向传递。解决方法相同：将自动混合精度作为模型的 forward 方法的一部分应用，以确保它在侧线程中启用。

自动混合精度和自定义 Autograd 函数

如果您的网络使用 自定义 Autograd 函数（torch.autograd.Function 的子类），则如果任何函数

• 接受多个浮点张量输入，

• 包装任何可自动混合精度的操作（请参阅自动混合精度操作参考），或

• 需要特定的 dtype（例如，如果它包装了仅针对 dtype 编译的CUDA 扩展），

则需要进行更改以实现自动混合精度兼容性。在所有情况下，如果您要导入该函数并且无法更改其定义，则安全的回退方法是在发生错误的任何使用点禁用自动混合精度并强制以 float32（或 dtype）执行。

with autocast(device_type='cuda', dtype=torch.float16):
    ...
    with autocast(device_type='cuda', dtype=torch.float16, enabled=False):
        output = imported_function(input1.float(), input2.float())

如果您是该函数的作者（或者可以更改其定义），则更好的解决方案是使用 torch.amp.custom_fwd() 和 torch.amp.custom_bwd() 装饰器，如下面的相关案例所示。

具有多个输入或可自动混合精度操作的函数

将 custom_fwd 和 custom_bwd（不带参数）分别应用于 forward 和 backward。这些操作确保 forward 在当前自动混合精度状态下执行，并且 backward 在与 forward 相同的自动混合精度状态下执行（这可以防止类型不匹配错误）。

class MyMM(torch.autograd.Function):
    @staticmethod
    @custom_fwd
    def forward(ctx, a, b):
        ctx.save_for_backward(a, b)
        return a.mm(b)
    @staticmethod
    @custom_bwd
    def backward(ctx, grad):
        a, b = ctx.saved_tensors
        return grad.mm(b.t()), a.t().mm(grad)

现在，可以在任何地方调用 MyMM，而无需禁用自动混合精度或手动转换输入

mymm = MyMM.apply

with autocast(device_type='cuda', dtype=torch.float16):
    output = mymm(input1, input2)

需要特定 dtype 的函数

考虑一个需要 torch.float32 输入的自定义函数。将 custom_fwd(device_type='cuda', cast_inputs=torch.float32) 应用于 forward，并将 custom_bwd(device_type='cuda') 应用于 backward。如果 forward 在启用了自动混合精度的区域中运行，则装饰器会将浮点张量输入转换为参数 device_type 指定的设备上的 float32（在本例中为 CUDA），并在 forward 和 backward 期间本地禁用自动混合精度。

class MyFloat32Func(torch.autograd.Function):
    @staticmethod
    @custom_fwd(device_type='cuda', cast_inputs=torch.float32)
    def forward(ctx, input):
        ctx.save_for_backward(input)
        ...
        return fwd_output
    @staticmethod
    @custom_bwd(device_type='cuda')
    def backward(ctx, grad):
        ...

现在，可以在任何地方调用 MyFloat32Func，而无需手动禁用自动混合精度或转换输入

func = MyFloat32Func.apply

with autocast(device_type='cuda', dtype=torch.float16):
    # func will run in float32, regardless of the surrounding autocast state
    output = func(input)