注意

点击这里下载完整的示例代码

从零开始的 NLP：使用字符级 RNN 对姓名进行分类¶

我们将构建和训练一个基本的字符级循环神经网络 (RNN) 来对单词进行分类。本教程以及另外两个自然语言处理 (NLP) “从零开始” 教程从零开始的 NLP：使用字符级 RNN 生成姓名和从零开始的 NLP：使用序列到序列网络和注意力进行翻译展示了如何预处理数据以对 NLP 进行建模。特别地，这些教程没有使用 torchtext 的许多便捷函数，因此您可以了解如何在低级对 NLP 进行预处理。

字符级 RNN 将单词读取为一系列字符 - 在每一步输出一个预测和“隐藏状态”，并将前一个隐藏状态馈送到下一步骤。我们将最后一步的预测作为输出，即单词属于哪个类别。

具体来说，我们将对来自 18 种起源语言的数千个姓氏进行训练，并根据拼写预测姓氏来自哪种语言。

$ python predict.py Hinton
(-0.47) Scottish
(-1.52) English
(-3.57) Irish

$ python predict.py Schmidhuber
(-0.19) German
(-2.48) Czech
(-2.68) Dutch

准备数据¶

注意

从这里下载数据并将其解压到当前目录。

在 data/names 目录中包含 18 个名为 [Language].txt 的文本文件。每个文件包含许多名称，每行一个名称，大部分是罗马化的（但我们仍然需要将 Unicode 转换为 ASCII）。

最终我们将得到一个字典，其中包含每个语言的名称列表，{language: [names ...]}。通用变量“category”和“line”（在我们的例子中分别指语言和名称）用于以后的扩展。

from io import open
import glob
import os

def findFiles(path): return glob.glob(path)

print(findFiles('data/names/*.txt'))

import unicodedata
import string

all_letters = string.ascii_letters + " .,;'"
n_letters = len(all_letters)

# Turn a Unicode string to plain ASCII, thanks to https://stackoverflow.com/a/518232/2809427
def unicodeToAscii(s):
    return ''.join(
        c for c in unicodedata.normalize('NFD', s)
        if unicodedata.category(c) != 'Mn'
        and c in all_letters
    )

print(unicodeToAscii('Ślusàrski'))

# Build the category_lines dictionary, a list of names per language
category_lines = {}
all_categories = []

# Read a file and split into lines
def readLines(filename):
    lines = open(filename, encoding='utf-8').read().strip().split('\n')
    return [unicodeToAscii(line) for line in lines]

for filename in findFiles('data/names/*.txt'):
    category = os.path.splitext(os.path.basename(filename))[0]
    all_categories.append(category)
    lines = readLines(filename)
    category_lines[category] = lines

n_categories = len(all_categories)

['data/names/Arabic.txt', 'data/names/Chinese.txt', 'data/names/Czech.txt', 'data/names/Dutch.txt', 'data/names/English.txt', 'data/names/French.txt', 'data/names/German.txt', 'data/names/Greek.txt', 'data/names/Irish.txt', 'data/names/Italian.txt', 'data/names/Japanese.txt', 'data/names/Korean.txt', 'data/names/Polish.txt', 'data/names/Portuguese.txt', 'data/names/Russian.txt', 'data/names/Scottish.txt', 'data/names/Spanish.txt', 'data/names/Vietnamese.txt']
Slusarski

现在我们有了 category_lines，它是一个字典，将每个类别（语言）映射到一个行（名称）列表。我们还保存了 all_categories（只是一个语言列表）和 n_categories 用于以后的参考。

print(category_lines['Italian'][:5])

['Abandonato', 'Abatangelo', 'Abatantuono', 'Abate', 'Abategiovanni']

将名称转换为张量¶

现在我们已经整理了所有名称，我们需要将它们转换为张量才能使用它们。

为了表示单个字母，我们使用大小为 <1 x n_letters> 的“独热向量”。独热向量除了在当前字母索引处为 1 之外，其他位置都填充 0，例如 "b" = <0 1 0 0 0 ...>。

为了构成一个单词，我们将这些向量组合成一个二维矩阵 <line_length x 1 x n_letters>。

这额外的一维是因为 PyTorch 假设所有内容都是批处理的 - 我们这里只使用批次大小为 1。

