From 2bf26e1f1bfc4484e0752156c5c36b854e2a2cf4 Mon Sep 17 00:00:00 2001
From: yinhaofeng <1841837261@qq.com>
Date: Thu, 16 Jul 2020 14:39:22 +0000
Subject: [PATCH] add readme

---
 models/match/match-pyramid/readme.md | 94 ++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 models/match/match-pyramid/readme.md

diff --git a/models/match/match-pyramid/readme.md b/models/match/match-pyramid/readme.md
new file mode 100644
index 00000000..c0aaa483
--- /dev/null
+++ b/models/match/match-pyramid/readme.md
@@ -0,0 +1,94 @@
+# match-pyramid文本匹配模型
+
+## 介绍
+在许多自然语言处理任务中，匹配两个文本是一个基本问题。一种有效的方法是从单词，短语和句子中提取有意义的匹配模式以产生匹配分数。受卷积神经网络在图像识别中的成功启发，神经元可以根据提取的基本视觉模式（例如定向的边角和边角）捕获许多复杂的模式，所以我们尝试将文本匹配建模为图像识别问题。本模型对齐原作者庞亮开源的tensorflow代码：https://github.com/pl8787/MatchPyramid-TensorFlow/blob/master/model/model_mp.py， 实现了下述论文中提出的Match-Pyramid模型：
+
+```text
+@inproceedings{Pang L , Lan Y , Guo J , et al. Text Matching as Image Recognition[J]. 2016.,
+  title={Text Matching as Image Recognition},
+  author={Liang Pang, Yanyan Lan, Jiafeng Guo, Jun Xu, Shengxian Wan, Xueqi Cheng},
+  year={2016}
+}
+```
+
+## 数据准备
+训练及测试数据集选用Letor07数据集和 embed_wiki-pdc_d50_norm 词向量初始化embedding层。  
+该数据集包括：  
+1.词典文件：我们将每个单词映射得到一个唯一的编号wid，并将此映射保存在单词词典文件中。例如：word_dict.txt  
+2.语料库文件：我们使用字符串标识符的值表示一个句子的编号。第二个数字表示句子的长度。例如：qid_query.txt和docid_doc.txt  
+3.关系文件：关系文件被用来存储两个句子之间的关系，如query 和document之间的关系。例如：relation.train.fold1.txt, relation.test.fold1.txt  
+4.嵌入层文件：我们将预训练的词向量存储在嵌入文件中。例如：embed_wiki-pdc_d50_norm  
+
+## 数据下载和预处理
+本文提供了数据集的下载以及一键生成训练和测试数据的预处理脚本，您可以直接一键运行:bash data_process.sh  
+执行该脚本，会从国内源的服务器上下载Letor07数据集，删除掉data文件夹中原有的relation.test.fold1.txt和relation.train.fold1.txt，并将完整的数据集解压到data文件夹。随后运行 process.py 将全量训练数据放置于`./data/train`，全量测试数据放置于`./data/test`。并生成用于初始化embedding层的embedding.npy文件  
+执行该脚本的理想输出为：  
+```
+bash data_process.sh
+...........load  data...............
+--2020-07-13 13:24:50--  https://paddlerec.bj.bcebos.com/match_pyramid/match_pyramid_data.tar.gz
+Resolving paddlerec.bj.bcebos.com... 10.70.0.165
+Connecting to paddlerec.bj.bcebos.com|10.70.0.165|:443... connected.
+HTTP request sent, awaiting response... 200 OK
+Length: 214449643 (205M) [application/x-gzip]
+Saving to: “match_pyramid_data.tar.gz”
+
+100%[==========================================================================================================>] 214,449,643  114M/s   in 1.8s
+
+2020-07-13 13:24:52 (114 MB/s) - “match_pyramid_data.tar.gz” saved [214449643/214449643]
+
+data/
+data/relation.test.fold1.txt
+data/relation.test.fold2.txt
+data/relation.test.fold3.txt
+data/relation.test.fold4.txt
+data/relation.test.fold5.txt
+data/relation.train.fold1.txt
+data/relation.train.fold2.txt
+data/relation.train.fold3.txt
+data/relation.train.fold4.txt
+data/relation.train.fold5.txt
+data/relation.txt
+data/docid_doc.txt
+data/qid_query.txt
+data/word_dict.txt
+data/embed_wiki-pdc_d50_norm
+...........data process...............
+[./data/word_dict.txt]
+        Word dict size: 193367
+[./data/qid_query.txt]
+        Data size: 1692
+[./data/docid_doc.txt]
+        Data size: 65323
+[./data/embed_wiki-pdc_d50_norm]
+        Embedding size: 109282
+('Generate numpy embed:', (193368, 50))
+[./data/relation.train.fold1.txt]
+        Instance size: 47828
+('Pair Instance Count:', 325439)
+[./data/relation.test.fold1.txt]
+        Instance size: 13652
+```
+
+## 一键训练并测试评估
+本文提供了一键执行训练，测试和评估的脚本，您可以直接一键运行：bash run.sh  
+执行该脚本后，会执行python -m paddlerec.run -m ./config.yaml 命令开始训练并测试模型，将测试的结果保存到result.txt文件，最后通过执行eval.py进行评估得到数据的map指标  
+执行该脚本的理想输出为：  
+```
+..............test.................
+13651
+336
+('map=', 0.420878322843591)
+```
+
+## 每个文件的作用
+paddlerec可以：  
+通过config.yaml规定模型的参数  
+通过model.py规定模型的组网  
+使用train_reader.py读取训练集中的数据  
+使用test_reader.py读取测试集中的数据。  
+本文额外提供：  
+data_process.sh用来一键处理数据  
+run.sh用来一键启动训练，直接得出测试结果  
+eval.py通过保存的测试结果，计算map指标  
+如需详细了解paddlerec的使用方法请参考https://github.com/PaddlePaddle/PaddleRec/blob/master/README_CN.md 页面下方的教程。    
-- 
GitLab