add pip install option to README
This commit is contained in:
19
README.md
19
README.md
@@ -38,7 +38,19 @@ 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.
|
||||
|
||||
## Installation
|
||||
> `pip leann` coming soon!
|
||||
|
||||
LEANN provides two installation methods: **pip install** (quick and easy) and **build from source** (recommended for development).
|
||||
|
||||
### 🚀 Quick Install (Recommended for most users)
|
||||
|
||||
```bash
|
||||
pip install leann
|
||||
```
|
||||
|
||||
### 🔧 Build from Source (Recommended for development)
|
||||
|
||||
For development, we recommend building from source:
|
||||
|
||||
```bash
|
||||
git clone git@github.com:yichuan-w/LEANN.git leann
|
||||
cd leann
|
||||
@@ -65,7 +77,7 @@ uv sync
|
||||
```
|
||||
|
||||
|
||||
**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.*
|
||||
|
||||
@@ -89,7 +101,7 @@ ollama serve &
|
||||
|
||||
# Pull a lightweight model (recommended for consumer hardware)
|
||||
ollama pull llama3.2:1b
|
||||
```
|
||||
``` -->
|
||||
|
||||
## Quick Start in 30s
|
||||
|
||||
@@ -465,4 +477,3 @@ This work is done at [**Berkeley Sky Computing Lab**](https://sky.cs.berkeley.e
|
||||
<p align="center">
|
||||
Made with ❤️ by the Leann team
|
||||
</p>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user