import torch

# Find letter index from all_letters, e.g. "a" = 0
def letterToIndex(letter):
    return all_letters.find(letter)

# Just for demonstration, turn a letter into a <1 x n_letters> Tensor
def letterToTensor(letter):
    tensor = torch.zeros(1, n_letters)
    tensor[0][letterToIndex(letter)] = 1
    return tensor

# Turn a line into a <line_length x 1 x n_letters>,
# or an array of one-hot letter vectors
def lineToTensor(line):
    tensor = torch.zeros(len(line), 1, n_letters)
    for li, letter in enumerate(line):
        tensor[li][0][letterToIndex(letter)] = 1
    return tensor

print(letterToTensor('J'))

print(lineToTensor('Jones').size())

tensor([[0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,
         0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 1.,
         0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,
         0., 0., 0.]])
torch.Size([5, 1, 57])

创建网络¶

在 autograd 出现之前，在 Torch 中创建循环神经网络需要多次克隆一个层的参数。层现在完全由图本身处理隐藏状态和梯度。这意味着你可以以非常“纯粹”的方式实现 RNN，就像常规的前馈层一样。

这个 RNN 模块实现了一个“vanilla RNN”，它只是 3 个线性层，对输入和隐藏状态进行操作，输出后有一个 LogSoftmax 层。

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

class RNN(nn.Module):
    def __init__(self, input_size, hidden_size, output_size):
        super(RNN, self).__init__()

        self.hidden_size = hidden_size

        self.i2h = nn.Linear(input_size, hidden_size)
        self.h2h = nn.Linear(hidden_size, hidden_size)
        self.h2o = nn.Linear(hidden_size, output_size)
        self.softmax = nn.LogSoftmax(dim=1)

    def forward(self, input, hidden):
        hidden = F.tanh(self.i2h(input) + self.h2h(hidden))
        output = self.h2o(hidden)
        output = self.softmax(output)
        return output, hidden

    def initHidden(self):
        return torch.zeros(1, self.hidden_size)

n_hidden = 128
rnn = RNN(n_letters, n_hidden, n_categories)

为了运行网络的一步，我们需要传入一个输入（在我们的例子中，是当前字母的张量）和一个之前的隐藏状态（最初将其初始化为零）。我们将得到输出（每个语言的概率）和下一个隐藏状态（我们将其保留用于下一步）。

input = letterToTensor('A')
hidden = torch.zeros(1, n_hidden)

output, next_hidden = rnn(input, hidden)

为了提高效率，我们不想为每一步创建一个新的张量，因此我们将使用 lineToTensor 而不是 letterToTensor 并使用切片。这可以通过预先计算张量的批次来进一步优化。

input = lineToTensor('Albert')
hidden = torch.zeros(1, n_hidden)

output, next_hidden = rnn(input[0], hidden)
print(output)

tensor([[-3.0014, -2.8677, -2.9758, -2.9196, -3.1387, -2.8728, -2.8886, -2.8754,
         -2.5694, -2.8957, -2.8363, -2.9602, -2.9206, -2.8656, -2.8350, -2.7372,
         -3.0470, -2.9479]], grad_fn=<LogSoftmaxBackward0>)

如您所见，输出是一个 <1 x n_categories> 张量，其中每个元素都是该类别的可能性（数值越高，可能性越大）。

训练¶

准备训练¶

在进行训练之前，我们应该创建一些辅助函数。第一个函数用于解释网络的输出，我们知道它是每个类别的可能性。我们可以使用 Tensor.topk 来获取最大值的索引。

def categoryFromOutput(output):
    top_n, top_i = output.topk(1)
    category_i = top_i[0].item()
    return all_categories[category_i], category_i

print(categoryFromOutput(output))

('Irish', 8)

我们还需要一种快速获取训练样本（名称及其语言）的方法。

import random

def randomChoice(l):
    return l[random.randint(0, len(l) - 1)]

def randomTrainingExample():
    category = randomChoice(all_categories)
    line = randomChoice(category_lines[category])
    category_tensor = torch.tensor([all_categories.index(category)], dtype=torch.long)
    line_tensor = lineToTensor(line)
    return category, line, category_tensor, line_tensor

