How to Contribute
DeepInverse is a community-driven project and welcomes contributions of all forms. We are ultimately aiming for a comprehensive library of inverse problems and deep learning, and we need your help to get there!
We will acknowledge all contributors in the documentation and in the source code. Significant contributions will also be taken into account when deciding on the authorship of future publications.
The preferred way to contribute to deepinv
is to fork the main
repository on GitHub,
then submit a “Pull Request” (PR). When preparing the PR, please make sure to
check the following points:
The code is compliant with the black style. This can be done easily by installing the black library and running
black .
in the root directory of the repository after making the desired changes.The automatic tests pass on your local machine. This can be done by running
python -m pytest deepinv/tests
in the root directory of the repository after making the desired changes.The documentation is updated if necessary. After making the desired changes, this can be done in the directory
docs
by running one of the commands in the table below.
Command |
Description of command |
---|---|
|
Generates all the documentation |
|
Generates documentation faster but without plots |
|
Generates documentation for files matching |
If you are not familiar with the GitHub contribution workflow, you can also open an issue on the issue tracker and also ask any question in our discord server Discord server. We will then try to address the issue as soon as possible. You can also send an email to any of the main developers with your questions or ideas.