SumGPT Introduction
SumGPT is an innovative project dedicated to providing detailed summarization of extensive documents. By leveraging the powerful capabilities of APIs from OpenAI, SumGPT offers ultra-fast parallelized completion, making it a significant tool for anyone needing quick and efficient document summarization.
Features
SumGPT comes equipped with an array of features designed to enhance user experience and improve summary quality:
- Document Summarization: Supports importing documents in .txt and .md formats for succinct summaries.
- Customizable Parameters and Bot Persona: Allows users to customize response generation parameters and select a bot persona, enabling more refined and targeted summaries.
- Parallel Processing: Boosts processing speed by breaking down documents into smaller chunks that are processed simultaneously.
- Config Export & Import: Users can easily share and reuse configurations, facilitating a seamless experience across different sessions or among various users.
- Encrypted Browser Cookies: Ensures that all your configuration settings are securely stored and maintained across browsing sessions.
- Model Support: SumGPT supports a variety of GPT models including
gpt-4o-mini
,gpt-4o
,gpt-4-turbo
, andgpt-3.5-turbo
, each offering unique capabilities to suit different summarization needs.
Requirements
To start using SumGPT, there are a few prerequisites:
- OpenAI API Keys: Users need to obtain API keys from OpenAI's API platform to access the summarization services.
Running Locally
For users who prefer to run SumGPT on their own machines, here are the straightforward steps to get started:
-
Install Python 3.11: Ensure Python 3.11 is installed on your computer. If unsure how to install, this tutorial might be helpful.
-
Clone the Repository: Begin by cloning the SumGPT repository into your local machine.
git clone https://github.com/sean1832/SumGPT cd SumGPT
-
Set Up Secrets File: You'll need to create a
secrets.toml
file within the.streamlit\
directory. This will store your encryption key for browser cookies.mkdir .streamlit echo "crypto_keycrypto_key = 'your_secure_key'" > .streamlit/secrets.toml
-
Run the Application: Launch SumGPT by executing the provided script.
./RUN.bat
SumGPT aims to provide a simplified yet powerful document summarization solution with the backing of state-of-the-art AI technology. Whether you're a developer or a content creator, SumGPT can significantly streamline your workflow by efficiently processing extensive textual data.