评价此页

★ ★ ★ ★ ★

intermediate/char_rnn_classification_tutorial

在 Google Colab 中运行

注意

请跳转到末尾下载完整的示例代码。

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

创建日期：2017 年 3 月 24 日 | 上次更新：2025 年 11 月 11 日 | 上次验证：2024 年 11 月 05 日

作者： Sean Robertson

本教程是三部曲系列的一部分

我们将构建并训练一个基础的字符级循环神经网络（RNN）来对单词进行分类。本教程与另外两个“从零开始”的自然语言处理（NLP）教程——《从零开始的 NLP：使用字符级 RNN 生成名称》和《从零开始的 NLP：使用序列到序列网络和注意力机制进行翻译》共同展示了如何对数据进行预处理以进行 NLP 建模。特别地，这些教程展示了 NLP 建模中的预处理在底层是如何运作的。

字符级 RNN 将单词读取为一系列字符，在每一步输出预测结果和“隐藏状态”（hidden state），并将前一个隐藏状态输入到下一步中。我们将最后的预测作为输出，即该单词属于哪一个类别。

具体来说，我们将使用来自 18 个语种的几千个姓氏进行训练，并根据拼写预测该姓名来自哪种语言。

准备 Torch#

设置 torch 默认使用合适的设备，根据你的硬件（CPU 或 CUDA）使用 GPU 加速。

import torch

# Check if CUDA is available
device = torch.device('cpu')
if torch.cuda.is_available():
    device = torch.device('cuda')

torch.set_default_device(device)
print(f"Using device = {torch.get_default_device()}")

Using device = cuda:0

准备数据#

从此处下载数据并解压到当前目录。

在 data/names 目录中包含 18 个名为 [Language].txt 的文本文件。每个文件包含大量姓名，每行一个姓名，大多已罗马化（但我们仍需将其从 Unicode 转换为 ASCII）。

第一步是定义和清洗数据。首先，我们需要将 Unicode 转换为纯 ASCII，以限制 RNN 输入层的维度。这通过将 Unicode 字符串转换为 ASCII 并仅保留一小组允许的字符来实现。

import string
import unicodedata

# We can use "_" to represent an out-of-vocabulary character, that is, any character we are not handling in our model
allowed_characters = string.ascii_letters + " .,;'" + "_"
n_letters = len(allowed_characters)

# 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 allowed_characters
    )

这是一个将 Unicode 字母姓名转换为纯 ASCII 的示例。这简化了输入层。

print (f"converting 'Ślusàrski' to {unicodeToAscii('Ślusàrski')}")

converting 'Ślusàrski' to Slusarski

将姓名转换为张量#

现在我们已经整理好了所有的姓名，我们需要将它们转换为张量（Tensors）才能使用它们。

为了表示单个字母，我们使用大小为 <1 x n_letters> 的“独热向量”（one-hot vector）。独热向量除了在当前字母对应的索引处为 1 外，其余位置均为 0，例如 "b" = <0 1 0 0 0 ...>。

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

那个额外的 1 维是因为 PyTorch 假设所有内容都是分批次（batch）的——这里我们只是使用了大小为 1 的批次。

# Find letter index from all_letters, e.g. "a" = 0
def letterToIndex(letter):
    # return our out-of-vocabulary character if we encounter a letter unknown to our model
    if letter not in allowed_characters:
        return allowed_characters.find("_")
    else:
        return allowed_characters.find(letter)

# 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

以下是一些如何对单个和多个字符字符串使用 lineToTensor() 的示例。

print (f"The letter 'a' becomes {lineToTensor('a')}") #notice that the first position in the tensor = 1
print (f"The name 'Ahn' becomes {lineToTensor('Ahn')}") #notice 'A' sets the 27th index to 1

The letter 'a' becomes tensor([[[1., 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., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,
          0., 0., 0., 0., 0., 0., 0.]]], device='cuda:0')
The name 'Ahn' becomes 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., 1., 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., 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., 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., 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., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,
          0., 0., 0., 0., 0., 0., 0.]]], device='cuda:0')

恭喜，你已经为这项学习任务构建了基础的张量对象！你可以将类似的方法应用于其他文本 RNN 任务。

接下来，我们需要将所有示例组合成一个数据集，以便训练、测试和验证我们的模型。为此，我们将使用 Dataset 和 DataLoader 类来保存我们的数据集。每个 Dataset 需要实现三个函数：__init__、__len__ 和 __getitem__。

from io import open
import glob
import os
import time

import torch
from torch.utils.data import Dataset

