Unisum - A Universal Summarization Tool

Unisum is a versatile and powerful universal summarization tool designed to streamline the process of summarizing various types of content. Whether you need to summarize raw text, text documents, images, or PDFs, Unisum has got you covered. Additionally, Unisum incorporates a unique question-answering feature, allowing you to ask specific questions related to the document you uploaded.

Table of Contents

• Screenshots
• Quickrun
• Installation
• Usage
• Features
• Contributing
• License

Screenshots📷

UI -

Raw text summarization -

Text document summarization

Image summarization

More to come...!🚀

Quickrun⚡

1. After creating your workspace, you will be redirected to an editor, open the terminal and choose server bash

   

2. Following prompt comes up, enter 'y' to install the correct python version

   pyenv: /workspace/.pyenv_mirror/fakeroot/versions/3.10.12 already exists
   continue with installation? (y/N) y
   

3. Wait for few minutes till the server initializes and fires up

    Watching for file changes with StatReloader
    Performing system checks...
    
    System check identified no issues (0 silenced).
    September 04, 2023 - 13:18:08
    Django version 4.2.3, using settings 'server.settings'
    Starting development server at http://127.0.0.1:8000/
    Quit the server with CONTROL-C.
   

4. Now switch to frontend bash, and ctrl + click on the link

VITE v4.4.2  ready in 528 ms

➜  Local:   http://localhost:5173/
➜  Network: use --host to expose
➜  press h to show help

Installation🛠

To get started with Unisum, follow these simple steps:

1. Clone the repository: $ git clone https://github.com/legit-programmer/unisum.git
2. Install the required dependencies:
   /server/$- pip3 install -r requirements.txt
/app/$- npm install
3. Setup .env file in /server/ by adding TOKEN = <YOUR HUGGING FACE HUB TOKEN HERE>. Get your token here

Usage💻

Unisum offers a user-friendly interface and easy-to-use functionalities. Follow the instructions below to utilize its features effectively:

1. Launch Unisum by running the following command:
   /server/$- python3 manage.py runserver
/app/$- npm run dev
2. Access Unisum in your preferred web browser at http://localhost:5173
3. Upload the document you wish to summarize. Unisum supports a wide range of file formats, including raw text, text documents and PDFs. see currently supported documents
4. If desired, utilize the question-answering feature to obtain specific answers related to the document content. Simply enter your question, and Unisum will provide the most relevant response.

Features✨

Unisum offers a comprehensive set of features that sets it apart from other summarization tools:

• Universal Summarization: Unisum supports a wide range of file formats, including raw text, text documents, and PDFs. You can easily summarize any type of content without switching between different tools.

• Question-Answering: Unisum incorporates an intelligent question-answering capability, allowing you to ask specific questions related to the uploaded document. Obtain accurate and relevant answers effortlessly.

• User-Friendly Interface: The intuitive and user-friendly interface of Unisum ensures a seamless and enjoyable user experience. Easily navigate through the tool and access all its features without any hassle.

Currently Supported Documents:

Document Type	Summary	Qna
Raw text	☑️	☑️
Text document	☑️	☑️
Image	☑️	☑️
Pdf	☑️	☑️

Contributing💖

We welcome contributions from the community to make Unisum even better. If you would like to contribute, please follow these guidelines:

1. Fork the repository and create a new branch.

2. Make your changes and ensure they align with the project's coding style and conventions.

3. Write clear and concise commit messages.

4. Test your changes thoroughly.

5. Submit a pull request describing the changes you made and their purpose.

License📃

This project is licensed under the MIT License. Feel free to use and modify the code as per the license terms.