rag-colls - Implement recent advanced RAG techniques
Project description
rag-colls
rag-colls a.k.a RAG Collections.
Simple and easy to use, production-ready advanced RAG techniques.
📑 Table of Contents
- 📖 Documentation
- 🔧 Installation
- 📚 Notebooks
- 🚀 Upcoming
- 🎉 Quickstart
- 💻 Develop Guidance
- ✨ Contributors
- ©️ License
📖 Documentation
Please visit documentation to get latest update.
🔧 Installation
- You can easily install it from pypi:
pip install -U rag-colls
- Docker - 🐳:
# Clone the repository
git clone https://github.com/hienhayho/rag-colls.git
cd rag-colls/
# Choose python version and setup OPENAI_API_KEY
export PYTHON_VERSION="3.10"
export OPENAI_API_KEY="your-openai-api-key-here"
# Docker build
DOCKER_BUILDKIT=1 docker build \
-f docker/Dockerfile \
--build-arg OPENAI_API_KEY="$OPENAI_API_KEY" \
--build-arg PYTHON_VERSION="$PYTHON_VERSION" \
-t rag-colls:$PYTHON_VERSION .
docker run -it --name rag_colls --shm-size=2G rag-colls:$PYTHON_VERSION
📚 Notebooks
We have provided some notebooks for example usage.
| RAG Tech | Code | Guide | Tech Description |
|---|---|---|---|
| BasicRAG | BasicRAG | Colab | Integrate with Chromadb |
| ContextualRAG | ContextualRAG | Colab | Integrate with Chromadb and BM25s version |
🚀 Upcoming
We are currently working on these projects and will be updated soon.
| RAG Tech | Link |
|---|---|
| Graph-RAG | Blog, Paper |
| RAFT | Blog, Paper |
| RAG-RL | Paper |
🎉 Quickstart
Please refer to example for more information.
💻 Develop Guidance
Please refer to DEVELOP.md for more information.
✨ Contributors
|
Ho Trong Hien |
congtuong |
Bao Tran Gia |
Phan Thanh Dat |
💎 Acknowledgement
This project is supported by UIT AIClub.
©️ LICENSE
rag-colls is under MIT LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rag_colls-0.2.0.11.tar.gz.
File metadata
- Download URL: rag_colls-0.2.0.11.tar.gz
- Upload date:
- Size: 70.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fc481703d9bf991385a5b409b88f40dec788c172e7af5317017c3e3c17679059
|
|
| MD5 |
1aeab7da6a4600c72b941686d95766be
|
|
| BLAKE2b-256 |
597b5739df1d82f54a25851761c3d4e682ab3fda328f3e106da816c9ccac977c
|
File details
Details for the file rag_colls-0.2.0.11-py3-none-any.whl.
File metadata
- Download URL: rag_colls-0.2.0.11-py3-none-any.whl
- Upload date:
- Size: 117.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.6.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f25a15a2aa7904bdd304b023ee056b3cb01d06a491fb25713bf896ef85283296
|
|
| MD5 |
e3ed75d76d2732fe999b95e2901baefa
|
|
| BLAKE2b-256 |
3fc150bd3092fbe8e4e42fda2498f18d083aabbc85496d40e6b183398acb9ab1
|