class NamesDataset(Dataset):

    def __init__(self, data_dir):
        self.data_dir = data_dir #for provenance of the dataset
        self.load_time = time.localtime #for provenance of the dataset
        labels_set = set() #set of all classes

        self.data = []
        self.data_tensors = []
        self.labels = []
        self.labels_tensors = []

        #read all the ``.txt`` files in the specified directory
        text_files = glob.glob(os.path.join(data_dir, '*.txt'))
        for filename in text_files:
            label = os.path.splitext(os.path.basename(filename))[0]
            labels_set.add(label)
            lines = open(filename, encoding='utf-8').read().strip().split('\n')
            for name in lines:
                self.data.append(name)
                self.data_tensors.append(lineToTensor(name))
                self.labels.append(label)

        #Cache the tensor representation of the labels
        self.labels_uniq = list(labels_set)
        for idx in range(len(self.labels)):
            temp_tensor = torch.tensor([self.labels_uniq.index(self.labels[idx])], dtype=torch.long)
            self.labels_tensors.append(temp_tensor)

    def __len__(self):
        return len(self.data)

    def __getitem__(self, idx):
        data_item = self.data[idx]
        data_label = self.labels[idx]
        data_tensor = self.data_tensors[idx]
        label_tensor = self.labels_tensors[idx]

        return label_tensor, data_tensor, data_label, data_item

在这里，我们可以将示例数据加载到 NamesDataset 中。

alldata = NamesDataset("data/names")
print(f"loaded {len(alldata)} items of data")
print(f"example = {alldata[0]}")

loaded 20074 items of data
example = (tensor([13], device='cuda:0'), 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., 0., 1., 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., 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., 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., 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., 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., 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., 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., 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., 0., 0., 0., 0., 0.,
          0., 0., 0., 0., 0., 0., 0.]]], device='cuda:0'), 'Arabic', 'Khoury')

使用 dataset 对象可以让我们轻松地将数据拆分为训练集和测试集。这里我们创建了一个 85/15 的: 拆分，但 torch.utils.data 还有更多实用的工具。这里我们指定了一个生成器（generator），因为我们需要使用

与上文 PyTorch 默认设置相同的设备。

train_set, test_set = torch.utils.data.random_split(alldata, [.85, .15], generator=torch.Generator(device=device).manual_seed(2024))

print(f"train examples = {len(train_set)}, validation examples = {len(test_set)}")

train examples = 17063, validation examples = 3011

现在我们有了一个包含 20074 个示例的基础数据集，其中每个示例都是标签和姓名的配对。我们还将数据集拆分为训练集和测试集，以便验证我们构建的模型。

创建网络#

在自动求导（autograd）出现之前，在 Torch 中创建循环神经网络涉及在多个时间步上克隆层的参数。这些层持有隐藏状态和梯度，而现在这些完全由计算图本身处理。这意味着你可以以一种非常“纯粹”的方式将 RNN 实现为常规的前馈层。

这个 CharRNN 类实现了一个包含三个组件的 RNN。首先，我们使用 nn.RNN 实现。接下来，我们定义一个将 RNN 隐藏层映射到输出的层。最后，我们应用 softmax 函数。与将每一层实现为 nn.Linear 相比，使用 nn.RNN 可以显著提高性能（例如使用 cuDNN 加速内核）。它还简化了 forward() 中的实现。

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

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

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

    def forward(self, line_tensor):
        rnn_out, hidden = self.rnn(line_tensor)
        output = self.h2o(hidden[0])
        output = self.softmax(output)

        return output

然后我们可以创建一个具有 58 个输入节点、128 个隐藏节点和 18 个输出的 RNN。

n_hidden = 128
rnn = CharRNN(n_letters, n_hidden, len(alldata.labels_uniq))
print(rnn)

CharRNN(
  (rnn): RNN(58, 128)
  (h2o): Linear(in_features=128, out_features=18, bias=True)
  (softmax): LogSoftmax(dim=1)
)

之后，我们可以将张量传递给 RNN 以获得预测输出。随后，我们使用辅助函数 label_from_output 来推导该类别的文本标签。

def label_from_output(output, output_labels):
    top_n, top_i = output.topk(1)
    label_i = top_i[0].item()
    return output_labels[label_i], label_i

input = lineToTensor('Albert')
output = rnn(input) #this is equivalent to ``output = rnn.forward(input)``
print(output)
print(label_from_output(output, alldata.labels_uniq))

tensor([[-2.7798, -2.8948, -2.8031, -3.0412, -2.9618, -2.8963, -3.0350, -2.7980,
         -2.7440, -2.9272, -2.8874, -2.9215, -3.0767, -2.9513, -2.8575, -2.7906,
         -2.8100, -2.9286]], device='cuda:0', grad_fn=<LogSoftmaxBackward0>)
('Portuguese', 8)

训练#

训练网络#

现在训练这个网络所需要做的就是给它展示大量的例子，让它进行猜测，并告诉它是否猜错了。

