Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 1.37 KB

contributing.md

File metadata and controls

61 lines (37 loc) · 1.37 KB
Raw

Welcome to our contributing guide

The following sections will help you set up your development environment and get started on your contribution.

Requirements

  • pre-commit>=2.19.0

Changes have been tested with the following dependency versions:

  • numpy>=1.21.4
  • matplotlib>=3.5.2
  • opencv-contrib-python-headless>=4.5.4.60
  • scikit-learn>=1.0.2
  • torch>=1.10.0
  • torchvision>=0.11.1

Installation

Install dependencies

sudo ./script/bootstrap

Usage

Refer to lrp.ipynb for an example.

Lint

Lint all files manually:

 pre-commit run --all-files

Uploading to PyPI

  1. Configure PyPI credentials in $HOME/.pypirc

  2. Bump version in setup.cfg

  3. Bump version in README.md

  4. Create GitHub release. Example

  5. Update zenodo links in README.md

  6. Build and upload package

    ./script/build
./script/upload

Full documentation here.

Credits