updated readme
Browse files
README.md
CHANGED
|
@@ -30,38 +30,7 @@ A Gradio-based web application for comparing multiple speech-to-text models side
|
|
| 30 |
|
| 31 |
## 🚀 Quick Start
|
| 32 |
|
| 33 |
-
### Option 1: Run
|
| 34 |
-
|
| 35 |
-
1. **Clone the repository**
|
| 36 |
-
```bash
|
| 37 |
-
git clone <your-repo-url>
|
| 38 |
-
cd stt_battle_arena
|
| 39 |
-
```
|
| 40 |
-
|
| 41 |
-
2. **Create a virtual environment** (recommended)
|
| 42 |
-
```bash
|
| 43 |
-
python -m venv venv
|
| 44 |
-
|
| 45 |
-
# Windows
|
| 46 |
-
venv\Scripts\activate
|
| 47 |
-
|
| 48 |
-
# Linux/macOS
|
| 49 |
-
source venv/bin/activate
|
| 50 |
-
```
|
| 51 |
-
|
| 52 |
-
3. **Install dependencies**
|
| 53 |
-
```bash
|
| 54 |
-
pip install -r requirements.txt
|
| 55 |
-
```
|
| 56 |
-
|
| 57 |
-
4. **Run the application**
|
| 58 |
-
```bash
|
| 59 |
-
python app.py
|
| 60 |
-
```
|
| 61 |
-
|
| 62 |
-
5. **Open your browser** and navigate to `http://localhost:7860`
|
| 63 |
-
|
| 64 |
-
### Option 2: Run with Docker (GPU - Linux/Windows with NVIDIA)
|
| 65 |
|
| 66 |
For machines with NVIDIA GPUs:
|
| 67 |
|
|
@@ -72,7 +41,7 @@ For machines with NVIDIA GPUs:
|
|
| 72 |
|
| 73 |
2. **Open your browser** and navigate to `http://localhost:7860`
|
| 74 |
|
| 75 |
-
### Option
|
| 76 |
|
| 77 |
For Mac users or machines without NVIDIA GPUs:
|
| 78 |
|
|
@@ -94,6 +63,39 @@ For Mac users or machines without NVIDIA GPUs:
|
|
| 94 |
|
| 95 |
> ⚠️ **Note**: CPU inference is significantly slower than GPU. Expect 10-30+ seconds per model depending on audio length.
|
| 96 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 97 |
## 🐳 Docker Configuration
|
| 98 |
|
| 99 |
### GPU Support (NVIDIA - Linux/Windows only)
|
|
|
|
| 30 |
|
| 31 |
## 🚀 Quick Start
|
| 32 |
|
| 33 |
+
### Option 1: Run with Docker (GPU - Linux/Windows with NVIDIA)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
For machines with NVIDIA GPUs:
|
| 36 |
|
|
|
|
| 41 |
|
| 42 |
2. **Open your browser** and navigate to `http://localhost:7860`
|
| 43 |
|
| 44 |
+
### Option 2: Run with Docker (CPU - Mac/Linux/Windows)
|
| 45 |
|
| 46 |
For Mac users or machines without NVIDIA GPUs:
|
| 47 |
|
|
|
|
| 63 |
|
| 64 |
> ⚠️ **Note**: CPU inference is significantly slower than GPU. Expect 10-30+ seconds per model depending on audio length.
|
| 65 |
|
| 66 |
+
|
| 67 |
+
### Option 3: Run Locally
|
| 68 |
+
|
| 69 |
+
1. **Clone the repository**
|
| 70 |
+
```bash
|
| 71 |
+
git clone <your-repo-url>
|
| 72 |
+
cd stt_battle_arena
|
| 73 |
+
```
|
| 74 |
+
|
| 75 |
+
2. **Create a virtual environment** (recommended)
|
| 76 |
+
```bash
|
| 77 |
+
python -m venv venv
|
| 78 |
+
|
| 79 |
+
# Windows
|
| 80 |
+
venv\Scripts\activate
|
| 81 |
+
|
| 82 |
+
# Linux/macOS
|
| 83 |
+
source venv/bin/activate
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
3. **Install dependencies**
|
| 87 |
+
```bash
|
| 88 |
+
pip install -r requirements.txt
|
| 89 |
+
```
|
| 90 |
+
|
| 91 |
+
4. **Run the application**
|
| 92 |
+
```bash
|
| 93 |
+
python app.py
|
| 94 |
+
```
|
| 95 |
+
|
| 96 |
+
5. **Open your browser** and navigate to `http://localhost:7860`
|
| 97 |
+
|
| 98 |
+
|
| 99 |
## 🐳 Docker Configuration
|
| 100 |
|
| 101 |
### GPU Support (NVIDIA - Linux/Windows only)
|