Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sean1832 committed Oct 28, 2024
1 parent 94638fd commit 131219a
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# SumGPT
[![python](https://img.shields.io/badge/python-3.11-blue)](https://www.python.org/downloads/release/python-3112/)

Achieve detailed summarization of extensive documents through πŸš€ultra-fast parallelized predictions, utilizing [GPT-3.5](https://platform.openai.com/docs/models/gpt-3-5) and [GPT-4](https://platform.openai.com/docs/models/gpt-4) APIs provided by [OpenAI](https://openai.com/).
Achieve detailed summarization of extensive documents through πŸš€ultra-fast parallelized completion with APIs provided by [OpenAI](https://openai.com/).

🌐 Web App: [https://sumgpt.streamlit.app](https://sumgpt.streamlit.app/)

Expand All @@ -13,22 +13,35 @@ Achieve detailed summarization of extensive documents through πŸš€ultra-fast par
---

### 🌟 Features
- πŸ“„ Summarize document (.pdf, .docx, .txt, .md).
- πŸŽ₯ Summarize YouTube video with subtitles.
- πŸ“„ Summarize document (.txt, .md).
- πŸ€– Customizable parameters and bot persona for refined response generation.
- πŸš€ Facilitates parallel processing of chunks, enabling ultra-fast generation speeds.
- πŸš€ Facilitates parallel processing of chunks.
- πŸ’Ό Export & import configs for easy sharing and reuse.
- 🧠 Supports GPT-3.5 and GPT-4.
- 🌍 Encrypted browser cookies ensure configuration settings are preserved across sessions.
- 🧠 Supports multiple modles:
- `gpt-4o-mini`
- `gpt-4o`
- `gpt-4-turbo`
- `gpt-3.5-turbo`

### πŸ’‘ What you need
- πŸ”‘ OpenAI **[API keys](https://platform.openai.com/account/api-keys)**

> ***Note: To access GPT-4, please [join the waitlist](https://openai.com/waitlist/gpt-4-api) if you haven't already received an invitation from OpenAI.***
### πŸ’» Running Locally
- Make sure you have **[python 3.11](https://www.python.org/downloads)** | [python installation tutorial (YouTube)](https://youtu.be/HBxCHonP6Ro?t=105)
1. Clone the repository
```bash
git clone https://github.com/sean1832/SumGPT
cd SumGPT
```

2. Create a `secrets.toml` file under `.streamlit\` directory. Replace `your_secure_key` with your own password for browser cookie encryption.
```bash
mkdir .streamlit
echo "crypto_keycrypto_key = 'your_secure_key'" > .streamlit/secrets.toml
```

3. Execute `RUN.bat`
```bash
./RUN.bat
```
2. Execute `RUN.bat`

0 comments on commit 131219a

Please sign in to comment.