【入門】PyTorchのモデル構築/学習/推論の基本的な流れをQuickstartでみる【初心者】

PyTorchで、Neural Networkの構築、学習、推論までの流れをPyTorch公式TutorialsのQuickstartに沿って進めていきます。

Quickstart – PyTorch Tutorials

データの準備
モデルの作成
モデルのトレーニング
モデルの保存
テストデータの推論
Quickstartを一通り終えたら

データの準備

今回のコードに必要なライブラリをインポートします。

import torch
from torch import nn
from torch.utils.data import DataLoader
from torchvision import datasets
from torchvision.transforms import ToTensor

ここでは、torchvision.datasetsを用いてFashionMNISTデータセットをダウンロードし、datasetとして読み込まれます。引数のtrainがTrueであれば学習データを読み込み、Falseであればテストデータを読み込みます。torchvision.datasetsには、CIFAR100、MNISTやImageNet 2012 Classification Datasetなど数多くの有名なデータセットが含まれています。

# Download training data from open datasets.
training_data = datasets.FashionMNIST(
    root="data",
    train=True,
    download=True,
    transform=ToTensor(),
)

# Download test data from open datasets.
test_data = datasets.FashionMNIST(
    root="data",
    train=False,
    download=True,
    transform=ToTensor(),
)

# Downloading <http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-images-idx3-ubyte.gz>
# Downloading <http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-images-idx3-ubyte.gz> to data/FashionMNIST/raw/train-images-idx3-ubyte.gz
#   0%|          | 0/26421880 [00:00<?, ?it/s]
# Extracting data/FashionMNIST/raw/train-images-idx3-ubyte.gz to data/FashionMNIST/raw
# 
# Downloading <http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-labels-idx1-ubyte.gz>
# Downloading <http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-labels-idx1-ubyte.gz> to data/FashionMNIST/raw/train-labels-idx1-ubyte.gz
# 29696/? [00:00<00:00, 1033686.47it/s]
# Extracting data/FashionMNIST/raw/train-labels-idx1-ubyte.gz to data/FashionMNIST/raw
# 
# Downloading <http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-images-idx3-ubyte.gz>
# Downloading <http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-images-idx3-ubyte.gz> to data/FashionMNIST/raw/t10k-images-idx3-ubyte.gz
# 4422656/? [00:00<00:00, 42197470.54it/s]
# Extracting data/FashionMNIST/raw/t10k-images-idx3-ubyte.gz to data/FashionMNIST/raw
# 
# Downloading <http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-labels-idx1-ubyte.gz>
# Downloading <http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-labels-idx1-ubyte.gz> to data/FashionMNIST/raw/t10k-labels-idx1-ubyte.gz
# 6144/? [00:00<00:00, 238463.57it/s]
# Extracting data/FashionMNIST/raw/t10k-labels-idx1-ubyte.gz to data/FashionMNIST/raw

DataLoaderの引数に、datasetとバッチサイズを指定します。これにより、バッチごとに64個のデータが読み込まれるイテラブルなdatasetになります。このため、for文でデータの形を確認すると、64個のデータが取り出せていることが分かります。fo文でDataLoaderから読み込まれるXは画像データ、yはラベルになります。

batch_size = 64

# Create data loaders.
train_dataloader = DataLoader(training_data, batch_size=batch_size)
test_dataloader = DataLoader(test_data, batch_size=batch_size)

for X, y in test_dataloader:
    print(f"Shape of X [N, C, H, W]: {X.shape}")
    print(f"Shape of y: {y.shape} {y.dtype}")
    break

# Shape of X [N, C, H, W]: torch.Size([64, 1, 28, 28])
# Shape of y: torch.Size([64]) torch.int64

より詳細な情報が知りたい場合は、DATASETS & DATALOADERSをみてください。

モデルの作成

モデルを作成していきます。ニューラルネットワークの学習はGPUを使用した方が通常早いため、現在GPUが使えるかtorch.cuda.is_available()で確認し、使用可能な場合はdeviceにcudaが入ります。GPUが使えない場合は、deviceにcpuを入れます。

関連記事 – PyTorchでGPUを使用するためのtorch.cuda.is_available

nn.Moduleを継承するクラスを作成し、ニューラルネットワークを定義します。initでレイヤーを定義し、forwardでデータが通過するネットワークを設定します。モデルに対して、to(device)をすることで、モデルをGPU/CPUに移動します。

# Get cpu or gpu device for training.
device = "cuda" if torch.cuda.is_available() else "cpu"
print(f"Using {device} device")

# Define model
class NeuralNetwork(nn.Module):
    def __init__(self):
        super(NeuralNetwork, self).__init__()
        self.flatten = nn.Flatten()
        self.linear_relu_stack = nn.Sequential(
            nn.Linear(28*28, 512),
            nn.ReLU(),
            nn.Linear(512, 512),
            nn.ReLU(),
            nn.Linear(512, 10)
        )

    def forward(self, x):
        x = self.flatten(x)
        logits = self.linear_relu_stack(x)
        return logits

model = NeuralNetwork().to(device)
print(model)

# Using cuda device
# NeuralNetwork(
#  (flatten): Flatten(start_dim=1, end_dim=-1)
#   (linear_relu_stack): Sequential(
#     (0): Linear(in_features=784, out_features=512, bias=True)
#     (1): ReLU()
#     (2): Linear(in_features=512, out_features=512, bias=True)
#     (3): ReLU()
#     (4): Linear(in_features=512, out_features=10, bias=True)
#   )
# )

