PyTorch 使用 nn.Transformer 和 TorchText 进行序列到序列的建模

要查看图文版教程，请移步：点击这里

这是关于如何训练使用 nn.Transformer module的序列到序列模型的教程。

PyTorch-1.2 版本包括一个基于论文 Attention is All You Need 的标准transformer模块。transformer模型在能够处理多个序列到序列问题的同时具有更好的并行性。 nn.Transformer 模块完全依赖于注意机制 (最近实现的另一个模块是 nn.MultiheadAttention ） 来绘制输入和输出之间的全局依赖关系。 nn.Transformer 模块现在高度模块化，因此单个组件 （如本教程中的 nn.TransformerEncoder ） 可以很容易地进行调整/组合。 ../_images/transformer_architecture.jpg

定义模型

在本教程中，我们将在语言建模任务中训练 nn.TransformerEncoder 模型。语言建模任务是为给定单词（或一系列单词）跟随另外一系列单词出现的可能性指定一个概率。 先将一系列标记(tokens)传递到嵌入层(embedding layer)，然后是位置编码层(positional encoding layer)， 以说明单词的顺序（有关详细信息，请参阅下一段）。 nn.TransformerEncoder 由多层 nn.TransformerEncoderLayer 组成。 由于 nn.TransformerEncoder 中的自关注层(self-attention layers)只允许关注序列中的早期位置，因此需要一个方形的关注掩码(attention mask)与输入序列一起工作。 对于语言建模任务，应该屏蔽未来位置上的任何标记。为了得到实际的单词， nn.TransformerEncoder 模型的输出被发送到最终的线性层，然后是log-Softmax函数。

import math
import torch
import torch.nn as nn
import torch.nn.functional as F

class TransformerModel(nn.Module):

    def __init__(self, ntoken, ninp, nhead, nhid, nlayers, dropout=0.5):
        super(TransformerModel, self).__init__()
        from torch.nn import TransformerEncoder, TransformerEncoderLayer
        self.model_type = 'Transformer'
        self.src_mask = None
        self.pos_encoder = PositionalEncoding(ninp, dropout)
        encoder_layers = TransformerEncoderLayer(ninp, nhead, nhid, dropout)
        self.transformer_encoder = TransformerEncoder(encoder_layers, nlayers)
        self.encoder = nn.Embedding(ntoken, ninp)
        self.ninp = ninp
        self.decoder = nn.Linear(ninp, ntoken)

        self.init_weights()

    def _generate_square_subsequent_mask(self, sz):
        mask = (torch.triu(torch.ones(sz, sz)) == 1).transpose(0, 1)
        mask = mask.float().masked_fill(mask == 0, float('-inf')).masked_fill(mask == 1, float(0.0))
        return mask

    def init_weights(self):
        initrange = 0.1
        self.encoder.weight.data.uniform_(-initrange, initrange)
        self.decoder.bias.data.zero_()
        self.decoder.weight.data.uniform_(-initrange, initrange)

    def forward(self, src):
        if self.src_mask is None or self.src_mask.size(0) != len(src):
            device = src.device
            mask = self._generate_square_subsequent_mask(len(src)).to(device)
            self.src_mask = mask

        src = self.encoder(src) * math.sqrt(self.ninp)
        src = self.pos_encoder(src)
        output = self.transformer_encoder(src, self.src_mask)
        output = self.decoder(output)
        return output

PositionalEncoding 模块注入一些与标记(tokens)在序列中的相对或绝对位置有关的信息。 位置编码与embeddings具有相同的维度，因此可以将两者相加。这里，我们使用不同频率的 sine 和 cosine 函数。

class PositionalEncoding(nn.Module):

    def __init__(self, d_model, dropout=0.1, max_len=5000):
        super(PositionalEncoding, self).__init__()
        self.dropout = nn.Dropout(p=dropout)

        pe = torch.zeros(max_len, d_model)
        position = torch.arange(0, max_len, dtype=torch.float).unsqueeze(1)
        div_term = torch.exp(torch.arange(0, d_model, 2).float() * (-math.log(10000.0) / d_model))
        pe[:, 0::2] = torch.sin(position * div_term)
        pe[:, 1::2] = torch.cos(position * div_term)
        pe = pe.unsqueeze(0).transpose(0, 1)
        self.register_buffer('pe', pe)

    def forward(self, x):
        x = x + self.pe[:x.size(0), :]
        return self.dropout(x)

加载数据并批量化

训练过程使用来自 torchtext 的 Wikitext-2 数据集。vocab 对象是基于训练数据集构建的，用于将标记(tokens)编号为张量。 函数 batchify() 的作用是将数据集排列成列，在将数据划分成 batch_size 大小的batch后，删除所有剩余的标记。 例如，将字母表作为序列（总长度为26）， batch_size 为4，我们就可以将字母表划分为4个长度为6的序列： [ABC…XYZ]⇒⎡⎣⎢⎢⎢⎢⎢⎢⎢⎢⎡⎣⎢⎢⎢⎢⎢⎢⎢⎢ABCDEF⎤⎦⎥⎥⎥⎥⎥⎥⎥⎥⎡⎣⎢⎢⎢⎢⎢⎢⎢⎢GHIJKL⎤⎦⎥⎥⎥⎥⎥⎥⎥⎥⎡⎣⎢⎢⎢⎢⎢⎢⎢⎢MNOPQR⎤⎦⎥⎥⎥⎥⎥⎥⎥⎥⎡⎣⎢⎢⎢⎢⎢⎢⎢⎢STUVWX⎤⎦⎥⎥⎥⎥⎥⎥⎥⎥⎤⎦⎥⎥⎥⎥⎥⎥⎥⎥

这些列被模型视为独立的，这意味着G和F的依赖性无法被学习到，但这样做可以使批处理更高效。

import torchtext
from torchtext.data.utils import get_tokenizer
TEXT = torchtext.data.Field(tokenize=get_tokenizer("basic_english"),
                            init_token='',
                            eos_token='',
                            lower=True)
train_txt, val_txt, test_txt = torchtext.datasets.WikiText2.splits(TEXT)
TEXT.build_vocab(train_txt)
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")

def batchify(data, bsz):
    data = TEXT.numericalize([data.examples[0].text])
    # Divide the dataset into bsz parts.
    nbatch = data.size(0) // bsz
    # Trim off any extra elements that wouldn't cleanly fit (remainders).
    data = data.narrow(0, 0, nbatch * bsz)
    # Evenly divide the data across the bsz batches.
    data = data.view(bsz, -1).t().contiguous()
    return data.to(device)

batch_size = 20
eval_batch_size = 10
train_data = batchify(train_txt, batch_size)
val_data = batchify(val_txt, eval_batch_size)
test_data = batchify(test_txt, eval_batch_size)

生成输入序列和目标序列的函数

get_batch() 函数为 transformer 模型产生输入序列和目标序列。 它将源数据细分为长度为 bptt.的块(chunk)。 对于语言建模任务，模型需要后续单词作为目标( Target )。 例如，如果 bptt 值为2，我们将得到以下两个 i = 0的变量(Variables)： ../_images/transformer_input_target.png

应该注意的是，块(chunks)是沿着维度0的，与Transformer模型中的 S 维度一致。 batch维 N 是沿着维度 1 的。

bptt = 35
def get_batch(source, i):
    seq_len = min(bptt, len(source) - 1 - i)
    data = source[i:i+seq_len]
    target = source[i+1:i+1+seq_len].view(-1)
    return data, target

初始化一个实例

模型的超参数设置如下所示. vocab 的 size 与 vocab objects的length相同。

ntokens = len(TEXT.vocab.stoi) # the size of vocabulary
emsize = 200 # embedding dimension
nhid = 200 # the dimension of the feedforward network model in nn.TransformerEncoder
nlayers = 2 # the number of nn.TransformerEncoderLayer in nn.TransformerEncoder
nhead = 2 # the number of heads in the multiheadattention models
dropout = 0.2 # the dropout value
model = TransformerModel(ntokens, emsize, nhead, nhid, nlayers, dropout).to(device)

运行模型

CrossEntropyLoss 被用来跟踪损失，并且 SGD 被用作执行梯度下降法的优化器. 初始学习率被设为 5.0. StepLR 被用于在每个回合后调整学习率。 在训练阶段, 我们使用 nn.utils.clip_grad_norm_ 函数将所有梯度统一缩放以防止爆炸(exploding)。

criterion = nn.CrossEntropyLoss()
lr = 5.0 # learning rate
optimizer = torch.optim.SGD(model.parameters(), lr=lr)
scheduler = torch.optim.lr_scheduler.StepLR(optimizer, 1.0, gamma=0.95)

import time
def train():
    model.train() # Turn on the train mode
    total_loss = 0.
    start_time = time.time()
    ntokens = len(TEXT.vocab.stoi)
    for batch, i in enumerate(range(0, train_data.size(0) - 1, bptt)):
        data, targets = get_batch(train_data, i)
        optimizer.zero_grad()
        output = model(data)
        loss = criterion(output.view(-1, ntokens), targets)
        loss.backward()
        torch.nn.utils.clip_grad_norm_(model.parameters(), 0.5)
        optimizer.step()

        total_loss += loss.item()
        log_interval = 200
        if batch % log_interval == 0 and batch > 0:
            cur_loss = total_loss / log_interval
            elapsed = time.time() - start_time
            print('| epoch {:3d} | {:5d}/{:5d} batches | '
                  'lr {:02.2f} | ms/batch {:5.2f} | '
                  'loss {:5.2f} | ppl {:8.2f}'.format(
                    epoch, batch, len(train_data) // bptt, scheduler.get_lr()[0],
                    elapsed * 1000 / log_interval,
                    cur_loss, math.exp(cur_loss)))
            total_loss = 0
            start_time = time.time()

def evaluate(eval_model, data_source):
    eval_model.eval() # Turn on the evaluation mode
    total_loss = 0.
    ntokens = len(TEXT.vocab.stoi)
    with torch.no_grad():
        for i in range(0, data_source.size(0) - 1, bptt):
            data, targets = get_batch(data_source, i)
            output = eval_model(data)
            output_flat = output.view(-1, ntokens)
            total_loss += len(data) * criterion(output_flat, targets).item()
    return total_loss / (len(data_source) - 1)

逐个回合(epoch)的循环。如果验证损失是我们从训练开始迄今为止看到的最好的，则保存模型。每个epoch后调整学习率。

best_val_loss = float("inf")
epochs = 3 # The number of epochs
best_model = None

for epoch in range(1, epochs + 1):
    epoch_start_time = time.time()
    train()
    val_loss = evaluate(model, val_data)
    print('-' * 89)
    print('| end of epoch {:3d} | time: {:5.2f}s | valid loss {:5.2f} | '
          'valid ppl {:8.2f}'.format(epoch, (time.time() - epoch_start_time),
                                     val_loss, math.exp(val_loss)))
    print('-' * 89)

    if val_loss < best_val_loss:
        best_val_loss = val_loss
        best_model = model

    scheduler.step()

在测试集上评估模型

应用最佳模型(best model)在测试数据集上检查结果。

test_loss = evaluate(best_model, test_data)
print('=' * 89)
print('| End of training | test loss {:5.2f} | test ppl {:8.2f}'.format(
    test_loss, math.exp(test_loss)))
print('=' * 89)