Merge pull request #1201 from NLGithubWP/dev-postgresql

examples/trans/README.md

@@ -0,0 +1,34 @@
+
+# Machine translation model using Transformer Example
+This example trains a Transformer model on a machine translation task. By default, the training script uses the anki dataset, provided.
+You can download from http://www.manythings.org/anki/. This example uses the Chinese and English sentence pairs provided by this dataset
+to complete the translation task. The dataset contains 29909 sentence pairs in both English and Chinese.
+
+Data format: English + TAB + Chinese + TAB + Attribution.
+
+Example:
+```
+Hi.	嗨。	CC-BY 2.0 (France) Attribution: tatoeba.org #538123 (CM) & #891077 (Martha)
+Hi.	你好。	CC-BY 2.0 (France) Attribution: tatoeba.org #538123 (CM) & #4857568 (musclegirlxyp)
+```
+
+The train.py script accepts the following arguments:
+```
+optional arguments:
+  [arg]              [type]     [desc]                                  [default]
+  --dataset          string     location of the dataset
+  --max-epoch        int        maximum epochs                          default 100           
+  --batch_size       int        batch size                              default 64
+  --shuffle          bool       shuffle the dataset                     default True
+  --lr               float      learning rate                           default 0.005
+  --seed             int        random seed                             default 0
+  --d_model          int        transformer model d_model               default 512
+  --n_head           int        transformer model n_head                default 8
+  --dim_feedforward  int        transformer model dim_feedforward       default 2048
+  --n_layers         int        transformer model n_layers              default 6
+```
+
+run the example
+```
+python train.py --dataset cmn.txt --max-epoch 100 --batch-size 32 --lr 0.01
+```