diff --git a/doc/benchmark.md b/doc/benchmark.md
new file mode 100644
index 0000000000000000000000000000000000000000..b16e26c71888d590f00f13782449acf840c4b6ee
--- /dev/null
+++ b/doc/benchmark.md
@@ -0,0 +1,2 @@
+# PaddleRec Benchmark
+> 占位
\ No newline at end of file
diff --git a/doc/contribute_code.md b/doc/contribute.md
similarity index 100%
rename from doc/contribute_code.md
rename to doc/contribute.md
diff --git a/doc/design.md b/doc/design.md
new file mode 100644
index 0000000000000000000000000000000000000000..6b16a2428a029adb2ce8f77e55a53c0eced1d44d
--- /dev/null
+++ b/doc/design.md
@@ -0,0 +1,2 @@
+# PaddleRec 设计
+> 占位
\ No newline at end of file
diff --git a/readme.md b/readme.md
index 6be4dd44a5be7c810030ba3ccc467ba0f3325b40..a2cdf9dcfd069e5dd8d6c5f05c466fcc7ed73cc5 100644
--- a/readme.md
+++ b/readme.md
@@ -34,7 +34,7 @@
-
安装
+便捷安装
### 环境要求
* Python >= 2.7
@@ -71,6 +71,8 @@
目前框架内置了多个模型,简单的命令即可使用内置模型开始单机训练和本地1*1模拟训练,我们以`ctr-dnn`为例介绍PaddleRec的简单使用。
+### 一行命令启动训练
+
单机训练
```bash
@@ -97,23 +99,27 @@ python -m fleetrec.run -m fleetrec.models.rank.dnn -d cpu -e cluster
支持模型列表
+> 部分表格占位待改(大规模稀疏)
+
+| 方向 | 模型 | 单机CPU训练 | 单机GPU训练 | 分布式CPU训练 | 大规模稀疏 | 分布式GPU训练 | 自定义数据集 |
+| :------: | :----------------------------------------------------------------------------: | :---------: | :---------: | :-----------: | :--------: | :-----------: | :----------: |
+| 内容理解 | [Text-Classifcation](models/contentunderstanding/text_classification/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 内容理解 | [TagSpace](models/contentunderstanding/tagspace/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 召回 | [Word2Vec](models/recall/word2vec/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 召回 | [TDM](models/recall/tdm/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 召回 | [SSR](models/recall/ssr/model.py) | ✓ | ✓ | ✓ | x | ✓ | ✓ |
+| 召回 | [Gru4Rec](models/recall/gru4rec/model.py) | ✓ | ✓ | ✓ | x | ✓ | ✓ |
+| 排序 | [CTR-Dnn](models/rank/dnn/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 排序 | [DeepFm](models/rank/deepfm/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 排序 | [xDeepFm](models/rank/xdeepfm/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 排序 | [DIN](models/rank/din/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 排序 | [Wide&Deep](models/rank/wide_deep/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 多任务 | [ESMM](models/multitask/essm/model.py) | ✓ | ✓ | ✓ | x | ✓ | ✓ |
+| 多任务 | [MMOE](models/multitask/mmoe/model.py) | ✓ | ✓ | ✓ | x | ✓ | ✓ |
+| 排序 | [ShareBottom](models/multitask/share-bottom/model.py) | ✓ | ✓ | ✓ | x | ✓ | ✓ |
+| 匹配 | [DSSM](models/match/dssm/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
+| 匹配 | [Simnet](models/match/multiview-simnet/model.py) | ✓ | x | ✓ | x | ✓ | ✓ |
-| 方向 | 模型 | 单机CPU训练 | 单机GPU训练 | 分布式CPU训练 | 大规模稀疏 | 分布式GPU训练 | 自定义数据集 |
-| :------: | :--------------------: | :---------: | :---------: | :-----------: | :--------: | :-----------: | :----------: |
-| 内容理解 | [Text-Classifcation]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 内容理解 | [TagSpace]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 召回 | [Word2Vec]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 召回 | [TDM]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 召回 | [SSR]() | ✓ | ✓ | ✓ | x | ✓ | ✓ |
-| 召回 | [Gru4Rec]() | ✓ | ✓ | ✓ | x | ✓ | ✓ |
-| 排序 | [CTR-Dnn]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 排序 | [DeepFm]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 排序 | [ListWise]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 排序 | [DSSM]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 排序 | [Multiview-Simnet]() | ✓ | x | ✓ | x | ✓ | ✓ |
-| 融合 | [MMOE]() | ✓ | ✓ | ✓ | x | ✓ | ✓ |
-| 融合 | [ESMM]() | ✓ | ✓ | ✓ | x | ✓ | ✓ |
-| 融合 | [ESMM]() | ✓ | ✓ | ✓ | x | ✓ | ✓ |
@@ -121,33 +127,32 @@ python -m fleetrec.run -m fleetrec.models.rank.dnn -d cpu -e cluster
文档
### 新手教程
-* [支持模型列表](#支持模型列表)
* [环境要求](#环境要求)
* [安装命令](#安装命令)
-* [快速开始](#快速开始)
+* [快速开始](#一行命令启动训练)
### 进阶教程
-* [自定义数据集及Reader](#自定义数据集及reader)
-* [模型调参](#模型调参)
-* [单机训练](#单机训练)
-* [分布式训练](#分布式训练)
-* [离线预测](#预测部署)
+* [自定义数据集及Reader](doc/custom_dataset_reader.md)
+* [模型调参](doc/optimization_model.md)
+* [单机训练](doc/local_train.md)
+* [分布式训练](doc/distributed_train.md)
+* [离线预测](doc/predict.md)
### 关于PaddleRec性能
-* [Benchamrk](#benchamrk)
+* [Benchamrk](doc/benchmark.md)
### FAQ
-* [常见问题FAQ](#常见问题faq)
+* [常见问题FAQ](doc/faq.md)
### 设计文档
-* [PaddleRec设计文档](#PaddleRec设计文档)
+* [PaddleRec设计文档](doc/design.md)
社区
### 贡献代码
-* [优化PaddleRec框架](#优化paddlerec框架)
-* [新增模型到PaddleRec](#新增模型到paddlerec)
+* [优化PaddleRec框架](doc/contribute.md)
+* [新增模型到PaddleRec](doc/contribute.md)
### 反馈
如有意见、建议及使用中的BUG,欢迎在`GitHub Issue`提交