注意
跳转至页面底部下载完整示例代码。
单样本梯度#
创建日期：2023年3月15日 | 最后更新：2025年7月30日 | 最后验证：2024年11月5日
这是什么？#
单样本梯度计算是指计算数据批次（batch）中每一个样本的梯度。这一量值在差分隐私、元学习和优化研究中非常有用。
注意
本教程需要 PyTorch 2.0.0 或更高版本。
import torch
import torch.nn as nn
import torch.nn.functional as F
torch.manual_seed(0)
# Here's a simple CNN and loss function:
class SimpleCNN(nn.Module):
def __init__(self):
super(SimpleCNN, self).__init__()
self.conv1 = nn.Conv2d(1, 32, 3, 1)
self.conv2 = nn.Conv2d(32, 64, 3, 1)
self.fc1 = nn.Linear(9216, 128)
self.fc2 = nn.Linear(128, 10)
def forward(self, x):
x = self.conv1(x)
x = F.relu(x)
x = self.conv2(x)
x = F.relu(x)
x = F.max_pool2d(x, 2)
x = torch.flatten(x, 1)
x = self.fc1(x)
x = F.relu(x)
x = self.fc2(x)
output = F.log_softmax(x, dim=1)
return output
def loss_fn(predictions, targets):
return F.nll_loss(predictions, targets)
让我们生成一批虚拟数据，并假定我们正在处理 MNIST 数据集。虚拟图像大小为 28x28，我们使用大小为 64 的小批量（minibatch）。
device = 'cuda'
num_models = 10
batch_size = 64
data = torch.randn(batch_size, 1, 28, 28, device=device)
targets = torch.randint(10, (64,), device=device)
在常规模型训练中，人们会将小批量数据通过模型进行前向传播，然后调用 .backward() 来计算梯度。这将生成整个小批量的“平均”梯度。
model = SimpleCNN().to(device=device)
predictions = model(data) # move the entire mini-batch through the model
loss = loss_fn(predictions, targets)
loss.backward() # back propagate the 'average' gradient of this mini-batch
与上述方法相比，单样本梯度计算等同于
对数据中的每个样本执行前向和后向传播，以获取单独的（单样本）梯度。
def compute_grad(sample, target):
sample = sample.unsqueeze(0) # prepend batch dimension for processing
target = target.unsqueeze(0)
prediction = model(sample)
loss = loss_fn(prediction, target)
return torch.autograd.grad(loss, list(model.parameters()))
def compute_sample_grads(data, targets):
""" manually process each sample with per sample gradient """
sample_grads = [compute_grad(data[i], targets[i]) for i in range(batch_size)]
sample_grads = zip(*sample_grads)
sample_grads = [torch.stack(shards) for shards in sample_grads]
return sample_grads
per_sample_grads = compute_sample_grads(data, targets)
sample_grads[0] 是 model.conv1.weight 的单样本梯度。model.conv1.weight.shape 为 [32, 1, 3, 3]；请注意，批次中的每个样本都有一个梯度，总共 64 个。
print(per_sample_grads[0].shape)
torch.Size([64, 32, 1, 3, 3])
使用函数变换的高效方法计算单样本梯度#
我们可以通过函数变换高效地计算单样本梯度。
torch.func 函数变换 API 可对函数进行变换。我们的策略是定义一个计算损失的函数，然后应用变换来构建一个计算单样本梯度的函数。
我们将使用 torch.func.functional_call 函数将 nn.Module 视为一个函数。
首先，让我们将 model 的状态提取到两个字典（参数和缓冲区）中。我们将把它们分离（detach），因为我们不会使用常规的 PyTorch 自动求导（例如 Tensor.backward(), torch.autograd.grad）。
from torch.func import functional_call, vmap, grad
params = {k: v.detach() for k, v in model.named_parameters()}
buffers = {k: v.detach() for k, v in model.named_buffers()}
接下来，定义一个函数，根据单个输入而非批量输入来计算模型损失。该函数必须接收参数、输入和目标，这一点很重要，因为我们将对其进行变换。
注意 - 因为模型最初是为处理批次而编写的，我们将使用 torch.unsqueeze 来增加一个批次维度。
def compute_loss(params, buffers, sample, target):
batch = sample.unsqueeze(0)
targets = target.unsqueeze(0)
predictions = functional_call(model, (params, buffers), (batch,))
loss = loss_fn(predictions, targets)
return loss
现在，使用 grad 变换来创建一个新函数，该函数计算相对于 compute_loss 第一个参数（即 params）的梯度。
ft_compute_grad = grad(compute_loss)
ft_compute_grad 函数计算单个（样本，目标）对的梯度。我们可以使用 vmap 来让它计算整个样本和目标批次的梯度。请注意，in_dims=(None, None, 0, 0)，因为我们希望对数据和目标的第 0 维映射 ft_compute_grad，并对每个样本使用相同的 params 和缓冲区。
ft_compute_sample_grad = vmap(ft_compute_grad, in_dims=(None, None, 0, 0))
最后，使用我们的变换函数来计算单样本梯度。
我们可以通过检查验证使用 grad 和 vmap 得到的结果与手动处理每个样本的结果是否一致。
for per_sample_grad, ft_per_sample_grad in zip(per_sample_grads, ft_per_sample_grads.values()):
assert torch.allclose(per_sample_grad, ft_per_sample_grad, atol=1.2e-1, rtol=1e-5)
简要说明：vmap 可以变换的函数类型存在一定限制。最适合变换的函数是纯函数：即输出仅由输入决定，且没有副作用（如修改变量）的函数。vmap 无法处理任意 Python 数据结构的变动，但能够处理许多原地（in-place）PyTorch 操作。
性能比较#
好奇 vmap 的性能如何吗？
目前，在较新的 GPU（如 A100 (Ampere)）上可以获得最佳结果，在该示例中我们观察到了高达 25 倍的加速。以下是我们构建机器上的一些结果。
def get_perf(first, first_descriptor, second, second_descriptor):
"""takes torch.benchmark objects and compares delta of second vs first."""
second_res = second.times[0]
first_res = first.times[0]
gain = (first_res-second_res)/first_res
if gain < 0: gain *=-1
final_gain = gain*100
print(f"Performance delta: {final_gain:.4f} percent improvement with {first_descriptor} ")
from torch.utils.benchmark import Timer
without_vmap = Timer(stmt="compute_sample_grads(data, targets)", globals=globals())
with_vmap = Timer(stmt="ft_compute_sample_grad(params, buffers, data, targets)",globals=globals())
no_vmap_timing = without_vmap.timeit(100)
with_vmap_timing = with_vmap.timeit(100)
print(f'Per-sample-grads without vmap {no_vmap_timing}')
print(f'Per-sample-grads with vmap {with_vmap_timing}')
get_perf(with_vmap_timing, "vmap", no_vmap_timing, "no vmap")
Per-sample-grads without vmap <torch.utils.benchmark.utils.common.Measurement object at 0x7efeb9f93fd0>
compute_sample_grads(data, targets)
60.04 ms
1 measurement, 100 runs , 1 thread
Per-sample-grads with vmap <torch.utils.benchmark.utils.common.Measurement object at 0x7efeba0f82b0>
ft_compute_sample_grad(params, buffers, data, targets)
3.41 ms
1 measurement, 100 runs , 1 thread
Performance delta: 1662.2039 percent improvement with vmap
在 PyTorch 中计算单样本梯度还有其他优化方案（例如 pytorch/opacus），它们也比朴素方法表现更好。但组合 vmap 和 grad 能带来不错的加速确实很棒。
通常，使用 vmap 进行向量化应该比在 for 循环中运行函数更快，并且与手动批处理具有竞争力。不过也有一些例外，例如如果我们尚未针对特定操作实现 vmap 规则，或者底层内核未针对旧硬件（GPU）进行优化。如果您遇到此类情况，请通过在 GitHub 上提交 issue 来告知我们。
脚本总运行时间：（0 分 8.490 秒）