diff --git a/README.md b/README.md index 47c6c41..f502479 100644 --- a/README.md +++ b/README.md @@ -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` - -If wishing to modify this package, clone and install in editable mode: +```bash +pip install whisperx ``` -$ git clone https://github.com/m-bain/whisperX.git -$ cd whisperX -$ pip install -e . + +#### Option B: Development Version +Install the latest development version directly from GitHub (may be unstable): + +```bash +pip install git+https://github.com/m-bain/whisperx.git ``` +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