モデルの作成についてより詳細な内容を知りたい場合は、BUILD THE NEURAL NETWORKを見ててください。

モデルのトレーニング

モデルをトレーニングするために、損失関数とオプティマイザーを指定します。ここでは、損失関数にクロスエントロピー、オプティマイザーにSGDを指定します。

loss_fn = nn.CrossEntropyLoss()
optimizer = torch.optim.SGD(model.parameters(), lr=1e-3)

1エポックで行われる学習コードをtrainをして定義します。dataloaderから、バッチごとに画像データとラベルデータがX, yに読み込まれ、to(device)でGPU/CPUに移動されます。

pred = model(X)で予測を行ない、loss_fnで予測誤差を算出します。 loss.backward()、optimizer.step()で誤差伝搬させてモデルのパラメーターを調整します。

def train(dataloader, model, loss_fn, optimizer):
    size = len(dataloader.dataset)
    model.train()
    for batch, (X, y) in enumerate(dataloader):
        X, y = X.to(device), y.to(device)

        # Compute prediction error
        pred = model(X)
        loss = loss_fn(pred, y)

        # Backpropagation
        optimizer.zero_grad()
        loss.backward()
        optimizer.step()

        if batch % 100 == 0:
            loss, current = loss.item(), batch * len(X)
            print(f"loss: {loss:>7f}  [{current:>5d}/{size:>5d}]")

テスト/検証データに対する評価関数を定義します。学習データのコードと違う箇所は、model.eval()、with torch.no_grad():の追加と誤差伝搬のコードが無いことです。今回のネットワークでは、影響がありませんが、model.eval()をすることで、dropoutの削除やバッチノーマライゼーションの値が推論用に変わります。テスト/検証データでは、モデルを学習させる必要がないため、with torch.no_grad():でテンソルの勾配の計算を不可にし、誤差伝搬のコードが無いがないです。loss.backward()を行わないだけでも結果は同様ですが、with torch.no_grad():をすることで、勾配の計算のメモリが削減されるためより効率的です。

def test(dataloader, model, loss_fn):
    size = len(dataloader.dataset)
    num_batches = len(dataloader)
    model.eval()
    test_loss, correct = 0, 0
    with torch.no_grad():
        for X, y in dataloader:
            X, y = X.to(device), y.to(device)
            pred = model(X)
            test_loss += loss_fn(pred, y).item()
            correct += (pred.argmax(1) == y).type(torch.float).sum().item()
    test_loss /= num_batches
    correct /= size
    print(f"Test Error: \\n Accuracy: {(100*correct):>0.1f}%, Avg loss: {test_loss:>8f} \\n")

学習は複数回反復（エポック）されるため、そのためのfor文を作成します。

epochs = 5
for t in range(epochs):
    print(f"Epoch {t+1}\\n-------------------------------")
    train(train_dataloader, model, loss_fn, optimizer)
    test(test_dataloader, model, loss_fn)
print("Done!")

# Epoch 5のみ表示している
# Epoch 5
# -------------------------------
# loss: 0.838466  [    0/60000]
# loss: 0.906265  [ 6400/60000]
# loss: 0.675421  [12800/60000]
# loss: 0.872784  [19200/60000]
# loss: 0.773359  [25600/60000]
# loss: 0.775093  [32000/60000]
# loss: 0.856052  [38400/60000]
# loss: 0.802289  [44800/60000]
# loss: 0.836298  [51200/60000]
# loss: 0.798353  [57600/60000]
# Test Error: 
#  Accuracy: 70.7%, Avg loss: 0.789178

モデルのトレーニングについてより詳細な内容を知りたい場合は、OPTIMIZING MODEL PARAMETERSを見てください。

モデルの保存

学習したモデルを保存します。

torch.save(model.state_dict(), "model.pth")
print("Saved PyTorch Model State to model.pth")

# Saved PyTorch Model State to model.pth

テストデータの推論

先ほど、保存したモデルを読み込みます。”model.pth”にはモデル構造自体は保存されていないため、モデルを読み込む前に、ネットワークを再度作成する必要があります。読み込みが成功すると、<All keys matched successfully>が表示されます。

model = NeuralNetwork()
model.load_state_dict(torch.load("model.pth"))

# <All keys matched successfully>

このモデルを利用して、テストデータの推論を行なってみます。

classes = [
    "T-shirt/top",
    "Trouser",
    "Pullover",
    "Dress",
    "Coat",
    "Sandal",
    "Shirt",
    "Sneaker",
    "Bag",
    "Ankle boot",
]

model.eval()
x, y = test_data[0][0], test_data[0][1]
with torch.no_grad():
    pred = model(x)
    predicted, actual = classes[pred[0].argmax(0)], classes[y]
    print(f'Predicted: "{predicted}", Actual: "{actual}"')

# Predicted: "Ankle boot", Actual: "Ankle boot"

test_dataデータから一つだけデータを取り出し、推論を行なった結果です。Ankle bootを正解していることが分かります。

Quickstartを一通り終えたら

PyTorch公式からも紹介されている本で、基礎的な内容から実際の画像データを用いた実践的な内容まで網羅しています。

PyTorch実践入門