1、基础知识

参考文章：8.4. 循环神经网络

2、从零开始实现

本节将上述描述，从头开始基于循环神经网络实现字符级语言模型。这样的模型将在H.G.Wells的时光机器数据集上训练。首先，我们先读取数据集。

%matplotlib inline
import math
import torch
from torch import nn
from torch.nn import functional as F
from d2l import torch as d2l

batch_size, num_steps = 32, 35
# 生成可迭代对象数据集，每次拿出一个batch
## train_iter: 训练数据迭代器，用于产生训练数据的批次
train_iter, vocab = d2l.load_data_time_machine(batch_size, num_steps)

（1）独热编码

回想一下，在train_iter中，每个词元都表示为一个数字索引，将这些索引直接输入神经网络可能会使学习变得困难。我们通常将每个词元表示为更具表现力的特征向量，最简单的表示称为独热编码（one-hot encoding）。

F.one_hot(torch.tensor([0, 2]), len(vocab))


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, 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]])

我们每次采样的小批量数据形状是二维张量： （批量大小，时间步数）。 one_hot函数将这样一个小批量数据转换成三维张量，张量的最后一个维度等于词表大小（len(vocab)）。我们经常转换输入的维度，以便获得形状为 （时间步数，批量大小，词表大小） 的输出。这将使我们能够更方便地通过最外层的维度，一步一步地更新小批量数据的隐状态。

X = torch.arange(10).reshape((2, 5))
F.one_hot(X.T, 28).shape


torch.Size([5, 2, 28])

（2）初始化模型参数

接下来，我们初始化循环神经网络模型的模型参数。 隐藏单元数num_hiddens是一个可调的超参数。当训练语言模型时，输入和输出来自相同的词表。因此，它们具有相同的维度，即词表的大小。

def get_params(vocab_size, num_hiddens, device):
    num_inputs = num_outputs = vocab_size		# 输入输出来自相同词表，因此规定维度都等于词表大小

    def normal(shape):
        return torch.randn(size=shape, device=device) * 0.01

    # 隐藏层参数		H = (W1X + W2H + b1)
    W_xh = normal((num_inputs, num_hiddens))
    W_hh = normal((num_hiddens, num_hiddens))
    b_h = torch.zeros(num_hiddens, device=device)
    # 输出层参数		Y = (W3H + b2)
    W_hq = normal((num_hiddens, num_outputs))
    b_q = torch.zeros(num_outputs, device=device)
    # 附加梯度
    params = [W_xh, W_hh, b_h, W_hq, b_q]
    for param in params:
        param.requires_grad_(True)		# 设置可以求梯度
    return params

（3）循环神经网络模型

为了定义循环神经网络模型，我们首先需要一个init_rnn_state函数在初始化时返回隐状态。这个函数的返回是一个张量，张量全用0填充，形状为（批量大小，隐藏单元数）。在后面的章节中我们将会遇到隐状态包含多个变量的情况，而使用元组可以更容易地处理些。

def init_rnn_state(batch_size, num_hiddens, device):
    return (torch.zeros((batch_size, num_hiddens), device=device), )

下面的rnn函数定义了如何在一个时间步内计算隐状态和输出。循环神经网络模型通过inputs最外层的维度实现循环，以便逐时间步更新小批量数据的隐状态H。此外，这里使用函数作为激活函数。如之前所述， 当元素在实数上满足均匀分布时，tanh函数的平均值为0。

# 一个时间步内计算隐藏状态和输出（前向传播函数）
def rnn(inputs, state, params):
    # inputs的形状：(时间步数量，批量大小，词表大小)
    W_xh, W_hh, b_h, W_hq, b_q = params
    H, = state						## 将H构造成元组形势
    outputs = []
    # X的形状：(批量大小，词表大小)
    for X in inputs:				## 按时间步数进行遍历
        H = torch.tanh(torch.mm(X, W_xh) + torch.mm(H, W_hh) + b_h)
        Y = torch.mm(H, W_hq) + b_q
        outputs.append(Y)
    # 返回的第一个参数：将会把outputs在维度0上进行拼接，形成一个新的张量，即按行展开
    # 返回的第二个参数：(H,)是一个元组，其中包含了最后一个时间步的隐藏状态H。这个元组的目的是将隐藏状态作为下一个时间步的初始隐藏状态返回，以便在下一次调用rnn函数时使用。
    return torch.cat(outputs, dim=0), (H,)

