Home

Awesome

<div align='center'> <img src="https://github.com/NTMC-Community/MatchZoo-py/blob/master/artworks/matchzoo-logo.png?raw=true" width = "400" alt="logo" align="center" /> </div>

MatchZoo-py Tweet

PyTorch version of MatchZoo.

Facilitating the design, comparison and sharing of deep text matching models.<br/> MatchZoo 是一个通用的文本匹配工具包,它旨在方便大家快速的实现、比较、以及分享最新的深度文本匹配模型。

Python 3.6 Pypi Downloads Documentation Status Build Status codecov License Requirements Status Gitter

The goal of MatchZoo is to provide a high-quality codebase for deep text matching research, such as document retrieval, question answering, conversational response ranking, and paraphrase identification. With the unified data processing pipeline, simplified model configuration and automatic hyper-parameters tunning features equipped, MatchZoo is flexible and easy to use.

<table> <tr> <th width=30%, bgcolor=#999999 >Tasks</th> <th width=20%, bgcolor=#999999>Text 1</th> <th width="20%", bgcolor=#999999>Text 2</th> <th width="20%", bgcolor=#999999>Objective</th> </tr> <tr> <td align="center", bgcolor=#eeeeee> Paraphrase Indentification </td> <td align="center", bgcolor=#eeeeee> string 1 </td> <td align="center", bgcolor=#eeeeee> string 2 </td> <td align="center", bgcolor=#eeeeee> classification </td> </tr> <tr> <td align="center", bgcolor=#eeeeee> Textual Entailment </td> <td align="center", bgcolor=#eeeeee> text </td> <td align="center", bgcolor=#eeeeee> hypothesis </td> <td align="center", bgcolor=#eeeeee> classification </td> </tr> <tr> <td align="center", bgcolor=#eeeeee> Question Answer </td> <td align="center", bgcolor=#eeeeee> question </td> <td align="center", bgcolor=#eeeeee> answer </td> <td align="center", bgcolor=#eeeeee> classification/ranking </td> </tr> <tr> <td align="center", bgcolor=#eeeeee> Conversation </td> <td align="center", bgcolor=#eeeeee> dialog </td> <td align="center", bgcolor=#eeeeee> response </td> <td align="center", bgcolor=#eeeeee> classification/ranking </td> </tr> <tr> <td align="center", bgcolor=#eeeeee> Information Retrieval </td> <td align="center", bgcolor=#eeeeee> query </td> <td align="center", bgcolor=#eeeeee> document </td> <td align="center", bgcolor=#eeeeee> ranking </td> </tr> </table>

Get Started in 60 Seconds

To train a Deep Semantic Structured Model, make use of MatchZoo customized loss functions and evaluation metrics to define a task:

import torch
import matchzoo as mz

ranking_task = mz.tasks.Ranking(losses=mz.losses.RankCrossEntropyLoss(num_neg=4))
ranking_task.metrics = [
    mz.metrics.NormalizedDiscountedCumulativeGain(k=3),
    mz.metrics.MeanAveragePrecision()
]

Prepare input data:

train_pack = mz.datasets.wiki_qa.load_data('train', task=ranking_task)
valid_pack = mz.datasets.wiki_qa.load_data('dev', task=ranking_task)

Preprocess your input data in three lines of code, keep track parameters to be passed into the model:

preprocessor = mz.models.ArcI.get_default_preprocessor()
train_processed = preprocessor.fit_transform(train_pack)
valid_processed = preprocessor.transform(valid_pack)

Generate pair-wise training data on-the-fly:

trainset = mz.dataloader.Dataset(
    data_pack=train_processed,
    mode='pair',
    num_dup=1,
    num_neg=4,
    batch_size=32
)
validset = mz.dataloader.Dataset(
    data_pack=valid_processed,
    mode='point',
    batch_size=32
)

Define padding callback and generate data loader:

padding_callback = mz.models.ArcI.get_default_padding_callback()

trainloader = mz.dataloader.DataLoader(
    dataset=trainset,
    stage='train',
    callback=padding_callback
)
validloader = mz.dataloader.DataLoader(
    dataset=validset,
    stage='dev',
    callback=padding_callback
)

Initialize the model, fine-tune the hyper-parameters:

model = mz.models.ArcI()
model.params['task'] = ranking_task
model.params['embedding_output_dim'] = 100
model.params['embedding_input_dim'] = preprocessor.context['embedding_input_dim']
model.guess_and_fill_missing_params()
model.build()

Trainer is used to control the training flow:

optimizer = torch.optim.Adam(model.parameters())

trainer = mz.trainers.Trainer(
    model=model,
    optimizer=optimizer,
    trainloader=trainloader,
    validloader=validloader,
    epochs=10
)

trainer.run()

References

Tutorials

English Documentation

If you're interested in the cutting-edge research progress, please take a look at awaresome neural models for semantic match.

Install

