From 30e5f126169b1bc687638a5c78ee509e7dabfc33 Mon Sep 17 00:00:00 2001 From: Andy Lee Date: Tue, 22 Jul 2025 22:33:04 -0700 Subject: [PATCH] docs: quick start --- README.md | 13 +++---------- packages/leann-backend-diskann/third_party/DiskANN | 2 +- 2 files changed, 4 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 95bc2bc..dcd2968 100755 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ LEANN achieves this through *graph-based selective recomputation* with *high-deg ✨ **No Accuracy Loss:** Maintain the same search quality as heavyweight solutions while using 97% less storage. -## Quick Start in 1 minute +## Installation ```bash git clone git@github.com:yichuan-w/LEANN.git leann @@ -53,9 +53,6 @@ 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):** @@ -64,13 +61,9 @@ sudo apt-get install libomp-dev libboost-all-dev protobuf-compiler libabsl-dev l # 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 (Recommended for full privacy):** > *You can skip this installation if you only want to use OpenAI API for generation.* @@ -97,9 +90,9 @@ ollama serve & ollama pull llama3.2:1b ``` -## Dead Simple API +## Quick Start in 30s -Just 3 lines of code. Our declarative API makes RAG as easy as writing a config file: +Our declarative API makes RAG as easy as writing a config file. ```python from leann.api import LeannBuilder, LeannSearcher, LeannChat diff --git a/packages/leann-backend-diskann/third_party/DiskANN b/packages/leann-backend-diskann/third_party/DiskANN index af2a264..25339b0 160000 --- a/packages/leann-backend-diskann/third_party/DiskANN +++ b/packages/leann-backend-diskann/third_party/DiskANN @@ -1 +1 @@ -Subproject commit af2a26481e65232b57b82d96e68833cdee9f7635 +Subproject commit 25339b03413b5067c25b6092ea3e0f77ef8515c8