PyTorch 1.5 Tutorials : テキスト : 文字レベル RNN で名前を分類する

PyTorch 1.5 Tutorials : テキスト : 文字レベル RNN で名前を分類する (翻訳/解説)
翻訳 : (株)クラスキャット セールスインフォメーション
作成日時 : 06/24/2020 (1.5.0)

* 本ページは、PyTorch 1.5 Tutorials の以下のページを翻訳した上で適宜、補足説明したものです:

* サンプルコードの動作確認はしておりますが、必要な場合には適宜、追加改変しています。
* ご自由にリンクを張って頂いてかまいませんが、sales-info@classcat.com までご一報いただけると嬉しいです。

 

無料セミナー開催中 クラスキャット主催 人工知能 & ビジネス Web セミナー

人工知能とビジネスをテーマにウェビナー (WEB セミナー) を定期的に開催しています。スケジュールは弊社 公式 Web サイト でご確認頂けます。
  • お住まいの地域に関係なく Web ブラウザからご参加頂けます。事前登録 が必要ですのでご注意ください。
  • Windows PC のブラウザからご参加が可能です。スマートデバイスもご利用可能です。

お問合せ : 本件に関するお問い合わせ先は下記までお願いいたします。

株式会社クラスキャット セールス・マーケティング本部 セールス・インフォメーション
E-Mail:sales-info@classcat.com ; WebSite: https://www.classcat.com/
Facebook: https://www.facebook.com/ClassCatJP/

 

テキスト : 文字レベル RNN で名前を分類する

単語を分類するために基本的な文字レベル RNN を構築して訓練していきます。このチュートリアルは、次の 2 つと連動して、「スクラッチから」の NLP モデリングのためにデータの前処理をどのように行なうかを示します、特に torchtext の多くの便利関数は使用しませんので、NLP モデリングのために前処理がどのように低位で動作するかを見ることができます。

文字レベル RNN は単語を文字のシリーズとして読み – 各ステップで予測と「隠れ状態」を出力して、各々の次のステップにその前の隠れ状態を供給します。出力を最終的な予測と取ります、i.e. 単語がどのクラスに属するかです。

具体的に言うと、元の 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

推薦文書

貴方が少なくとも PyTorch をインストールして、Python を知り、そして Tensor を理解していることを仮定しています。

RNN について知り、それらがどのように動作するかを知ることもまた有用でしょう :

 

データを準備する

Note: ここ からデータをダウンロードして現在のディレクトリにそれを展開してください。

“[Language].txt” と名前付けられた 18 テキストファイルが data/names ディレクトリに含まれています。各ファイルは多くの名前を含み、1 行に 1 つの名前で、殆どはローマ字化されています (しかし依然として Unicode から ASCII に変換する必要があります)。

言語毎の名前リストの辞書で終わります, {language: [names …]}。一般的な変数 “category” と “line” (私達のケースでは言語と名前のため) は後の拡張性のために使用されます。

from __future__ import unicode_literals, print_function, division
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/French.txt', 'data/names/Czech.txt', 'data/names/Dutch.txt', 'data/names/Polish.txt', 'data/names/Scottish.txt', 'data/names/Chinese.txt', 'data/names/English.txt', 'data/names/Italian.txt', 'data/names/Portuguese.txt', 'data/names/Japanese.txt', 'data/names/German.txt', 'data/names/Russian.txt', 'data/names/Korean.txt', 'data/names/Arabic.txt', 'data/names/Greek.txt', 'data/names/Vietnamese.txt', 'data/names/Spanish.txt', 'data/names/Irish.txt']
Slusarski

 
今私達は category_lines を持っています、各カテゴリ (言語) を行のリスト (名前) にマップする辞書です。all_categories (言語の単なるリスト) と n_categories もまた後の参照のために追跡しました。

print(category_lines['Italian'][:5])
['Abandonato', 'Abatangelo', 'Abatantuono', 'Abate', 'Abategiovanni']

 

