Spaces:
No application file
No application file
Update README.md
Browse files
README.md
CHANGED
|
@@ -12,7 +12,12 @@ Transform lecture audio into structured, comprehensive notes using AI.
|
|
| 12 |
|
| 13 |
## Demo
|
| 14 |
|
| 15 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
## How It Works
|
| 18 |
|
|
@@ -24,27 +29,30 @@ Transform lecture audio into structured, comprehensive notes using AI.
|
|
| 24 |
|
| 25 |
```bash
|
| 26 |
# Clone the repository
|
| 27 |
-
git clone https://github.com/
|
| 28 |
-
cd
|
| 29 |
|
| 30 |
# Install dependencies
|
| 31 |
-
pip install
|
| 32 |
```
|
| 33 |
|
| 34 |
## Usage
|
| 35 |
|
| 36 |
-
### Option 1: Run the
|
| 37 |
|
| 38 |
-
```
|
| 39 |
-
|
| 40 |
```
|
| 41 |
|
| 42 |
-
|
|
|
|
|
|
|
| 43 |
|
| 44 |
-
|
| 45 |
|
| 46 |
```python
|
| 47 |
-
|
|
|
|
| 48 |
|
| 49 |
# Generate notes from an audio file
|
| 50 |
notes = process_audio("path_to_lecture_audio.mp3")
|
|
@@ -92,7 +100,7 @@ The generated notes follow this structure:
|
|
| 92 |
|
| 93 |
## License
|
| 94 |
|
| 95 |
-
MIT
|
| 96 |
|
| 97 |
## Acknowledgements
|
| 98 |
|
|
|
|
| 12 |
|
| 13 |
## Demo
|
| 14 |
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
<video controls autoplay src="https://cdn-uploads.huggingface.co/production/uploads/64ed91f11d42449431ee2253/0J7jWig2JLimC8n2NF0KO.mp4"></video>
|
| 18 |
+
|
| 19 |
+
|
| 20 |
+
|
| 21 |
|
| 22 |
## How It Works
|
| 23 |
|
|
|
|
| 29 |
|
| 30 |
```bash
|
| 31 |
# Clone the repository
|
| 32 |
+
git clone https://github.com/Abdulllah-Rizwan/AI_Lecture-s-Note-Generator.git
|
| 33 |
+
cd AI-Lecture-Notes-Generator
|
| 34 |
|
| 35 |
# Install dependencies
|
| 36 |
+
pip install requests torch bitsandbytes transformers sentencepiece accelerate gradio httpx==0.27.2
|
| 37 |
```
|
| 38 |
|
| 39 |
## Usage
|
| 40 |
|
| 41 |
+
### Option 1: Run the Jupyter Notebook
|
| 42 |
|
| 43 |
+
```bash
|
| 44 |
+
jupyter notebook "AI Lecture Notes Generator.ipynb"
|
| 45 |
```
|
| 46 |
|
| 47 |
+
Run all cells in the notebook to start the Gradio interface, then interact with the application through the displayed URL (typically http://127.0.0.1:7860/).
|
| 48 |
+
|
| 49 |
+
### Option 2: Use the functions directly in your code
|
| 50 |
|
| 51 |
+
You can import the functions from the notebook into your own Python code:
|
| 52 |
|
| 53 |
```python
|
| 54 |
+
# Import the necessary functions
|
| 55 |
+
from AI_Lecture_Notes_Generator import process_audio
|
| 56 |
|
| 57 |
# Generate notes from an audio file
|
| 58 |
notes = process_audio("path_to_lecture_audio.mp3")
|
|
|
|
| 100 |
|
| 101 |
## License
|
| 102 |
|
| 103 |
+
MIT License.
|
| 104 |
|
| 105 |
## Acknowledgements
|
| 106 |
|