Installation

Choose the matching version

Development commands match these pages. PyPI 0.2.1 predates them, so some APIs differ.

Virtual environment

Tip

You will need an environment manager, and I cannot recommend enough uv.

Create a virtual environment with your preferred Python version (3.11 or higher is required to use Holocron):

$ uv venv --python 3.11

Development (this documentation)Stable v0.2.1

$ uv pip install "pylocron @ git+https://github.com/frgfm/holocron.git"

$ uv pip install pylocron

System installation

You'll need Python 3.11 or higher, and a package installer like uv or pip.

Development (uv)Stable v0.2.1 (uv)Development (pip)Stable v0.2.1 (pip)

$ uv pip install --system "pylocron @ git+https://github.com/frgfm/holocron.git"

$ uv pip install --system pylocron

$ pip install "pylocron @ git+https://github.com/frgfm/holocron.git"

$ pip install pylocron

Info

Holocron is built on top of PyTorch which is a complex dependency. Proper installation depends on your system and available hardware. You can refer to installation guide of uv which is quite detailed.