Update README.md
Browse files
README.md
CHANGED
|
@@ -1,154 +1,154 @@
|
|
| 1 |
-
---
|
| 2 |
-
title: Meeting Minutes Generator
|
| 3 |
-
emoji: π
|
| 4 |
-
colorFrom: blue
|
| 5 |
-
colorTo: purple
|
| 6 |
-
sdk: gradio
|
| 7 |
-
sdk_version:
|
| 8 |
-
app_file: app.py
|
| 9 |
-
pinned: false
|
| 10 |
-
license: mit
|
| 11 |
-
---
|
| 12 |
-
|
| 13 |
-
# π Meeting Minutes Generator
|
| 14 |
-
|
| 15 |
-
Upload meeting audio and get professionally formatted minutes instantly!
|
| 16 |
-
|
| 17 |
-
## π Features
|
| 18 |
-
|
| 19 |
-
- **Audio Transcription** using Groq Whisper Large v3
|
| 20 |
-
- **Smart Formatting** using Groq GPT-OSS-120B
|
| 21 |
-
- **Instant Results** in clean Markdown format
|
| 22 |
-
- **No Login Required** - privacy-focused
|
| 23 |
-
- **Free to Use** - no hidden costs
|
| 24 |
-
|
| 25 |
-
## π― How to Use
|
| 26 |
-
|
| 27 |
-
1. **Upload** your meeting audio file (MP3, WAV, M4A, WEBM)
|
| 28 |
-
2. **Click** "Generate Minutes"
|
| 29 |
-
3. **Wait** ~30-40 seconds for processing
|
| 30 |
-
4. **Copy** your formatted minutes
|
| 31 |
-
|
| 32 |
-
## π Supported Files
|
| 33 |
-
|
| 34 |
-
- **Formats:** MP3, WAV, M4A, WEBM, FLAC
|
| 35 |
-
- **Max Size:** 25 MB (~25 minutes at 128kbps)
|
| 36 |
-
- **Languages:** English (optimized)
|
| 37 |
-
|
| 38 |
-
## π οΈ Tech Stack
|
| 39 |
-
|
| 40 |
-
- **Backend:** FastAPI
|
| 41 |
-
- **Frontend:** Gradio
|
| 42 |
-
- **Transcription:** Groq Whisper Large v3 (temperature: 0.1)
|
| 43 |
-
- **Minutes Generation:** Groq GPT-OSS-120B (120B parameters, temperature: 0.1)
|
| 44 |
-
|
| 45 |
-
## π» Local Setup
|
| 46 |
-
|
| 47 |
-
If you want to run this locally:
|
| 48 |
-
|
| 49 |
-
1. Clone the repository
|
| 50 |
-
2. Install dependencies: `pip install -r requirements.txt`
|
| 51 |
-
3. Add your `GROQ_API_KEY` to `.env` file
|
| 52 |
-
4. Run: `python app.py`
|
| 53 |
-
5. Open: http://localhost:7860
|
| 54 |
-
|
| 55 |
-
## π Privacy & Security
|
| 56 |
-
|
| 57 |
-
- β
No data is stored or logged
|
| 58 |
-
- β
Audio files are processed in memory only
|
| 59 |
-
- β
Temporary files are deleted after processing
|
| 60 |
-
- β
Your meetings stay completely private
|
| 61 |
-
- β
Open source - audit the code yourself
|
| 62 |
-
|
| 63 |
-
## π Output Format
|
| 64 |
-
|
| 65 |
-
The generated minutes include:
|
| 66 |
-
- **Meeting metadata** (date, attendees)
|
| 67 |
-
- **Summary** (2-3 sentence overview)
|
| 68 |
-
- **Key discussions** (structured agenda items)
|
| 69 |
-
- **Action items** (with owners and deadlines when mentioned)
|
| 70 |
-
- **Open issues/concerns**
|
| 71 |
-
- **Additional context** (when relevant)
|
| 72 |
-
|
| 73 |
-
## π Use Cases
|
| 74 |
-
|
| 75 |
-
Perfect for:
|
| 76 |
-
- Team standups and sprint reviews
|
| 77 |
-
- Client meetings and consultations
|
| 78 |
-
- Board meetings and executive sessions
|
| 79 |
-
- Educational lectures and seminars
|
| 80 |
-
- Medical consultations (keep HIPAA in mind)
|
| 81 |
-
- Legal depositions (with appropriate consent)
|
| 82 |
-
|
| 83 |
-
## β‘ Performance
|
| 84 |
-
|
| 85 |
-
- **Transcription**: ~30 seconds for 10-minute audio
|
| 86 |
-
- **Minutes Generation**: ~5 seconds
|
| 87 |
-
- **Total Processing**: ~35-40 seconds end-to-end
|
| 88 |
-
|
| 89 |
-
## π§ Technical Details
|
| 90 |
-
|
| 91 |
-
### API Endpoints (Backend)
|
| 92 |
-
- `POST /transcribe` - Audio to text transcription
|
| 93 |
-
- `POST /generate-minutes` - Text to formatted minutes
|
| 94 |
-
- `GET /` - Health check
|
| 95 |
-
|
| 96 |
-
### Models Used
|
| 97 |
-
- **Whisper Large v3**: 1550M parameters, multilingual
|
| 98 |
-
- **GPT-OSS-120B**: 120B parameters, optimized for structured output
|
| 99 |
-
|
| 100 |
-
### Processing Pipeline
|
| 101 |
-
```
|
| 102 |
-
Audio Upload β Validation β Whisper Transcription β
|
| 103 |
-
LLM Formatting β Markdown Output β Copy/Download
|
| 104 |
-
```
|
| 105 |
-
|
| 106 |
-
## π€ Contributing
|
| 107 |
-
|
| 108 |
-
This is an MVP. Future enhancements could include:
|
| 109 |
-
- Speaker diarization (who said what)
|
| 110 |
-
- Multi-language support (Hindi, Spanish, etc.)
|
| 111 |
-
- PDF/DOCX export
|
| 112 |
-
- Meeting history with search
|
| 113 |
-
- Real-time transcription
|
| 114 |
-
- Calendar integration
|
| 115 |
-
|
| 116 |
-
## π¨βπ» Built By
|
| 117 |
-
|
| 118 |
-
Made with β€οΈ by Jai
|
| 119 |
-
|
| 120 |
-
## π License
|
| 121 |
-
|
| 122 |
-
MIT License - Free to use and modify
|
| 123 |
-
|
| 124 |
-
---
|
| 125 |
-
|
| 126 |
-
**β οΈ Note**: This app requires a Groq API key. Add yours in the HF Spaces Settings β Repository Secrets with the name `GROQ_API_KEY`.
|
| 127 |
-
```
|
| 128 |
-
|
| 129 |
-
---
|
| 130 |
-
|
| 131 |
-
## π Files Summary for HF Upload
|
| 132 |
-
|
| 133 |
-
**Upload these 6 files to HF Spaces:**
|
| 134 |
-
|
| 135 |
-
1. β
`app.py` (NEW - just gave you)
|
| 136 |
-
2. β
`backend.py` (your existing file)
|
| 137 |
-
3. β
`frontend.py` (your existing file)
|
| 138 |
-
4. β
`requirements.txt` (your existing file)
|
| 139 |
-
5. β
`README.md` (updated version above)
|
| 140 |
-
6. β
`.gitignore` (NEW - just gave you)
|
| 141 |
-
|
| 142 |
-
---
|
| 143 |
-
|
| 144 |
-
## β
Final Checklist
|
| 145 |
-
|
| 146 |
-
**In Cursor, verify you now have:**
|
| 147 |
-
```
|
| 148 |
-
hackathon/
|
| 149 |
-
βββ app.py β
NEW
|
| 150 |
-
βββ backend.py β
Existing
|
| 151 |
-
βββ frontend.py β
Existing
|
| 152 |
-
βββ requirements.txt β
Existing
|
| 153 |
-
βββ README.md β
Updated
|
| 154 |
βββ .gitignore β
NEW
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Meeting Minutes Generator
|
| 3 |
+
emoji: π
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: gradio
|
| 7 |
+
sdk_version: 5.49.1
|
| 8 |
+
app_file: app.py
|
| 9 |
+
pinned: false
|
| 10 |
+
license: mit
|
| 11 |
+
---
|
| 12 |
+
|
| 13 |
+
# π Meeting Minutes Generator
|
| 14 |
+
|
| 15 |
+
Upload meeting audio and get professionally formatted minutes instantly!
|
| 16 |
+
|
| 17 |
+
## π Features
|
| 18 |
+
|
| 19 |
+
- **Audio Transcription** using Groq Whisper Large v3
|
| 20 |
+
- **Smart Formatting** using Groq GPT-OSS-120B
|
| 21 |
+
- **Instant Results** in clean Markdown format
|
| 22 |
+
- **No Login Required** - privacy-focused
|
| 23 |
+
- **Free to Use** - no hidden costs
|
| 24 |
+
|
| 25 |
+
## π― How to Use
|
| 26 |
+
|
| 27 |
+
1. **Upload** your meeting audio file (MP3, WAV, M4A, WEBM)
|
| 28 |
+
2. **Click** "Generate Minutes"
|
| 29 |
+
3. **Wait** ~30-40 seconds for processing
|
| 30 |
+
4. **Copy** your formatted minutes
|
| 31 |
+
|
| 32 |
+
## π Supported Files
|
| 33 |
+
|
| 34 |
+
- **Formats:** MP3, WAV, M4A, WEBM, FLAC
|
| 35 |
+
- **Max Size:** 25 MB (~25 minutes at 128kbps)
|
| 36 |
+
- **Languages:** English (optimized)
|
| 37 |
+
|
| 38 |
+
## π οΈ Tech Stack
|
| 39 |
+
|
| 40 |
+
- **Backend:** FastAPI
|
| 41 |
+
- **Frontend:** Gradio
|
| 42 |
+
- **Transcription:** Groq Whisper Large v3 (temperature: 0.1)
|
| 43 |
+
- **Minutes Generation:** Groq GPT-OSS-120B (120B parameters, temperature: 0.1)
|
| 44 |
+
|
| 45 |
+
## π» Local Setup
|
| 46 |
+
|
| 47 |
+
If you want to run this locally:
|
| 48 |
+
|
| 49 |
+
1. Clone the repository
|
| 50 |
+
2. Install dependencies: `pip install -r requirements.txt`
|
| 51 |
+
3. Add your `GROQ_API_KEY` to `.env` file
|
| 52 |
+
4. Run: `python app.py`
|
| 53 |
+
5. Open: http://localhost:7860
|
| 54 |
+
|
| 55 |
+
## π Privacy & Security
|
| 56 |
+
|
| 57 |
+
- β
No data is stored or logged
|
| 58 |
+
- β
Audio files are processed in memory only
|
| 59 |
+
- β
Temporary files are deleted after processing
|
| 60 |
+
- β
Your meetings stay completely private
|
| 61 |
+
- β
Open source - audit the code yourself
|
| 62 |
+
|
| 63 |
+
## π Output Format
|
| 64 |
+
|
| 65 |
+
The generated minutes include:
|
| 66 |
+
- **Meeting metadata** (date, attendees)
|
| 67 |
+
- **Summary** (2-3 sentence overview)
|
| 68 |
+
- **Key discussions** (structured agenda items)
|
| 69 |
+
- **Action items** (with owners and deadlines when mentioned)
|
| 70 |
+
- **Open issues/concerns**
|
| 71 |
+
- **Additional context** (when relevant)
|
| 72 |
+
|
| 73 |
+
## π Use Cases
|
| 74 |
+
|
| 75 |
+
Perfect for:
|
| 76 |
+
- Team standups and sprint reviews
|
| 77 |
+
- Client meetings and consultations
|
| 78 |
+
- Board meetings and executive sessions
|
| 79 |
+
- Educational lectures and seminars
|
| 80 |
+
- Medical consultations (keep HIPAA in mind)
|
| 81 |
+
- Legal depositions (with appropriate consent)
|
| 82 |
+
|
| 83 |
+
## β‘ Performance
|
| 84 |
+
|
| 85 |
+
- **Transcription**: ~30 seconds for 10-minute audio
|
| 86 |
+
- **Minutes Generation**: ~5 seconds
|
| 87 |
+
- **Total Processing**: ~35-40 seconds end-to-end
|
| 88 |
+
|
| 89 |
+
## π§ Technical Details
|
| 90 |
+
|
| 91 |
+
### API Endpoints (Backend)
|
| 92 |
+
- `POST /transcribe` - Audio to text transcription
|
| 93 |
+
- `POST /generate-minutes` - Text to formatted minutes
|
| 94 |
+
- `GET /` - Health check
|
| 95 |
+
|
| 96 |
+
### Models Used
|
| 97 |
+
- **Whisper Large v3**: 1550M parameters, multilingual
|
| 98 |
+
- **GPT-OSS-120B**: 120B parameters, optimized for structured output
|
| 99 |
+
|
| 100 |
+
### Processing Pipeline
|
| 101 |
+
```
|
| 102 |
+
Audio Upload β Validation β Whisper Transcription β
|
| 103 |
+
LLM Formatting β Markdown Output β Copy/Download
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
## π€ Contributing
|
| 107 |
+
|
| 108 |
+
This is an MVP. Future enhancements could include:
|
| 109 |
+
- Speaker diarization (who said what)
|
| 110 |
+
- Multi-language support (Hindi, Spanish, etc.)
|
| 111 |
+
- PDF/DOCX export
|
| 112 |
+
- Meeting history with search
|
| 113 |
+
- Real-time transcription
|
| 114 |
+
- Calendar integration
|
| 115 |
+
|
| 116 |
+
## π¨βπ» Built By
|
| 117 |
+
|
| 118 |
+
Made with β€οΈ by Jai
|
| 119 |
+
|
| 120 |
+
## π License
|
| 121 |
+
|
| 122 |
+
MIT License - Free to use and modify
|
| 123 |
+
|
| 124 |
+
---
|
| 125 |
+
|
| 126 |
+
**β οΈ Note**: This app requires a Groq API key. Add yours in the HF Spaces Settings β Repository Secrets with the name `GROQ_API_KEY`.
|
| 127 |
+
```
|
| 128 |
+
|
| 129 |
+
---
|
| 130 |
+
|
| 131 |
+
## π Files Summary for HF Upload
|
| 132 |
+
|
| 133 |
+
**Upload these 6 files to HF Spaces:**
|
| 134 |
+
|
| 135 |
+
1. β
`app.py` (NEW - just gave you)
|
| 136 |
+
2. β
`backend.py` (your existing file)
|
| 137 |
+
3. β
`frontend.py` (your existing file)
|
| 138 |
+
4. β
`requirements.txt` (your existing file)
|
| 139 |
+
5. β
`README.md` (updated version above)
|
| 140 |
+
6. β
`.gitignore` (NEW - just gave you)
|
| 141 |
+
|
| 142 |
+
---
|
| 143 |
+
|
| 144 |
+
## β
Final Checklist
|
| 145 |
+
|
| 146 |
+
**In Cursor, verify you now have:**
|
| 147 |
+
```
|
| 148 |
+
hackathon/
|
| 149 |
+
βββ app.py β
NEW
|
| 150 |
+
βββ backend.py β
Existing
|
| 151 |
+
βββ frontend.py β
Existing
|
| 152 |
+
βββ requirements.txt β
Existing
|
| 153 |
+
βββ README.md β
Updated
|
| 154 |
βββ .gitignore β
NEW
|