diff --git a/README.md b/README.md index 281760e..6bf96a9 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ ![GitHub](https://img.shields.io/github/license/NotShrirang/LoomRAG) ![GitHub last commit](https://img.shields.io/github/last-commit/NotShrirang/LoomRAG) ![GitHub repo size](https://img.shields.io/github/repo-size/NotShrirang/LoomRAG) - + -This project implements a Multimodal Retrieval-Augmented Generation (RAG) system, named **LoomRAG**, that leverages OpenAI's CLIP model for neural cross-modal retrieval and semantic search. The system allows users to input text queries and retrieve both text and image responses seamlessly through vector embeddings. It also supports uploading images and PDFs for enhanced interaction and intelligent retrieval capabilities through a Streamlit-based interface. +This project implements a Multimodal Retrieval-Augmented Generation (RAG) system, named **LoomRAG**, that leverages OpenAI's CLIP model for neural cross-modal retrieval and semantic search. The system allows users to input text queries and retrieve both text and image responses seamlessly through vector embeddings. It features a comprehensive annotation interface for creating custom datasets and supports CLIP model fine-tuning with configurable parameters for domain-specific applications. The system also supports uploading images and PDFs for enhanced interaction and intelligent retrieval capabilities through a Streamlit-based interface. Experience the project in action: @@ -20,9 +20,13 @@ Experience the project in action: ## πŸ“Έ Implementation Screenshots -| ![Screenshot 2024-12-30 111906](https://github.com/user-attachments/assets/13c0bd0d-1569-4d9e-aae5-ea5801a69beb) | ![Screenshot 2024-12-30 114200](https://github.com/user-attachments/assets/d74e9d75-7716-4705-9564-0c6fdc26790b) | +| ![Screenshot 2025-01-01 184852](https://github.com/user-attachments/assets/ad79d0f0-d200-4a82-8c2f-0890a9fe8189) | ![Screenshot 2025-01-01 222334](https://github.com/user-attachments/assets/7307857d-a41f-4f60-8808-00d6db6e8e3e) | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| Screenshot 1 | Screenshot 2 | +| Data Upload Page | Data Search / Retrieval | +| | | +| ![Screenshot 2025-01-01 222412](https://github.com/user-attachments/assets/e38273f4-426b-444d-80f0-501fa9563779) | ![Screenshot 2025-01-01 223948](https://github.com/user-attachments/assets/21724a92-ef79-44ae-83e6-25f8de29c45a) +| Data Annotation Page | CLIP Fine-Tuning | + --- @@ -33,6 +37,9 @@ Experience the project in action: - πŸ“€ **Upload Options**: Allows users to upload images and PDFs for AI-powered processing and retrieval - 🧠 **Embedding-Based Search**: Uses OpenAI's CLIP model to align text and image embeddings in a shared latent space - πŸ” **Augmented Text Generation**: Enhances text results using LLMs for contextually rich outputs +- 🏷️ Image Annotation: Enables users to annotate uploaded images through an intuitive interface +- 🎯 CLIP Fine-Tuning: Supports custom model training with configurable parameters including test dataset split size, learning rate, optimizer, and weight decay +- πŸ”¨ Fine-Tuned Model Integration: Seamlessly load and utilize fine-tuned CLIP models for enhanced search and retrieval --- @@ -54,6 +61,17 @@ Experience the project in action: - For image results: Directly returned or enhanced with image captions - For PDFs: Extracts text content and provides relevant sections +4. **Image Annotation**: + - Dedicated annotation page for managing uploaded images + - Support for creating and managing multiple datasets simultaneously + - Flexible annotation workflow for efficient data labeling + - Dataset organization and management capabilities + +5. **Model Fine-Tuning**: + - Custom CLIP model training on annotated images + - Configurable training parameters for optimization + - Integration of fine-tuned models into the search pipeline + --- ## πŸš€ Installation @@ -85,6 +103,9 @@ Experience the project in action: - Access the interface in your browser to: - Submit natural language queries - Upload images or PDFs to retrieve contextually relevant results + - Annotate uploaded images + - Fine-tune CLIP models with custom parameters + - Use fine-tuned models for improved search results 2. **Example Queries**: - **Text Query**: "sunset over mountains" @@ -99,12 +120,13 @@ Experience the project in action: - πŸ“Š **Vector Database**: It uses FAISS for efficient similarity search - πŸ€– **Model**: Uses OpenAI CLIP for neural embedding generation - ✍️ **Augmentation**: Optional LLM-based augmentation for text responses +- πŸŽ›οΈ Fine-Tuning: Configurable parameters for model training and optimization --- ## πŸ—ΊοΈ Roadmap -- [ ] Fine-tuning CLIP for domain-specific datasets +- [x] Fine-tuning CLIP for domain-specific datasets - [ ] Adding support for audio and video modalities - [ ] Improving the re-ranking system for better contextual relevance - [ ] Enhanced PDF parsing with semantic section segmentation @@ -119,7 +141,7 @@ Contributions are welcome! Please open an issue or submit a pull request for any ## πŸ“„ License -This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. +This project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file for details. ---