An insanely fast whisper CLI
Project description
Insanely Fast Whisper
Powered by 🤗 Transformers, Optimum & flash-attn
TL;DR - Transcribe 150 minutes (2.5 hours) of audio in less than 98 seconds - with OpenAI's Whisper Large v3. Blazingly fast transcription is now a reality!⚡️
Not convinced? Here are some benchmarks we ran on a Nvidia A100 - 80GB 👇
Optimisation type | Time to Transcribe (150 mins of Audio) |
---|---|
Transformers (fp32 ) |
~31 (31 min 1 sec) |
Transformers (fp16 + batching [24] + bettertransformer ) |
~5 (5 min 2 sec) |
Transformers (fp16 + batching [24] + Flash Attention 2 ) |
~2 (1 min 38 sec) |
distil-whisper (fp16 + batching [24] + bettertransformer ) |
~3 (3 min 16 sec) |
distil-whisper (fp16 + batching [24] + Flash Attention 2 ) |
~1 (1 min 18 sec) |
Faster Whisper (fp16 + beam_size [1] ) |
~9.23 (9 min 23 sec) |
Faster Whisper (8-bit + beam_size [1] ) |
~8 (8 min 15 sec) |
P.S. We also ran the benchmarks on a Google Colab T4 GPU instance too!
🆕 Blazingly fast transcriptions via your terminal! ⚡️
We've added a CLI to enable fast transcriptions. Here's how you can use it:
Install insanely-fast-whisper
with pipx
:
pipx install insanely-fast-whisper
Run inference from any path on your computer:
insanely-fast-whisper --file-name <filename or URL>
🔥 You can run Whisper-large-v3 w/ Flash Attention 2 from this CLI too:
insanely-fast-whisper --file-name <filename or URL> --flash True
🌟 You can run distil-whisper directly from this CLI too:
insanely-fast-whisper --model-name distil-whisper/large-v2 --file-name <filename or URL>
Don't want to install insanely-fast-whisper
? Just use pipx run
:
pipx run insanely-fast-whisper --file-name <filename or URL>
Note: The CLI is opinionated and currently only works for Nvidia GPUs. Make sure to check out the defaults and the list of options you can play around with to maximise your transcription throughput. Run insanely-fast-whisper --help
or pipx run insanely-fast-whisper --help
to get all the CLI arguments and defaults.
CLI Options
The insanely-fast-whisper
repo provides an all round support for running Whisper in various settings. Note that as of today 20th Nov, insanely-fast-whisper
only works on CUDA enabled devices.
-h, --help show this help message and exit
--file-name FILE_NAME
Path or URL to the audio file to be transcribed.
--device-id DEVICE_ID
Device ID for your GPU (just pass the device ID number). (default: "0")
--transcript-path TRANSCRIPT_PATH
Path to save the transcription output. (default: output.json)
--model-name MODEL_NAME
Name of the pretrained model/ checkpoint to perform ASR. (default: openai/whisper-large-v3)
--task {transcribe,translate}
Task to perform: transcribe or translate to another language. (default: transcribe)
--language LANGUAGE
Language of the input audio. (default: "None" (Whisper auto-detects the language))
--batch-size BATCH_SIZE
Number of parallel batches you want to compute. Reduce if you face OOMs. (default: 24)
--flash FLASH
Use Flash Attention 2. Read the FAQs to see how to install FA2 correctly. (default: False)
--timestamp {chunk,word}
Whisper supports both chunked as well as word level timestamps. (default: chunk)
Frequently Asked Questions
How to correctly install flash-attn to make it work with insanely-fast-whisper
?
Make sure to install it via pipx runpip insanely-fast-whisper install flash-attn --no-build-isolation
. Massive kudos to @li-yifei for helping with this.
How to solve an AssertionError: Torch not compiled with CUDA enabled
error on Windows?
The root cause of this problem is still unkown, however, you can resolve this by manually installing torch in the virtualenv like python -m pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu121
. Thanks to @pto2k for all tdebugging this.
How to use Whisper without a CLI?
For older GPUs, all you need to run is:
import torch
from transformers import pipeline
pipe = pipeline("automatic-speech-recognition",
"openai/whisper-large-v3",
torch_dtype=torch.float16,
device="cuda:0")
pipe.model = pipe.model.to_bettertransformer()
outputs = pipe("<FILE_NAME>",
chunk_length_s=30,
batch_size=24,
return_timestamps=True)
outputs["text"]
For newer (A10, A100, H100s), use [Flash Attention](https://github.com/Dao-AILab/flash-attention):
import torch
from transformers import pipeline
pipe = pipeline("automatic-speech-recognition",
"openai/whisper-large-v3",
torch_dtype=torch.float16,
model_kwargs={"use_flash_attention_2": True},
device="cuda:0")
outputs = pipe("<FILE_NAME>",
chunk_length_s=30,
batch_size=24,
return_timestamps=True)
outputs["text"]
Acknowledgements
- OpenAI Whisper team for open sourcing such a brilliant check point.
- Hugging Face Transformers team, specifically Arthur, Patrick, Sanchit & Yoach (alphabetical order) for continuing to maintain Whisper in Transformers.
- Hugging Face Optimum team for making the BetterTransformer API so easily accessible.
- Patrick Arminio for helping me tremendously to put together this CLI.
Community showcase
@ochen1 created a brilliant MVP for a CLI here: https://github.com/ochen1/insanely-fast-whisper-cli (Try it out now!)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file insanely_fast_whisper-0.0.8.tar.gz
.
File metadata
- Download URL: insanely_fast_whisper-0.0.8.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.10.3 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5050786a75371c49c55c88d903d37cd9484e31a8206c7a7465c4717adbc421a |
|
MD5 | da2c766605d77411fa22a4a2c6d16904 |
|
BLAKE2b-256 | ac80ddd26bef0ca1585b3b4d4bef6bd82dcc5b66b1e0b2b6197abf830a8d86e9 |
File details
Details for the file insanely_fast_whisper-0.0.8-py3-none-any.whl
.
File metadata
- Download URL: insanely_fast_whisper-0.0.8-py3-none-any.whl
- Upload date:
- Size: 9.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.10.3 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c36643e8a8787a89aa2e3f9dd2970140c52a4c179781a17affeabc62e460955 |
|
MD5 | dc8cbf28b2441361c6d52d21bdb513f1 |
|
BLAKE2b-256 | bfff2cc385a948333c70efeb8021ce043c9770a995ab526bc4433bd8e1e7baaf |