From e60fad8c73aa1486eaf685177c32c8975400a840 Mon Sep 17 00:00:00 2001 From: Andy Lee Date: Sat, 19 Jul 2025 22:24:44 -0700 Subject: [PATCH] chore: mark diskann as optional --- README.md | 10 ++++++++++ pyproject.toml | 5 ++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1acc470..4c138b1 100755 --- a/README.md +++ b/README.md @@ -49,13 +49,23 @@ git submodule update --init --recursive brew install llvm libomp boost protobuf export CC=$(brew --prefix llvm)/bin/clang export CXX=$(brew --prefix llvm)/bin/clang++ + +# Install with HNSW backend (default, recommended for most users) uv sync + +# Or add DiskANN backend if you want to test more options +uv sync --extra diskann ``` **Linux (Ubuntu/Debian):** ```bash sudo apt-get install libomp-dev libboost-all-dev protobuf-compiler libabsl-dev libmkl-full-dev libaio-dev + +# Install with HNSW backend (default, recommended for most users) uv sync + +# Or add DiskANN backend if you want to test more options +uv sync --extra diskann ``` **Ollama Setup (Optional for Local LLM):** diff --git a/pyproject.toml b/pyproject.toml index 9cd0db9..3a0c027 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,7 +9,6 @@ requires-python = ">=3.10" dependencies = [ "leann-core", - "leann-backend-diskann", "leann-backend-hnsw", "numpy>=1.26.0", "torch", @@ -48,6 +47,10 @@ dev = [ "huggingface-hub>=0.20.0", ] +diskann = [ + "leann-backend-diskann", +] + [tool.setuptools] py-modules = []