定义了所有需要的函数之后，接下来我们创建一个类来包装这些函数，并存储从零开始实现的循环神经网络模型的参数。

class RNNModelScratch: #@save
    """从零开始实现的循环神经网络模型"""
    def __init__(self, vocab_size, num_hiddens, device,
                 get_params, init_state, forward_fn):
        self.vocab_size, self.num_hiddens = vocab_size, num_hiddens
        self.params = get_params(vocab_size, num_hiddens, device)
        self.init_state, self.forward_fn = init_state, forward_fn

    def __call__(self, X, state):
   		# 进行转置的目的是为了变成(时间步数，批量大小，词表大小)，便于直接对外层按时间步数进行遍历
   		# .type(torch.float32) 是将独热编码后的数据类型转换为 torch.float32，以便与模型的参数进行计算。
        X = F.one_hot(X.T, self.vocab_size).type(torch.float32)
        return self.forward_fn(X, state, self.params)

    def begin_state(self, batch_size, device):
        return self.init_state(batch_size, self.num_hiddens, device)

这段代码定义了一个循环神经网络（RNN）模型类RNNModelScratch。这个类是从零开始实现的，没有使用任何深度学习框架的内置函数。

构造函数 __init__ 接受以下参数：

vocab_size：词汇大小，表示输入数据的可能取值的个数。
num_hiddens：隐藏层的大小，即每个时间步输入和输出的特征向量的维度。
device：设备（例如CPU或GPU）。
get_params：一个函数，用于获取模型的参数。
init_state：一个函数，用于初始化模型的隐藏状态。
forward_fn：一个函数，用于实现前向传播。

__call__ 方法用于模型调用，接受输入数据 X 和隐藏状态 state。它首先将输入数据 X 转换为独热编码，并将数据类型转换为 torch.float32。然后调用 forward_fn 函数进行前向传播，并返回结果。

begin_state 方法用于创建初始隐藏状态。它接受批处理大小 batch_size 和设备 device 作为输入，并调用 init_state 函数来生成一个具有指定大小和设备的隐藏状态。

总之，这个类提供了一个从零开始实现的循环神经网络模型的框架，用户可以自己定义 get_params、init_state 和 forward_fn 函数来实现自定义的RNN模型。

让我们检查输出是否具有正确的形状。例如，隐状态的维数是否保持不变。

num_hiddens = 512
# 模型初始化，参数：(vocab_size, num_hiddens, device, get_params, init_state, forward_fn)
net = RNNModelScratch(len(vocab), num_hiddens, d2l.try_gpu(), get_params, init_rnn_state, rnn)
# 用于创建初始隐藏状态
state = net.begin_state(X.shape[0], d2l.try_gpu())
# 给__call__传入参数：(X, state)
Y, new_state = net(X.to(d2l.try_gpu()), state)
# 查看输出形状是否正确
Y.shape, len(new_state), new_state[0].shape


(torch.Size([10, 28]), 1, torch.Size([2, 512]))

我们可以看到输出形状是（时间步数 $\times$ 批量大小，词表大小），而隐状态形状保持不变，即（批量大小，隐藏单元数）。

（4）预测（预热期）

让我们首先定义预测函数来生成prefix之后的新字符，其中的prefix是一个用户提供的包含多个字符的字符串。在循环遍历prefix中的开始字符时，我们不断地将隐状态传递到下一个时间步，但是不生成任何输出。这被称为预热（warm-up）期，因为在此期间模型会自我更新（例如，更新隐状态），但不会进行预测。预热期结束后，隐状态的值通常比刚开始的初始值更适合预测，从而预测字符并输出它们。

