Merge pull request #96 from NTMC-Community/dev

Version 1.1

Author: Chriskuei

.flake8

@@ -1,4 +1,9 @@
 [flake8]
+
+# Maximum number of characters on a single line.  Ideally, lines should be under 79 characters,
+# but we allow some leeway before calling it an error.
+max-line-length = 90
+
 ignore = 
     # D401 First line should be in imperative mood
     D401,

.gitattributes

@@ -0,0 +1 @@
+tutorials/* linguist-vendored

.gitignore

@@ -26,4 +26,5 @@ notebooks/wikiqa/.ipynb_checkpoints/*
 .cache
 .tmpdir
 htmlcov/
-docs/_build
+docs/_build
+matchzoo_py.egg-info/

CODEOWNERS

@@ -7,7 +7,7 @@
 # to get notified about changes in a specific package.
 # See https://help.github.com/articles/about-teams how to setup teams.
 
-#  Define individuals or teams that are responsible for code in a repository.
+# Define individuals or teams that are responsible for code in a repository.
 
 # global owner.
 *       @faneshion

CONTRIBUTING.md

@@ -1,23 +1,23 @@
-Contributing to MatchZoo
+Contributing to MatchZoo-py
 ----------
 
-> Note: MatchZoo is developed under Python 3.6.
+> Note: MatchZoo-py is developed under Python 3.6.
 
-Welcome! MatchZoo is a community project that aims to work for a wide range of NLP and IR tasks such as Question Answering, Information Retrieval, Paraphrase identification etc. Your experience and what you can contribute are important to the project's success.
+Welcome! MatchZoo-py is a community project that aims to work for a wide range of NLP and IR tasks such as Question Answering, Information Retrieval, Paraphrase identification etc. Your experience and what you can contribute are important to the project's success.
 
 Discussion
 ----------
 
-If you've run into behavior in MatchZoo you don't understand, or you're having trouble working out a good way to apply it to your code, or you've found a bug or would like a feature it doesn't have, we want to hear from you!
+If you've run into behavior in MatchZoo-py you don't understand, or you're having trouble working out a good way to apply it to your code, or you've found a bug or would like a feature it doesn't have, we want to hear from you!
 
 Our main forum for discussion is the project's [GitHub issue tracker](https://github.com/NTMC-Community/MatchZoo-py/issues).  This is the right place to start a discussion of any of the above or most any other topic concerning the project.
 
-For less formal discussion we have a chat room on WeChat (mostly Chinese speakers). MatchZoo core developers are almost always present; feel free to find us there and we're happy to chat. Please add *YQ-Cai1198593462* as your WeChat friend, she will invite you to join the chat room.
+For less formal discussion we have a chat room on WeChat (mostly Chinese speakers). MatchZoo-py core developers are almost always present; feel free to find us there and we're happy to chat. Please add *YQ-Cai1198593462* as your WeChat friend, she will invite you to join the chat room.
 
 First Time Contributors
 -----------------------
 
-MatchZoo appreciates your contribution! If you are interested in helping improve MatchZoo, there are several ways to get started:
+MatchZoo-py appreciates your contribution! If you are interested in helping improve MatchZoo-py, there are several ways to get started:
 
 * Work on [new models](https://github.com/NTMC-Community/awaresome-neural-models-for-semantic-match).
 * Work on [tutorials](https://github.com/NTMC-Community/MatchZoo-py/tree/master/tutorials).
@@ -27,19 +27,19 @@ MatchZoo appreciates your contribution! If you are interested in helping improve
 Submitting Changes
 ------------------
 
-Even more excellent than a good bug report is a fix for a bug, or the implementation of a much-needed new model. 
+Even more excellent than a good bug report is a fix for a bug, or the implementation of a much-needed new model.
 
 (*)  We'd love to have your contributions.
 
 (*) If your new feature will be a lot of work, we recommend talking to us early -- see below.
 
-We use the usual GitHub pull-request flow, which may be familiar to you if you've contributed to other projects on GitHub -- see below. 
+We use the usual GitHub pull-request flow, which may be familiar to you if you've contributed to other projects on GitHub -- see below.
 
-Anyone interested in MatchZoo may review your code.  One of the MatchZoo core developers will merge your pull request when they think it's ready.
+Anyone interested in MatchZoo-py may review your code.  One of the MatchZoo-py core developers will merge your pull request when they think it's ready.
 For every pull request, we aim to promptly either merge it or say why it's not yet ready; if you go a few days without a reply, please feel
 free to ping the thread by adding a new comment.
 
-For a list of MatchZoo core developers, see [README](https://github.com/NTMC-Community/MatchZoo-py/blob/master/README.md).
+For a list of MatchZoo-py core developers, see [README](https://github.com/NTMC-Community/MatchZoo-py/blob/master/README.md).
 
 Contributing Flow
 ------------------
@@ -55,12 +55,12 @@ Contributing Flow
 
 
 Your PR will be merged if:
-- Funcitonally benefit for the project.
-- Passed Countinuous Integration (all unit tests, integration tests and [PEP8](https://www.python.org/dev/peps/pep-0008/) check passed).
-- Test coverage didn't decreased, we use [pytest](https://docs.pytest.org/en/latest/).
-- With proper docstrings, see codebase as examples.
-- With type hints, see [typing](https://docs.python.org/3/library/typing.html). 
-- All reviewers approved your changes.
+    - Funcitonally benefit for the project.
+    - Passed Countinuous Integration (all unit tests, integration tests and [PEP8](https://www.python.org/dev/peps/pep-0008/) check passed).
+    - Test coverage didn't decreased, we use [pytest](https://docs.pytest.org/en/latest/).
+    - With proper docstrings, see codebase as examples.
+    - With type hints, see [typing](https://docs.python.org/3/library/typing.html).
+    - All reviewers approved your changes.
 
 
-**Thanks and let's improve MatchZoo together!**
+**Thanks and let's improve MatchZoo-py together!**

MANIFEST.in

@@ -1 +1 @@
-recursive-include matchzoo/datasets/toy *
+recursive-include matchzoo/datasets/toy *

README.md

@@ -85,7 +85,7 @@ 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:
 
 ```python
-preprocessor = mz.models.DSSM.get_default_preprocessor()
+preprocessor = mz.models.ArcI.get_default_preprocessor()
 train_processed = preprocessor.fit_transform(train_pack)
 valid_processed = preprocessor.transform(valid_pack)
 ```
@@ -106,7 +106,7 @@ validset = mz.dataloader.Dataset(
 
 Define padding callback and generate data loader:
 ```python
-padding_callback = mz.models.DSSM.get_default_padding_callback()
+padding_callback = mz.models.ArcI.get_default_padding_callback()
 
 trainloader = mz.dataloader.DataLoader(
     dataset=trainset,
@@ -125,7 +125,7 @@ validloader = mz.dataloader.DataLoader(
 Initialize the model, fine-tune the hyper-parameters:
 
 ```python
-model = mz.models.DSSM()
+model = mz.models.ArcI()
 model.params['task'] = ranking_task
 model.params['vocab_size'] = preprocessor.context['vocab_size']
 model.guess_and_fill_missing_params()
@@ -188,8 +188,13 @@ python setup.py install
 - [ConvKNRM](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/conv_knrm.py): this model is an implementation of <a href="http://www.cs.cmu.edu/~zhuyund/papers/WSDM_2018_Dai.pdf">Convolutional neural networks for soft-matching n-grams in ad-hoc search</a>
 - [ESIM](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/esim.py): this model is an implementation of <a href="https://arxiv.org/abs/1609.06038">Enhanced LSTM for Natural Language Inference</a>
 - [BiMPM](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/bimpm.py): this model is an implementation of <a href="https://arxiv.org/abs/1702.03814">Bilateral Multi-Perspective Matching for Natural Language Sentences</a>
-
-- Models under development: <a href="https://arxiv.org/abs/1602.06359">MatchPyramid</a>, <a href="https://arxiv.org/abs/1604.04378">Match-SRNN</a>, <a href="https://arxiv.org/abs/1710.05649">DeepRank</a>, <a href="https://arxiv.org/abs/1801.01641">aNMM</a> .... 
+- [MatchPyramid](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/match_pyramid.py): this model is an implementation of <a href="https://arxiv.org/abs/1602.06359">Text Matching as Image Recognition</a>
+- [Match-SRNN](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/match_srnn.py): this model is an implementation of <a href="https://arxiv.org/abs/1604.04378">Match-SRNN: Modeling the Recursive Matching Structure with Spatial RNN</a>
+- [aNMM](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/anmm.py): this model is an implementation of <a href="https://arxiv.org/abs/1801.01641">aNMM: Ranking Short Answer Texts with Attention-Based Neural Matching Model</a>
+- [MV-LSTM](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/mvlstm.py): this model is an implementation of <a href="https://arxiv.org/pdf/1511.08277.pdf">A Deep Architecture for Semantic Matching with Multiple Positional Sentence Representations</a>
+- [DIIN](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/diin.py): this model is an implementation of <a href="https://arxiv.org/pdf/1709.04348.pdf">Natural Lanuguage Inference Over Interaction Space</a>
+- [HBMP](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/hbmp.py): this model is an implementation of <a href="https://arxiv.org/pdf/1808.08762.pdf">Sentence Embeddings in NLI with Iterative Refinement Encoders</a>
+- [BERT](https://github.com/NTMC-Community/MatchZoo-py/tree/master/matchzoo/models/bert.py): this model is an implementation of <a href="https://arxiv.org/abs/1810.04805">BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding</a>
 
 
 ## Citation
@@ -251,6 +256,20 @@ If you use MatchZoo in your research, please use the following BibTex entry.
         <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> ​