Merge branch 'doc_v2' into 'develop'

Doc v2

See merge request !55

README.md

@@ -42,6 +42,8 @@
 * Python 2.7/ 3.5 / 3.6 / 3.7
 * PaddlePaddle  >= 1.7.2
 * 操作系统: Windows/Mac/Linux
+
+  > Windows下目前仅提供单机训练，建议使用Linux
   
 ### 安装命令
 
@@ -72,9 +74,11 @@
 
 ### 启动内置模型的默认配置
 
-目前框架内置了多个模型，简单的命令即可使用内置模型开始单机训练和本地1*1模拟训练，我们以`dnn`为例介绍PaddleRec的简单使用。
+目前框架内置了多个模型，一行命令即可使用内置模型开始单机训练和本地模拟分布式训练。
+  > 本地模拟分布式(`local_cluster`)为`1个server + 1个trainer`的参数服务器模式
+
 
-#### 单机训练
+我们以排序模型中的`dnn`模型为例介绍PaddleRec的简单使用。训练数据来源为[Criteo数据集](https://www.kaggle.com/c/criteo-display-ad-challenge/)，我们从中截取了100条方便您快速上手体验完整的PaddleRec流程。
 
 ```bash
 # 使用CPU进行单机训练
@@ -85,12 +89,29 @@ python -m paddlerec.run -m paddlerec.models.rank.dnn
 
 若您复用内置模型，对**yaml**配置文件进行了修改，如更改超参，重新配置数据后，可以直接使用paddlerec运行该yaml文件。
 
-我们以dnn模型为例，在paddlerec代码目录下
+我们以dnn模型为例，在paddlerec代码目录下:
 ```bash
 cd paddlerec
 ```
 
-修改了dnn模型`models/rank/dnn/config.yaml`的配置后，运行`dnn`模型：
+修改dnn模型的[超参配置](./models/rank/dnn/config.yaml)，例如将迭代训练轮数从10轮修改为5轮:
+```yaml
+train:
+  # epochs: 10
+  epochs: 5
+```
+
+在Linux环境下，可以使用`vim`等文本编辑工具修改yaml文件：
+
+```bash
+vim ./models/rank/dnn/config.yaml
+# 键入 i, 进入编辑模式
+# 修改yaml文件配置
+# 完成修改后，点击esc，退出编辑模式
+# 键入 :wq 保存文件并退出 
+```
+
+完成dnn模型`models/rank/dnn/config.yaml`的配置修改后，运行`dnn`模型：
 ```bash
 # 使用自定配置进行训练
 python -m paddlerec.run -m ./models/rank/dnn/config.yaml 
@@ -140,6 +161,8 @@ python -m paddlerec.run -m ./models/rank/dnn/config.yaml -b backend.yaml
 | :------: | :-----------------------------------------------------------------------: | :---------: | :---------: | :-----------: |
 | 内容理解 | [Text-Classifcation](models/contentunderstanding/classification/model.py) |      ✓      |      x      |       ✓       |
 | 内容理解 |         [TagSpace](models/contentunderstanding/tagspace/model.py)         |      ✓      |      x      |       ✓       |
+|   召回   |                    [DSSM](models/match/dssm/model.py)                     |      ✓      |      x      |       ✓       |
+|   召回   |        [MultiView-Simnet](models/match/multiview-simnet/model.py)         |      ✓      |      x      |       ✓       |
 |   召回   |                   [TDM](models/treebased/tdm/model.py)                    |      ✓      |      x      |       ✓       |
 |   召回   |                [Word2Vec](models/recall/word2vec/model.py)                |      ✓      |      x      |       ✓       |
 |   召回   |                     [SSR](models/recall/ssr/model.py)                     |      ✓      |      ✓      |       ✓       |
@@ -152,8 +175,7 @@ python -m paddlerec.run -m ./models/rank/dnn/config.yaml -b backend.yaml
 |  多任务  |                  [ESMM](models/multitask/esmm/model.py)                   |      ✓      |      ✓      |       ✓       |
 |  多任务  |                  [MMOE](models/multitask/mmoe/model.py)                   |      ✓      |      ✓      |       ✓       |
 |  多任务  |           [ShareBottom](models/multitask/share-bottom/model.py)           |      ✓      |      ✓      |       ✓       |
-|   匹配   |                    [DSSM](models/match/dssm/model.py)                     |      ✓      |      x      |       ✓       |
-|   匹配   |        [MultiView-Simnet](models/match/multiview-simnet/model.py)         |      ✓      |      x      |       ✓       |
+
 
 
 

doc/rec_background.md

 # 推荐系统背景知识
+本文来源于[个性化推荐](https://github.com/PaddlePaddle/book/blob/develop/05.recommender_system/README.cn.md)，进行了节选。
 
 本文代码目录在[book/recommender_system](https://github.com/PaddlePaddle/book/tree/develop/05.recommender_system),初次使用请您参考[Book文档使用说明](https://github.com/PaddlePaddle/book/blob/develop/README.cn.md#运行这本书)。
 

models/rank/dnn/config.yaml

@@ -13,13 +13,14 @@
 # limitations under the License.
 
 train:
+  epochs: 10
+  engine: single
+  workspace: "paddlerec.models.rank.dnn"
+
   trainer:
     # for cluster training
     strategy: "async"
 
-  epochs: 10
-  workspace: "paddlerec.models.rank.dnn"
-
   reader:
     batch_size: 2
     class: "{workspace}/../criteo_reader.py"

models/rank/dnn/data/train/sample_train.txt

@@ -97,4 +97,4 @@
 0		-1			12674	4	26	0	73		2			05db9164	09e68b86	eecaacb9	d268ac84	25c83c98	13718bbd	33cca6fa	0b153874	a73ee510	401ced54	683e14e9	ce76d69d	2b9fb512	b28479f6	52baadf5	7bf10350	e5ba7672	5aed7436	55dd3565	b1252a9d	3d7cfd1b		3a171ecb	3fdb382b	3d2bedd7	49d68486
 0		259	4		103468		0	0	14		0			05db9164	8947f767	d8ec4c68	ac1667dd	4cf72387	7e0ccccf	3527bb7c	0b153874	7cc72ec2	3b08e48b	2b9f131d	2a63b3ee	aca10c14	07d13a8f	2c14c412	11b43c2e	8efede7f	bd17c3da	21ddcdc9	a458ea53	79a05ba5		32c7478e	4fb9fee0	010f6491	004f1180
 1	3	145		4	108	6	4	4	31	1	2		4	8cf07265	6c2cbbdc	a42bd759	8b3b6b2e	25c83c98		f00bddf8	062b5529	a73ee510	0d538fca	55795b33	6bb7b021	39795005	64c94865	af094307	c3815fe3	e5ba7672	fb299884			987d0b7a		32c7478e	145ae095		
-1		147		1	159966		0	1	1		0		1	68fd1e64	38d50e09	c86b2d8d	657dc3b9	25c83c98	7e0ccccf	bc324536	1f89b562	7cc72ec2	474773a7	2bcfb78f	1ca7a526	e6fc496d	b28479f6	06373944	ba46c3a1	e5ba7672	fffe2a63	21ddcdc9	b1252a9d	eb0fc6f8	ad3062eb	32c7478e	df487a73	001f3601	c27f155b
+1		147		1	159966		0	1	1		0		1	68fd1e64	38d50e09	c86b2d8d	657dc3b9	25c83c98	7e0ccccf	bc324536	1f89b562	7cc72ec2	474773a7	2bcfb78f	1ca7a526	e6fc496d	b28479f6	06373944	ba46c3a1	e5ba7672	fffe2a63	21ddcdc9	b1252a9d	eb0fc6f8	ad3062eb	32c7478e	df487a73	001f3601	c27f155b
\ No newline at end of file