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

🚀 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
Ho Trong Hien
congtuong/
congtuong
Phan
Phan Thanh Dat

💎 Acknowledgement

This project is suported 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.8.tar.gz (48.7 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.8-py3-none-any.whl (84.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rag_colls-0.2.0.8.tar.gz
Algorithm Hash digest
SHA256 3a1001d796946688cb3f98278897bfd59eac2e5e0ec07696de02ab25ee655400
MD5 0ea4a01838143627d8e9482fc442c5fd
BLAKE2b-256 30e76fbd89d6d3c6706296cf2c280c5a82999a442769bc40d64cc326f953cdc2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rag_colls-0.2.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c8b3d1be010328e72e09b37f5dc024c10b26a7c6e56e452b3d1668728f3cfcfe
MD5 7e30bdc86f57400e7db8e50d48467e46
BLAKE2b-256 7a36dd400ffff99bc5e11c9791f1b7382411c6838a57fe927b3641650999d746

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