CONTRIBUTING.md

Contributing

ArcticTraining welcomes your contributions!

Prerequisites

ArcticTraining uses pre-commit to ensure that formatting is consistent across the library and pytest to verify library functionality and correctness. Installing with the extra dev dependencies will ensure you have both of these pacakges installed:

If you are installing from a pre-built wheel hosted on PyPI:

pip install "arctic_training[dev]"

If you are installing from the cloned repository:

pip install ".[dev]"

Next, install the pre-commit hooks so that our suit of formatting workflows will run automatically before each git commit:

pre-commit install

Formatting

Our formatting pre-commit hooks will run automatically if you ran the above command to install the pre-commit hooks. However, you can also run the formatting manually using:

pre-commit run --all-files

It's better to use:

make format

as it'll install all the required venv things automatically for you and will do the right thing.

If a formatting test fails, some pre-commit hooks will attempt to modify the code in place. Other formatting checks, like the mypy type checker will require you to make modifications to the code yourself. In either event, if any of the pre-commit hooks fail, the git commit is aborted. After reviewing automatic changes or making your own changes to fix formatting issues, you can git add <modified files> and the repeat the previous git commit command.

Unit Tests

A collection of unit tests can be found in the tests/ directory. Broadly, there are two types of tests: CPU-based and GPU-based.

To run all tests:

make test

or:

pytest tests

To run only the CPU-based tests:

make test-cpu

or:

pytest -m "not gpu" tests

To run only the GPU-based tests:

make test-gpu

or:

pytest -m gpu tests