jaiarora123's picture
Update README.md
1c8d4ee verified
---
title: Meeting Minutes Generator
emoji: πŸ“
colorFrom: blue
colorTo: purple
sdk: gradio
sdk_version: 5.49.1
app_file: app.py
pinned: false
license: mit
---
# πŸ“ Meeting Minutes Generator
Upload meeting audio and get professionally formatted minutes instantly!
## πŸš€ Features
- **Audio Transcription** using Groq Whisper Large v3
- **Smart Formatting** using Groq GPT-OSS-120B
- **Instant Results** in clean Markdown format
- **No Login Required** - privacy-focused
- **Free to Use** - no hidden costs
## 🎯 How to Use
1. **Upload** your meeting audio file (MP3, WAV, M4A, WEBM)
2. **Click** "Generate Minutes"
3. **Wait** ~30-40 seconds for processing
4. **Copy** your formatted minutes
## πŸ“Š Supported Files
- **Formats:** MP3, WAV, M4A, WEBM, FLAC
- **Max Size:** 25 MB (~25 minutes at 128kbps)
- **Languages:** English (optimized)
## πŸ› οΈ Tech Stack
- **Backend:** FastAPI
- **Frontend:** Gradio
- **Transcription:** Groq Whisper Large v3 (temperature: 0.1)
- **Minutes Generation:** Groq GPT-OSS-120B (120B parameters, temperature: 0.1)
## πŸ’» Local Setup
If you want to run this locally:
1. Clone the repository
2. Install dependencies: `pip install -r requirements.txt`
3. Add your `GROQ_API_KEY` to `.env` file
4. Run: `python app.py`
5. Open: http://localhost:7860
## πŸ”’ Privacy & Security
- βœ… No data is stored or logged
- βœ… Audio files are processed in memory only
- βœ… Temporary files are deleted after processing
- βœ… Your meetings stay completely private
- βœ… Open source - audit the code yourself
## πŸ“‹ Output Format
The generated minutes include:
- **Meeting metadata** (date, attendees)
- **Summary** (2-3 sentence overview)
- **Key discussions** (structured agenda items)
- **Action items** (with owners and deadlines when mentioned)
- **Open issues/concerns**
- **Additional context** (when relevant)
## πŸŽ“ Use Cases
Perfect for:
- Team standups and sprint reviews
- Client meetings and consultations
- Board meetings and executive sessions
- Educational lectures and seminars
- Medical consultations (keep HIPAA in mind)
- Legal depositions (with appropriate consent)
## ⚑ Performance
- **Transcription**: ~30 seconds for 10-minute audio
- **Minutes Generation**: ~5 seconds
- **Total Processing**: ~35-40 seconds end-to-end
## πŸ”§ Technical Details
### API Endpoints (Backend)
- `POST /transcribe` - Audio to text transcription
- `POST /generate-minutes` - Text to formatted minutes
- `GET /` - Health check
### Models Used
- **Whisper Large v3**: 1550M parameters, multilingual
- **GPT-OSS-120B**: 120B parameters, optimized for structured output
### Processing Pipeline
```
Audio Upload β†’ Validation β†’ Whisper Transcription β†’
LLM Formatting β†’ Markdown Output β†’ Copy/Download
```
## 🀝 Contributing
This is an MVP. Future enhancements could include:
- Speaker diarization (who said what)
- Multi-language support (Hindi, Spanish, etc.)
- PDF/DOCX export
- Meeting history with search
- Real-time transcription
- Calendar integration
## πŸ‘¨β€πŸ’» Built By
Made with ❀️ by Jai
## πŸ“„ License
MIT License - Free to use and modify
---
**⚠️ Note**: This app requires a Groq API key. Add yours in the HF Spaces Settings β†’ Repository Secrets with the name `GROQ_API_KEY`.
```
---
## πŸ“Š Files Summary for HF Upload
**Upload these 6 files to HF Spaces:**
1. βœ… `app.py` (NEW - just gave you)
2. βœ… `backend.py` (your existing file)
3. βœ… `frontend.py` (your existing file)
4. βœ… `requirements.txt` (your existing file)
5. βœ… `README.md` (updated version above)
6. βœ… `.gitignore` (NEW - just gave you)
---
## βœ… Final Checklist
**In Cursor, verify you now have:**
```
hackathon/
β”œβ”€β”€ app.py βœ… NEW
β”œβ”€β”€ backend.py βœ… Existing
β”œβ”€β”€ frontend.py βœ… Existing
β”œβ”€β”€ requirements.txt βœ… Existing
β”œβ”€β”€ README.md βœ… Updated
└── .gitignore βœ… NEW