tonykipkemboi / ollama_pdf_rag

A demo Jupyter Notebook showcasing a simple local RAG (Retrieval Augmented Generation) pipeline to chat with your PDFs.
MIT License
244 stars 103 forks source link

๐Ÿค– Chat with PDF locally using Ollama + LangChain

A powerful local RAG (Retrieval Augmented Generation) application that lets you chat with your PDF documents using Ollama and LangChain. This project includes both a Jupyter notebook for experimentation and a Streamlit web interface for easy interaction.

๐Ÿ“บ Video Tutorial

Watch the video

โœจ Features

๐Ÿš€ Getting Started

Prerequisites

  1. Install Ollama

    • Visit Ollama's website to download and install
    • Pull required models:
      ollama pull llama2  # or your preferred model
      ollama pull nomic-embed-text
  2. Clone Repository

    git clone https://github.com/tonykipkemboi/ollama_pdf_rag.git
    cd ollama_pdf_rag
  3. Set Up Environment

    python -m venv venv
    source venv/bin/activate  # On Windows: .\venv\Scripts\activate
    pip install -r requirements.txt

๐ŸŽฎ Running the Application

Option 1: Streamlit Interface

streamlit run streamlit_app.py

Then open your browser to http://localhost:8501

Streamlit UI Streamlit interface showing PDF viewer and chat functionality

Option 2: Jupyter Notebook

jupyter notebook

Open updated_rag_notebook.ipynb to experiment with the code

๐Ÿ’ก Usage Tips

  1. Upload PDF: Use the file uploader in the Streamlit interface or try the sample PDF
  2. Select Model: Choose from your locally available Ollama models
  3. Ask Questions: Start chatting with your PDF through the chat interface
  4. Adjust Display: Use the zoom slider to adjust PDF visibility
  5. Clean Up: Use the "Delete Collection" button when switching documents

๐Ÿค Contributing

Feel free to:

โš ๏ธ Troubleshooting

Common Errors

ONNX DLL Error

If you encounter this error:

DLL load failed while importing onnx_copy2py_export: a dynamic link Library (DLL) initialization routine failed.

Try these solutions:

  1. Install Microsoft Visual C++ Redistributable:

  2. If the error persists, try installing ONNX Runtime manually:

    pip uninstall onnxruntime onnxruntime-gpu
    pip install onnxruntime

CPU-Only Systems

If you're running on a CPU-only system:

  1. Ensure you have the CPU version of ONNX Runtime:

    pip uninstall onnxruntime-gpu  # Remove GPU version if installed
    pip install onnxruntime  # Install CPU-only version
  2. You may need to modify the chunk size in the code to prevent memory issues:

    • Reduce chunk_size to 500-1000 if you experience memory problems
    • Increase chunk_overlap for better context preservation

Note: The application will run slower on CPU-only systems, but it will still work effectively.

๐Ÿ“ License

This project is open source and available under the MIT License.


โญ๏ธ Star History

Star History Chart

Built with โค๏ธ by Tony Kipkemboi