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.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
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.14.tar.gz (122.9 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.14-py3-none-any.whl (184.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rag_colls-0.2.0.14.tar.gz
Algorithm Hash digest
SHA256 b49925cf8af281f2dd4b91cd4490ca1b963757bc1908a79523658697c3a1c97a
MD5 27497331d4315995c6a359b320efdd7b
BLAKE2b-256 fcd58dd8e3287d787dad942579bf6a27ea77d8f2659cd2b1f4b4e3d632b0dec1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rag_colls-0.2.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 f5d1facd0919c28504bd7c6dfc9d12d40ea040620925497b523bb827154c1c10
MD5 a87b61ba849127455c13b1d21c34b1bd
BLAKE2b-256 012c0f879cf15168100bb52c8e9908125a4562907f6a21b3448e43af82b91c04

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