Transformer encoder in PyTorch

Introduction

A Transformer encoder helps a computer understand sequences like sentences by looking at all parts at once, not just step-by-step.

When you want to understand the meaning of a sentence for translation.

When analyzing time series data to find patterns.

When processing audio signals to recognize speech.

When building recommendation systems that consider user history.

When summarizing long documents by focusing on important parts.

Syntax

PyTorch

torch.nn.TransformerEncoder(encoder_layer, num_layers, norm=None)

encoder_layer is a single Transformer encoder block that you repeat.

num_layers is how many times you stack the encoder blocks.

Examples

This creates a Transformer encoder with 6 layers, each layer has 512 features and 8 attention heads.

PyTorch

encoder_layer = torch.nn.TransformerEncoderLayer(d_model=512, nhead=8)
transformer_encoder = torch.nn.TransformerEncoder(encoder_layer, num_layers=6)

This creates a smaller Transformer encoder with 3 layers and adds normalization for stability.

PyTorch

encoder_layer = torch.nn.TransformerEncoderLayer(d_model=256, nhead=4)
transformer_encoder = torch.nn.TransformerEncoder(encoder_layer, num_layers=3, norm=torch.nn.LayerNorm(256))

Sample Model

This code builds a Transformer encoder with 2 layers. It processes a random sequence of length 10 with 16 features. The output shape shows the sequence length, batch size, and feature size stay the same.

PyTorch

import torch
import torch.nn as nn

# Define a single encoder layer
encoder_layer = nn.TransformerEncoderLayer(d_model=16, nhead=4)
# Stack 2 layers to build the encoder
transformer_encoder = nn.TransformerEncoder(encoder_layer, num_layers=2)

# Create a sample input: sequence length=10, batch size=1, feature size=16
input_seq = torch.rand(10, 1, 16)

# Pass input through the transformer encoder
output = transformer_encoder(input_seq)

# Print output shape and first vector
print('Output shape:', output.shape)
print('First output vector:', output[0, 0])

Important Notes

The input to TransformerEncoder must have shape (sequence_length, batch_size, feature_size).

TransformerEncoderLayer uses multi-head attention to look at all parts of the sequence together.

Adding normalization (LayerNorm) can help training be more stable.

Summary

Transformer encoder processes sequences by looking at all parts at once.

It stacks multiple encoder layers for deeper understanding.

Input shape is (sequence length, batch size, features) and output shape matches input shape.

Practice

1. What is the primary purpose of a Transformer encoder in PyTorch?

easy

A. To classify images using convolutional layers

B. To generate new sequences from random noise

C. To process sequences by attending to all positions simultaneously

D. To reduce the dimensionality of input data using convolution

Solution

1. Step 1: Understand the Transformer encoder role

   The Transformer encoder looks at all parts of the input sequence at once using self-attention, unlike sequential models.

2. Step 2: Compare options with this role

   Only To process sequences by attending to all positions simultaneously describes this behavior correctly. Other options describe unrelated tasks.

3. Final Answer:

   To process sequences by attending to all positions simultaneously -> Option C

4. Quick Check:

   Transformer encoder = attends all positions [OK]

Hint: Remember: Transformer encoder uses self-attention on sequences [OK]

Common Mistakes:

• Confusing encoder with decoder
• Thinking it generates sequences
• Mixing with convolutional networks

2. Which of the following is the correct way to create a Transformer encoder layer in PyTorch?

easy

A. torch.nn.Conv1d(in_channels=512, out_channels=8)

B. torch.nn.TransformerEncoderLayer(d_model=512, nhead=8)

C. torch.nn.TransformerDecoderLayer(d_model=512, nhead=8)

D. torch.nn.Linear(512, 8)

Solution

1. Step 1: Identify the correct PyTorch class for Transformer encoder layer

   The class to create a Transformer encoder layer is torch.nn.TransformerEncoderLayer.

2. Step 2: Check the parameters

   d_model and nhead are required parameters for this class, matching torch.nn.TransformerEncoderLayer(d_model=512, nhead=8).

3. Final Answer:

   torch.nn.TransformerEncoderLayer(d_model=512, nhead=8) -> Option B

4. Quick Check:

   Encoder layer class = TransformerEncoderLayer [OK]

Hint: Look for TransformerEncoderLayer class with d_model and nhead [OK]

Common Mistakes:

• Using DecoderLayer instead of EncoderLayer
• Confusing convolution or linear layers with Transformer layers
• Missing required parameters

3. Given the following code, what is the shape of the output tensor?

import torch
from torch.nn import TransformerEncoderLayer

layer = TransformerEncoderLayer(d_model=16, nhead=4)
input_tensor = torch.rand(10, 32, 16)  # (seq_len, batch_size, features)
output = layer(input_tensor)