for i in range(10):
    category, line, category_tensor, line_tensor = randomTrainingExample()
    print('category =', category, '/ line =', line)

category = Chinese / line = Hou
category = Scottish / line = Mckay
category = Arabic / line = Cham
category = Russian / line = V'Yurkov
category = Irish / line = O'Keeffe
category = French / line = Belrose
category = Spanish / line = Silva
category = Japanese / line = Fuchida
category = Greek / line = Tsahalis
category = Korean / line = Chang

训练网络¶

现在，训练这个网络所需要做的就是向它展示许多样本，让它进行猜测，并告诉它是否错了。

对于损失函数，nn.NLLLoss 是合适的，因为 RNN 的最后一层是 nn.LogSoftmax。

criterion = nn.NLLLoss()

训练的每次循环将

创建输入和目标张量。
创建一个初始化为零的隐藏状态。
读取每个字母并
- 将隐藏状态保留用于下一个字母。
将最终输出与目标进行比较。
反向传播。
返回输出和损失。

learning_rate = 0.005 # If you set this too high, it might explode. If too low, it might not learn

def train(category_tensor, line_tensor):
    hidden = rnn.initHidden()

    rnn.zero_grad()

    for i in range(line_tensor.size()[0]):
        output, hidden = rnn(line_tensor[i], hidden)

    loss = criterion(output, category_tensor)
    loss.backward()

    # Add parameters' gradients to their values, multiplied by learning rate
    for p in rnn.parameters():
        p.data.add_(p.grad.data, alpha=-learning_rate)

    return output, loss.item()

现在我们只需要用许多样本运行它。由于 train 函数返回输出和损失，因此我们可以打印它的猜测并跟踪损失以进行绘图。由于有 1000 多个样本，我们只打印每 print_every 个样本，并取损失的平均值。

import time
import math

n_iters = 100000
print_every = 5000
plot_every = 1000



# Keep track of losses for plotting
current_loss = 0
all_losses = []

def timeSince(since):
    now = time.time()
    s = now - since
    m = math.floor(s / 60)
    s -= m * 60
    return '%dm %ds' % (m, s)

start = time.time()

for iter in range(1, n_iters + 1):
    category, line, category_tensor, line_tensor = randomTrainingExample()
    output, loss = train(category_tensor, line_tensor)
    current_loss += loss

    # Print ``iter`` number, loss, name and guess
    if iter % print_every == 0:
        guess, guess_i = categoryFromOutput(output)
        correct = '✓' if guess == category else '✗ (%s)' % category
        print('%d %d%% (%s) %.4f %s / %s %s' % (iter, iter / n_iters * 100, timeSince(start), loss, line, guess, correct))

    # Add current loss avg to list of losses
    if iter % plot_every == 0:
        all_losses.append(current_loss / plot_every)
        current_loss = 0

5% (0m 17s) 2.2208 Horigome / Japanese ✓
10% (0m 36s) 1.6752 Miazga / Japanese ✗ (Polish)
15% (0m 54s) 0.1778 Yukhvidov / Russian ✓
20% (1m 12s) 1.5856 Mclaughlin / Irish ✗ (Scottish)
25% (1m 31s) 0.6552 Banh / Vietnamese ✓
30% (1m 49s) 1.5547 Machado / Japanese ✗ (Portuguese)
35% (2m 7s) 0.0168 Fotopoulos / Greek ✓
40% (2m 25s) 1.1464 Quirke / Irish ✓
45% (2m 44s) 1.7532 Reier / French ✗ (German)
50% (3m 2s) 0.8413 Hou / Chinese ✓
55% (3m 21s) 0.8587 Duan / Vietnamese ✗ (Chinese)
60% (3m 39s) 0.2047 Giang / Vietnamese ✓
65% (3m 58s) 2.5534 Cober / French ✗ (Czech)
70% (4m 16s) 1.5163 Mateus / Arabic ✗ (Portuguese)
75% (4m 34s) 0.2217 Hamilton / Scottish ✓
80% (4m 53s) 0.4456 Maessen / Dutch ✓
85% (5m 11s) 0.0239 Gan / Chinese ✓
90% (5m 29s) 0.0521 Bellomi / Italian ✓
95% (5m 48s) 0.0867 Vozgov / Russian ✓
100000 100% (6m 6s) 0.2730 Tong / Vietnamese ✓

