【动手学深度学习-Pytorch版】循环神经网络-从零开始实现

"""导包并设置batch和steps大小"""
import math
import torch
from torch import nn
from torch.nn import functional as F
from d2l import torch as d2l
# num_steps是输入的小批量句子的长度
batch_size, num_steps = 32, 35

# device = torch.device("cuda:0" if torch.cuda.is_available() else "cpu")

"""读入数据集"""
train_iter, vocab = d2l.load_data_time_machine(batch_size, num_steps)
# print('train_iter前2项:',list(train_iter)[:2])
# print('前10个vocab:',list(vocab.token_to_idx.items())[:10])
"""one-hot编码:为了使用神经网络,将数据变成了向量的形式"""
oneHot_valu = F.one_hot(torch.tensor([0, 2, 5]), len(vocab))
# print('oneHot:',oneHot_valu)
X = torch.arange(10).reshape((2, 5))
# print('最初的X形状:',X.size())
"""构造一个小批量数据的size:(批量大小,时间步数)
    one-hot会在后面追加一个维度即词表大小  (批量大小,时间步数,词表大小)
    但是我们通常会将输入维度进行转换 将时间步数作为一维 (时间步数,批量大小,样本的特征长度)
    对于(5,2,28): 一共有5个时间步,即X=5 则Xt=(2,28)
    这样做以后得X_t就是一个连续的
"""

"""初始化模型参数:num_hiddens是一个可调的超参数"""
"""当训练语言模型时,输入和输出来自相同的词表。 因此,它们具有相同的维度,即词表的大小。"""


def get_params(vocab_size, num_hiddens, device):  # debug
    num_inputs = num_outputs = vocab_size
    """输入时应该是一个词的特征向量(经过了one-hot编码形成)"""
    """因为这里是做的分类,所以你的下一个预测词也是vocab类型,它可以是你vocab中的任何一个词"""

    # 这里的norma没有用到
    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))  # debug:W_hh = normal((num_inputs,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)
    # print('各个参数的形状:')
    # print('W_xh:',W_xh.size(),'W_hh:',W_hh.size(),'b_h:',b_h.size(),
    #       'W_hq:',W_hq.size(),'b_q:',b_q.size())
    # 附加梯度
    params = [W_xh, W_hh, b_h, W_hq, b_q]
    for param in params:
        param.requires_grad_(True)
    return params


"""循环神经网络模型"""


# init_rnn_state函数在初始化时返回隐状态
# 这个函数的返回是一个tuple,其中含有的张量全用0填充, 形状为(批量大小,隐藏单元数)
def init_rnn_state(batch_size, num_hiddens, device):
    return (torch.zeros((batch_size, num_hiddens), device=device),)


# rnn函数定义了[给一个小批量]如何在一个时间步内   计算隐状态 和 输出。
# 外层的for循环用来更新小批量数据的隐状态H
# 此外,这里使用tanh函数作为了激活函数

def rnn(inputs, state, params):
    # inputs 的形状:(时间步数,批量大小,词表大小) 【它包含了所有的时间步】
    # state  是一个长度为1的tuple,它的元素是给出的初始化的隐藏状态
    # params 就是模型可学习的参数
    W_xh, W_hh, b_h, W_hq, b_q = params
    H, = state
    outputs = []
    # X_t的形状:(时间步数,批量大小,词表大小)
    """for X_t in inputs会沿着inputs的第一个维度进行遍历【这也就是为什么上面要对X进行转置的原因】"""
    for X_t in inputs: #这里的H和Y都是每一个时间步更新一次
        # 矩阵乘法中的H是包含前一个时间步的隐藏状态
        H = torch.tanh(torch.mm(X_t, W_xh) + torch.mm(H, W_hh) + b_h)
        Y = torch.mm(H, W_hq) + b_q
        # print('X_t的形状:',X_t.size(),'W_xh的形状:',W_xh.size(),'H的形状:',H.size(),
        #       'W_hh的形状:',W_hh.size(),'b_h的形状:',b_h.size())
        # print('W_hq的形状:',W_hq.size(),'b_q的形状:',b_q.size())
        outputs.append(Y)
    # 返回的是基于当前时刻的输出以及包括当前时间步信息的隐藏状态
    return torch.cat(outputs, dim=0), (H,)
    # cat以后原来矩阵的列数依旧没有发生变化 还是vocab_size的大小 但是行数变成了批量大小*时间长度


# 一个时间步内计算隐藏状态和输出(前向传播函数)
"""review:
该函数与普通的MLP函数的不同:
1、inputs维度中增加了时间步维度
2、添加了state,即包括前一个时间步的隐藏状态;模型既要接受一个隐藏状态,也要输出一个更新的隐藏状态
"""
"""建立一个类包装上述函数————————并存储循环网络模型的参数
构造函数 __init__ 接受以下参数:
·vocab_size:词汇大小,表示输入数据的可能取值的个数。
·num_hiddens:隐藏层的大小,即每个时间步输入和输出的特征向量的维度。
·device:设备(例如CPU或GPU)。
·get_params:一个函数,用于获取模型的参数。
·init_state:一个函数,用于初始化模型的隐藏状态。
·forward_fn:(rnn)一个函数,用于实现前向传播。

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

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

"""


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
        # 在这里rnn函数已经成为了它的前向传播函数
        """这里的X是一开始读入的信息,其形状为(批量大小,时间步数)"""

    def __call__(self, X, state):
        # 进行转置的目的是为了变成(时间步数,批量大小,词表大小),便于直接对外层按时间步数进行遍历
        # .type(torch.float32) 是将独热编码后的数据类型转换为 torch.float32,以便与模型的参数进行计算。
        X = F.one_hot(X.T, self.vocab_size).type(torch.float32)
        # one-hot出来的都是整型,这里将它转变成了浮点型
        # print('改变后X的形状:',X.size())
        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)


