rgcodeai commited on
Commit
37373ee
·
verified ·
1 Parent(s): 0e3e64c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +53 -41
README.md CHANGED
@@ -1,42 +1,54 @@
1
- # **WhisperX Local Installation Kit**
2
-
3
- ## **Description**
4
-
5
- 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.
6
-
7
- ## **Requirements**
8
-
9
- - Miniconda
10
- - CUDA (only for NVIDIA GPU users)
11
-
12
- ## **File Description**
13
-
14
- - **`environment-cuda.yml`**: Configuration file for automatic installation on systems with NVIDIA GPU.
15
- - **`environment-cpu.yml`**: Configuration file for automatic installation on systems without NVIDIA GPU.
16
- - **`app.py`**: Script to run the WhisperX user interface on Gradio.
17
- - **`transcription_utils.py`**: Transcription logic.
18
-
19
- ## **Installation**
20
-
21
- 1. **Miniconda**: [Miniconda Installation](https://docs.anaconda.com/free/miniconda/)
22
- 2. **CUDA**: [CUDA Installation](https://developer.nvidia.com/cuda-toolkit-archive) (Only for NVIDIA GPU users)
23
- 3. **GitHub Repository**: Download and setup of the repository. See details on our website.
24
-
25
- 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)
26
-
27
- ## **Usage**
28
-
29
- To use WhisperX after completing the installation:
30
-
31
- 1. Activate the corresponding Conda environment.
32
- 2. Run **`python app.py`** to start the Gradio user interface.
33
-
34
- ## **Authors**
35
-
36
- - [MISTER CONTENTS](https://mistercontenidos.com/)
37
- - [Ricardo Gonzalez](https://www.linkedin.com/in/pedrocuervomkt/)
38
-
39
- ## **Languages**
40
-
41
- - [Spanish](docs/README_ES.md)
 
 
 
 
 
 
 
 
 
 
 
 
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)