绘制结果¶

绘制 all_losses 中的历史损失表明网络正在学习。

import matplotlib.pyplot as plt
import matplotlib.ticker as ticker

plt.figure()
plt.plot(all_losses)

[<matplotlib.lines.Line2D object at 0x7f41386d2860>]

评估结果¶

为了查看网络在不同类别上的表现如何，我们将创建一个混淆矩阵，用于指示对于每种实际语言（行）网络猜测了哪种语言（列）。为了计算混淆矩阵，许多样本将使用 evaluate() 通过网络运行，该函数与 train() 相同，只是没有反向传播。

# Keep track of correct guesses in a confusion matrix
confusion = torch.zeros(n_categories, n_categories)
n_confusion = 10000

# Just return an output given a line
def evaluate(line_tensor):
    hidden = rnn.initHidden()

    for i in range(line_tensor.size()[0]):
        output, hidden = rnn(line_tensor[i], hidden)

    return output

# Go through a bunch of examples and record which are correctly guessed
for i in range(n_confusion):
    category, line, category_tensor, line_tensor = randomTrainingExample()
    output = evaluate(line_tensor)
    guess, guess_i = categoryFromOutput(output)
    category_i = all_categories.index(category)
    confusion[category_i][guess_i] += 1

# Normalize by dividing every row by its sum
for i in range(n_categories):
    confusion[i] = confusion[i] / confusion[i].sum()

# Set up plot
fig = plt.figure()
ax = fig.add_subplot(111)
cax = ax.matshow(confusion.numpy())
fig.colorbar(cax)

# Set up axes
ax.set_xticklabels([''] + all_categories, rotation=90)
ax.set_yticklabels([''] + all_categories)

# Force label at every tick
ax.xaxis.set_major_locator(ticker.MultipleLocator(1))
ax.yaxis.set_major_locator(ticker.MultipleLocator(1))

# sphinx_gallery_thumbnail_number = 2
plt.show()

您可以找出主对角线以外的亮点，这些亮点表明网络错误地猜测了哪些语言，例如将中文误认为韩语，将西班牙语误认为意大利语。它似乎对希腊语的识别非常好，对英语的识别很差（可能是因为与其他语言有重叠）。

运行用户输入¶

def predict(input_line, n_predictions=3):
    print('\n> %s' % input_line)
    with torch.no_grad():
        output = evaluate(lineToTensor(input_line))

        # Get top N categories
        topv, topi = output.topk(n_predictions, 1, True)
        predictions = []

        for i in range(n_predictions):
            value = topv[0][i].item()
            category_index = topi[0][i].item()
            print('(%.2f) %s' % (value, all_categories[category_index]))
            predictions.append([value, all_categories[category_index]])

predict('Dovesky')
predict('Jackson')
predict('Satoshi')

> Dovesky
(-0.23) Czech
(-2.02) Russian
(-3.35) English

> Jackson
(-0.20) Scottish
(-2.51) Russian
(-3.05) Greek

> Satoshi
(-0.91) Italian
(-1.26) Japanese
(-1.57) Polish

在 Practical PyTorch 存储库中的最终版本将上述代码拆分成了几个文件。

data.py（加载文件）。
model.py（定义 RNN）。
train.py（运行训练）。
predict.py（使用命令行参数运行 predict()）。
server.py（使用 bottle.py 将预测作为 JSON API 提供服务）。

运行 train.py 来训练并保存网络。

运行 predict.py 并输入一个名称来查看预测结果。

$ python predict.py Hazaki
(-0.42) Japanese
(-1.39) Polish
(-3.51) Czech

运行 server.py 并访问 http://localhost:5533/Yourname 获取预测结果的 JSON 输出。

练习¶

尝试使用不同的行到类别的 dataset，例如
- 任何单词 -> 语言
- 名字 -> 性别
- 角色名称 -> 作者
- 页面标题 -> 博客或 subreddit
使用更大或形状更好的网络获得更好的结果。
- 添加更多线性层。
- 尝试 nn.LSTM 和 nn.GRU 层。
- 将多个 RNN 组合成更高级别的网络。

脚本的总运行时间：（6 分钟 19.168 秒）

Sphinx-Gallery 生成的画廊