From 02ee52d0efa6e939443a958fffa1b53c48484423 Mon Sep 17 00:00:00 2001
From: Piotr Czapla <github@piotrczapla.com>
Date: Sat, 7 Sep 2019 19:11:52 +0200
Subject: [PATCH] Update README.md

---
 README.md | 106 ++++++------------------------------------------------
 1 file changed, 10 insertions(+), 96 deletions(-)

diff --git a/README.md b/README.md
index 41cd8b6..747aa35 100644
--- a/README.md
+++ b/README.md
@@ -1,100 +1,14 @@
-# ulmfit-multilingual
-Temporary repository used for collaboration on application of for multiple languages.
 
-# How to train classifier
+# Retraining a multifit model from wikipedia
 
-```
-$ python -m ulmfit lm --dataset-path data/wiki/wikitext-103 --bidir=False --qrnn=False --tokenizer=vf --name 'bs40' --bs=40 --cuda-id=0  -  train 20 --drop-mult=0.9
-...
-Model dir: data/wiki/wikitext-103/models/vf60k/lstm_bs40.m
-...
-$ python -m ulmfit cls --dataset-path data/imdb --base-lm-path data/wiki/wikitext-103/models/vf60k/lstm_bs40.m - train 20   
-```
- 
-
-
-## data directory strucutre
-
-Directory structure after changes to the way we process wiki dumps.
-```
-data
-├── imdb
-│   ├── aclImdb
-│   ├── imdb_lm
-│   └── tmp
-├── wiki
-│   ├── de-100
-│   │   └── models
-│   ├── de-100-unk
-│   │   └── models
-│   ├── de-2
-│   │   └── models
-│   ├── de-2-unk
-│   │   └── models
-│   ├── de-all
-│   │   └── models
-│   ├── wikitext-103
-│   │   └── models
-│   └── wikitext-2
-│       └── models
-├── wiki_dumps
-├── wiki_extr
-│   └── de
-│       ├── AA
-│       ├── AB
-...
-        └── CC
-└── xnli
-    ├── XNLI-1.0
-    └── XNLI-MT-1.0
-        ├── multinli
-        └── xnli
-```
-
-## how to contribute
-We have a fork of fastai to propose changes to fastai.text, with a branch for this project:
- https://github.com/n-waves/fastai/tree/ulmfit_multilingual  
-
-Let us know that you want to start collaboration on fastai forum thread: [Multilingual ULMFIT](https://forums.fast.ai/t/multilingual-ulmfit/28117)
-and you will get access to both repositories.
-
-- Follow the [developer installation of fastai](https://github.com/fastai/fastai#developer-install)
-- Add n-waves/fastai as additional remote as described here: https://help.github.com/articles/adding-a-remote/
-
-Here is what I did:
+The whole training process from wikipedia to mldoc can be run as follows:  
 ```bash
-$ cd fastai
-$ git remote add n-waves https://github.com/n-waves/fastai.git
-$ git remote -v 
-n-waves	https://github.com/n-waves/fastai.git (fetch)
-n-waves	https://github.com/n-waves/fastai.git (push)
-origin	https://github.com/fastai/fastai.git (fetch)
-origin	https://github.com/fastai/fastai.git (push)
-
-$ git fetch n-waves
-$ git checkout ulmfit_multilingual
-Branch 'ulmfit_multilingual' set up to track remote branch 'ulmfit_multilingual' from 'n-waves'.
-Switched to a new branch 'ulmfit_multilingual'
-
-$ git push --set-upstream n-waves ulmfit_multilingual  # to automatically push ulmfit_multilingual branch to the n-waves repo
+python -m experiment new multifit_fp16 \
+    pretrain-lm train- data/wiki/de-100 - \
+    finetune-lm train- data/mldoc/de-1 - \
+    classifier train- data/mldoc/de-1
+```
+You can evaulate any model with the following command: 
+```bash
+python -m experiment load data/mldoc/de-1/models/fsp15k/multfit_fp16 classifier validate data/mldoc/de-1
 ```
-
-## Repo structure
-
-- `fastai_contrib`  -- anything that can be ported to fastai once we finish the project like:  NLI models, Sentence Piece tok.,
-- `ulmfit`  
-    - `data`  -- scripts to fetch and prepare data: wikipedia, xnli, classification data sets  
-    - `lm` -- scripts to train language models
-    - `bilm` -- scripts to train biLM ELMo style, Bert style
-    - `class`  -- scripts to test classifiers on multiple languages
-    - `xnli` -- scripts to test nli 
-
-
-## Running tests
-
-To run the tests, the following data is necessary:
-
-- wikitext-2 (prepared by `./prepare_wiki-en.sh`, along with wikitext-103)
-- imdb (prepared by `./prepare_imdb.sh`)
-
-then simply run tests, e.g. `pytest .`