-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update MatchZoo * Update README.md * Update README.md * Change logo URL * Update README.md * Update README.md * Update badge * Add pytorch-transformers requirement * MatchZoo v1.0
- Loading branch information
Showing
11 changed files
with
1,013 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Describe the bug | ||
Please provide a clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem, especially for visualization related problems. | ||
|
||
### To Reproduce | ||
Please provide a [Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) here. We hope we can simply copy/paste/run it. It is also nice to share a hosted runnable script (e.g. Google Colab), especially for hardware-related problems. | ||
|
||
### Describe your attempts | ||
- [ ] I checked the documentation and found no answer | ||
- [ ] I checked to make sure that this is not a duplicate issue | ||
|
||
You should also provide code snippets you tried as a workaround, StackOverflow solution that you have walked through, or your best guess of the cause that you can't locate (e.g. cosmic radiation). | ||
|
||
### Context | ||
- **OS** [e.g. Windows 10, macOS 10.14]: | ||
- **Hardware** [e.g. CPU only, GTX 1080 Ti]: | ||
|
||
In addition, figure out your MatchZoo version by running `import matchzoo; matchzoo.__version__`. | ||
|
||
### Additional Information | ||
Other things you want the developers to know. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
- [ ] I checked to make sure that this is not a duplicate issue | ||
- [ ] I'm submitting the request to the correct repository (for model requests, see [here](https://github.com/NTMC-Community/awaresome-neural-models-for-semantic-match)) | ||
|
||
### Is your feature request related to a problem? Please describe. | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
### Describe the solution you'd like | ||
A clear and concise description of what you want to happen. | ||
|
||
### Describe alternatives you've considered | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
### Additional Information | ||
Other things you want the developers to know. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Usage Question | ||
about: Ask a question about MatchZoo usage | ||
title: '' | ||
labels: question | ||
assignees: '' | ||
|
||
--- | ||
|
||
### Describe the Question | ||
Please provide a clear and concise description of what the question is. | ||
|
||
### Describe your attempts | ||
- [ ] I walked through the tutorials | ||
- [ ] I checked the documentation | ||
- [ ] I checked to make sure that this is not a duplicate question | ||
|
||
You may also provide a [Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) you tried as a workaround, or StackOverflow solution that you have walked through. (e.g. cosmic radiation). | ||
|
||
In addition, figure out your MatchZoo version by running `import matchzoo; matchzoo.__version__`. |
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Watchers and contributors to MatchZoo repo directories/packages/files | ||
# Please see documentation of use of CODEOWNERS file at | ||
# https://help.github.com/articles/about-codeowners/ and | ||
# https://github.com/blog/2392-introducing-code-owners | ||
# | ||
# Anybody can add themselves or a team as additional watcher or contributor | ||
# 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. | ||
|
||
# global owner. | ||
* @faneshion | ||
* @Chriskuei | ||
|
||
# third-party & project configuration | ||
.codecov.yml @Chriskuei | ||
.coveragerc @Chriskuei | ||
.flake8 @Chriskuei | ||
.gitignore @faneshion | ||
.travis.yml @Chriskuei | ||
CONTRIBUTING.MD @Chriskuei | ||
Makefile @faneshion @Chriskuei | ||
pytest.ini @Chriskuei | ||
README.md @faneshion @Chriskuei | ||
readthedocs.yml @wqh17101 | ||
requirements.txt @faneshion @Chriskuei | ||
setup.py @faneshion @Chriskuei | ||
|
||
# artworks | ||
/artworks/ @faneshion | ||
|
||
# tutorials | ||
/tutorials/ @Chriskuei @faneshion | ||
|
||
# docs | ||
/docs/ @wqh17101 | ||
|
||
# tests | ||
/tests/ @Chriskuei @faneshion | ||
|
||
# matchzoo | ||
|
||
/matchzoo/auto/ @Chriskuei | ||
/matchzoo/data_pack/ @faneshion @caiyinqiong | ||
/matchzoo/dataloader/ @caiyinqiong @Chriskuei | ||
/matchzoo/datasets/ @caiyinqiong | ||
/matchzoo/embedding/ @caiyinqiong | ||
/matchzoo/engine/ @faneshion @Chriskuei | ||
/matchzoo/losses/ @faneshion @Chriskuei | ||
/matchzoo/metrics/ @faneshion @Chriskuei | ||
/matchzoo/models/ @Chriskuei @faneshion | ||
/matchzoo/modules/ @Chriskuei | ||
/matchzoo/preprocessors/ @caiyinqiong @faneshion | ||
/matchzoo/tasks/ @Chriskuei | ||
/matchzoo/trainers/ @Chriskuei | ||
/matchzoo/utils/ @Chriskuei @caiyinqiong | ||
/matchzoo/* @faneshion @Chriskuei |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
Contributing to MatchZoo | ||
---------- | ||
|
||
> Note: MatchZoo 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. | ||
|
||
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! | ||
|
||
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. | ||
|
||
First Time Contributors | ||
----------------------- | ||
|
||
MatchZoo appreciates your contribution! If you are interested in helping improve MatchZoo, 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). | ||
* Work on [documentation](https://github.com/NTMC-Community/MatchZoo-py/tree/master/docs). | ||
* Try to answer questions on [the issue tracker](https://github.com/NTMC-Community/MatchZoo-py/issues). | ||
|
||
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. | ||
|
||
(*) 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. | ||
|
||
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. | ||
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). | ||
|
||
Contributing Flow | ||
------------------ | ||
|
||
1. Fork the latest version of [MatchZoo-py](https://github.com/NTMC-Community/MatchZoo-py) into your repo. | ||
2. Create an issue under [NTMC-Community/MatchZoo-py](https://github.com/NTMC-Community/MatchZoo-py/issues), write description about the bug/enhancement. | ||
3. Clone your forked MatchZoo into your machine, add your changes together with associated tests. | ||
4. Run `make push` with terminal, ensure all unit tests & integration tests passed on your computer. | ||
5. Push to your forked repo, then send the pull request to the official repo. In pull request, you need to create a link to the issue you created using `#[issue_id]`, and describe what has been changed. | ||
6. Wait [continuous integration](https://travis-ci.org/NTMC-Community/MatchZoo-py) passed. | ||
7. Wait [Codecov](https://codecov.io/gh/NTMC-Community/MatchZoo-py) generate the coverage report. | ||
8. We'll assign reviewers to review your code. | ||
|
||
|
||
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. | ||
|
||
|
||
**Thanks and let's improve MatchZoo together!** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.