Skip to content

Commit

Permalink
Updated README.md for new install pattern
Browse files Browse the repository at this point in the history
  • Loading branch information
ceberhardt committed Jan 23, 2025
1 parent 358bc2c commit a1420ae
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,36 @@ This repository hosts the code of LightRAG. The structure of this code is based

## Install

* Install from source (Recommend)

* Install from source (Recommended)
```bash
cd LightRAG
pip install -e .
pip install -e . # Minimal install with core dependencies
pip install -e ".[full]" # Full install with all dependencies
```

* Install from PyPI
```bash
pip install lightrag-hku
pip install lightrag-hku # Minimal install with core dependencies
pip install "lightrag-hku[full]" # Full install with all dependencies
```

The minimal install includes only core dependencies:
- numpy
- pydantic
- tiktoken
- aiohttp
- nano-vectordb
- networkx
- openai
- ollama
- tenacity
- tqdm
- xxhash
- setuptools
- python-dotenv

For additional features like using local models (torch, transformers) or specific storage backends, use the full install.

## Quick Start
* [Video demo](https://www.youtube.com/watch?v=g21royNJ4fw) of running LightRAG locally.
* All the code can be found in the `examples`.
Expand Down Expand Up @@ -777,7 +796,7 @@ Output your evaluation in the following JSON format:
| **Overall** | 32.4% | **67.6%** | 38.8% | **61.2%** | 15.2% | **84.8%** | 40.0% | **60.0%** |
| | RQ-RAG | **LightRAG** | RQ-RAG | **LightRAG** | RQ-RAG | **LightRAG** | RQ-RAG | **LightRAG** |
| **Comprehensiveness** | 31.6% | **68.4%** | 38.8% | **61.2%** | 15.2% | **84.8%** | 39.2% | **60.8%** |
| **Diversity** | 29.2% | **70.8%** | 39.2% | **60.8%** | 11.6% | **88.4%** | 30.8% | **69.2%** |
| **Diversity** | 29.2% | **70.8%** | 40.8% | **59.2%** | 11.6% | **88.4%** | 30.8% | **69.2%** |
| **Empowerment** | 31.6% | **68.4%** | 36.4% | **63.6%** | 15.2% | **84.8%** | 42.4% | **57.6%** |
| **Overall** | 32.4% | **67.6%** | 38.0% | **62.0%** | 14.4% | **85.6%** | 40.0% | **60.0%** |
| | HyDE | **LightRAG** | HyDE | **LightRAG** | HyDE | **LightRAG** | HyDE | **LightRAG** |
Expand Down

0 comments on commit a1420ae

Please sign in to comment.