RAGmap is a simple RAG visualization package for exploring document chunks and queries in embedding space
Project description
RAGmap 🗺️🔍
Overview
RAGmap is a simple RAG visualization tool for exploring document chunks and queries in embedding space.
Inspired by DeepLearning.ai's short course on Advanced Retrieval for AI with Chroma and Gabriel Chua's award-winning RAGxplorer.
Updates:
- 👨💻 RAGmap is now available as a standalone Python package!
- 🌐 Try the live demo hosted on Streamlit Community Cloud.
- 📢 RAGmap now supports Hugging Face 🤗 models!
What's inside?
RAGmap supports the following features:
- Multiple document formats 📄
PDF
DOCX
PPTX
- Multiple embedding models
- Hugging Face 🤗
- Amazon Bedrock ⛰️
- Dimensionality reduction (2D and 3D)
- Natural language queries
- Advanced query augmentation
- Generated Answers (HyDE)
- Multiple Queries
- ... and more!
☝️⚠️ Important notice: As of January 2024, chromadb's AmazonBedrockEmbeddingFunction
only works with Titan models. Feel free to upvote this PR to add support for Cohere Embed models.
Prerequisites
Amazon Bedrock
Enable access to the embedding (Titan Embeddings, Cohere Embed) and text (Anthropic Claude) models via Amazon Bedrock.
For more information on how to request model access, please refer to the Amazon Bedrock User Guide (Set up > Model access)
How to use
Option 1 💻
-
Install dependencies
pip install -r requirements.txt
-
Run the application
streamlit run app.py
-
Point your browser to http://localhost:8501
Option 2 🐳
-
Run the following command to start the application
docker-compose up
-
Once the service is up and running, head over to http://localhost:8501
Option 3 👨💻
-
Install the
ragmap
packagepip install ragmap
-
Start building your own apps.
Check out the examples folder to get started!
Example: Amazon shareholder letters
References
- (AWS) What is Retrieval-Augmented Generation?
- (DeepLearning.ai) Advanced Retrieval for AI with Chroma
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ragmap-0.1.1.tar.gz
.
File metadata
- Download URL: ragmap-0.1.1.tar.gz
- Upload date:
- Size: 11.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 080a1573d35328d8856c64fdb5b8c503b4abff0533de1af41b05d416d72a9a04 |
|
MD5 | 10c6e94d75ee7e3db508c9de3235fe0a |
|
BLAKE2b-256 | 7a480197fad9f7f2c2c2f7a59b319592d3c76a7226eb7bc9492ab18a1476720d |
File details
Details for the file ragmap-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: ragmap-0.1.1-py3-none-any.whl
- Upload date:
- Size: 10.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccc300416d62d215683e38f317828514353443cb6b94eddd36af78ccbe752322 |
|
MD5 | 45547877a8eb8a340faf30d1e98c1e70 |
|
BLAKE2b-256 | d0a1e17552b08453d34b721b60b568b7249f320940f59d8fbe94bb9dd3f8aa3f |