PyTorchでニューラルネットワークの詳細情報を表示する魔法の杖：torch.nn.Module.extra_repr()

PyTorchのニューラルネットワークにおける torch.nn.Module.extra_repr() の詳細解説

extra_repr() は、モジュールの文字列表現を返す関数です。デフォルトの表現に加えて、extra_repr() 内で任意の文字列を返すことで、追加情報を表示することができます。

extra_repr() は、以下の方法で使用できます。

1. モジュールのクラス内で extra_repr() メソッドを定義する。
2. メソッド内で、追加したい情報を返す文字列を記述する。

例:

class MyModule(nn.Module):
    def __init__(self):
        super().__init__()
        # ...

    def extra_repr(self):
        return f"activation_fn={self.activation_fn}"

# モジュールの使用例
model = MyModule()
print(model)

上記の例では、MyModule クラスの extra_repr() メソッドで、モジュールの属性 activation_fn の値を出力しています。

extra_repr() で表示できる情報は、自由です。以下は、いくつかの例です。

• モジュールの属性
• モジュールの設定
• モジュールの統計情報
• その他、任意の情報

extra_repr() を使用することで、以下の利点があります。

• モジュールの詳細情報を簡単に確認できる
• デバッグが容易になる
• モジュールの動作を理解しやすくなる

torch.nn.Module.extra_repr() は、PyTorch のニューラルネットワークモジュールにおける、詳細情報を表示するための便利なメソッドです。デフォルトの表示に加えて、extra_repr() を使用することで、さらに追加情報を表示することができます。

PyTorch torch.nn.Module.extra_repr() サンプルコード

モジュールの属性を表示

class MyModule(nn.Module):
    def __init__(self, num_features):
        super().__init__()
        self.linear = nn.Linear(num_features, 10)

    def extra_repr(self):
        return f"num_features={self.linear.in_features}"

# モジュールの使用例
model = MyModule(100)
print(model)

MyModule(
  (linear): Linear(in_features=100, out_features=10, bias=True)
  num_features=100
)

モジュールの設定を表示

class MyModule(nn.Module):
    def __init__(self):
        super().__init__()
        self.conv = nn.Conv2d(1, 32, 3, padding=1)

    def extra_repr(self):
        return f"padding={self.conv.padding}"

# モジュールの使用例
model = MyModule()
print(model)

出力例:

MyModule(
  (conv): Conv2d(1, 32, kernel_size=(3, 3), stride=(1, 1), padding=(1, 1), bias=True)
  padding=(1, 1)
)

モジュールの統計情報を表示

class MyModule(nn.Module):
    def __init__(self):
        super().__init__()
        self.fc = nn.Linear(10, 1)

    def extra_repr(self):
        return f"mean_weight={self.fc.weight.mean():.2f}"

# モジュールの使用例
model = MyModule()
model.fc.weight.data.normal_(0, 0.1)

print(model)

出力例:

MyModule(
  (fc): Linear(in_features=10, out_features=1, bias=True)
  mean_weight=-0.01
)

その他の情報を表示

class MyModule(nn.Module):
    def __init__(self):
        super().__init__()
        self.lstm = nn.LSTM(10, 20)

    def extra_repr(self):
        return f"num_layers={self.lstm.num_layers}"

# モジュールの使用例
model = MyModule()
print(model)

出力例:

MyModule(
  (lstm): LSTM(10, 20, num_layers=1, bidirectional=False)
  num_layers=1
)

上記のサンプルコードは、torch.nn.Module.extra_repr() の使い方をいくつか示しています。これらのサンプルコードを参考に、ニーズに合わせて情報を表示することができます。

torch.nn.Module.extra_repr() 以外の詳細情報表示方法

モジュールの属性に直接アクセスすることで、その値を取得することができます。

model = nn.Conv2d(1, 32, 3)

# モジュールの属性へのアクセス
print(model.kernel_size)
print(model.padding)
print(model.bias)

出力例:

(3, 3)
(0, 0)
Parameter containing:
tensor([0., 0., 0., ..., 0., 0., 0.], requires_grad=True)

モジュールの state_dict() を使用

state_dict() メソッドは、モジュールの状態辞書を取得します。状態辞書には、モジュールのパラメータやバッファなどの情報が含まれています。

model = nn.Linear(10, 1)

# モジュールの状態辞書
state_dict = model.state_dict()

# 状態辞書のキーと値の表示
for key, value in state_dict.items():
    print(f"{key}: {value}")

出力例:

linear.weight: Parameter containing:
tensor([-0.0153,  0.0342, -0.0720, ...,  0.0044,  0.0557, -0.0261], requires_grad=True)
linear.bias: Parameter containing:
tensor([0.], requires_grad=True)

デバッガーを使用することで、モジュールの内部状態を詳細に調べることができます。

torch.nn.Module.extra_repr() は、ニューラルネットワークモジュールの詳細情報を表示する便利な方法です。しかし、上記で紹介した他の方法も、状況に応じて役立ちます。