pytorch-patterns

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，使用运行中的BN统计量
    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

数据管道模式

自定义数据集

# 好：带类型提示的清晰数据集
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(
    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

# 好：在collate_fn中填充序列
def collate_fn(batch: list[tuple[torch.Tensor, int]]) -> tuple[torch.Tensor, torch.Tensor]:
    sequences, labels = zip(*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)

检查点模式

保存和加载检查点

# 好：包含所有训练状态的完整检查点
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)

大型模型的梯度检查点

# 好：用计算换内存
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惯用法

惯用法	描述
model.train() / model.eval()	在训练/评估前始终设置模式
torch.no_grad()	推理时禁用梯度
optimizer.zero_grad(set_to_none=True)	更高效的梯度清零
.to(device)	设备无关的张量/模型放置
torch.amp.autocast	混合精度，速度提升2倍
pin_memory=True	更快的CPU→GPU数据传输
torch.compile	JIT编译加速（2.0+）
weights_only=True	安全的模型加载
torch.manual_seed	可复现的实验
gradient_checkpointing	用计算换内存

应避免的反模式

# 坏：验证时忘记model.eval()
model.train()
with torch.no_grad():
    output = model(val_data)  # Dropout仍然激活！BatchNorm使用批次统计量！

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

# 坏：原地操作破坏自动求导
x = F.relu(x, inplace=True)  # 可能破坏梯度计算
x += residual                  # 原地加法破坏自动求导图

# 好：非原地操作
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}")  # .item()在backward之后没问题

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

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

记住：PyTorch代码应设备无关、可复现且内存敏感。如有疑问，使用torch.profiler进行分析，并使用torch.cuda.memory_summary()检查GPU内存。