我们通过定义一个 train() 函数来实现这一点，该函数使用小批量（minibatches）在给定数据集上训练模型。RNN 的训练与其他网络类似；因此，为了完整起见，我们在这里包含了一个批处理训练方法。循环（for i in batch）在调整权重之前计算批次中每个项目的损失。此操作重复执行，直到达到指定的轮数（epochs）。

import random
import numpy as np

def train(rnn, training_data, n_epoch = 10, n_batch_size = 64, report_every = 50, learning_rate = 0.2, criterion = nn.NLLLoss()):
    """
    Learn on a batch of training_data for a specified number of iterations and reporting thresholds
    """
    # Keep track of losses for plotting
    current_loss = 0
    all_losses = []
    rnn.train()
    optimizer = torch.optim.SGD(rnn.parameters(), lr=learning_rate)

    start = time.time()
    print(f"training on data set with n = {len(training_data)}")

    for iter in range(1, n_epoch + 1):
        rnn.zero_grad() # clear the gradients

        # create some minibatches
        # we cannot use dataloaders because each of our names is a different length
        batches = list(range(len(training_data)))
        random.shuffle(batches)
        batches = np.array_split(batches, len(batches) //n_batch_size )

        for idx, batch in enumerate(batches):
            batch_loss = 0
            for i in batch: #for each example in this batch
                (label_tensor, text_tensor, label, text) = training_data[i]
                output = rnn.forward(text_tensor)
                loss = criterion(output, label_tensor)
                batch_loss += loss

            # optimize parameters
            batch_loss.backward()
            nn.utils.clip_grad_norm_(rnn.parameters(), 3)
            optimizer.step()
            optimizer.zero_grad()

            current_loss += batch_loss.item() / len(batch)

        all_losses.append(current_loss / len(batches) )
        if iter % report_every == 0:
            print(f"{iter} ({iter / n_epoch:.0%}): \t average batch loss = {all_losses[-1]}")
        current_loss = 0

    return all_losses

我们现在可以按指定的轮数使用小批量训练数据集。此示例的轮数已减少以加快构建速度。使用不同的参数可以获得更好的结果。

start = time.time()
all_losses = train(rnn, train_set, n_epoch=27, learning_rate=0.15, report_every=5)
end = time.time()
print(f"training took {end-start}s")

training on data set with n = 17063
(19%):         average batch loss = 0.879735651495072
(37%):        average batch loss = 0.6876146075196732
(56%):        average batch loss = 0.5736018509482841
(74%):        average batch loss = 0.490441005729126
(93%):        average batch loss = 0.4329366212957439
training took 346.158771276474s

绘制结果#

绘制来自 all_losses 的历史损失可以显示网络的学习情况。

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

plt.figure()
plt.plot(all_losses)
plt.show()

评估结果#

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

def evaluate(rnn, testing_data, classes):
    confusion = torch.zeros(len(classes), len(classes))

    rnn.eval() #set to eval mode
    with torch.no_grad(): # do not record the gradients during eval phase
        for i in range(len(testing_data)):
            (label_tensor, text_tensor, label, text) = testing_data[i]
            output = rnn(text_tensor)
            guess, guess_i = label_from_output(output, classes)
            label_i = classes.index(label)
            confusion[label_i][guess_i] += 1

    # Normalize by dividing every row by its sum
    for i in range(len(classes)):
        denom = confusion[i].sum()
        if denom > 0:
            confusion[i] = confusion[i] / denom

    # Set up plot
    fig = plt.figure()
    ax = fig.add_subplot(111)
    cax = ax.matshow(confusion.cpu().numpy()) #numpy uses cpu here so we need to use a cpu version
    fig.colorbar(cax)

    # Set up axes
    ax.set_xticks(np.arange(len(classes)), labels=classes, rotation=90)
    ax.set_yticks(np.arange(len(classes)), labels=classes)

    # 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()



evaluate(rnn, test_set, classes=alldata.labels_uniq)

你可以从主轴外挑出亮点，这些点显示了它错误猜测的语言，例如将韩语猜成中文，将意大利语猜成西班牙语。它似乎在希腊语上表现非常好，而在英语上表现很差（可能是因为与其他语言有重叠）。

练习#

通过更大和/或形状更好的网络获得更好的结果
- 调整超参数以增强性能，例如更改轮数（epochs）、批次大小（batch size）和学习率（learning rate）
- 尝试 nn.LSTM 和 nn.GRU 层
- 修改层的尺寸，例如增加或减少隐藏节点的数量或添加额外的线性层
- 将多个此类 RNN 组合为一个更高级的网络
尝试使用不同的“行 -> 标签”数据集，例如：
- 任意单词 -> 语言
- 名字 -> 性别
- 角色名字 -> 作家
- 页面标题 -> 博客或子版块（subreddit）

脚本总运行时间：（5 分 52.383 秒）