使用 TorchText 进行语言翻译

原文： https://pytorch.org/tutorials/beginner/torchtext_translation_tutorial.html

注意

单击此处的下载完整的示例代码

本教程说明如何使用torchtext的几个便捷类来预处理包含英语和德语句子的著名数据集的数据，并使用它来训练序列到序列模型，并注意将德语句子翻译成英语 。

它基于 PyTorch 社区成员 Ben Trevett 的本教程，并由 Seth Weidman 在 Ben 的允许下创建。

在本教程结束时，您将能够：

<cite>字段</cite>和 <cite>TranslationDataset</cite>

torchtext具有用于创建数据集的实用程序，可以轻松地对其进行迭代，以创建语言翻译模型。 一个关键类是字段，它指定应该对每个句子进行预处理的方式，另一个关键类是 <cite>TranslationDataset</cite> ； torchtext有几个这样的数据集； 在本教程中，我们将使用 Multi30k 数据集，其中包含约 30,000 个英语和德语句子(平均长度约为 13 个单词）。

注意：本教程中的标记化需要 Spacy 我们使用 Spacy，因为它为英语以外的其他语言的标记化提供了强大的支持。 torchtext提供了basic_english标记器，并支持其他英语标记器(例如摩西），但对于语言翻译(需要多种语言），Spacy 是您的最佳选择。

要运行本教程，请先使用pip或conda安装spacy。 接下来，下载英语和德语 Spacy 分词器的原始数据：

  1. python -m spacy download en
  2. python -m spacy download de

安装 Spacy 后，以下代码将根据Field中定义的标记器，标记TranslationDataset中的每个句子。

  1. from torchtext.datasets import Multi30k
  2. from torchtext.data import Field, BucketIterator
  4. SRC = Field(tokenize = "spacy",
  5.             tokenizer_language="de",
  6.             init_token = '<sos>',
  7.             eos_token = '<eos>',
  8.             lower = True)
  10. TRG = Field(tokenize = "spacy",
  11.             tokenizer_language="en",
  12.             init_token = '<sos>',
  13.             eos_token = '<eos>',
  14.             lower = True)
  16. train_data, valid_data, test_data = Multi30k.splits(exts = ('.de', '.en'),
  17.                                                     fields = (SRC, TRG))

出：

  1. downloading training.tar.gz
  2. downloading validation.tar.gz
  3. downloading mmt_task1_test2016.tar.gz

现在我们已经定义了train_data，我们可以看到torchtext的Field的一个非常有用的功能：build_vocab方法现在允许我们创建与每种语言相关的词汇

  1. SRC.build_vocab(train_data, min_freq = 2)
  2. TRG.build_vocab(train_data, min_freq = 2)

一旦运行了这些代码行，SRC.vocab.stoi将是一个词典，其词汇表中的标记作为键，而其对应的索引作为值； SRC.vocab.itos将是相同的字典，其中的键和值被交换。 在本教程中，我们不会广泛使用此事实，但这在您将遇到的其他 NLP 任务中可能很有用。

BucketIterator

我们将使用的最后torchtext个特定功能是BucketIterator，它很容易使用，因为它以TranslationDataset作为第一个参数。 具体来说，正如文档所说：定义一个迭代器，该迭代器将相似长度的示例批处理在一起。 在为每个新纪元生产新鲜改组的批次时，最大程度地减少所需的填充量。 有关使用的存储过程，请参阅池。

  1. import torch
  3. device = torch.device('cuda' if torch.cuda.is_available() else 'cpu')
  5. BATCH_SIZE = 128
  7. train_iterator, valid_iterator, test_iterator = BucketIterator.splits(
  8.     (train_data, valid_data, test_data),
  9.     batch_size = BATCH_SIZE,
  10.     device = device)

可以像DataLoader``s; below, in the ``train和evaluate函数一样调用这些迭代器，只需使用以下命令即可调用它们：

  1. for i, batch in enumerate(iterator):

每个batch然后具有src和trg属性：

  1. src = batch.src
  2. trg = batch.trg

定义我们的nn.Module和Optimizer

这大部分是从torchtext角度出发的：构建了数据集并定义了迭代器，本教程的其余部分仅将模型定义为nn.Module以及Optimizer，然后对其进行训练。

具体来说，我们的模型遵循在此处中描述的架构(您可以在此处找到更多注释的版本）。

注意：此模型只是可用于语言翻译的示例模型； 我们选择它是因为它是任务的标准模型，而不是因为它是用于翻译的推荐模型。 如您所知，目前最先进的模型基于“变形金刚”； 您可以在此处看到 PyTorch 的实现 Transformer 层的功能； 特别是，以下模型中使用的“注意”与变压器模型中存在的多头自我注意不同。

  1. import random
  2. from typing import Tuple
  4. import torch.nn as nn
  5. import torch.optim as optim
  6. import torch.nn.functional as F
  7. from torch import Tensor
  9. class Encoder(nn.Module):
  10.     def __init__(self,
  11.                  input_dim: int,
  12.                  emb_dim: int,
  13.                  enc_hid_dim: int,
  14.                  dec_hid_dim: int,
  15.                  dropout: float):
  16.         super().__init__()
  18.         self.input_dim = input_dim
  19.         self.emb_dim = emb_dim
  20.         self.enc_hid_dim = enc_hid_dim
  21.         self.dec_hid_dim = dec_hid_dim
  22.         self.dropout = dropout
  24.         self.embedding = nn.Embedding(input_dim, emb_dim)
  26.         self.rnn = nn.GRU(emb_dim, enc_hid_dim, bidirectional = True)
  28.         self.fc = nn.Linear(enc_hid_dim * 2, dec_hid_dim)
  30.         self.dropout = nn.Dropout(dropout)
  32.     def forward(self,
  33.                 src: Tensor) -> Tuple[Tensor]:
  35.         embedded = self.dropout(self.embedding(src))
  37.         outputs, hidden = self.rnn(embedded)
  39.         hidden = torch.tanh(self.fc(torch.cat((hidden[-2,:,:], hidden[-1,:,:]), dim = 1)))
  41.         return outputs, hidden
  43. class Attention(nn.Module):
  44.     def __init__(self,
  45.                  enc_hid_dim: int,
  46.                  dec_hid_dim: int,
  47.                  attn_dim: int):
  48.         super().__init__()
  50.         self.enc_hid_dim = enc_hid_dim
  51.         self.dec_hid_dim = dec_hid_dim
  53.         self.attn_in = (enc_hid_dim * 2) + dec_hid_dim
  55.         self.attn = nn.Linear(self.attn_in, attn_dim)
  57.     def forward(self,
  58.                 decoder_hidden: Tensor,
  59.                 encoder_outputs: Tensor) -> Tensor:
  61.         src_len = encoder_outputs.shape[0]
  63.         repeated_decoder_hidden = decoder_hidden.unsqueeze(1).repeat(1, src_len, 1)
  65.         encoder_outputs = encoder_outputs.permute(1, 0, 2)
  67.         energy = torch.tanh(self.attn(torch.cat((
  68.             repeated_decoder_hidden,
  69.             encoder_outputs),
  70.             dim = 2)))
  72.         attention = torch.sum(energy, dim=2)
  74.         return F.softmax(attention, dim=1)
  76. class Decoder(nn.Module):
  77.     def __init__(self,
  78.                  output_dim: int,
  79.                  emb_dim: int,
  80.                  enc_hid_dim: int,
  81.                  dec_hid_dim: int,
  82.                  dropout: int,
  83.                  attention: nn.Module):
  84.         super().__init__()
  86.         self.emb_dim = emb_dim
  87.         self.enc_hid_dim = enc_hid_dim
  88.         self.dec_hid_dim = dec_hid_dim
  89.         self.output_dim = output_dim
  90.         self.dropout = dropout
  91.         self.attention = attention
  93.         self.embedding = nn.Embedding(output_dim, emb_dim)
  95.         self.rnn = nn.GRU((enc_hid_dim * 2) + emb_dim, dec_hid_dim)
  97.         self.out = nn.Linear(self.attention.attn_in + emb_dim, output_dim)
  99.         self.dropout = nn.Dropout(dropout)
  101.     def _weighted_encoder_rep(self,
  102.                               decoder_hidden: Tensor,
  103.                               encoder_outputs: Tensor) -> Tensor:
  105.         a = self.attention(decoder_hidden, encoder_outputs)
  107.         a = a.unsqueeze(1)
  109.         encoder_outputs = encoder_outputs.permute(1, 0, 2)
  111.         weighted_encoder_rep = torch.bmm(a, encoder_outputs)
  113.         weighted_encoder_rep = weighted_encoder_rep.permute(1, 0, 2)
  115.         return weighted_encoder_rep
  117.     def forward(self,
  118.                 input: Tensor,
  119.                 decoder_hidden: Tensor,
  120.                 encoder_outputs: Tensor) -> Tuple[Tensor]:
  122.         input = input.unsqueeze(0)
  124.         embedded = self.dropout(self.embedding(input))
  126.         weighted_encoder_rep = self._weighted_encoder_rep(decoder_hidden,
  127.                                                           encoder_outputs)
  129.         rnn_input = torch.cat((embedded, weighted_encoder_rep), dim = 2)
  131.         output, decoder_hidden = self.rnn(rnn_input, decoder_hidden.unsqueeze(0))
  133.         embedded = embedded.squeeze(0)
  134.         output = output.squeeze(0)
  135.         weighted_encoder_rep = weighted_encoder_rep.squeeze(0)
  137.         output = self.out(torch.cat((output,
  138.                                      weighted_encoder_rep,
  139.                                      embedded), dim = 1))
  141.         return output, decoder_hidden.squeeze(0)
  143. class Seq2Seq(nn.Module):
  144.     def __init__(self,
  145.                  encoder: nn.Module,
  146.                  decoder: nn.Module,
  147.                  device: torch.device):
  148.         super().__init__()
  150.         self.encoder = encoder
  151.         self.decoder = decoder
  152.         self.device = device
  154.     def forward(self,
  155.                 src: Tensor,
  156.                 trg: Tensor,
  157.                 teacher_forcing_ratio: float = 0.5) -> Tensor:
  159.         batch_size = src.shape[1]
  160.         max_len = trg.shape[0]
  161.         trg_vocab_size = self.decoder.output_dim
  163.         outputs = torch.zeros(max_len, batch_size, trg_vocab_size).to(self.device)
  165.         encoder_outputs, hidden = self.encoder(src)
  167.         # first input to the decoder is the <sos> token
  168.         output = trg[0,:]
  170.         for t in range(1, max_len):
  171.             output, hidden = self.decoder(output, hidden, encoder_outputs)
  172.             outputs[t] = output
  173.             teacher_force = random.random() < teacher_forcing_ratio
  174.             top1 = output.max(1)[1]
  175.             output = (trg[t] if teacher_force else top1)
  177.         return outputs
  179. INPUT_DIM = len(SRC.vocab)
  180. OUTPUT_DIM = len(TRG.vocab)
  181. # ENC_EMB_DIM = 256
  182. # DEC_EMB_DIM = 256
  183. # ENC_HID_DIM = 512
  184. # DEC_HID_DIM = 512
  185. # ATTN_DIM = 64
  186. # ENC_DROPOUT = 0.5
  187. # DEC_DROPOUT = 0.5
  189. ENC_EMB_DIM = 32
  190. DEC_EMB_DIM = 32
  191. ENC_HID_DIM = 64
  192. DEC_HID_DIM = 64
  193. ATTN_DIM = 8
  194. ENC_DROPOUT = 0.5
  195. DEC_DROPOUT = 0.5
  197. enc = Encoder(INPUT_DIM, ENC_EMB_DIM, ENC_HID_DIM, DEC_HID_DIM, ENC_DROPOUT)
  199. attn = Attention(ENC_HID_DIM, DEC_HID_DIM, ATTN_DIM)
  201. dec = Decoder(OUTPUT_DIM, DEC_EMB_DIM, ENC_HID_DIM, DEC_HID_DIM, DEC_DROPOUT, attn)
  203. model = Seq2Seq(enc, dec, device).to(device)
  205. def init_weights(m: nn.Module):
  206.     for name, param in m.named_parameters():
  207.         if 'weight' in name:
  208.             nn.init.normal_(param.data, mean=0, std=0.01)
  209.         else:
  210.             nn.init.constant_(param.data, 0)
  212. model.apply(init_weights)
  214. optimizer = optim.Adam(model.parameters())
  216. def count_parameters(model: nn.Module):
  217.     return sum(p.numel() for p in model.parameters() if p.requires_grad)
  219. print(f'The model has {count_parameters(model):,} trainable parameters')

Out:

  1. The model has 1,856,685 trainable parameters

注意：特别是在对语言翻译模型的性能进行评分时，我们必须告诉nn.CrossEntropyLoss函数忽略仅填充目标的索引。

  1. PAD_IDX = TRG.vocab.stoi['<pad>']
  3. criterion = nn.CrossEntropyLoss(ignore_index=PAD_IDX)

最后，我们可以训练和评估该模型：

  1. import math
  2. import time
  4. def train(model: nn.Module,
  5.           iterator: BucketIterator,
  6.           optimizer: optim.Optimizer,
  7.           criterion: nn.Module,
  8.           clip: float):
  10.     model.train()
  12.     epoch_loss = 0
  14.     for _, batch in enumerate(iterator):
  16.         src = batch.src
  17.         trg = batch.trg
  19.         optimizer.zero_grad()
  21.         output = model(src, trg)
  23.         output = output[1:].view(-1, output.shape[-1])
  24.         trg = trg[1:].view(-1)
  26.         loss = criterion(output, trg)
  28.         loss.backward()
  30.         torch.nn.utils.clip_grad_norm_(model.parameters(), clip)
  32.         optimizer.step()
  34.         epoch_loss += loss.item()
  36.     return epoch_loss / len(iterator)
  38. def evaluate(model: nn.Module,
  39.              iterator: BucketIterator,
  40.              criterion: nn.Module):
  42.     model.eval()
  44.     epoch_loss = 0
  46.     with torch.no_grad():
  48.         for _, batch in enumerate(iterator):
  50.             src = batch.src
  51.             trg = batch.trg
  53.             output = model(src, trg, 0) #turn off teacher forcing
  55.             output = output[1:].view(-1, output.shape[-1])
  56.             trg = trg[1:].view(-1)
  58.             loss = criterion(output, trg)
  60.             epoch_loss += loss.item()
  62.     return epoch_loss / len(iterator)
  64. def epoch_time(start_time: int,
  65.                end_time: int):
  66.     elapsed_time = end_time - start_time
  67.     elapsed_mins = int(elapsed_time / 60)
  68.     elapsed_secs = int(elapsed_time - (elapsed_mins * 60))
  69.     return elapsed_mins, elapsed_secs
  71. N_EPOCHS = 10
  72. CLIP = 1
  74. best_valid_loss = float('inf')
  76. for epoch in range(N_EPOCHS):
  78.     start_time = time.time()
  80.     train_loss = train(model, train_iterator, optimizer, criterion, CLIP)
  81.     valid_loss = evaluate(model, valid_iterator, criterion)
  83.     end_time = time.time()
  85.     epoch_mins, epoch_secs = epoch_time(start_time, end_time)
  87.     print(f'Epoch: {epoch+1:02} | Time: {epoch_mins}m {epoch_secs}s')
  88.     print(f'\tTrain Loss: {train_loss:.3f} | Train PPL: {math.exp(train_loss):7.3f}')
  89.     print(f'\t Val. Loss: {valid_loss:.3f} |  Val. PPL: {math.exp(valid_loss):7.3f}')
  91. test_loss = evaluate(model, test_iterator, criterion)
  93. print(f'| Test Loss: {test_loss:.3f} | Test PPL: {math.exp(test_loss):7.3f} |')

Out:

  1. Epoch: 01 | Time: 0m 35s
  2.         Train Loss: 5.667 | Train PPL: 289.080
  3.          Val. Loss: 5.201 |  Val. PPL: 181.371
  4. Epoch: 02 | Time: 0m 35s
  5.         Train Loss: 4.968 | Train PPL: 143.728
  6.          Val. Loss: 5.096 |  Val. PPL: 163.375
  7. Epoch: 03 | Time: 0m 35s
  8.         Train Loss: 4.720 | Train PPL: 112.221
  9.          Val. Loss: 4.989 |  Val. PPL: 146.781
  10. Epoch: 04 | Time: 0m 35s
  11.         Train Loss: 4.586 | Train PPL:  98.094
  12.          Val. Loss: 4.841 |  Val. PPL: 126.612
  13. Epoch: 05 | Time: 0m 35s
  14.         Train Loss: 4.430 | Train PPL:  83.897
  15.          Val. Loss: 4.809 |  Val. PPL: 122.637
  16. Epoch: 06 | Time: 0m 35s
  17.         Train Loss: 4.331 | Train PPL:  75.997
  18.          Val. Loss: 4.797 |  Val. PPL: 121.168
  19. Epoch: 07 | Time: 0m 35s
  20.         Train Loss: 4.240 | Train PPL:  69.434
  21.          Val. Loss: 4.694 |  Val. PPL: 109.337
  22. Epoch: 08 | Time: 0m 35s
  23.         Train Loss: 4.116 | Train PPL:  61.326
  24.          Val. Loss: 4.714 |  Val. PPL: 111.452
  25. Epoch: 09 | Time: 0m 35s
  26.         Train Loss: 4.004 | Train PPL:  54.815
  27.          Val. Loss: 4.563 |  Val. PPL:  95.835
  28. Epoch: 10 | Time: 0m 36s
  29.         Train Loss: 3.922 | Train PPL:  50.519
  30.          Val. Loss: 4.452 |  Val. PPL:  85.761
  31. | Test Loss: 4.456 | Test PPL:  86.155 |

下一步

  • 在上查看使用torchtext 的 Ben Trevett 其余教程。
  • 敬请关注使用其他torchtext功能以及nn.Transformer通过下一个单词预测进行语言建模的教程！

脚本的总运行时间：(6 分钟 10.266 秒）

Download Python source code: torchtext_translation_tutorial.py Download Jupyter notebook: torchtext_translation_tutorial.ipynb

由狮身人面像画廊生成的画廊