MatchZoo-py is dependent on PyTorch. Two ways to install MatchZoo-py:

Install MatchZoo-py from Pypi:

pip install matchzoo-py

Install MatchZoo-py from the Github source:

git clone https://github.com/NTMC-Community/MatchZoo-py.git
cd MatchZoo-py
python setup.py install

Models

Citation

If you use MatchZoo in your research, please use the following BibTex entry.

@inproceedings{Guo:2019:MLP:3331184.3331403,
 author = {Guo, Jiafeng and Fan, Yixing and Ji, Xiang and Cheng, Xueqi},
 title = {MatchZoo: A Learning, Practicing, and Developing System for Neural Text Matching},
 booktitle = {Proceedings of the 42Nd International ACM SIGIR Conference on Research and Development in Information Retrieval},
 series = {SIGIR'19},
 year = {2019},
 isbn = {978-1-4503-6172-9},
 location = {Paris, France},
 pages = {1297--1300},
 numpages = {4},
 url = {http://doi.acm.org/10.1145/3331184.3331403},
 doi = {10.1145/3331184.3331403},
 acmid = {3331403},
 publisher = {ACM},
 address = {New York, NY, USA},
 keywords = {matchzoo, neural network, text matching},
} 

Development Team

​ ​ ​ ​

<table border="0"> <tbody> <tr align="center"> <td> ​ <a href="https://github.com/faneshion"><img width="40" height="40" src="https://github.com/faneshion.png?s=40" alt="faneshion"></a><br> ​ <a href="http://www.bigdatalab.ac.cn/~fanyixing/">Yixing Fan</a> ​ <p>Core Dev<br> ASST PROF, ICT</p>​ </td> <td> <a href="https://github.com/Chriskuei"><img width="40" height="40" src="https://github.com/Chriskuei.png?s=40" alt="Chriskuei"></a><br> <a href="https://github.com/Chriskuei">Jiangui Chen</a> ​ <p>Core Dev<br> PhD. ICT</p>​ </td> <td> ​ <a href="https://github.com/caiyinqiong"><img width="40" height="40" src="https://github.com/caiyinqiong.png?s=36" alt="caiyinqiong"></a><br> <a href="https://github.com/caiyinqiong">Yinqiong Cai</a> <p>Core Dev<br> M.S. ICT</p>​ </td> <td> ​ <a href="https://github.com/pl8787"><img width="40" height="40" src="https://github.com/pl8787.png?s=40" alt="pl8787"></a><br> ​ <a href="https://github.com/pl8787">Liang Pang</a> ​ <p>Core Dev<br> ASST PROF, ICT</p>​ </td> <td> ​ <a href="https://github.com/lixinsu"><img width="40" height="40" src="https://github.com/lixinsu.png?s=40" alt="lixinsu"></a><br> ​ <a href="https://github.com/lixinsu">Lixin Su</a> <p>Dev<br> PhD. ICT</p>​ </td> </tr> <tr align="center"> <td> ​ <a href="https://github.com/ChrisRBXiong"><img width="40" height="40" src="https://github.com/ChrisRBXiong.png?s=40" alt="ChrisRBXiong"></a><br> ​ <a href="https://github.com/ChrisRBXiong">Ruibin Xiong</a> ​ <p>Dev<br> M.S. ICT</p>​ </td> <td> ​ <a href="https://github.com/dyuyang"><img width="40" height="40" src="https://github.com/dyuyang.png?s=40" alt="dyuyang"></a><br> ​ <a href="https://github.com/dyuyang">Yuyang Ding</a> ​ <p>Dev<br> M.S. ICT</p>​ </td> <td> ​ <a href="https://github.com/rgtjf"><img width="40" height="40" src="https://github.com/rgtjf.png?s=36" alt="rgtjf"></a><br> ​ <a href="https://github.com/rgtjf">Junfeng Tian</a> ​ <p>Dev<br> M.S. ECNU</p>​ </td> <td> ​ <a href="https://github.com/wqh17101"><img width="40" height="40" src="https://github.com/wqh17101.png?s=40" alt="wqh17101"></a><br> ​ <a href="https://github.com/wqh17101">Qinghua Wang</a> ​ <p>Documentation<br> B.S. Shandong Univ.</p>​ </td> </tr> </tbody> </table>

Contribution

Please make sure to read the Contributing Guide before creating a pull request. If you have a MatchZoo-related paper/project/compnent/tool, send a pull request to this awesome list!

Thank you to all the people who already contributed to MatchZoo!

Bo Wang, Zeyi Wang, Liu Yang, Zizhen Wang, Zhou Yang, Jianpeng Hou, Lijuan Chen, Yukun Zheng, Niuguo Cheng, Dai Zhuyun, Aneesh Joshi, Zeno Gantner, Kai Huang, stanpcf, ChangQF, Mike Kellogg

Project Organizers

License

Apache-2.0

Copyright (c) 2019-present, Yixing Fan (faneshion)