Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nimavahdat/llama_rag_system
Llama_RAG_System is a local Retrieval-Augmented Generation (RAG) system that leverages the LLaMA model to provide intelligent answers to user queries by processing uploaded PDFs and fetching relevant web information while ensuring privacy.
https://github.com/nimavahdat/llama_rag_system
aiassistant chatbot chromadb flask gradio llama3 llm prompt-engineering rag webscraping
Last synced: 15 days ago
JSON representation
Llama_RAG_System is a local Retrieval-Augmented Generation (RAG) system that leverages the LLaMA model to provide intelligent answers to user queries by processing uploaded PDFs and fetching relevant web information while ensuring privacy.
- Host: GitHub
- URL: https://github.com/nimavahdat/llama_rag_system
- Owner: NimaVahdat
- License: mit
- Created: 2024-10-21T02:22:38.000Z (17 days ago)
- Default Branch: main
- Last Pushed: 2024-10-21T17:49:09.000Z (17 days ago)
- Last Synced: 2024-10-23T01:11:12.766Z (15 days ago)
- Topics: aiassistant, chatbot, chromadb, flask, gradio, llama3, llm, prompt-engineering, rag, webscraping
- Language: Python
- Homepage:
- Size: 124 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Llama_RAG_System
## Overview
The **Llama_RAG_System** is a robust retrieval-augmented generation (RAG) system designed to interactively respond to user queries with rich, contextually relevant answers. Built using the **LLaMA** model and **Ollama**, this system can handle various tasks, including answering general questions, summarizing content, and extracting information from uploaded PDF documents. The architecture utilizes ChromaDB for efficient document embedding and retrieval, while also incorporating web scraping capabilities to fetch up-to-date information from the internet.
Here’s a glimpse of the Gradio app interface:
🚧 Please note: This project is currently in development. Your feedback and contributions are welcome!
## Features
- **Local Model Execution with Ollama**: Utilizes **Ollama** to run the LLaMA model locally, ensuring faster responses and enhanced privacy. By keeping the data processing local, users can maintain control over their information without sending it to external servers.
- **Web Scraping for Updated Answers**: Scrapes the internet to provide real-time, relevant information, allowing the system to deliver accurate responses based on the latest data.
- **PDF Document Processing**: Upload PDF files for automatic text extraction and embedding.
- **Dynamic Query Handling**: Automatically detects the type of user queries (general questions, summarization, chit-chat, etc.) and provides appropriate responses.
- **Gradio and Flask Interfaces**: User-friendly web interfaces for interacting with the model and uploading documents.
- **Custom Embeddings**: Utilizes ChromaDB to store and retrieve document embeddings efficiently.
## Why Use Ollama?
**Ollama** is an excellent option for running machine learning models locally for several reasons:
- **Privacy**: Running the model on local infrastructure ensures that sensitive data remains within the user's environment, minimizing the risk of data breaches or leaks.
- **Performance**: Local execution reduces latency, allowing for quicker response times compared to cloud-based solutions.
- **Customization**: Users can fine-tune the model to meet specific needs without depending on external service providers.
## Folder Structure
The project is organized as follows:
```
project/
├── core/
│ ├── embedding.py # Embedding-related functionality
│ ├── document_utils.py # Functions to handle document loading and processing
│ ├── query.py # Query document functionality
│ ├── generate.py # Response generation logic
│ ├── web_scrape.py # Web scraping functionality
│
├── scripts/
│ ├── run_flask.py # Script to run Flask API
│ ├── run_gradio.py # Script to run Gradio interface
│
├── chromadb_setup.py # ChromaDB setup and connection
│
├── README.md # Project documentation
```
## Installation
To set up the Llama_RAG_System, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/NimaVahdat/Llama_RAG_System.git
cd Llama_RAG_System
```
2. Ensure that ChromaDB and any other necessary services are running as needed.
## Usage
### Running the Flask API
To start the Flask API, run the following command:
```bash
python -m scripts.run_flask
```
### Running the Gradio Interface
To launch the Gradio interface, execute:
```bash
python -m scripts.run_gradio
```
After running either script, you will be able to interact with the system via the provided web interface.
## Contributing
Contributions are welcome! If you have suggestions for improvements or features, please fork the repository and submit a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgements
- [LLaMA](https://llama.ai) for the underlying model architecture.
- [Ollama](https://ollama.com) for local execution of machine learning models, enhancing privacy and performance.
- [Gradio](https://gradio.app) for the interactive interface.
- [ChromaDB](https://chromadb.com) for efficient document storage and retrieval.
## Contact
For any inquiries or support, please contact me.