From e6f590c185e7b125835ff0c0517e74da99054306 Mon Sep 17 00:00:00 2001
From: malin10 <malin10@baidu.com>
Date: Tue, 12 May 2020 21:05:51 +0800
Subject: [PATCH] add recall/readme

---
 models/recall/readme.md | 61 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100755 models/recall/readme.md

diff --git a/models/recall/readme.md b/models/recall/readme.md
new file mode 100755
index 00000000..5511ba2f
--- /dev/null
+++ b/models/recall/readme.md
@@ -0,0 +1,61 @@
+# 召回模型库
+
+## 简介
+我们提供了常见的召回任务中使用的模型算法的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)。
+
+模型算法库在持续添加中，欢迎关注。
+
+## 目录
+* [整体介绍](#整体介绍)
+    * [召回模型列表](#召回模型列表)
+* [使用教程](#使用教程)
+    * [数据处理](#数据处理)
+    * [训练](#训练)
+    * [预测](#预测)
+* [效果对比](#效果对比)
+    * [模型效果列表](#模型效果列表)
+* [分布式](#分布式)
+    * [模型性能列表](#模型性能列表)
+
+## 整体介绍
+### 召回模型列表
+
+|       模型        |       简介        |       论文        |
+| :------------------: | :--------------------: | :---------: |
+| GNN | SR-GNN | [Session-based Recommendation with Graph Neural Networks](https://arxiv.org/abs/1811.00855)(2018) |
+| GRU4REC | SR-GRU | [Session-based Recommendations with Recurrent Neural Networks](https://arxiv.org/abs/1511.06939)(2015) |
+| SSR | Sequence Semantic Retrieval Model | [Multi-Rate Deep Learning for Temporal Recommendation](http://sonyis.me/paperpdf/spr209-song_sigir16.pdf)(2016) |
+| TDM | Tree-based Deep Model | [Learning Tree-based Deep Model for Recommender Systems](https://arxiv.org/pdf/1801.02294.pdf)(2018) |
+| Word2Vec | word2vector | [Distributed Representations of Words and Phrases and their Compositionality](https://papers.nips.cc/paper/5021-distributed-representations-of-words-and-phrases-and-their-compositionality.pdf)(2013) |
+
+## 使用教程
+### 数据处理
+```shell
+sh data_process.sh
+```
+### 训练
+```shell
+python -m fleetrec.run -m config.yaml -d cpu -e single 
+```
+### 预测
+
+## 效果对比
+### 模型效果列表
+
+|       数据集        |       模型       |       loss        |       测试Recall@20       | 
+| :------------------: | :--------------------: | :---------: |:---------: |
+|       DIGINETICA     |       GNN       |       --        |       0.507       |
+|       RSC15        |       GRU4REC       |       --        |       0.67          |
+|       RSC15        |       SSR       |       --        |       --          |
+|       -        |       TDM       |       --        |       --          |
+|       1 Billion Word Language Model Benchmark        |       Word2Vec       |       --         |       0.54          |
+
+## 分布式
+### 模型性能列表
+|       数据集        |       模型       |       单机        |       多机（同步）          |       多机（异步）          |       GPU          |
+| :------------------: | :--------------------: | :---------: |:---------: |:---------: |:---------: |
+|       DIGINETICA        |       GNN       |       --        |       --          |       --          |       --          |
+|       RSC15        |       GRU4REC       |       --        |       --          |       --          |       --          |
+|       RSC15        |       SSR       |       --        |       --          |       --          |       --          |
+|       -        |       TDM       |       --        |       --          |       --          |       --          |
+|       1 Billion Word Language Model Benchmark        |       Word2Vec       |       --        |       --          |       --          |       --          |
-- 
GitLab