Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (18 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

26 lines (18 loc) · 1.01 KB

Setting up a development environment

The orb_models package uses Poetry for dependency management. To install the package and its dependencies, run the following command:

pip install poetry  # Install Poetry if you don't have it
poetry install

Optionally, also install cuML (requires CUDA):

pip install --extra-index-url=https://pypi.nvidia.com "cuml-cu11==25.2.*"  # For cuda versions >=11.4, <11.8
pip install --extra-index-url=https://pypi.nvidia.com "cuml-cu12==25.2.*"  # For cuda versions >=12.0, <13.0

Running tests

The orb_models package uses pytest for testing. To run the tests, navigate to the root directory of the package and run the following command:

pytest

Publishing

The orb_models package is published using trusted publishers. Whenever a new release is created on GitHub, the package is automatically published to PyPI using GitHub Actions.