mirror of
https://github.com/HKUDS/LightRAG.git
synced 2025-11-12 16:14:15 +00:00
Update README.md
This commit is contained in:
zrguo
parent
bc70e6066c
commit
d1aeb291d6
140
README.md
140
README.md
@ -1254,6 +1254,33 @@ Valid modes are:
|
||||
|
||||
</details>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Initialization Errors
|
||||
|
||||
If you encounter these errors when using LightRAG:
|
||||
|
||||
1. **`AttributeError: __aenter__`**
|
||||
- **Cause**: Storage backends not initialized
|
||||
- **Solution**: Call `await rag.initialize_storages()` after creating the LightRAG instance
|
||||
|
||||
2. **`KeyError: 'history_messages'`**
|
||||
- **Cause**: Pipeline status not initialized
|
||||
- **Solution**: Call `await initialize_pipeline_status()` after initializing storages
|
||||
|
||||
3. **Both errors in sequence**
|
||||
- **Cause**: Neither initialization method was called
|
||||
- **Solution**: Always follow this pattern:
|
||||
```python
|
||||
rag = LightRAG(...)
|
||||
await rag.initialize_storages()
|
||||
await initialize_pipeline_status()
|
||||
```
|
||||
|
||||
### Model Switching Issues
|
||||
|
||||
When switching between different embedding models, you must clear the data directory to avoid errors. The only file you may want to preserve is `kv_store_llm_response_cache.json` if you wish to retain the LLM cache.
|
||||
|
||||
## LightRAG API
|
||||
|
||||
The LightRAG Server is designed to provide Web UI and API support. **For more information about LightRAG Server, please refer to [LightRAG Server](./lightrag/api/README.md).**
|
||||
@ -1519,7 +1546,47 @@ def extract_queries(file_path):
|
||||
|
||||
</details>
|
||||
|
||||
## Star History
|
||||
## 🔗 Related Projects
|
||||
|
||||
*Ecosystem & Extensions*
|
||||
|
||||
<div align="center">
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<a href="https://github.com/HKUDS/RAG-Anything">
|
||||
<div style="width: 100px; height: 100px; background: linear-gradient(135deg, rgba(0, 217, 255, 0.1) 0%, rgba(0, 217, 255, 0.05) 100%); border-radius: 15px; border: 1px solid rgba(0, 217, 255, 0.2); display: flex; align-items: center; justify-content: center; margin-bottom: 10px;">
|
||||
<span style="font-size: 32px;">📸</span>
|
||||
</div>
|
||||
<b>RAG-Anything</b><br>
|
||||
<sub>Multimodal RAG</sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/HKUDS/VideoRAG">
|
||||
<div style="width: 100px; height: 100px; background: linear-gradient(135deg, rgba(0, 217, 255, 0.1) 0%, rgba(0, 217, 255, 0.05) 100%); border-radius: 15px; border: 1px solid rgba(0, 217, 255, 0.2); display: flex; align-items: center; justify-content: center; margin-bottom: 10px;">
|
||||
<span style="font-size: 32px;">🎥</span>
|
||||
</div>
|
||||
<b>VideoRAG</b><br>
|
||||
<sub>Extreme Long-Context Video RAG</sub>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://github.com/HKUDS/MiniRAG">
|
||||
<div style="width: 100px; height: 100px; background: linear-gradient(135deg, rgba(0, 217, 255, 0.1) 0%, rgba(0, 217, 255, 0.05) 100%); border-radius: 15px; border: 1px solid rgba(0, 217, 255, 0.2); display: flex; align-items: center; justify-content: center; margin-bottom: 10px;">
|
||||
<span style="font-size: 32px;">✨</span>
|
||||
</div>
|
||||
<b>MiniRAG</b><br>
|
||||
<sub>Extremely Simple RAG</sub>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## ⭐ Star History
|
||||
|
||||
<a href="https://star-history.com/#HKUDS/LightRAG&Date">
|
||||
<picture>
|
||||
@ -1529,42 +1596,22 @@ def extract_queries(file_path):
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
## Contribution
|
||||
## 🤝 Contribution
|
||||
|
||||
Thank you to all our contributors!
|
||||
<div align="center">
|
||||
We thank all our contributors for their valuable contributions.
|
||||
</div>
|
||||
|
||||
<a href="https://github.com/HKUDS/LightRAG/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=HKUDS/LightRAG" />
|
||||
</a>
|
||||
<div align="center">
|
||||
<a href="https://github.com/HKUDS/LightRAG/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=HKUDS/LightRAG" style="border-radius: 15px; box-shadow: 0 0 20px rgba(0, 217, 255, 0.3);" />
|
||||
</a>
|
||||
</div>
|
||||
|
||||
## Troubleshooting
|
||||
---
|
||||
|
||||
### Common Initialization Errors
|
||||
|
||||
If you encounter these errors when using LightRAG:
|
||||
|
||||
1. **`AttributeError: __aenter__`**
|
||||
- **Cause**: Storage backends not initialized
|
||||
- **Solution**: Call `await rag.initialize_storages()` after creating the LightRAG instance
|
||||
|
||||
2. **`KeyError: 'history_messages'`**
|
||||
- **Cause**: Pipeline status not initialized
|
||||
- **Solution**: Call `await initialize_pipeline_status()` after initializing storages
|
||||
|
||||
3. **Both errors in sequence**
|
||||
- **Cause**: Neither initialization method was called
|
||||
- **Solution**: Always follow this pattern:
|
||||
```python
|
||||
rag = LightRAG(...)
|
||||
await rag.initialize_storages()
|
||||
await initialize_pipeline_status()
|
||||
```
|
||||
|
||||
### Model Switching Issues
|
||||
|
||||
When switching between different embedding models, you must clear the data directory to avoid errors. The only file you may want to preserve is `kv_store_llm_response_cache.json` if you wish to retain the LLM cache.
|
||||
|
||||
## 🌟Citation
|
||||
## 📖 Citation
|
||||
|
||||
```python
|
||||
@article{guo2024lightrag,
|
||||
@ -1577,4 +1624,31 @@ primaryClass={cs.IR}
|
||||
}
|
||||
```
|
||||
|
||||
**Thank you for your interest in our work!**
|
||||
---
|
||||
|
||||
<div align="center" style="background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); border-radius: 15px; padding: 30px; margin: 30px 0;">
|
||||
<div>
|
||||
<img src="https://user-images.githubusercontent.com/74038190/212284100-561aa473-3905-4a80-b561-0d28506553ee.gif" width="500">
|
||||
</div>
|
||||
<div style="margin-top: 20px;">
|
||||
<a href="https://github.com/HKUDS/LightRAG" style="text-decoration: none;">
|
||||
<img src="https://img.shields.io/badge/⭐%20Star%20us%20on%20GitHub-1a1a2e?style=for-the-badge&logo=github&logoColor=white">
|
||||
</a>
|
||||
<a href="https://github.com/HKUDS/LightRAG/issues" style="text-decoration: none;">
|
||||
<img src="https://img.shields.io/badge/🐛%20Report%20Issues-ff6b6b?style=for-the-badge&logo=github&logoColor=white">
|
||||
</a>
|
||||
<a href="https://github.com/HKUDS/LightRAG/discussions" style="text-decoration: none;">
|
||||
<img src="https://img.shields.io/badge/💬%20Discussions-4ecdc4?style=for-the-badge&logo=github&logoColor=white">
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
<div style="width: 100%; max-width: 600px; margin: 20px auto; padding: 20px; background: linear-gradient(135deg, rgba(0, 217, 255, 0.1) 0%, rgba(0, 217, 255, 0.05) 100%); border-radius: 15px; border: 1px solid rgba(0, 217, 255, 0.2);">
|
||||
<div style="display: flex; justify-content: center; align-items: center; gap: 15px;">
|
||||
<span style="font-size: 24px;">⭐</span>
|
||||
<span style="color: #00d9ff; font-size: 18px;">Thank you for visiting LightRAG!</span>
|
||||
<span style="font-size: 24px;">⭐</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user