名前を Tensor に変える

名前全部を体系化した今、それらを任意に利用するために Tensor に変換する必要があります。

シングル文字 (= single letter) を表わすために、サイズ <1 x n_letters> の “one-hot ベクトル” を使用します。one-hot ベクトルは現在の文字のインデックスにおける 1 を除いて 0 で満たされます, e.g. “b” = <0 1 0 0 0 …> 。

単語を作成するためには多くのそれらを 2D 行列 <line_length x 1 x n_letters> に結合します。

その特別な 1 次元は 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 ,
# 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 を非常に「純粋な」方法で、通常の順伝播層として実装できることを意味しています。

(Torch ユーザチュートリアルのための PyTorch から殆どコピーされた) RNN モジュールは単に 2 線形層で、これらは入力と隠れ状態の上で、出力後の LogSoftmax 層とともに動作します。

import torch.nn as nn

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, hidden_size)
        self.i2o = nn.Linear(input_size + hidden_size, output_size)
        self.softmax = nn.LogSoftmax(dim=1)

    def forward(self, input, hidden):
        combined = torch.cat((input, hidden), 1)
        hidden = self.i2h(combined)
        output = self.i2o(combined)
        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)

このネットワークのステップを実行するためには入力 (私達のケースでは、現在の文字に対する Tensor) と前の隠れ状態 (これは最初はゼロとして初期化します) を渡すことが必要です。出力 (各言語の確率) と次の隠れ状態 (これは次のステップのために保持します) を再取得するでしょう。

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

output, next_hidden = rnn(input, hidden)

効率性のために総てのステップのために新しい Tensor を作成することは望みませんので、letterToTensor の代わりに lineToTensor を使用してそしてスライスを使用します。これは Tensor のバッチを事前計算することにより更に最適化できるでしょう。

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

output, next_hidden = rnn(input[0], hidden)
print(output)
tensor([[-2.9196, -2.8323, -2.7732, -2.8583, -2.8558, -2.9003, -2.8124, -2.9453,
         -2.8653, -2.9060, -2.8062, -2.8845, -2.9427, -2.9065, -2.8680, -2.9659,
         -3.0104, -3.0119]], grad_fn=<LogSoftmaxBackward>)

見て取れるように output は <1 x n_categories> Tensor で、そこでは総ての項目はそのカテゴリーの尤度です (より高ければより尤もらしい)。

 

訓練

訓練のための準備

訓練に入る前に幾つかヘルパー関数を作成するべきです。最初のものはネットワークの出力を解釈します、これは各カテゴリーの尤度であることを知っています。最も大きな値のインデックスを得るために 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))
('Dutch', 2)

訓練サンプル (名前とその言語) を得る素早い方法もまた望みます :

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 = Scottish / line = Mccallum
category = English / line = Glew
category = Russian / line = Rujitsky
category = Russian / line = Jakhaev
category = Russian / line = Jukhtman
category = Chinese / line = Tow
category = German / line = Hase
category = Russian / line = Awelitcheff
category = Spanish / line = Rojas
category = French / line = Bertrand

 

ネットワークを訓練する

今はこのネットワークを訓練するために必要な総てはそれに多くのサンプルを見せて、それに推測をさせて、そしてそれが間違っているかどうかをそれに教えることです。

損失関数については nn.NLLLoss が適切です、何故ならば RNN の最後の層は nn.LogSoftmax であるからです。

