From e9853a9d64190a827b279dbd1c2acd0e2b1339bb Mon Sep 17 00:00:00 2001
From: malin10 <malin10@baidu.com>
Date: Mon, 18 May 2020 17:22:09 +0800
Subject: [PATCH] update recall/match readme

---
 models/match/multiview-simnet/config.yaml |  4 +--
 models/match/readme.md                    | 32 +++++------------------
 models/recall/readme.md                   | 27 ++++++-------------
 3 files changed, 17 insertions(+), 46 deletions(-)

diff --git a/models/match/multiview-simnet/config.yaml b/models/match/multiview-simnet/config.yaml
index 8399b40d..53ac4c09 100755
--- a/models/match/multiview-simnet/config.yaml
+++ b/models/match/multiview-simnet/config.yaml
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 evaluate:
-  workspace: "paddlerec.models.recall.multiview-simnet"
+  workspace: "paddlerec.models.match.multiview-simnet"
   reader:
     batch_size: 2
     class: "{workspace}/evaluate_reader.py"
@@ -24,7 +24,7 @@ train:
     strategy: "async"
 
   epochs: 2
-  workspace: "paddlerec.models.recall.multiview-simnet"
+  workspace: "paddlerec.models.match.multiview-simnet"
 
   reader:
     batch_size: 2
diff --git a/models/match/readme.md b/models/match/readme.md
index 1115eabd..6bccc109 100755
--- a/models/match/readme.md
+++ b/models/match/readme.md
@@ -9,13 +9,7 @@
 * [整体介绍](#整体介绍)
     * [匹配模型列表](#匹配模型列表)
 * [使用教程](#使用教程)
-    * [数据处理](#数据处理)
-    * [训练](#训练)
-    * [预测](#预测)
-* [效果对比](#效果对比)
-    * [模型效果列表](#模型效果列表)
-* [分布式](#分布式)
-    * [模型性能列表](#模型性能列表)
+    * [训练&预测](#训练&预测)
 
 ## 整体介绍
 ### 匹配模型列表
@@ -38,21 +32,9 @@
 <p>
 
 ## 使用教程
-### 数据处理
-### 训练
-### 预测
-
-## 效果对比
-### 模型效果列表
-
-|       数据集        |       模型       |       loss        |       auc       | 
-| :------------------: | :--------------------: | :---------: |:---------: |
-|       -        |       DSSM       |       --        |       --          |
-|       -        |       MultiView-Simnet       |       --        |       --          |
-
-## 分布式
-### 模型性能列表
-|       数据集        |       模型       |       单机        |       多机（同步）          |       多机（异步）          |       GPU          |
-| :------------------: | :--------------------: | :---------: |:---------: |:---------: |:---------: |
-|       -        |       DSSM       |       --        |       --          |       --          |       --          |
-|       -        |       MultiView-Simnet       |       --        |       --          |       --          |       --          |
+### 训练&预测
+```shell
+python -m paddlerec.run -m paddlerec.models.match.dssm # dssm
+python -m paddlerec.run -m paddlerec.models.match.multiview-simnet # multiview-simnet
+```
+
diff --git a/models/recall/readme.md b/models/recall/readme.md
index db1aa3cb..806e0a99 100755
--- a/models/recall/readme.md
+++ b/models/recall/readme.md
@@ -9,13 +9,9 @@
 * [整体介绍](#整体介绍)
     * [召回模型列表](#召回模型列表)
 * [使用教程](#使用教程)
-    * [数据处理](#数据处理)
-    * [训练](#训练)
-    * [预测](#预测)
+    * [训练&预测](#训练&预测)
 * [效果对比](#效果对比)
     * [模型效果列表](#模型效果列表)
-* [分布式](#分布式)
-    * [模型性能列表](#模型性能列表)
 
 ## 整体介绍
 ### 召回模型列表
@@ -50,12 +46,13 @@
 <p>
 
 ## 使用教程
-### 数据处理
-
-### 训练
-
-### 预测
-
+### 训练&预测
+```shell
+python -m paddlerec.run -m paddlerec.models.recall.word2vec # word2vec
+python -m paddlerec.run -m paddlerec.models.recall.ssr # ssr
+python -m paddlerec.run -m paddlerec.models.recall.gru4rec # gru4rec
+python -m paddlerec.run -m paddlerec.models.recall.gnn # gnn
+```
 ## 效果对比
 ### 模型效果列表
 
@@ -66,11 +63,3 @@
 |       RSC15        |       SSR       |       --        |       0.590          |
 |       1 Billion Word Language Model Benchmark        |       Word2Vec       |       --         |       0.54          |
 
-## 分布式
-### 模型性能列表
-|       数据集        |       模型       |       单机        |       多机（同步）          |       多机（异步）          |       GPU          |
-| :------------------: | :--------------------: | :---------: |:---------: |:---------: |:---------: |
-|       DIGINETICA        |       GNN       |       --        |       --          |       --          |       --          |
-|       RSC15        |       GRU4REC       |       --        |       --          |       --          |       --          |
-|       RSC15        |       SSR       |       --        |       --          |       --          |       --          |
-|       1 Billion Word Language Model Benchmark        |       Word2Vec       |       --        |       --          |       --          |       --          |
-- 
GitLab