Code Monkey home page Code Monkey logo

quotr's Introduction

QuotR

QuotR is a NLP-based web application developed to retrieve relevant quotes from user-provided source PDFs to support essay claims. It is an innovative solution for students seeking to support their claims with references from their required readings.

Requirements

To use QuotR, you need to install the relevant packages. Use the requirements.txt file for this purpose.

Adding PDF Files

Once you have installed the required packages, add your relevant readings/lecture notes/journals/articles/textbooks to the Data folder. The files must be in PDF format.

Insert your OPENAI API Key

You must insert your OPENAI API key in both the ingest.py and similarity_search.py files. In the documents, I have labelled the relevant places where you must insert it.

Running the Application

Run the ingest.py file to process the PDF files you added to the Data folder. After the ingest.py file has finished running, run the similarity_search.py file to start finding your quotes. The application uses Gradio and OpenAI to provide a user-friendly interface for quote retrieval.

Conclusion

QuotR is an innovative solution that offers a convenient way for students to support their claims with references from their required readings. The application has been developed using the latest NLP and GPT technology and is easy to use. We hope you find this application helpful in your academic pursuits.

quotr's People

Contributors

alexkstern 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.