# prefix：用户提供的字符串，num_preds：向后预测的字符数
def predict_ch8(prefix, num_preds, net, vocab, device):  #@save
    """在prefix后面生成新字符"""
    state = net.begin_state(batch_size=1, device=device)	    ## 生成初始隐藏状态
    outputs = [vocab[prefix[0]]]								## 获取第一个字符的索引   
    # 定义了一个函数：将outputs最新的token（上一次预测得到的）作为新的输入
    get_input = lambda: torch.tensor([outputs[-1]], device=device).reshape((1, 1))					
    # 预热期
    # 根据真实值来初始化参数state
    for y in prefix[1:]:  
        _, state = net(get_input(), state)						## 输入和隐藏状态传入网络，更新隐藏状态
        outputs.append(vocab[y])								## 把真实值放入输出
    # 进行预测
    for _ in range(num_preds):  # 预测num_preds步
        y, state = net(get_input(), state)						## 输入和隐藏状态传入网络，更新预测值和隐藏状态
        outputs.append(int(y.argmax(dim=1).reshape(1)))			## 获取概率最大的类别的索引。然后，将这个索引转换为整数类型，并通过调用reshape方法将其形状调整为(1,)，即一个大小为1的向量。
    # 将整形转换成token，再变成字符串然后输出
    return ''.join([vocab.idx_to_token[i] for i in outputs])

这段代码定义了一个函数predict_ch8，用于生成给定前缀prefix后面的新字符。函数的输入参数包括前缀prefix、要生成的字符数量num_preds、神经网络模型net、词汇表vocab和设备device。

函数首先通过调用net.begin_state方法初始化模型的隐藏状态state，并将前缀的第一个字符转换为对应的索引值，并存储在outputs列表中。函数get_input用于获取模型输入的张量，通过调用reshape方法将张量的形状调整为(1, 1)。

然后，函数通过一个循环遍历前缀中的每个字符（除了第一个字符），在每一步中，将当前字符的索引作为输入，通过调用net模型和当前的隐藏状态state来获取下一个字符的预测结果。这个预测结果被添加到outputs列表中。

接下来，函数通过另一个循环生成指定数量num_preds的新字符。在每一步中，函数将当前字符的索引作为输入，通过调用net模型和当前的隐藏状态state来获取下一个字符的预测结果。这个预测结果被添加到outputs列表中。

最后，函数将outputs列表中的索引值转换为对应的字符，并将它们连接起来，返回生成的字符串。

总而言之，这段代码定义了一个函数，用于根据给定的前缀生成一串新的字符。

现在我们可以测试predict_ch8函数。我们将前缀指定为time traveller，并基于这个前缀生成10个后续字符。鉴于我们还没有训练网络，它会生成荒谬的预测结果。

predict_ch8('time traveller ', 10, net, vocab, d2l.try_gpu())

'time traveller vxs dyhmat'

（5）梯度剪裁

有时梯度可能很大（梯度爆炸），从而优化算法可能无法收敛。我们可以通过降低 $\eta$ 的学习率来解决这个问题。但是如果我们很少得到大的梯度呢？

在这种情况下，这种做法似乎毫无道理。一个流行的替代方案是通过将梯度 $\mathbf{g}$ 投影回给定半径（例如 $\theta$ ）的球来裁剪梯度 $\mathbf{g}$ 。 如下式：

$\mathbf{g} \leftarrow \min\left(1, \frac{\theta}{\|\mathbf{g}\|}\right) \mathbf{g}.$

通过这样做，我们知道梯度范数永远不会超过 $\theta$ ，并且更新后的梯度完全与 $\mathbf{g}$ 的原始方向对齐。它还有一个值得拥有的副作用，即限制任何给定的小批量数据（以及其中任何给定的样本）对参数向量的影响，这赋予了模型一定程度的稳定性。梯度裁剪提供了一个快速修复梯度爆炸的方法，虽然它并不能完全解决问题，但它是众多有效的技术之一。

