Installation

Choose the matching version

These pages follow the main branch. The latest PyPI release may not include recent changes. Install from source to use unreleased APIs.

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

Stable (PyPI)Development (main branch)

$ uv pip install pylocron

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

System installation

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

Stable (PyPI, uv)Development (uv)Stable (PyPI, pip)Development (pip)

$ uv pip install --system pylocron

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

$ pip install pylocron

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

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.