Search code examples
pythonmachine-learningdeep-learningpytorchconv-neural-network

PyTorch model input shape

I loaded a custom PyTorch model and I want to find out its input shape. Something like this:

model.input_shape

Is it possible to get this information?

Update: print() and summary() don't show this model's input shape, so they are not what I'm looking for.

Solution

  • PyTorch flexibility

    PyTorch models are very flexible objects, to the point where they do not enforce or generally expect a fixed input shape for data.

    If you have certain layers there may be constraints e.g:

    • a flatten followed by a fully connected layer of width N would enforce the dimensions of your original input (M1 x M2 x ... Mn) to have a product equal to N
    • a 2d convolution of N input channels would enforce the data to be 3 dimensionsal, with the first dimension having size N

    But as you can see neither of these enforce the total shape of the data.

    We might not realize it right now, but in more complex models, getting the size of the first linear layer right is sometimes a source of frustration. We’ve heard stories of famous practitioners putting in arbitrary numbers and then relying on error messages from PyTorch to backtrack the correct sizes for their linear layers. Lame, eh? Nah, it’s all legit!

    • Deep Learning with PyTorch

    Investigation

    Simple case: First layer is Fully Connected

    If your model's first layer is a fully connected one, then the first layer in print(model) will detail the expected dimensionality of a single sample.

    Ambiguous case: CNN

    If it is a convolutional layer however, since these are dynamic and will stride as long/wide as the input permits, there is no simple way to retrieve this info from the model itself.1 This flexibility means that for many architectures multiple compatible input sizes2 will all be acceptable by the network.

    This is a feature of PyTorch's Dynamic computational graph.

    Manual inspection

    What you will need to do is investigate the network architecture, and once you've found an interpretable layer (if one is present e.g. fully connected) "work backwards" with its dimensions, determining how the previous layers (e.g. poolings and convolutions) have compressed/modified it.

    Example

    e.g. in the following model from Deep Learning with PyTorch (8.5.1):

    class NetWidth(nn.Module):
    def __init__(self):
        super().__init__()
        self.conv1 = nn.Conv2d(3, 32, kernel_size=3, padding=1)
        self.conv2 = nn.Conv2d(32, 16, kernel_size=3, padding=1)
        self.fc1 = nn.Linear(16 * 8 * 8, 32)
        self.fc2 = nn.Linear(32, 2)
    
    def forward(self, x):
        out = F.max_pool2d(torch.tanh(self.conv1(x)), 2)
        out = F.max_pool2d(torch.tanh(self.conv2(out)), 2)
        out = out.view(-1, 16 * 8 * 8)
        out = torch.tanh(self.fc1(out))
        out = self.fc2(out)
        return out

    We see the model takes an input 2.d. image with 3 channels and:

    • Conv2d -> sends it to an image of the same size with 32 channels
    • max_pool2d(,2) -> halves the size of the image in each dimension
    • Conv2d -> sends it to an image of the same size with 16 channels
    • max_pool2d(,2) -> halves the size of the image in each dimension
    • view -> reshapes the image
    • Linear -> takes a tensor of size 16 * 8 * 8 and sends to size 32
    • ...

    So working backwards, we have:

    • a tensor of shape 16 * 8 * 8
    • un-reshaped into shape (channels x height x width)
    • un-max_pooled in 2d with factor 2, so height and width un-halved
    • un-convolved from 16 channels to 32
      Hypothesis: It is likely 16 in the product thus refers to the number of channels, and that the image seen by view was of shape (channels, 8,8), and currently is (channels, 16,16)2
    • un-max_pooled in 2d with factor 2, so height and width un-halved again (channels, 32,32)
    • un-convolved from 32 channels to 3

    So assuming the kernel_size and padding are sufficient that the convolutions themselves maintain image dimensions, it is likely that the input image is of shape (3,32,32) i.e. RGB 32x32 pixel square images.

    Notes:

    1. Even the external package pytorch-summary requires you provide the input shape in order to display the shape of the output of each layer.

    2. It could however be any 2 numbers whose produce equals 8*8 e.g. (64,1), (32,2), (16,4) etc however since the code is written as 8*8 it is likely the authors used the actual dimensions.