Coder Social home page Coder Social logo

local-rag-pdf's Introduction

Local RAG query tool for PDFs

This is a simple Retrieval Augmented Generation (RAG) tool built in Python which allows us to read information from a PDF document and then generate a response based on the information in the document.

We use Ollama to run the tool Locally and we use llama3 currently as the model for the RAG tool.

Setup

After cloning the repository, you can install the required packages using the requirements.txt file. To install the packages, you can run the following command:

pip install -r requirements.txt

After installing the required packages, you also need to place the PDF documents you want to get information about in the data folder.

You also need to download Ollama if you haven't already. After downloading Ollama, make sure you download the 'llama3' model in the terminal by running the following command:

ollama pull llama3

This will download the llama3 model which we will use for the RAG tool. Learn more about Ollama implementation in my Guide to Ollama. You can also download other models if you want but then you will have to change the MODEL_NAME in the main.py file.

Usage

To use the tool, you can run the following command:

python main.py

This will start the script and you can then input a question and it will generate a response based on the information in the PDF document.

local-rag-pdf's People

Contributors

jayantaadhikary avatar

Stargazers

Abhik C avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.