Git Product home page Git Product logo

document_summarization's Introduction

Running Instructions

First, you must create a .env file and add your OpenAI API key. You can use the template.env as a reference.

You can run the application by first downloading Docker and using the command docker compose up --build. There are two components to the app, the front-end which you can find at http://localhost:3000/, and the backend. Navigate to the URL, and upload a .txt file, such as test_file.txt. In a few seconds, or longer if you've uploaded a larger file, you will see the summary of your document.

Potential Improvements

Due to this application just being a POC, many components of it are simplistic. For example, the chunking technique to reduce a large document into smaller, important chunks is done if the document length exceeds an arbitrary word count. An improvement would be to use token counts, and quantitivate metrics to determine when this necessary. Further, the chunking mechanism is quite simple. The API logic is also not concurrent, so if multiple users upload documents it will take a while to complete.

document_summarization's People

Contributors

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