Thank you for contributing to DeepInverse!
Please read our contributing guidelines for instructions on how to contribute, including writing tests, documentation and code style.
Once the GitHub tests have been approved by a maintainer (only required for first-time contributors), and the Build Docs GitHub action has run successfully, you can download the documentation as a zip file from the Actions page. Look for the workflow run corresponding to your pull request.
-
python3 -m pytest deepinv/testsruns successfully. -
black .andruff check .run successfully. -
make htmlruns successfully (in thedocs/directory). - Updated docstrings related to the changes (as applicable).
- Added an entry to the changelog.rst.
LLM usage is ok, but not PRs generated 100% by AI. See our LLM policy Tick below as appropriate:
- I did not use LLM tools to write the code
- I, a human, wrote code, and LLM tools helped me to write part of the code.
- An LLM tool wrote all of the code.
- An agent submitted the PR and wrote the description.