From 6e7d7931994e42455b2e18ebe60157193e1bb83d Mon Sep 17 00:00:00 2001
From: Coet <writerphone@163.com>
Date: Mon, 25 Jun 2018 14:41:30 +0800
Subject: [PATCH] update README.md, add file tree

update README.md, add file tree
---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 55 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 840c7a6a..a726832b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,56 @@
 # FastNLP
-FastNLP
\ No newline at end of file
+```
+FastNLP
+│  LICENSE
+│  README.md
+│  requirements.txt
+│  setup.py
+|
+├─action      (model independent process)
+│  │  action.py (base class)
+│  │  README.md
+│  │  tester.py (model testing, for deployment and validation)
+│  │  trainer.py  (main logic for model training)
+│  │  __init__.py
+│  │
+|
+├─docs  (documentation)
+│      quick_tutorial.md
+│
+├─loader    (file loader for all loading operations)
+│   |  base_loader.py  (base class)
+│   |  config_loader.py   (model-specific configuration/parameter loader)
+│   |  dataset_loader.py  (data set loader, base class)
+│   |  embed_loader.py    (embedding loader, base class)
+│   |  __init__.py
+│
+├─model  (definitions of PyTorch models)
+│  │  base_model.py  (base class, abstract)
+│  │  char_language_model.py  (derived class, to implement abstract methods)
+│  │  word_seg_model.py  
+│  │  __init__.py
+│  │
+│
+├─reproduction   (code library for paper reproduction)
+│  ├─Char-aware_NLM
+│  │
+│  ├─CNN-sentence_classification
+│  │
+│  └─HAN-document_classification
+│
+├─saver  (file saver for all saving operations)
+│      base_saver.py
+│      logger.py
+│      model_saver.py
+│
+└─tests  (unit tests, intergrating tests, system tests)
+    │  test_charlm.py
+    │  test_loader.py
+    │  test_trainer.py
+    │  test_word_seg.py
+    │
+    └─data_for_tests  (test data used by models)
+            charlm.txt
+            cws_test
+            cws_train
+```