ReviewSummariser / README.md
Manish014's picture
update readme
850ecf3 verified
---
title: ReviewSummariser
emoji: πŸ‘€
colorFrom: pink
colorTo: red
sdk: gradio
sdk_version: 5.35.0
app_file: app.py
pinned: false
---
# πŸ“ Review Summariser GPT - Config 1
This is a Gradio-powered web application that uses a fine-tuned T5 model to summarize long product reviews into short, helpful summaries β€” and also predicts the overall sentiment (Positive/Negative) of the review.
- πŸ”§ Built with: [πŸ€— Transformers](https://huggingface.co/transformers), [Gradio](https://gradio.app), [Hugging Face Spaces](https://huggingface.co/spaces)
- 🧠 Model: Fine-tuned from `t5-small` on a custom review-summary dataset
- πŸ” Sentiment: Powered by `distilbert-base-uncased-finetuned-sst-2-english`
---
## πŸš€ Demo
πŸ‘‰ **Live on Hugging Face Spaces**:
[πŸ”— Launch App](https://huggingface.co/spaces/Manish014/ReviewSummariser)
---
## πŸ“¦ Features
- βœ‚οΈ Summarizes long product reviews (e.g., from Amazon, Flipkart, etc.)
- πŸ“Š Predicts sentiment using a pre-trained classifier
- πŸ–ΌοΈ Clean Gradio UI with examples and collapsible "About" section
- ⚑ Optimized for GPU inference (but also works on CPU)
---
## πŸ§ͺ Example
**Input Review:**
> This product leaks water and smells like burnt plastic. Total waste of money.
**β†’ Summary:**
> Leaks and has a bad odor. Not recommended.
**β†’ Sentiment:**
> NEGATIVE (99.8%)
---
## πŸ“ Files in This Repo
| File | Description |
|-------------------|------------------------------------------|
| `app.py` | Main app file with Gradio Blocks UI |
| `requirements.txt`| Python dependencies for the Space |
| `thumbnail.png` | Preview image used on Hugging Face Space |
| `README.md` | This file |
---
## 🧠 Model Details
- **Base Model:** `t5-small`
- **Fine-Tuning:** Trained on a 1000-sample custom dataset (`review β†’ summary`)
- **Epochs:** 5
- **Batch size:** 4
- **Learning rate:** 5e-5
- **Training Env:** Google Colab + Kaggle
---
## πŸ“„ License
This project is licensed under the [MIT License](LICENSE).
---
## πŸ™‹β€β™‚οΈ Author
**Manish Kumar Kondoju**
🌐 [Hugging Face Profile](https://huggingface.co/Manish014)
πŸ“« [email protected]
---
> ⭐ Star this repo if you found it useful β€” and feel free to fork, extend, or share!
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference