Welcome to our unofficial reimplementation of GENIE paper project.
We are wanting to reimplement this amazing method in order to make it accessible to the community and make it possible to reuse it for further purposes.
We are open to any contribution : improving documentation, model implementations/corrections, new features, bugs fixing, optimization,... If the feature you search is not already implemented or in the TODO list, ask for it in the issue section of the repo.
- If you find a bug please submit a GitHub issue.
- Make sure the title explains the issue.
- Describe your setup, what you are trying to do, expected vs. actual behaviour. Please add configs and code samples.
- Add details on how to reproduce the issue - a minimal test case is always best, colab is also great. Note, that the sample code shall be minimal and if needed with publicly available data.
- Try to fix it or recommend a solution.
- Convert your minimal code example to a unit/integration test with assert on expected results.
- Start by debugging the issue.
- Verify that your test case fails on the master branch and only passes with the fix applied.
- Submit a PR!
- Submit a GitHub issue - describe what is the motivation of such feature (adding the use case, or an example is helpful).
- Determine the feature scope with us.
- Submit a PR!
- Write a test for the functionality you want to add.
- Write the functional code until the test passes.
- Add/update the relevant tests!
To keep the project working as it should, we welcome any testing contribution to make sure that every bricks are working great together. If you fall into an error that has not been yet covered by a test, it means that we needs your contribution.
The best practice would be to follow Google's guideline : https://google.github.io/styleguide/pyguide.html