From b2a8248dc8e7f92621249f4219aa67a7514e762b Mon Sep 17 00:00:00 2001
From: malin10 <malin10@baidu.com>
Date: Tue, 12 May 2020 21:25:50 +0800
Subject: [PATCH] update readme

---
 models/match/readme.md  | 46 +++++++++++++++++++++++++++++++++++++++++
 models/recall/readme.md |  4 ++--
 2 files changed, 48 insertions(+), 2 deletions(-)
 create mode 100755 models/match/readme.md

diff --git a/models/match/readme.md b/models/match/readme.md
new file mode 100755
index 00000000..f1df59ec
--- /dev/null
+++ b/models/match/readme.md
@@ -0,0 +1,46 @@
+# 匹配通用模型库
+
+## 简介
+我们提供了常见的匹配任务中均可以使用的模型算法的PaddleRec实现, 单机训练&预测效果指标以及分布式训练&预测性能指标等。实现的模型包括 [DSSM](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/match/dssm)、[MultiView-Simnet](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/match/multiview-simnet)。
+
+模型算法库在持续添加中，欢迎关注。
+
+## 目录
+* [整体介绍](#整体介绍)
+    * [匹配模型列表](#匹配模型列表)
+* [使用教程](#使用教程)
+    * [数据处理](#数据处理)
+    * [训练](#训练)
+    * [预测](#预测)
+* [效果对比](#效果对比)
+    * [模型效果列表](#模型效果列表)
+* [分布式](#分布式)
+    * [模型性能列表](#模型性能列表)
+
+## 整体介绍
+### 匹配模型列表
+
+|       模型        |       简介        |       论文        |
+| :------------------: | :--------------------: | :---------: |
+| DSSM | Deep Structured Semantic Models | [Learning Deep Structured Semantic Models for Web Search using Clickthrough Data](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/cikm2013_DSSM_fullversion.pdf)(2013) |
+| MultiView-Simnet | Multi-view Simnet for Personalized recommendation | [A Multi-View Deep Learning Approach for Cross Domain User Modeling in Recommendation Systems](https://www.microsoft.com/en-us/research/wp-content/uploads/2016/02/frp1159-songA.pdf)(2015) |
+
+## 使用教程
+### 数据处理
+### 训练
+### 预测
+
+## 效果对比
+### 模型效果列表
+
+|       数据集        |       模型       |       loss        |       auc       | 
+| :------------------: | :--------------------: | :---------: |:---------: |
+|       -        |       DSSM       |       --        |       --          |
+|       -        |       MultiView-Simnet       |       --        |       --          |
+
+## 分布式
+### 模型性能列表
+|       数据集        |       模型       |       单机        |       多机（同步）          |       多机（异步）          |       GPU          |
+| :------------------: | :--------------------: | :---------: |:---------: |:---------: |:---------: |
+|       -        |       DSSM       |       --        |       --          |       --          |       --          |
+|       -        |       MultiView-Simnet       |       --        |       --          |       --          |       --          |
diff --git a/models/recall/readme.md b/models/recall/readme.md
index 5511ba2f..79b95fb4 100755
--- a/models/recall/readme.md
+++ b/models/recall/readme.md
@@ -1,7 +1,7 @@
 # 召回模型库
 
 ## 简介
-我们提供了常见的召回任务中使用的模型算法的PaddleRec实现, 单机训练&预测效果指标以及分布式训练&预测性能指标等。实现的排序模型包括 [SR-GNN](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/gnn)、[GRU4REC](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/gru4rec)、[Sequence Semantic Retrieval Model](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/ssr)、 [Tree-based Deep Model](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/tdm)、[Word2Vector](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/word2vec)。
+我们提供了常见的召回任务中使用的模型算法的PaddleRec实现, 单机训练&预测效果指标以及分布式训练&预测性能指标等。实现的召回模型包括 [SR-GNN](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/gnn)、[GRU4REC](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/gru4rec)、[Sequence Semantic Retrieval Model](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/ssr)、 [Tree-based Deep Model](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/tdm)、[Word2Vector](http://gitlab.baidu.com/tangwei12/paddlerec/tree/develop/models/recall/word2vec)。
 
 模型算法库在持续添加中，欢迎关注。
 
@@ -42,7 +42,7 @@ python -m fleetrec.run -m config.yaml -d cpu -e single
 ## 效果对比
 ### 模型效果列表
 
-|       数据集        |       模型       |       loss        |       测试Recall@20       | 
+|       数据集        |       模型       |       loss        |       Recall@20       | 
 | :------------------: | :--------------------: | :---------: |:---------: |
 |       DIGINETICA     |       GNN       |       --        |       0.507       |
 |       RSC15        |       GRU4REC       |       --        |       0.67          |
-- 
GitLab