Installation Guide¶

🚀 Quick Start

Install using the ultra-fast uv package manager.

installation-with-uv-recommended

📦 Standard Pip

Install using the standard Python pip tool.

installation-with-pip

Note

Requirement: Python 3.11 or higher.

Installation¶

Choose your preferred package manager:

Using uv (Recommended)

First, ensure you have uv installed.

# Standard CPU
uv pip install canns

# With Acceleration
uv pip install "canns[cuda12]"   # NVIDIA CUDA 12
uv pip install "canns[tpu]"      # Google TPU

Using pip

# Standard CPU
pip install canns

# With Acceleration
pip install "canns[cuda12]"   # NVIDIA CUDA 12
pip install "canns[tpu]"      # Google TPU

From Source

git clone https://github.com/routhleck/canns.git
cd canns
pip install -e .

Verify Installation¶

import canns
print(f"✅ Successfully installed canns version {canns.__version__}")