"""检查输出以及隐状态的形状,其中隐状态的形状不会发生改变"""
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)
# 查看输出形状是否正确
print('Y.shape:', Y.shape, 'len(new_state):', len(new_state),
      'new_state[0].shape:', new_state[0].shape)
"""(Y的形状:批量大小*时间步数 , X的每个向量下一个预测向量,长为28)"""

# 预测predict
"""预热期:prefix是用户提供的包括多个字符的字符串,在循环遍历predix中的开始字符时
   我们不断地将隐状态传递到下一个时间步,但是不生成任何输出
经过预热期后,隐状态的值比刚刚开始时的值更加适合预测,从而开始预测下面的字符并输出它们
"""
def predict_ch8(prefix, num_preds, net, vocab, device):  # @save
    """在predix后面生成新字符"""
    state = net.begin_state(batch_size=1, device=device)
    outputs = [vocab[prefix[0]]]  # outputs是拿到第一个词的一个idx索引值
    print('outputs of the predict', outputs)
    """outputs[-1]即最近预测的那个词做成一个tensor当做输入"""
    """reshape(1,1):批量大小为1,时间步长为1"""
    get_input = lambda: torch.tensor([outputs[-1]], device=device).reshape((1, 1))
    for y in prefix[1:]:  # 预热期
        # predix[0]已经放到outputs里面了 所以从1开始遍历一遍
        """这里不存输出的原因是已经得知后面的词了 比如输入你好,在对你做预测时已经知道后面的是好"""
        _, state = net(get_input(), state)
        outputs.append(vocab[y])  # outputs是使用的真实的prefix
        # 这样就避免了使用预测导致的累积误差
    for _ in range(num_preds):  # 预测num_preds步
        # 每一个时刻把前一个时刻的预测作为输入放到Net中
        # 以此更新state 拿到输出y
        y, state = net(get_input(), state)

        outputs.append(int(y.argmax(dim=1).reshape(1)))
        # outputs就是对应的下一个词的下标
        # 通过vocab中的方法将idx转换成token 利用空字符join并返回
    return ''.join([vocab.idx_to_token[i] for i in outputs])


# 利用训练函数输出后的结果是错误的 所以后面需要训练模型然后不断看训练模型的效果
res_predict_ch8 = predict_ch8('time traveller ', 10, net, vocab, d2l.try_gpu())
print('预热期输出:',res_predict_ch8)

# 定义梯度剪裁
def grad_clipping(net, theta):  # @save
    # 如果是采用nn.Module实现的就从net.parameters()中拿出含有梯度的参数
    if isinstance(net, nn.Module):
        params = [p for p in net.parameters() if p.requires_grad]
    else:
        # 如果不是就直接从net里面将参数取出 params保存的是所有层的参数,而不是一层一层的拿出来
        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  # in-place原地操作:如果norm>theta则把它映射回去


# @save
# 如果采用随机iter的话,上一个批量的第i个样本和下一个批量第i个样本是没有任何关系的
# 如果不是则是顺序分区
def train_epoch_ch8(net, train_iter, loss, updater, device, use_random_iter):
    """训练网络一个迭代周期"""
    # state初始化为空,timer是一个计时器
    state, timer = None, d2l.Timer()  # 初始化状态变量和计时器
    # metric用来存储loss信息
    metric = d2l.Accumulator(2)  # 训练损失之和,词元数量
    for X, Y in train_iter:  # 通过遍历训练数据迭代器 train_iter 获取每个批次的输入数据 X 和标签数据 Y
        # 如果state为None则需要初始化一下state
        # 如果是用的random_iter则在每个iteration在back后会把state重新initial成0
        # 因为前一个时刻的序列的信息和当前序列信息不是连续的 所以上一个批量的state不应该用到这次的iter中
        if state is None or use_random_iter:
            # 在第一次迭代或使用随机抽样时初始化state
            state = net.begin_state(batch_size=X.shape[0], device=device)
        else:  # 如果是顺序分区则只进行detach,就是前面的计算图不要了,而只从现在开始做梯度计算
            if isinstance(net, nn.Module) and not isinstance(state, tuple):
                # 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
        """为什么要把所有的输出cat到第一个维度,因为从loss角度讲就是一个多分类的问题"""
        l = loss(y_hat, y.long()).mean()  # 计算预测值 y_hat 与标签值 y 的损失,使用损失函数 loss 并取均值
        if isinstance(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 将损失值乘以标签数据的数量累加到第一个指标中,将标签数据的数量累加到第二个指标中
        # metric[0]是小批量Loss的累加,metric[1]是有多少个样本
    return math.exp(metric[0] / metric[1]), metric[1] / timer.stop()
    # # 返回模型的困惑度(将第一个指标指数化)和每秒处理的词元数量(总词元数量除以计时器的停止时间)


# @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'))
num_epochs, lr = 500, 1
# train_ch8(net, train_iter, vocab, lr, num_epochs, d2l.try_gpu())
"""检查随机采样的结果"""
train_ch8(net,train_iter,vocab,lr,num_epochs,d2l.try_gpu(),use_random_iter=True)

你可能感兴趣的:(深度学习,pytorch,rnn)