medium

A. (32, 10, 16)

B. (32, 16, 10)

C. (10, 16, 32)

D. (10, 32, 16)

Solution

1. Step 1: Understand input shape format

   The input tensor shape is (sequence length, batch size, features) = (10, 32, 16).

2. Step 2: TransformerEncoderLayer output shape

   The output shape matches the input shape for TransformerEncoderLayer.

3. Final Answer:

   (10, 32, 16) -> Option D

4. Quick Check:

   Output shape = input shape (seq_len, batch, features) [OK]

Hint: Output shape matches input shape for Transformer encoder layers [OK]

Common Mistakes:

• Swapping batch size and sequence length
• Confusing feature dimension order
• Assuming output shape changes

4. What is wrong with this code snippet that tries to create a Transformer encoder with 2 layers?

import torch
from torch.nn import TransformerEncoder, TransformerEncoderLayer

layer = TransformerEncoderLayer(d_model=64, nhead=8)
encoder = TransformerEncoder(layer, num_layers=2)
input_tensor = torch.rand(20, 16, 64)
output = encoder(input_tensor)

medium

A. The input tensor shape is correct; no error

B. The number of heads (nhead) must be 1

C. The input tensor shape should be (batch_size, seq_len, features)

D. TransformerEncoderLayer requires an additional dropout parameter

Solution

1. Step 1: Check input tensor shape

   Input shape is (seq_len=20, batch_size=16, features=64), which is correct for TransformerEncoder.

2. Step 2: Verify other parameters

   nhead=8 is valid as 64 is divisible by 8; dropout is optional; no error in code.

3. Final Answer:

   The input tensor shape is correct; no error -> Option A

4. Quick Check:

   Input shape (seq_len, batch, features) is correct [OK]

Hint: Remember input shape is (seq_len, batch, features) for TransformerEncoder [OK]

Common Mistakes:

• Swapping batch and sequence dimensions
• Thinking dropout is mandatory
• Assuming nhead must be 1

5. You want to build a Transformer encoder in PyTorch that processes sequences of length 15 with batch size 8 and feature size 32. You want 3 encoder layers, each with 4 attention heads. Which code snippet correctly creates this model and processes a random input?

hard

A. import torch
from torch.nn import TransformerEncoder, TransformerEncoderLayer

layer = TransformerEncoderLayer(d_model=32, nhead=4)
encoder = TransformerEncoder(layer, num_layers=3)
input_tensor = torch.rand(15, 8, 32)
output = encoder(input_tensor)

B. import torch
from torch.nn import TransformerEncoder, TransformerEncoderLayer

layer = TransformerEncoderLayer(d_model=32, nhead=3)
encoder = TransformerEncoder(layer, num_layers=4)
input_tensor = torch.rand(8, 15, 32)
output = encoder(input_tensor)

C. import torch
from torch.nn import TransformerEncoder, TransformerEncoderLayer

layer = TransformerEncoderLayer(d_model=15, nhead=4)
encoder = TransformerEncoder(layer, num_layers=3)
input_tensor = torch.rand(15, 8, 32)
output = encoder(input_tensor)

D. import torch
from torch.nn import TransformerEncoder, TransformerEncoderLayer

layer = TransformerEncoderLayer(d_model=32, nhead=4)
encoder = TransformerEncoder(layer, num_layers=3)
input_tensor = torch.rand(8, 15, 32)
output = encoder(input_tensor)

Solution

1. Step 1: Check d_model and nhead parameters

   d_model must match feature size (32), and nhead must divide d_model (4 divides 32). import torch from torch.nn import TransformerEncoder, TransformerEncoderLayer layer = TransformerEncoderLayer(d_model=32, nhead=4) encoder = TransformerEncoder(layer, num_layers=3) input_tensor = torch.rand(15, 8, 32) output = encoder(input_tensor) matches this.

2. Step 2: Verify input tensor shape and num_layers

   Input shape should be (seq_len=15, batch=8, features=32). import torch from torch.nn import TransformerEncoder, TransformerEncoderLayer layer = TransformerEncoderLayer(d_model=32, nhead=4) encoder = TransformerEncoder(layer, num_layers=3) input_tensor = torch.rand(15, 8, 32) output = encoder(input_tensor) uses this shape and 3 layers as required.

3. Final Answer:

   Code snippet in option A correctly creates and processes the input -> Option A

4. Quick Check:

   d_model=32, nhead=4, input shape correct [OK]

Hint: Match d_model to features and input shape (seq_len, batch, features) [OK]

Common Mistakes:

• Swapping batch and sequence dimensions
• Using nhead that doesn't divide d_model
• Mismatching d_model and input feature size