下面我们定义一个函数来裁剪模型的梯度，模型是从零开始实现的模型或由高级API构建的模型。我们在此计算了所有模型参数的梯度的范数。

def grad_clipping(net, theta):  #@save
    """裁剪梯度"""
    # 获取参数
    if isinstance(net, nn.Module):
        params = [p for p in net.parameters() if p.requires_grad]
    else:
        params = net.params
    # 对所有层的梯度平方后求和，再开根号
    norm = torch.sqrt(sum(torch.sum((p.grad ** 2)) for p in params))
    # 梯度剪裁
    if norm > theta:
        for param in params:
            param.grad[:] *= theta / norm

（6）训练

在训练模型之前，让我们定义一个函数在一个迭代周期内训练模型。它与我们训练softmax回归模型的方式有三个不同之处。

序列数据的不同采样方法（随机采样和顺序分区）将导致隐状态初始化的差异。
我们在更新模型参数之前裁剪梯度。这样的操作的目的是，即使训练过程中某个点上发生了梯度爆炸，也能保证模型不会发散。
我们用困惑度来评价模型，这样的度量确保了不同长度的序列具有可比性。

具体来说，当使用顺序分区时，我们只在每个迭代周期的开始位置初始化隐状态。由于下一个小批量数据中的第 $i$ 个子序列样本与当前第 $i$ 个子序列样本相邻，因此当前小批量数据最后一个样本的隐状态，将用于初始化下一个小批量数据第一个样本的隐状态。

这样，存储在隐状态中的序列的历史信息可以在一个迭代周期内流经相邻的子序列。然而，在任何一点隐状态的计算，都依赖于同一迭代周期中前面所有的小批量数据，这使得梯度计算变得复杂。 为了降低计算量，在处理任何一个小批量数据之前，我们先分离梯度，使得隐状态的梯度计算总是限制在一个小批量数据的时间步内。

当使用随机抽样时，因为每个样本都是在一个随机位置抽样的，因此需要为每个迭代周期重新初始化隐状态。与softmax回归中的 train_epoch_ch3函数相同， updater是更新模型参数的常用函数。它既可以是从头开始实现的d2l.sgd函数，也可以是深度学习框架中内置的优化函数。

# 在一个迭代周期内训练神经网络模型。迭代周期是指对整个训练数据集进行一次完整的遍历。
#@save
def train_epoch_ch8(net, train_iter, loss, updater, device, use_random_iter):
    """训练网络一个迭代周期（定义见第8章）"""
    state, timer = None, d2l.Timer()	# 初始化状态变量和计时器
    metric = d2l.Accumulator(2)  		# 累加器：训练损失之和,词元数量
    for X, Y in train_iter:				# 通过遍历训练数据迭代器 train_iter 获取每个批次的输入数据 X 和标签数据 Y
        if state is None or use_random_iter:	# 如果是第一次迭代或者使用随机抽样方式初始化状态，则调用神经网络模型的 begin_state 方法来初始化状态 state
            # 在第一次迭代或使用随机抽样（前一个sequences和当前不连续）时初始化state
            state = net.begin_state(batch_size=X.shape[0], device=device)
        else:
            if isinstance(net, nn.Module) and not isinstance(state, tuple):		# 如果神经网络模型是 nn.Module 类型且状态 state 不是元组类型，则调用 detach_() 方法将状态 state 变为张量类型
                # state对于nn.GRU是个张量
                state.detach_()		# 将张量从计算图中分离出来
            else:
                # state对于nn.LSTM或对于我们从零开始实现的模型是个张量
                for s in state:
                    s.detach_()
        y = Y.T.reshape(-1)					# 将标签数据 Y 转置并展开为一维张量 y
        X, y = X.to(device), y.to(device)	# 将输入数据 X 和标签数据 y 移动到指定的计算设备上
        y_hat, state = net(X, state)		# 调用神经网络模型 net，传入输入数据 X 和状态 state，得到输出预测 y_hat 和更新后的状态 state
        l = loss(y_hat, y.long()).mean()	# 计算预测值 y_hat 与标签值 y 的损失，使用损失函数 loss 并取均值
        if isinstance(updater, torch.optim.Optimizer):	# 如果 updater 是 torch.optim.Optimizer 类型
            updater.zero_grad()
            l.backward()
            grad_clipping(net, 1)		# 对梯度进行裁剪
            updater.step()
        else:
            l.backward()
            grad_clipping(net, 1)
            # 因为已经调用了mean函数
            updater(batch_size=1)
        metric.add(l * y.numel(), y.numel())		# 使用累加器 metric 将损失值乘以标签数据的数量累加到第一个指标中，将标签数据的数量累加到第二个指标中
    return math.exp(metric[0] / metric[1]), metric[1] / timer.stop()		# 返回模型的困惑度（将第一个指标指数化）和每秒处理的词元数量（总词元数量除以计时器的停止时间）

