If you want to contribute bug-fixes please directly file a pull-request. If you plan to introduce new features or extend CompressAI, please first open an issue to start a public discussion or contact us directly.
We try to follow PEP 8 recommendations. Automatic formatting is performed via YAPF.
We use pytest. To run all the tests:
pip install pytest pytest-cov coveragepython -m pytest --cov=compressai -s- You can run
coverage reportorcoverage htmlto visualize the tests coverage analysis
See docs/Readme.md for more information.
By contributing to CompressAI, you agree that your contributions will be licensed under the same license as described in the LICENSE file at the root of this repository.