JabriA commited on
Commit
6d88267
·
1 Parent(s): ff9c2e5

Add README for Hugging Face Space configuration

Browse files
Files changed (1) hide show
  1. README.md +28 -6
README.md CHANGED
@@ -1,11 +1,33 @@
1
- # Audio Transcription and Topic Extraction
2
 
3
- This app allows you to upload an audio file, transcribe it to text, and extract the main topics using machine learning models.
 
 
 
 
 
 
 
4
 
5
  ## Features
6
- - Transcription powered by OpenAI's Whisper.
7
- - Topic extraction using Hugging Face Transformers.
 
 
 
 
 
 
 
 
 
 
 
8
 
9
  ## Usage
10
- - Upload an audio file.
11
- - View the transcription and extracted topics.
 
 
 
 
 
1
+ # MyIVR: Audio Transcription and Summarization
2
 
3
+ This Space provides a simple web-based interface to upload audio files, transcribe them into text, and generate a summarized version of the transcription.
4
+
5
+ ## How It Works
6
+ 1. Upload an audio file in formats like `.wav` or `.mp3`.
7
+ 2. The app uses:
8
+ - [Whisper](https://github.com/openai/whisper) for audio transcription.
9
+ - [Hugging Face Transformers](https://huggingface.co/docs/transformers/index) for text summarization.
10
+ 3. Get the transcription and summary displayed on the interface.
11
 
12
  ## Features
13
+ - **Audio Transcription**: Convert speech to text.
14
+ - **Text Summarization**: Generate concise summaries of the transcription.
15
+
16
+ ## Models Used
17
+ - **Whisper** (OpenAI): Handles the audio-to-text conversion.
18
+ - **T5-Small** (Hugging Face): Summarizes the transcription.
19
+
20
+ ## Requirements
21
+ Dependencies are listed in the `requirements.txt` file. The app uses:
22
+ - `gradio`
23
+ - `openai-whisper`
24
+ - `transformers`
25
+ - `torch`
26
 
27
  ## Usage
28
+ Visit the deployed app at the following link:
29
+ [MyIVR on Hugging Face Spaces](https://huggingface.co/spaces/JabriA/MyIVR)
30
+
31
+ Upload an audio file, and the app will process it to provide a transcription and summary.
32
+
33
+ ---