fix readme

This commit is contained in:
yichuan520030910320
2025-07-22 23:14:31 -07:00
parent e07aaf52a7
commit 5dd74982ba
3 changed files with 11 additions and 218 deletions

View File

@@ -52,6 +52,9 @@ export CC=$(brew --prefix llvm)/bin/clang
export CXX=$(brew --prefix llvm)/bin/clang++
# Install with HNSW backend (default, recommended for most users)
# Install uv first if you don't have it:
# curl -LsSf https://astral.sh/uv/install.sh | sh
# See: https://docs.astral.sh/uv/getting-started/installation/#installation-methods
uv sync
```
@@ -93,6 +96,7 @@ ollama pull llama3.2:1b
## Quick Start in 30s
Our declarative API makes RAG as easy as writing a config file.
[Try in this ipynb file →](demo.ipynb)
```python
from leann.api import LeannBuilder, LeannSearcher, LeannChat
@@ -123,10 +127,6 @@ response = chat.ask(
)
```
**That's it.** No cloud setup, no API keys, no "fine-tuning". Just your data, your questions, your laptop.
[Try the interactive demo →](demo.ipynb)
## Wild Things You Can Do
LEANN supports RAGing a lot of data sources, like .pdf, .txt, .md, and also supports RAGing your WeChat, Google Search History, and more.