Code Monkey home page Code Monkey logo

pdf_summarize_chatgpt's Introduction

PDF Papers Summarizer with ChatGPT

Author: Munir Jojo-Verge

This Python project is designed to summarize PDF documents using OpenAI's GPT-3 AI model. It reads PDF files from a given directory, counts the number of tokens in the text to manage usage of GPT-3, and uses GPT-3 to summarize the document. The summaries are then saved into Word (.docx) documents in a specified directory.

It's mainly aimed to summarize papers for further analysis and code development. The summaries will include the key findings, methodology, experimental results, statistical analysis, and any limitations. The summary is formatted with bullet points for easy reference.

Features

  • PDF text extraction using pdfplumber.
  • Token counting using tiktoken.
  • GPT-3 based text summarization using openai.
  • Progress tracking with tqdm.
  • Configuration handling with hydra and omegaconf.
  • Document creation with docx.

Installation

  1. Clone the repository:

    git clone https://github.com/munirjojoverge/pdf_summarize_chatGPT.git
  2. Change into the directory:

    cd pdf_summarize_chatGPT
  3. Create a simple conda/mamba enviroment and install the required packages:

    mamba env create -f environment.yaml
    mamba activate summarize

Configuration

This project uses hydra for configuration. The config file is located at config/config.yaml. You can specify the openAI API key, the engine, and various other settings related to the GPT-3 model in this config file.

You also need to specify the path to the directory containing the PDF files to summarize, and the output directory where the summarized documents will be saved.

Usage

After configuring the settings, you can run the project with the following command:

python pdf_summarize.py

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

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

Disclaimer

This software is not guaranteed to be perfect and comes with no warranty. You should check the summarized documents for accuracy and completeness.

Contact

Please raise an issue in this GitHub repository if you have any issues, questions, or feedback.

pdf_summarize_chatgpt's People

Contributors

munirjojoverge avatar

Watchers

 avatar Kostas Georgiou 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.