Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Bklieger/ScribeWizard
ScribeWizard: Generate organized notes from audio using Groq, Whisper, and Llama3
https://github.com/Bklieger/ScribeWizard
ai groq groq-api llama3 replit whisper
Last synced: 29 days ago
JSON representation
ScribeWizard: Generate organized notes from audio using Groq, Whisper, and Llama3
- Host: GitHub
- URL: https://github.com/Bklieger/ScribeWizard
- Owner: Bklieger
- License: mit
- Created: 2024-06-19T23:50:23.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T03:43:29.000Z (4 months ago)
- Last Synced: 2024-11-19T09:45:05.333Z (about 1 month ago)
- Topics: ai, groq, groq-api, llama3, replit, whisper
- Language: Python
- Homepage: https://wizard.benjamin.sh
- Size: 41.2 MB
- Stars: 456
- Watchers: 3
- Forks: 99
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
ScribeWizard: Generate organized notes from audio
using Groq, Whisper, and Llama3
Overview •
Features •
Quickstart •
Contributing
[Demo of ScribeWizard](https://github.com/user-attachments/assets/c222bea0-3784-4f06-b431-ef81eea5691d)
> Demo of ScribeWizard fast transcription of audio and generation of structured notes
## Overview
ScribeWizard is a streamlit app that scaffolds the creation of structured lecture notes by iteratively structuring and generating notes from transcribed audio lectures using Groq's Whisper API. The app mixes Llama3-8b and Llama3-70b, utilizing the larger model for generating the notes structure and the faster of the two for creating the content.
### Features
- 🎧 Generate structured notes using transcribed audio by Whisper-large and text by Llama3
- ⚡ Lightning fast speed transcribing audio and generating text using Groq
- 📖 Scaffolded prompting strategically switches between Llama3-70b and Llama3-8b to balance speed and quality
- 🖊️ Markdown styling creates aesthetic notes on the streamlit app that can include tables and code
- 📂 Allows user to download a text or PDF file with the entire notes contents
### Example Generated Notes:
| Example | Youtube Link |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| [Transformers Explained by Google Cloud Tech](examples/transformers_explained/generated_notes.pdf) | https://www.youtube.com/watch?v=SZorAJ4I-sA |
| [The Essence of Calculus by 3Blue1Brown](examples/essence_calculus/generated_notes.pdf) | https://www.youtube.com/watch?v=WUvTyaaNkzM |
> As with all generative AI, content may include inaccurate or placeholder information. ScribeWizard is in beta and all feedback is welcome!
---
## Quickstart
> [!IMPORTANT]
> To use ScribeWizard, you can use a hosted version at [scribewizard.streamlit.app](https://scribewizard.streamlit.app).
> Alternatively, you can run ScribeWizard locally with Streamlit using the quickstart instructions.
### Hosted on Streamlit:
To use ScribeWizard, you can use the hosted version at [scribewizard.streamlit.app](https://scribewizard.streamlit.app)
### Run locally:
Alternative, you can run ScribeWizard locally with streamlit.
#### Step 1
First, you can set your Groq API key in the environment variables:
~~~
export GROQ_API_KEY="gsk_yA..."
~~~
This is an optional step that allows you to skip setting the Groq API key later in the streamlit app.
#### Step 2
Next, you can set up a virtual environment and install the dependencies.
~~~
python3 -m venv venv
~~~
~~~
source venv/bin/activate
~~~
~~~
pip3 install -r requirements.txt
~~~
#### Step 3
Finally, you can run the streamlit app.
~~~
python3 -m streamlit run main.py
~~~
## Details
### Technologies
- Streamlit
- Llama3 on Groq Cloud
- Whisper-large on Groq Cloud
### Limitations
ScribeWizard may generate inaccurate information or placeholder content. It should be used to generate notes for entertainment purposes only.
## Contributing
Improvements through PRs are welcome!
## Changelog
### v0.1.0
This release is an initial release of the application codebase. It includes the following features:
🎧 Generate structured notes using transcribed audio by Whisper-large and text by Llama3
⚡ Lightning fast speed transcribing audio and generating text using Groq
📖 Scaffolded prompting strategically switches between Llama3-70b and Llama3-8b to balance speed and quality
🖊️ Markdown styling creates aesthetic notes on the streamlit app that can include tables and code
📂 Allows user to download a text or PDF file with the entire notes contents
### Future Features:
- Create summary version of transcript, batching into sections of n characters.
- Allow upload of multiple audio files