Skip to main content

​
Requirements

  • Python 3.11 or later
  • A working pip or uv installation
  • PyTorch 2.0 or later (installed automatically as a dependency)

​
Install

Or with uv:

​
Verify

Expected output:
If torch is not installed, the doctor check still passes — PyTorch is required for training but not for running pre-compiled artifacts.

​
Install with training dependencies

If you are training models (not just running pre-compiled artifacts), install with the training extras:
This adds PyTorch and any dataset utilities. If you already have PyTorch installed in your environment, plain pip install thrindex is sufficient.

​
The CLI

After installation, the thrindex command is available on your PATH:
The CLI and the Python SDK are peer consumers of the same Rust engine. They produce identical output.

​
Building from source

The Rust workspace builds with cargo build --workspace. The Python wheel is built with maturin. CI runs on Ubuntu and macOS.