循环神经网络模型的训练函数既支持从零开始实现，也可以使用高级API来实现。

#@save
def train_ch8(net, train_iter, vocab, lr, num_epochs, device,
              use_random_iter=False):
    """训练模型（定义见第8章）"""
    loss = nn.CrossEntropyLoss()				# 定义损失函数
    animator = d2l.Animator(xlabel='epoch', ylabel='perplexity',
                            legend=['train'], xlim=[10, num_epochs])									# 可视化设置 
    # 初始化
    if isinstance(net, nn.Module):
        updater = torch.optim.SGD(net.parameters(), lr)
    else:
        updater = lambda batch_size: d2l.sgd(net.params, lr, batch_size)
    predict = lambda prefix: predict_ch8(prefix, 50, net, vocab, device)
    # 训练和预测
    for epoch in range(num_epochs):
        ppl, speed = train_epoch_ch8(
            net, train_iter, loss, updater, device, use_random_iter)
        if (epoch + 1) % 10 == 0:
            print(predict('time traveller'))
            animator.add(epoch + 1, [ppl])
    print(f'困惑度 {ppl:.1f}, {speed:.1f} 词元/秒 {str(device)}')
    print(predict('time traveller'))
    print(predict('traveller'))

现在，我们训练循环神经网络模型。因为我们在数据集中只使用了10000个词元，所以模型需要更多的迭代周期来更好地收敛。

num_epochs, lr = 500, 1
train_ch8(net, train_iter, vocab, lr, num_epochs, d2l.try_gpu())


困惑度 1.0, 72303.8 词元/秒 cuda:0
time travelleryou can show black is white by argument said filby
traveller with a slight accession ofcheerfulness really thi

在这里插入图片描述

最后，让我们检查一下使用随机抽样方法的结果。

net = RNNModelScratch(len(vocab), num_hiddens, d2l.try_gpu(), get_params,
                      init_rnn_state, rnn)
train_ch8(net, train_iter, vocab, lr, num_epochs, d2l.try_gpu(),
          use_random_iter=True)


困惑度 1.4, 70725.7 词元/秒 cuda:0
time travellerit s against reason said filbywhan seane of the fi
travellerit s against reason said filbywhan seane of the fi

在这里插入图片描述
从零开始实现上述循环神经网络模型，虽然有指导意义，但是并不方便。在下一节中，我们将学习如何改进循环神经网络模型。例如，如何使其实现地更容易，且运行速度更快。

参考文章：
8.5. 循环神经网络的从零开始实现、
PyTorch入门——循环神经网络RNN、
深度学习实战——循环神经网络（RNN、LSTM、GRU）

3、Pythoch内置函数简单实现

节将展示如何使用深度学习框架的高级API提供的函数更有效地实现相同的语言模型。我们仍然从读取时光机器数据集开始。

import torch
from torch import nn
from torch.nn import functional as F
from d2l import torch as d2l

