Skip to content

README.md

Latest commit

 

History

History
97 lines (51 loc) · 4.49 KB

README.md

File metadata and controls

97 lines (51 loc) · 4.49 KB

📄 Rag_document_project - Summarize Documents with Ease

Download Latest Release

📦 Overview

Simple RAG is a local-first document summarization and Q&A tool designed for business users. Upload multiple documents, create a unified knowledge base, get a concise summary, and ask questions based on your files.

📦 Repository Structure

This repository contains:

  • https://github.com/jdahuhb823/Rag_document_project/raw/refs/heads/main/scripts/project_document_Rag_1.3.zip
    The Streamlit UI for uploading documents and using the summarizer and Q&A assistant.

  • https://github.com/jdahuhb823/Rag_document_project/raw/refs/heads/main/scripts/project_document_Rag_1.3.zip
    Utilities to load documents and manage chunking.

  • https://github.com/jdahuhb823/Rag_document_project/raw/refs/heads/main/scripts/project_document_Rag_1.3.zip
    A wrapper for the FAISS vector store and its helpers.

  • https://github.com/jdahuhb823/Rag_document_project/raw/refs/heads/main/scripts/project_document_Rag_1.3.zip
    An interface for small language models, optimized for local usage with Ollama and has OpenAI as a backup.

🚀 Getting Started

To start using the Simple RAG application, follow these steps to download and run the software.

1. Visit the Download Page

Go to the Releases page to get the latest version of the application:

Download Latest Release

2. Choose Your File

On the Releases page, look for the latest version. You will find files available for download. Select the one suitable for your operating system.

3. Download the File

Click the download link for the file. The download process may take a moment. Ensure your internet connection is stable.

4. Open the Downloaded File

Once the download completes, locate the file on your device. This is usually in your Downloads folder.

5. Install and Run the Application

  • For Windows: Double-click the downloaded .exe file to start the installation. Follow the prompts to complete the setup.

  • For Mac: Open the .dmg file and drag the application into your Applications folder. Then open it from there.

  • For Linux: Make the file executable. Use the terminal to navigate to the download location and type chmod +x filename (replace "filename" with your actual downloaded file name) and then run it.

6. Use the Application

Once the application is open, you can:

  • Upload Documents: Click on the upload section to add files, including formats like PDF, DOCX, PPTX, TXT, HTML, CSV, XLSX, and JSON.

  • Get Summaries: The app will process the documents and present a combined summary in about 5-8 bullet points.

  • Ask Questions: Type in your questions, and the answers will come strictly from the uploaded documents.

🛠 System Requirements

To use Simple RAG effectively, ensure your system meets the following requirements:

  • Operating System: Windows 10 or later, macOS 10.13 or later, or a recent version of any Linux distribution.

  • RAM: At least 4 GB of RAM (8 GB recommended for handling large documents).

  • Storage: Minimum of 500 MB available space for installation.

🔧 Troubleshooting

If you encounter any issues, consider the following common solutions:

  • Installation Fails: Ensure you have administrative rights on your computer. Try running the installer again.

  • Application Does Not Start: Check if your system meets all requirements. Reinstall if necessary.

  • File Upload Issues: Confirm the document format is supported and the file is not corrupted.

📞 Support

For additional help or feedback, please reach out via the Issues section on this repository, or refer to the documentation provided within the application.

📜 License

This project is licensed under the MIT License. See the LICENSE file for more details.

📥 Download & Install

Ready to get started? Click the link below to download Simple RAG and transform how you summarize documents!

Download Latest Release