Update README.md

README.md

@@ -1,3 +1,89 @@
----
-license: mit
----
+---
+license: mit
+language:
+- ru
+tags:
+  - natural-language-processing
+  - text-generation
+  - tensorflow
+  - lstm
+  - tolkien
+---
+
+This model is trained in August of 2016 with TensorFlow as character-based. Russian translation of Tolkien's onomastics served as the train corpus.
+
+## Usage
+
+To generate new samples, run the script `sample.py` (Python 2!). The scripts `utils.py` and `model.py` should be in the same folder, and the `save` folder with the model files should be a subfolder (its location can be changed in the script in line 22).
+
+## Train data
+
+*«Властелин колец»: переводы имён* by Наталия Семенова.
+
+Example:
+
+```
+агларонд
+аданы
+аделярд
+азанульбизар
+айглос
+айсен
+айсенгард
+айсенгрим
+айсенмут
+айсенские броды
+аладоломэ
+алая книга западных пределов
+алая книга перианнат
+алая стрела
+алдалом
+алдор
+аллея победы
+алфирин
+альдаломэ
+альдор
+```
+
+## What for?
+
+To check if NN catch the thing in Tolkien's name generation.
+
+## Samples
+
+### Sample 1
+
+Test with temperature of 1.2 | epoch: 020 | loss: 0.01917 | val_loss: 0.06580 -- iter: 21406/21406
+
+```
+Ненья
+Намранной Омной Леска
+Виние Теревог
+Глинделинние Наро
+```
+
+### Sample 2
+
+Test with temperature of 1.0
+
+```
+Ненья
+Нанраюной Най
+Странгол
+Дунгерезние Юсемебна
+Тревестой
+```
+
+### Sample 3
+
+Test with temperature of 0.5
+
+```
+Ненья
+Нанредний Дтели
+Корбы
+Холстольза
+Темноество
+Натраки-к
+```
+