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

Uploaded Python 3

File details

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

File metadata

  • Download URL: rag_colls-0.2.0.15.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.15.tar.gz
Algorithm Hash digest
SHA256 67a60dbab7d604261d71ae09a627fa1e2ef6d4e7e7847a6f6dbe4b3f67e22826
MD5 ae98c1f1a69f617571388f5e28f534f9
BLAKE2b-256 79c6239194bbae5f97a1c40470acbe80d16e08255af5b1f8b21cd77d05431bd6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rag_colls-0.2.0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 094fcd6c952198221b5f766462429ffe0ee74ddba9e3499b5585162f9f62e65a
MD5 9598b9543395a72f3eb7d05cd6c45ec6
BLAKE2b-256 17e719df85dffc1ef661f9301640e17fc3e6bdd0d63f121f5bef04b21aa5c80a

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