PyTorch 开发模式

构建健壮、高效且可复现的深度学习应用所采用的惯用 PyTorch 模式与最佳实践。

何时启用

• 编写新的 PyTorch 模型或训练脚本
• 评审深度学习代码
• 调试训练循环或数据流水线
• 优化 GPU 内存使用或训练速度
• 配置可复现实验

核心原则

1. 与设备无关的代码

始终编写可在 CPU 和 GPU 上运行的代码，避免硬编码设备类型。

# 好：与设备无关
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
model = MyModel().to(device)
data = data.to(device)

# 差：设备硬编码
model = MyModel().cuda()  # 无 GPU 时崩溃
data = data.cuda()

2. 可复现性优先

设置所有随机种子以确保结果可复现。

# 好：完整的可复现性配置
def set_seed(seed: int = 42) -> None:
    torch.manual_seed(seed)
    torch.cuda.manual_seed_all(seed)
    np.random.seed(seed)
    random.seed(seed)
    torch.backends.cudnn.deterministic = True
    torch.backends.cudnn.benchmark = False

# 差：未控制随机种子
model = MyModel()  # 每次运行权重均不同

3. 显式张量形状管理

始终记录并验证张量形状。

# 好：带形状注解的前向传播
def forward(self, x: torch.Tensor) -> torch.Tensor:
    # x: (batch_size, channels, height, width)
    x = self.conv1(x)    # -> (batch_size, 32, H, W)
    x = self.pool(x)     # -> (batch_size, 32, H//2, W//2)
    x = x.view(x.size(0), -1)  # -> (batch_size, 32*H//2*W//2)
    return self.fc(x)    # -> (batch_size, num_classes)

# 差：无形状追踪
def forward(self, x):
    x = self.conv1(x)
    x = self.pool(x)
    x = x.view(x.size(0), -1)  # 此处尺寸是多少？
    return self.fc(x)           # 这能正常工作吗？

模型架构模式

清晰的 nn.Module 结构

# 好：组织良好的模块
class ImageClassifier(nn.Module):
    def __init__(self, num_classes: int, dropout: float = 0.5) -> None:
        super().__init__()
        self.features = nn.Sequential(
            nn.Conv2d(3, 64, kernel_size=3, padding=1),
            nn.BatchNorm2d(64),
            nn.ReLU(inplace=True),
            nn.MaxPool2d(2),
        )
        self.classifier = nn.Sequential(
            nn.Dropout(dropout),
            nn.Linear(64 * 16 * 16, num_classes),
        )

    def forward(self, x: torch.Tensor) -> torch.Tensor:
        x = self.features(x)
        x = x.view(x.size(0), -1)
        return self.classifier(x)

# 差：所有逻辑塞入 forward
class ImageClassifier(nn.Module):
    def __init__(self):
        super().__init__()

    def forward(self, x):
        x = F.conv2d(x, weight=self.make_weight())  # 每次调用都新建权重！
        return x

恰当的权重初始化

# 好：显式初始化
def _init_weights(self, module: nn.Module) -> None:
    if isinstance(module, nn.Linear):
        nn.init.kaiming_normal_(module.weight, mode="fan_out", nonlinearity="relu")
        if module.bias is not None:
            nn.init.zeros_(module.bias)
    elif isinstance(module, nn.Conv2d):
        nn.init.kaiming_normal_(module.weight, mode="fan_out", nonlinearity="relu")
    elif isinstance(module, nn.BatchNorm2d):
        nn.init.ones_(module.weight)
        nn.init.zeros_(module.bias)

model = MyModel()
model.apply(model._init_weights)

训练循环模式

标准训练循环

# 好：包含最佳实践的完整训练循环
def train_one_epoch(
    model: nn.Module,
    dataloader: DataLoader,
    optimizer: torch.optim.Optimizer,
    criterion: nn.Module,
    device: torch.device,
    scaler: torch.amp.GradScaler | None = None,
) -> float:
    model.train()  # 始终设置为训练模式
    total_loss = 0.0

    for batch_idx, (data, target) in enumerate(dataloader):
        data, target = data.to(device), target.to(device)

        optimizer.zero_grad(set_to_none=True)  # 比 zero_grad() 更高效

        # 混合精度训练
        with torch.amp.autocast("cuda", enabled=scaler is not None):
            output = model(data)
            loss = criterion(output, target)

        if scaler is not None:
            scaler.scale(loss).backward()
            scaler.unscale_(optimizer)
            torch.nn.utils.clip_grad_norm_(model.parameters(), max_norm=1.0)
            scaler.step(optimizer)
            scaler.update()
        else:
            loss.backward()
            torch.nn.utils.clip_grad_norm_(model.parameters(), max_norm=1.0)
            optimizer.step()

        total_loss += loss.item()

    return total_loss / len(dataloader)

验证循环

# 好：规范的评估实现
@torch.no_grad()  # 比包裹在 torch.no_grad() 块中更高效
def evaluate(
    model: nn.Module,
    dataloader: DataLoader,
    criterion: nn.Module,
    device: torch.device,
) -> tuple[float, float]:
    model.eval()  # 始终设置为评估模式 —— 关闭 Dropout，使用 BatchNorm 的运行统计量
    total_loss = 0.0
    correct = 0
    total = 0

    for data, target in dataloader:
        data, target = data.to(device), target.to(device)
        output = model(data)
        total_loss += criterion(output, target).item()
        correct += (output.argmax(1) == target).sum().item()
        total += target.size(0)

    return total_loss / len(dataloader), correct / total

数据流水线模式

自定义 Dataset

