Contributing to Captum
We want to make contributing to Captum is as easy and transparent as possible.
To get the development installation with all the necessary dependencies for linting, testing, and building the documentation, run the following:
git clone https://github.com/pytorch/captum.git cd captum pip install -e .[dev]
Our Development Process
Captum uses the black code formatter to
enforce a common code style across the code base. black is installed easily via
pip install black, and run locally by calling
from the repository root. No additional configuration should be needed (see the black documentation for advanced usage).
We feel strongly that having a consistent code style is extremely important, so Travis will fail on your PR if it does not adhere to the black formatting style.
Captum is fully typed using python 3.6+ type hints. We expect any contributions to also use proper type annotations. While we currently do not enforce full consistency of these in our continuous integration test, you should strive to type check your code locally. For this we recommend using pyre.
To run the unit tests, you can either use
pytest (if installed):
python -m unittest
To get coverage reports we recommend using the
pytest -ra --cov=. --cov-report term-missing
- The documentation in Docusaurus itself (if you know Markdown, you can already contribute!). This lives in the docs.
- The API reference, auto-generated from the docstrings using Sphinx, and embedded into the Docusaurus website. The sphinx .rst source files for this live in sphinx/source.
- The Jupyter notebook tutorials, parsed by
nbconvert, and embedded into the Docusaurus website. These live in tutorials.
The following command will both build the docs and serve the site locally:
We actively welcome your pull requests.
- Fork the repo and create your branch from
- If you have added code that should be tested, add unit tests. In other words, add unit tests.
- If you have changed APIs, update the documentation. Make sure the documentation builds.
- Ensure the test suite passes.
- Make sure your code passes both
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
By contributing to Captum, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.