Contributing

Contributions are welcome! If you would like to contribute to autrainer, please open an issue or a pull request on the GitHub repository.

Installation

To install autrainer, first ensure that PyTorch (along with torchvision and torchaudio) version 2.0 or higher is installed. For installation instructions, refer to the PyTorch website.

It is recommended to install autrainer within a virtual environment. To create a new virtual environment, refer to the Python venv documentation.

To set up autrainer for development, start by cloning the repository and then install the development dependencies with poetry:

git clone git@github.com:autrainer/autrainer.git
cd autrainer
poetry install --all-extras

Conventions

We use Ruff to enforce code style and formatting. Common spelling errors are automatically corrected by codespell.

Linting, formatting, and spelling checks are run with pre-commit. To install the pre-commit hooks, run the following command:

pre-commit install

Tests

We use pytest for testing. To run the tests, use the following command:

pytest tests