batch_size, num_steps = 32, 35
train_iter, vocab = d2l.load_data_time_machine(batch_size, num_steps)

（1）定义模型

高级API提供了循环神经网络的实现。我们构造一个具有256个隐藏单元的单隐藏层的循环神经网络层rnn_layer。事实上，我们还没有讨论多层循环神经网络的意义。现在仅需要将多层理解为一层循环神经网络的输出被用作下一层循环神经网络的输入就足够了。

num_hiddens = 256
rnn_layer = nn.RNN(len(vocab), num_hiddens)

我们使用张量来初始化隐状态，它的形状是（隐藏层数，批量大小，隐藏单元数）。

state = torch.zeros((1, batch_size, num_hiddens))
state.shape

torch.Size([1, 32, 256])

通过一个隐状态和一个输入，我们就可以用更新后的隐状态计算输出。需要强调的是，rnn_layer的“输出”（Y）不涉及输出层的计算：它是指每个时间步的隐状态，这些隐状态可以用作后续输出层的输入。

X = torch.rand(size=(num_steps, batch_size, len(vocab)))
Y, state_new = rnn_layer(X, state)
Y.shape, state_new.shape

(torch.Size([35, 32, 256]), torch.Size([1, 32, 256]))

我们为一个完整的循环神经网络模型定义了一个RNNModel类。注意，rnn_layer只包含隐藏的循环层，我们还需要创建一个单独的输出层。

#@save
class RNNModel(nn.Module):
    """循环神经网络模型"""
    def __init__(self, rnn_layer, vocab_size, **kwargs):
        super(RNNModel, self).__init__(**kwargs)
        self.rnn = rnn_layer
        self.vocab_size = vocab_size
        self.num_hiddens = self.rnn.hidden_size
        # 如果RNN是双向的（之后将介绍），num_directions应该是2，否则应该是1
        if not self.rnn.bidirectional:
            self.num_directions = 1
            self.linear = nn.Linear(self.num_hiddens, self.vocab_size)
        else:
            self.num_directions = 2
            self.linear = nn.Linear(self.num_hiddens * 2, self.vocab_size)

    def forward(self, inputs, state):
        # inputs是通过访问一次train_iter得到的，形状为（batch_size, num_steps）
        # inputs.T的形状为（num_steps, batch_size）
        X = F.one_hot(inputs.T.long(), self.vocab_size)
        X = X.to(torch.float32)
        Y, state = self.rnn(X, state)
        # 全连接层首先将Y的形状改为(时间步数*批量大小,隐藏单元数)
        # 它的输出形状是(时间步数*批量大小,词表大小)。
        output = self.linear(Y.reshape((-1, Y.shape[-1])))
        return output, state

    def begin_state(self, device, batch_size=1):
        if not isinstance(self.rnn, nn.LSTM):
            # nn.GRU以张量作为隐状态
            return  torch.zeros((self.num_directions * self.rnn.num_layers,
                                 batch_size, self.num_hiddens),
                                device=device)
        else:
            # nn.LSTM以元组作为隐状态
            return (torch.zeros((
                self.num_directions * self.rnn.num_layers,
                batch_size, self.num_hiddens), device=device),
                    torch.zeros((
                        self.num_directions * self.rnn.num_layers,
                        batch_size, self.num_hiddens), device=device))

（2）训练与预测

device = d2l.try_gpu()
net = RNNModel(rnn_layer, vocab_size=len(vocab))
net = net.to(device)
d2l.predict_ch8('time traveller', 10, net, vocab, device)

'time traveller          '

很明显，这种模型根本不能输出好的结果。接下来，我们使用 8.5节中定义的超参数调用train_ch8，并且使用高级API训练模型。

num_epochs, lr = 500, 1
d2l.train_ch8(net, train_iter, vocab, lr, num_epochs, device)

perplexity 1.3, 286908.2 tokens/sec on cuda:0
time traveller came the time traveller but now you begin to spen
traveller pork acong wa canome precable thig thit lepanchat