Skip to content

Commit

Permalink
docs: update installation instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Barabazs committed Jan 2, 2025
1 parent c18f9f9 commit ad659c2
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,21 +80,40 @@ GPU execution requires the NVIDIA libraries cuBLAS 11.x and cuDNN 8.x to be inst

See other methods [here.](https://pytorch.org/get-started/previous-versions/#v200)

### 3. Install this repo
### 3. Install WhisperX

`pip install git+https://github.com/m-bain/whisperx.git`
You have several installation options:

If already installed, update package to most recent commit
#### Option A: Stable Release (recommended)
Install the latest stable version from PyPI:

`pip install git+https://github.com/m-bain/whisperx.git --upgrade`
```bash
pip install whisperx
```

#### Option B: Development Version
Install the latest development version directly from GitHub (may be unstable):

If wishing to modify this package, clone and install in editable mode:
```bash
pip install git+https://github.com/m-bain/whisperx.git
```
$ git clone https://github.com/m-bain/whisperX.git
$ cd whisperX
$ pip install -e .

If already installed, update to the most recent commit:

```bash
pip install git+https://github.com/m-bain/whisperx.git --upgrade
```

#### Option C: Development Mode
If you wish to modify the package, clone and install in editable mode:
```bash
git clone https://github.com/m-bain/whisperX.git
cd whisperX
pip install -e .
```

> **Note**: The development version may contain experimental features and bugs. Use the stable PyPI release for production environments.
You may also need to install ffmpeg, rust etc. Follow openAI instructions here https://github.com/openai/whisper#setup.

### Speaker Diarization
Expand Down

0 comments on commit ad659c2

Please sign in to comment.