Git Product home page Git Product logo

discopdf's Introduction

DiscoPDF

Overview

DiscoPDF is a powerful tool designed for embedding PDF documents into a vectorized database, enabling advanced data interpretation through AI-driven questioning capabilities. This tool primarily uses the Mistral 7B model in GGUF format, though it supports other models as well. It is ideal for researchers and analysts who require deep insights from result data in PDF formats.

Features

  • PDF Vectorization: Embed PDF files into a searchable, vectorized database.
  • Flexible Model Support: Uses Mistral 7B by default but allows the integration of alternative models.
  • Interactive Querying: Users can query the embedded PDFs to extract and interpret data.
  • Integration Friendly: Designed to be a part of a broader AI-based workflow for result data interpretation.
  • Streamlit Application: User-friendly web interface powered by Streamlit.

Prerequisites

  • Python 3.x
  • Conda or Miniconda (optional)

Installation Instructions

Setting up the Environment

  1. Clone the Repository:

    git clone https://github.com/nikolatom/DiscoPDF.git
    cd DiscoPDF
  2. Create a Conda Environment:

    conda create --name discopdf python=3.8
    conda activate discopdf
  3. Install Required Python Packages:

    pip install -r requirements.txt

Model Setup

Download the necessary models from Hugging Face as described in the ./models/download_notes.rtf file included in the repository.

Running the Application

  1. Launch the Streamlit App:
    streamlit run disco_pdf.py

Usage

Once the application is running, navigate to the local web URL provided by Streamlit (typically http://localhost:8501). You can upload PDF files to be embedded into the database and use the interactive interface to query the database.

Contributing

Contributions to DiscoPDF are welcome! Please refer to the CONTRIBUTING.md for guidelines on how to make contributions.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Support

For support, please open an issue in the GitHub repository.

Acknowledgements

  • Models provided by Hugging Face.
  • Streamlit for the web framework.

discopdf's People

Contributors

nikolatom avatar paureel avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

paureel

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.