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. 明示的な形状管理

テンソルの形状を常に文書化し、検証します。

# 良い例: 形状が注釈されたforward
    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()  # 常に評価モードに設定—ドロップアウト無効、バッチノルムのランニング統計を使用
    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 = DataLoader(
    dataset,
    batch_size=32,
    shuffle=True,            # トレーニング用にシャッフル
    num_workers=4,           # 並列データ読み込み
    pin_memory=True,         # CPU→GPU転送を高速化
    persistent_workers=True, # エポック間でワーカーを維持
    drop_last=True,          # BatchNorm用に一貫したバッチサイズ
)

# 悪い例: デフォルトのまま（遅い）
dataloader = DataLoader(dataset, batch_size=32)  # num_workers=0, pin_memory=False

可変長データ用のカスタム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)  # ドロップアウトがまだ有効！BatchNormがバッチ統計を使用！

# 良い例: 常に評価モードを設定
model.eval()
with torch.no_grad():
    output = model(val_data)

# 悪い例: 自動微分を壊すインプレース操作
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()  # 毎イテレーションでモデルを移動！

# 良い例: ループの前に1度だけモデルを移動
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メモリを確認してください。