CUDA 自动混合精度示例

通常，“自动混合精度训练”表示使用 torch.autocast 和 torch.cuda.amp.GradScaler 一起进行训练。

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

torch.cuda.amp.GradScaler 的实例有助于方便地执行梯度缩放步骤。梯度缩放通过最大程度减少梯度下溢来改善具有 float16 梯度的网络的收敛性，如 此处 所述。

torch.autocast 和 torch.cuda.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() 之前无需重复取消缩放梯度。

警告

unscale_ 应每个优化器仅在每个 step 调用中调用一次，并且仅在已累积该优化器分配的参数的所有梯度后调用。在每次 step 之间为给定优化器调用 unscale_ 两次将触发 RuntimeError。

使用缩放梯度

梯度累积

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

因此，如果您想取消缩放梯度（例如，允许裁剪未缩放梯度），请在 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.cuda.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 方法，以确保它在辅助线程中启用。

自动转换和自定义自动微分函数

如果你的网络使用自定义自动微分函数（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.cuda.amp.custom_fwd()和torch.cuda.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(cast_inputs=torch.float32) 应用于 forward，将 custom_bwd（无参数）应用于 backward。如果 forward 在启用了自动转换的区域中运行，装饰器会将浮点 CUDA 张量输入转换为 float32，并在 forward 和 backward 期间在本地禁用自动转换

class MyFloat32Func(torch.autograd.Function):
    @staticmethod
    @custom_fwd(cast_inputs=torch.float32)
    def forward(ctx, input):
        ctx.save_for_backward(input)
        ...
        return fwd_output
    @staticmethod
    @custom_bwd
    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)