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.18.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.18-py3-none-any.whl (234.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rag_colls-0.2.0.18.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.18.tar.gz
Algorithm Hash digest
SHA256 d5ee01080d260212aa8efa7ce2ee4e5bc65461ed86a7f3dd53f5807c0b10e9b8
MD5 285d6dc4fedabbe575ebec44c2403247
BLAKE2b-256 6f2ad758fa4836ba86a6cc73b42768c2c3915123fa9296f6d9d2500c01535e4d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rag_colls-0.2.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 ba47cda5ab01d95eac85a8d597eabc611d6f3bc313d6afb5d0298dc58fc4a612
MD5 017880a321324eacf2b399845b94d886
BLAKE2b-256 0a56b0b480151b1e66d00fab8abba3ec20c25cdccbcae07abe5a36332e175e2e

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