PyTorch : Tutorial 中級 : 文字レベル RNN で名前を分類する (翻訳/解説)
翻訳 : (株)クラスキャット セールスインフォメーション
更新日時 : 06/08/2018 (0.4.0)
作成日時 : 05/12/2018 (0.4.0)
* 本ページは、PyTorch Intermidiate Tutorials の – Classifying Names with a Character-Level RNN を
動作確認・翻訳した上で適宜、補足説明したものです：
* サンプルコードの動作確認はしておりますが、適宜、追加改変している場合もあります。
* ご自由にリンクを張って頂いてかまいませんが、sales-info@classcat.com までご一報いただけると嬉しいです。
単語を分類するために基本的な文字レベル RNN を構築して訓練します。文字レベル 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 について知り、それらがどのように動作するかを知ることは有用です :
- The Unreasonable Effectiveness of Recurrent Neural Networks は多くの現実のサンプルを示しています。
- Understanding LSTM Networks は特に LSTM についてですが、一般的な 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
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 http://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 = filename.split('/')[-1].split('.')[0]
all_categories.append(category)
lines = readLines(filename)
category_lines[category] = lines
n_categories = len(all_categories)
Out:
['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']
(訳注 : 日本語の場合も試しておきます : )
print(category_lines['Japanese'][:5])
['Abe', 'Abukara', 'Adachi', 'Aida', 'Aihara']
名前を 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 <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())
Out:
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 を非常に「純粋な」方法で、標準的な feed-forward 層として実装できることを意味しています。
(大半は PyTorch for Torch ユーザ・チュートリアル からコピーされた) RNN モジュールは単に 2 linear 層で、これは入力と隠れ状態上で、出力後の 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)
Out:
tensor([[-2.9645, -2.9886, -2.9102, -2.7943, -2.9355, -2.7949, -2.9719,
-2.8328, -2.9599, -2.9536, -2.9064, -2.8923, -2.7990, -2.9494,
-2.8305, -2.8649, -2.9266, -2.7927]])
見て取れるように 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))
Out:
('Vietnamese', 17)
訓練サンプル (名前とその言語) を得る素早い方法もまた望みます :
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)
Out:
category = Czech / line = Ballaltick category = Korean / line = Jon category = Chinese / line = Sha category = Czech / line = Svotchak category = English / line = Carmichael category = Chinese / line = Zhou category = Korean / line = Choi category = German / line = Rettig category = Czech / line = Biganska category = Portuguese / line = De santigo
ネットワークを訓練する
今はこのネットワークを訓練するために必要なのはそれに多くのサンプルを見せて、それに推測をさせて、そしてそれが間違っているかそれに教えることです。
損失関数のためには 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_(-learning_rate, p.grad.data)
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
Out:
5000 5% (0m 5s) 2.7675 Sugase / French ✗ (Japanese) 10000 10% (0m 11s) 2.3496 Nakadai / Arabic ✗ (Japanese) 15000 15% (0m 16s) 2.9673 Sanna / Spanish ✗ (Dutch) 20000 20% (0m 21s) 1.2245 Luong / Vietnamese ✓ 25000 25% (0m 26s) 2.1757 Silva / Spanish ✗ (Portuguese) 30000 30% (0m 32s) 3.0591 Cameron / Portuguese ✗ (Scottish) 35000 35% (0m 38s) 0.3989 Choi / Korean ✓ 40000 40% (0m 43s) 1.4654 Rivero / Portuguese ✗ (Spanish) 45000 45% (0m 49s) 3.3164 Adam / Arabic ✗ (French) 50000 50% (0m 54s) 2.1011 Segher / German ✗ (Dutch) 55000 55% (0m 59s) 1.4330 Marquez / Portuguese ✗ (Spanish) 60000 60% (1m 4s) 0.1739 Thao / Vietnamese ✓ 65000 65% (1m 9s) 2.1390 O'Sullivan / Czech ✗ (Irish) 70000 70% (1m 15s) 1.5673 Nunes / Dutch ✗ (Portuguese) 75000 75% (1m 21s) 0.5570 Jiao / Chinese ✓ 80000 80% (1m 26s) 1.3812 Spannagel / Czech ✗ (German) 85000 85% (1m 32s) 0.1442 Mustafa / Arabic ✓ 90000 90% (1m 37s) 0.7814 Abadi / Arabic ✓ 95000 95% (1m 43s) 0.4214 Morekhin / Russian ✓ 100000 100% (1m 48s) 3.1693 Leon / Chinese ✗ (French)
結果をプロットする
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()
(訳注: 実際にプロットしてみた混同行列です : )
貴方は主軸から離れた明るいスポットを拾い出すことができます、これはどの言語をそれが間違って推測したかを示します、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')
Out:
> Dovesky (-0.67) Czech (-0.94) Russian (-3.49) English > Jackson (-0.28) Scottish (-2.07) English (-2.68) Russian > Satoshi (-0.73) Arabic (-1.32) Japanese (-2.24) Italian
Out:
> Dovesky (-0.43) Russian (-1.34) Czech (-2.80) English > Jackson (-0.17) Scottish (-2.48) English (-3.58) Russian > Satoshi (-1.02) Japanese (-1.41) Italian (-1.77) Arabic
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 より良い形状のネットワークでより良い結果を得る。
- 更なる linear 層を追加する
- nn.LSTM と nn.GRU 層を試す
- これらの複数の RNN をより高位なネットワークとして結合する
以上