# 好：带类型提示的简洁 Dataset 实现
class ImageDataset(Dataset):
    def __init__(
        self,
        image_dir: str,
        labels: dict[str, int],
        transform: transforms.Compose | None = None,
    ) -> None:
        self.image_paths = list(Path(image_dir).glob("*.jpg"))
        self.labels = labels
        self.transform = transform

    def __len__(self) -> int:
        return len(self.image_paths)

    def __getitem__(self, idx: int) -> tuple[torch.Tensor, int]:
        img = Image.open(self.image_paths[idx]).convert("RGB")
        label = self.labels[self.image_paths[idx].stem]

        if self.transform:
            img = self.transform(img)

        return img, label

高效的 DataLoader 配置

# 好：优化后的 DataLoader
dataloader = DataLoader(
    dataset,
    batch_size=32,
    shuffle=True,            # 训练时打乱顺序
    num_workers=4,           # 并行数据加载
    pin_memory=True,         # 加速 CPU→GPU 数据传输
    persistent_workers=True, # 在各 epoch 间保持 worker 进程存活
    drop_last=True,          # 对 BatchNorm 保证批次尺寸一致
)

# 差：低效的默认配置
dataloader = DataLoader(dataset, batch_size=32)  # num_workers=0，无 pin_memory

适用于变长数据的自定义 collate_fn

# 好：在 collate_fn 中填充序列
def collate_fn(batch: list[tuple[torch.Tensor, int]]) -> tuple[torch.Tensor, torch.Tensor]:
    sequences, labels = zip(*batch)
    # 填充至当前 batch 中最大长度
    padded = nn.utils.rnn.pad_sequence(sequences, batch_first=True, padding_value=0)
    return padded, torch.tensor(labels)

dataloader = DataLoader(dataset, batch_size=32, collate_fn=collate_fn)

检查点（Checkpointing）模式

保存与加载检查点

# 好：包含全部训练状态的完整检查点
def save_checkpoint(
    model: nn.Module,
    optimizer: torch.optim.Optimizer,
    epoch: int,
    loss: float,
    path: str,
) -> None:
    torch.save({
        "epoch": epoch,
        "model_state_dict": model.state_dict(),
        "optimizer_state_dict": optimizer.state_dict(),
        "loss": loss,
    }, path)

def load_checkpoint(
    path: str,
    model: nn.Module,
    optimizer: torch.optim.Optimizer | None = None,
) -> dict:
    checkpoint = torch.load(path, map_location="cpu", weights_only=True)
    model.load_state_dict(checkpoint["model_state_dict"])
    if optimizer:
        optimizer.load_state_dict(checkpoint["optimizer_state_dict"])
    return checkpoint

# 差：仅保存模型权重（无法恢复训练）
torch.save(model.state_dict(), "model.pt")

性能优化

混合精度训练

# 好：搭配 GradScaler 使用 AMP
scaler = torch.amp.GradScaler("cuda")
for data, target in dataloader:
    with torch.amp.autocast("cuda"):
        output = model(data)
        loss = criterion(output, target)
    scaler.scale(loss).backward()
    scaler.step(optimizer)
    scaler.update()
    optimizer.zero_grad(set_to_none=True)

大型模型的梯度检查点（Gradient Checkpointing）

# 好：以计算换内存
from torch.utils.checkpoint import checkpoint

class LargeModel(nn.Module):
    def forward(self, x: torch.Tensor) -> torch.Tensor:
        # 反向传播时重新计算激活值以节省内存
        x = checkpoint(self.block1, x, use_reentrant=False)
        x = checkpoint(self.block2, x, use_reentrant=False)
        return self.head(x)

使用 torch.compile 加速执行

# 好：编译模型以提升执行速度（PyTorch 2.0+）
model = MyModel().to(device)
model = torch.compile(model, mode="reduce-overhead")

# 模式说明："default"（安全）、"reduce-overhead"（更快）、"max-autotune"（最快）

速查表：PyTorch 惯用法

应避免的反模式（Anti-Patterns）

# 差：验证阶段忘记调用 model.eval()
model.train()
with torch.no_grad():
    output = model(val_data)  # Dropout 仍处于激活状态！BatchNorm 使用当前 batch 统计量！

# 好：始终显式设置评估模式
model.eval()
with torch.no_grad():
    output = model(val_data)

# 差：原地操作破坏 autograd
x = F.relu(x, inplace=True)  # 可能中断梯度计算
x += residual                  # 原地加法破坏 autograd 计算图

# 好：非原地操作
x = F.relu(x)
x = x + residual

# 差：在训练循环内重复将模型移至 GPU
for data, target in dataloader:
    model = model.cuda()  # 每轮迭代都移动模型！

# 好：循环外一次性迁移模型
model = model.to(device)
for data, target in dataloader:
    data, target = data.to(device), target.to(device)

# 差：在 backward() 前调用 .item()
loss = criterion(output, target).item()  # 从计算图中分离！
loss.backward()  # 错误：无法对 .item() 后的标量反向传播

# 好：仅在日志中调用 .item()
loss = criterion(output, target)
loss.backward()
print(f"Loss: {loss.item():.4f}")  # backward 后调用 .item() 是安全的

# 差：未正确使用 torch.save
torch.save(model, "model.pt")  # 保存整个模型对象（脆弱、不可移植）

# 好：保存 state_dict
torch.save(model.state_dict(), "model.pt")

请牢记：PyTorch 代码应具备设备无关性、可复现性，并对内存使用保持敏感。如有疑问，请使用 torch.profiler 进行性能分析，并通过 torch.cuda.memory_summary() 查看 GPU 内存使用情况。