0. CUDA Installation

To use WhisperX with GPU acceleration, install the CUDA toolkit 12.8 before WhisperX. Skip this step if using only the CPU.

- For Linux users, install the CUDA toolkit 12.8 following this guide: CUDA Installation Guide for Linux. - For Windows users, download and install the CUDA toolkit 12.8: CUDA Downloads.

1. Simple Installation (Recommended)

The easiest way to install WhisperX is through PyPi:

pip install whisperx

Or if using uvx:

uvx whisperx

2. Advanced Installation Options

These installation methods are for developers or users with specific needs. If you're not sure, stick with the simple installation above.

Option A: Install from GitHub

To install directly from the GitHub repository:

uvx git+https://github.com/m-bain/whisperX.git

Option B: Developer Installation

If you want to modify the code or contribute to the project:

git clone https://github.com/m-bain/whisperX.git
cd whisperX
uv sync --all-extras --dev

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.

Python usage 🐍

```python import whisperx import gc from whisperx.diarize import DiarizationPipeline

device = "cuda" audio_file = "audio.mp3" batch_size = 16 # reduce if low on GPU mem compute_type = "float16" # change to "int8" if low on GPU mem (may reduce accuracy)

Demos 🚀

If you don't have access to your own GPUs, use the links above to try out WhisperX.

Technical Details 👷‍♂️

For specific details on the batching and alignment, the effect of VAD, as well as the chosen alignment model, see the preprint paper.

To reduce GPU memory requirements, try any of the following (2. & 3. can affect quality):

1. reduce batch size, e.g. --batch_size 4
2. use a smaller ASR model --model base
3. Use lighter compute type --compute_type int8

Transcription differences from openai's whisper:

1. Transcription without timestamps. To enable single pass batching, whisper inference is performed --without_timestamps True, this ensures 1 forward pass per sample in the batch. However, this can cause discrepancies the default whisper output.
2. VAD-based segment transcription, unlike the buffered transcription of openai's. In the WhisperX paper we show this reduces WER, and enables accurate batched inference
3. --condition_on_prev_text is set to False by default (reduces hallucination)

Limitations ⚠️

• Transcript words which do not contain characters in the alignment models dictionary e.g. "2014." or "£13.60" cannot be aligned and therefore are not given a timing.
• Overlapping speech is not handled particularly well by whisper nor whisperx
• Diarization is far from perfect
• Language specific wav2vec2 model is needed

Contribute 🧑‍🏫

If you are multilingual, a major way you can contribute to this project is to find phoneme models on huggingface (or train your own) and test them on speech for the target language. If the results look good send a pull request and some examples showing its success.

Bug finding and pull requests are also highly appreciated to keep this project going, since it's already diverging from the original research scope.

TODO 🗓

• [x] Multilingual init

• [x] Automatic align model selection based on language detection

• [x] Python usage

• [x] Incorporating speaker diarization

• [x] Model flush, for low gpu mem resources

• [x] Faster-whisper backend

• [x] Add max-line etc. see (openai's whisper utils.py)

• [x] Sentence-level segments (nltk toolbox)

• [x] Improve alignment logic

• [ ] update examples with diarization and word highlighting

• [ ] Subtitle .ass output <- bring this back (removed in v3)

• [ ] Add benchmarking code (TEDLIUM for spd/WER & word segmentation)

• [x] Allow silero-vad as alternative VAD option

• [ ] Improve diarization (word level). Harder than first thought...

Contact/Support 📇

Contact maxhbain@gmail.com for queries.

<a href="https://www.buymeacoffee.com/maxhbain" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>

Acknowledgements 🙏

This work, and my PhD, is supported by the VGG (Visual Geometry Group) and the University of Oxford.

Of course, this is builds on openAI's whisper. Borrows important alignment code from PyTorch tutorial on forced alignment And uses the wonderful pyannote VAD / Diarization https://github.com/pyannote/pyannote-audio

Valuable VAD & Diarization Models from:

• pyannote-audio — Speaker diarization powered by the speaker-diarization-community-1 model, licensed under CC-BY-4.0 by pyannoteAI
• silero-vad

Great backend from faster-whisper and CTranslate2

Those who have supported this work financially 🙏

Finally, thanks to the OS contributors of this project, keeping it going and identifying bugs.

Citation

@article{bain2022whisperx,
  title={WhisperX: Time-Accurate Speech Transcription of Long-Form Audio},
  author={Bain, Max and Huh, Jaesung and Han, Tengda and Zisserman, Andrew},
  journal={INTERSPEECH 2023},
  year={2023}
}

save model to local path (optional)

Recall.ai - Meeting Transcription API

If you’re looking for a transcription API for meetings, consider checking out Recall.ai's Meeting Transcription API, an API that works with Zoom, Google Meet, Microsoft Teams, and more. Recall.ai diarizes by pulling the speaker data and separate audio streams from the meeting platforms, which means 100% accurate speaker diarization with actual speaker names.

<p align="center"> <a href="https://github.com/m-bain/whisperX/stargazers"> <img src="https://img.shields.io/github/stars/m-bain/whisperX.svg?colorA=orange&colorB=orange&logo=github" alt="GitHub stars"> </a> <a href="https://github.com/m-bain/whisperX/issues"> <img src="https://img.shields.io/github/issues/m-bain/whisperx.svg" alt="GitHub issues"> </a> <a href="https://github.com/m-bain/whisperX/blob/master/LICENSE"> <img src="https://img.shields.io/github/license/m-bain/whisperX.svg" alt="GitHub license"> </a> <a href="https://arxiv.org/abs/2303.00747"> <img src="http://img.shields.io/badge/Arxiv-2303.00747-B31B1B.svg" alt="ArXiv paper"> </a> <a href="https://twitter.com/intent/tweet?text=&url=https%3A%2F%2Fgithub.com%2Fm-bain%2FwhisperX"> <img src="https://img.shields.io/twitter/url/https/github.com/m-bain/whisperX.svg?style=social" alt="Twitter"> </a> </p>

<img width="1216" align="center" alt="whisperx-arch" src="https://raw.githubusercontent.com/m-bain/whisperX/refs/heads/main/figures/pipeline.png">

This repository provides fast automatic speech recognition (70x realtime with large-v2) with word-level timestamps and speaker diarization.

• ⚡️ Batched inference for 70x realtime transcription using whisper large-v2
• 🪶 faster-whisper backend, requires <8GB gpu memory for large-v2 with beam_size=5
• 🎯 Accurate word-level timestamps using wav2vec2 alignment
• 👯‍♂️ Multispeaker ASR using speaker diarization from pyannote-audio (speaker ID labels)
• 🗣️ VAD preprocessing, reduces hallucination & batching with no WER degradation

Whisper is an ASR model developed by OpenAI, trained on a large dataset of diverse audio. Whilst it does produces highly accurate transcriptions, the corresponding timestamps are at the utterance-level, not per word, and can be inaccurate by several seconds. OpenAI's whisper does not natively support batching.

Phoneme-Based ASR A suite of models finetuned to recognise the smallest unit of speech distinguishing one word from another, e.g. the element p in "tap". A popular example model is wav2vec2.0.

Forced Alignment refers to the process by which orthographic transcriptions are aligned to audio recordings to automatically generate phone level segmentation.

Voice Activity Detection (VAD) is the detection of the presence or absence of human speech.

Speaker Diarization is the process of partitioning an audio stream containing human speech into homogeneous segments according to the identity of each speaker.

New🚨

• 1st place at Ego4d transcription challenge 🏆
• WhisperX accepted at INTERSPEECH 2023
• v3 transcript segment-per-sentence: using nltk sent_tokenize for better subtitlting & better diarization
• v3 released, 70x speed-up open-sourced. Using batched whisper with faster-whisper backend!
• v2 released, code cleanup, imports whisper library VAD filtering is now turned on by default, as in the paper.
• Paper drop🎓👨‍🏫! Please see our ArxiV preprint for benchmarking and details of WhisperX. We also introduce more efficient batch inference resulting in large-v2 with \*60-70x REAL TIME speed.

Setup ⚙️