TBNilles/LEANN
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: quick start

Browse Source
This commit is contained in:
Andy Lee
2025-07-22 22:33:04 -07:00
parent 594427bf87
commit 30e5f12616
2 changed files with 4 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -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. ✨ **No Accuracy Loss:** Maintain the same search quality as heavyweight solutions while using 97% less storage.
## Quick Start in 1 minute ## Installation
```bash ```bash
git clone git@github.com:yichuan-w/LEANN.git leann 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) # Install with HNSW backend (default, recommended for most users)
uv sync uv sync
# Or add DiskANN backend if you want to test more options
uv sync --extra diskann
``` ```
**Linux (Ubuntu/Debian):** **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) # Install with HNSW backend (default, recommended for most users)
uv sync uv sync
# Or add DiskANN backend if you want to test more options
uv sync --extra diskann
``` ```
**Ollama Setup (Recommended for full privacy):** **Ollama Setup (Recommended for full privacy):**
> *You can skip this installation if you only want to use OpenAI API for generation.* > *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 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 ```python
from leann.api import LeannBuilder, LeannSearcher, LeannChat from leann.api import LeannBuilder, LeannSearcher, LeannChat

2
packages/leann-backend-diskann/third_party/DiskANN vendored

Submodule packages/leann-backend-diskann/third_party/DiskANN updated: af2a26481e...25339b0341