Spaces:
Runtime error
Runtime error
Update README.md
Browse files
README.md
CHANGED
@@ -1,42 +1,54 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
|
13 |
-
|
14 |
-
|
15 |
-
|
16 |
-
|
17 |
-
-
|
18 |
-
|
19 |
-
## **
|
20 |
-
|
21 |
-
|
22 |
-
|
23 |
-
|
24 |
-
|
25 |
-
|
26 |
-
|
27 |
-
|
28 |
-
|
29 |
-
|
30 |
-
|
31 |
-
|
32 |
-
|
33 |
-
|
34 |
-
|
35 |
-
|
36 |
-
|
37 |
-
- [
|
38 |
-
|
39 |
-
## **
|
40 |
-
|
41 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
42 |
- [Portuguese](docs/README_PT.md)
|
|
|
1 |
+
---
|
2 |
+
title: WhisperX Local Installation Kit
|
3 |
+
emoji: 🗣️
|
4 |
+
colorFrom: purple
|
5 |
+
colorTo: red
|
6 |
+
sdk: gradio
|
7 |
+
sdk_version: "3.0"
|
8 |
+
app_file: app.py
|
9 |
+
pinned: false
|
10 |
+
---
|
11 |
+
|
12 |
+
|
13 |
+
# **WhisperX Local Installation Kit**
|
14 |
+
|
15 |
+
## **Description**
|
16 |
+
|
17 |
+
This project enables the local installation and use of WhisperX, an advanced audio transcription system based on OpenAI's Whisper but optimized for running on local hardware with or without a GPU. This project is made possible thanks to [Whisperx](https://github.com/m-bain/whisperX) and [Faster Whisper](https://github.com/SYSTRAN/faster-whisper). This document provides a general overview of the installation and links to the website where the [complete installation and usage](https://mistercontenidos.com/en/how-to-install-whisperx-locally) procedure for this project can be found.
|
18 |
+
|
19 |
+
## **Requirements**
|
20 |
+
|
21 |
+
- Miniconda
|
22 |
+
- CUDA (only for NVIDIA GPU users)
|
23 |
+
|
24 |
+
## **File Description**
|
25 |
+
|
26 |
+
- **`environment-cuda.yml`**: Configuration file for automatic installation on systems with NVIDIA GPU.
|
27 |
+
- **`environment-cpu.yml`**: Configuration file for automatic installation on systems without NVIDIA GPU.
|
28 |
+
- **`app.py`**: Script to run the WhisperX user interface on Gradio.
|
29 |
+
- **`transcription_utils.py`**: Transcription logic.
|
30 |
+
|
31 |
+
## **Installation**
|
32 |
+
|
33 |
+
1. **Miniconda**: [Miniconda Installation](https://docs.anaconda.com/free/miniconda/)
|
34 |
+
2. **CUDA**: [CUDA Installation](https://developer.nvidia.com/cuda-toolkit-archive) (Only for NVIDIA GPU users)
|
35 |
+
3. **GitHub Repository**: Download and setup of the repository. See details on our website.
|
36 |
+
|
37 |
+
For a detailed step-by-step installation process, please visit our website: [View complete installation process](https://mistercontenidos.com/en/how-to-install-whisperx-locally)
|
38 |
+
|
39 |
+
## **Usage**
|
40 |
+
|
41 |
+
To use WhisperX after completing the installation:
|
42 |
+
|
43 |
+
1. Activate the corresponding Conda environment.
|
44 |
+
2. Run **`python app.py`** to start the Gradio user interface.
|
45 |
+
|
46 |
+
## **Authors**
|
47 |
+
|
48 |
+
- [MISTER CONTENTS](https://mistercontenidos.com/)
|
49 |
+
- [Ricardo Gonzalez](https://www.linkedin.com/in/pedrocuervomkt/)
|
50 |
+
|
51 |
+
## **Languages**
|
52 |
+
|
53 |
+
- [Spanish](docs/README_ES.md)
|
54 |
- [Portuguese](docs/README_PT.md)
|