Skip to main content

rag-colls - Implement recent advanced RAG techniques

Project description

rag-colls

rag-colls

rag-colls a.k.a RAG Collections.

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

Downloads License

GitHub CI GitHub CI

Latest News

📑 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.20.tar.gz (155.0 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.20-py3-none-any.whl (243.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rag_colls-0.2.0.20.tar.gz
Algorithm Hash digest
SHA256 3aa7ef2718522d44b64c1fc68e9e1efd6305232a12f889c534835c656bcb38a9
MD5 140107462abe5a0ff428e0e0aa60dac3
BLAKE2b-256 d7944058016b220f4d5ced39669ecddd510657ce16e75be6424207412d9fa685

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rag_colls-0.2.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 dc71fa0b765cff947011514b4c0a417db0ddba930b1811401ce7b330a7b7a058
MD5 1c1b5af5b756ab2bcaf1cb8fe2133c10
BLAKE2b-256 cf693871ffc739b58cdb20c54abb0356dad9285e2036114f60b7c5d51aabce6d

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