criterion = nn.NLLLoss()

 
訓練の各ループは :

  • 入力とターゲット tensor を作成する
  • ゼロで (初期化された) 初期隠れ状態を作成する
  • 各文字を読み込み、そして
    • 次の文字のために隠れ状態を保持する
  • 最後の出力をターゲットと比較する
  • 逆伝播する
  • 出力と損失を返す
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
5000 5% (0m 15s) 2.1109 Baldovini / Russian ✗ (Italian)
10000 10% (0m 26s) 1.4460 Ahn / Chinese ✗ (Korean)
15000 15% (0m 38s) 2.0936 Santana / Italian ✗ (Spanish)
20000 20% (0m 49s) 1.1156 Mei / Chinese ✓
25000 25% (1m 0s) 3.0432 Tomas / Arabic ✗ (Spanish)
30000 30% (1m 12s) 0.7684 Ragno / Italian ✓
35000 35% (1m 23s) 1.7801 Osladil / Czech ✓
40000 40% (1m 34s) 1.2313 Herrera / Spanish ✓
45000 45% (1m 45s) 1.0233 Kosmatka / Polish ✓
50000 50% (1m 57s) 0.0304 Shiokawa / Japanese ✓
55000 55% (2m 8s) 3.0589 Nieddu / Irish ✗ (Italian)
60000 60% (2m 19s) 0.9098 Mogilevich / Russian ✓
65000 65% (2m 31s) 0.3801 Calogerakis / Greek ✓
70000 70% (2m 42s) 0.5261 Schultz / German ✓
75000 75% (2m 53s) 2.3748 Brodbeck / Czech ✗ (German)
80000 80% (3m 5s) 0.3019 O'Brien / Irish ✓
85000 85% (3m 16s) 4.5358 Paulis / Greek ✗ (Dutch)
90000 90% (3m 27s) 0.3027 Dang / Vietnamese ✓
95000 95% (3m 39s) nan Kwong / Russian ✗ (Chinese)
100000 100% (3m 50s) nan Vo / Russian ✗ (Vietnamese)

 

結果をプロットする

all_losses からの履歴損失のプロットはネットワーク学習を示します :

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

plt.figure()
plt.plot(all_losses)

 

結果を評価する

ネットワークが異なるカテゴリー上でどのくらい上手く遂行するかを見るために、混同行列 (= confusion matrix) を作成します、これは総ての実際の言語 (行) についてネットワークがどの言語 (列) を推測したかを示します。混同行列を計算するためには多くのサンプルが evaluate() でネットワークを通して実行されます、これは train() マイナス backprop と同じです。

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

(訳注: 下の図は 1.5 ドキュメント原文に掲載)

(訳注 : 下の図は 1.3 ドキュメント原文に掲載)

貴方は主軸から離れた明るいスポットを拾い出すことができます、これはどの言語をそれが間違って推測したかを示します、e.g. 韓国語のための中国語、そしてイタリア語のためのスペイン語。ギリシャ語では非常に上手く遂行し、そして英語では非常に下手に遂行されるようです (多分他の言語とのオーバーラップが原因です) 。

 

ユーザ入力上で実行する

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
(nan) Russian
(nan) Arabic
(nan) Korean

> Jackson
(nan) Russian
(nan) Arabic
(nan) Korean

> Satoshi
(nan) Russian
(nan) Arabic
(nan) Korean

Practical PyTorch レポジトリ のスクリプトの最終版は上のコードを幾つかのファイルに分割しています :

  • data.py (ファイルをロードする)
  • model.py (RNN を定義する)
  • train.py (訓練を実行する)
  • predict.py (コマンドライン引数で precict() を実行する)
  • server.py (bottle.py により JSON API として予測をサービス提供する)

ネットワークを訓練してセーブするために train.py を実行します。

予測を見るために名前と共に predict.py を実行します :

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

予測の JSON 出力を得るためには server.py を実行して http://localhost:5533/Yourname を訪ねてください。

 

課題

  • line -> category の異なるデータセットで試してください、例えば :
    • 任意の単語 -> 言語
    • ファーストネーム -> 性別
    • キャラクター名 -> 作者
    • ページタイトル -> ブログ or サブレディット
  • より大きな and/or より良い形状のネットワークでより良い結果を得る。
    • より多くの線形層を追加する
    • nn.LSTM と nn.GRU 層を試す
    • これらの複数の RNN をより高位なネットワークとして結合する

 
以上