Skip to main content

rag-colls - Implement recent advanced RAG techniques

Project description

rag-colls

Logo

rag-colls a.k.a RAG Collections.

Simple and easy to use, production-ready advanced RAG techniques.

Downloads License

GitHub CI GitHub CI

📑 Table of Contents

📖 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.11"
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
RAFT RAFT Colab Boost RAG with SFT

🚀 Upcoming

We are currently working on these projects and will be updated soon.

RAG Tech Link
Graph-RAG Blog, Paper
RAG-RL Paper

🎉 Quickstart

Please refer to example for more information.

💻 Develop Guidance

Please refer to DEVELOP.md for more information.

💎 Acknowledgement

This project is supported by UIT AIClub.

©️ LICENSE

rag-colls is under MIT LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rag_colls-0.2.0.16.tar.gz (151.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rag_colls-0.2.0.16-py3-none-any.whl (234.6 kB view details)

Uploaded Python 3

File details

Details for the file rag_colls-0.2.0.16.tar.gz.

File metadata

  • Download URL: rag_colls-0.2.0.16.tar.gz
  • Upload date:
  • Size: 151.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.10

File hashes

Hashes for rag_colls-0.2.0.16.tar.gz
Algorithm Hash digest
SHA256 c736ae1b9efd08d4a5ef2071e090c6bbd2651b8b6f62c1483f684358814fa733
MD5 9c8aa6c223c983b9a4a66bdeeecc8083
BLAKE2b-256 35ebee6c3fbe5fc1ae9c6ddd76483277a3c5f2a54bcdd9e3022e28659fff12d5

See more details on using hashes here.

File details

Details for the file rag_colls-0.2.0.16-py3-none-any.whl.

File metadata

File hashes

Hashes for rag_colls-0.2.0.16-py3-none-any.whl
Algorithm Hash digest
SHA256 c23008ac1f402b29ed09ea35899f3278b32c6ef33d04c0288dd08754717ead71
MD5 5f84c68a067eab2acf75adde82a71d5c
BLAKE2b-256 bb6e186904f21852e0cbc6e3621f41c1d7c0802a5bb4fdd90abf64b8e1fafb50

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page