Whisper command line client that uses CTranslate2
Project description
Introduction
Whisper command line client compatible with original OpenAI client based on CTranslate2.
It uses CTranslate2 and Faster-whisper Whisper implementation that is up to 4 times faster than openai/whisper for the same accuracy while using less memory.
Goals of the project:
- Provide an easy way to use the CTranslate2 Whisper implementation
- Ease the migration for people using OpenAI Whisper CLI
Installation
To install the latest stable version, just type:
pip install -U whisper-ctranslate2
Alternatively, if you are interested in the latest development (non-stable) version from this repository, just type:
pip install git+https://github.com/jordimas/whisper-ctranslate2.git
CPU and GPU support
GPU and CPU support are provided by CTranslate2.
It has compatibility with x86-64 and AArch64/ARM64 CPU and integrates multiple backends that are optimized for these platforms: Intel MKL, oneDNN, OpenBLAS, Ruy, and Apple Accelerate.
GPU execution requires the NVIDIA libraries cuBLAS 11.x and cuDNN 8.x to be installed on the system. Please refer to the CTranslate2 documentation
By default the best hardware available is selected for inference. You can use the options --device
and --device_index
to control manually the selection.
Usage
Same command line as OpenAI Whisper.
To transcribe:
whisper-ctranslate2 inaguracio2011.mp3 --model medium
To translate:
whisper-ctranslate2 inaguracio2011.mp3 --model medium --task translate
Whisper translate task translates the transcription from the source language to English (the only target language supported).
Additionally using:
whisper-ctranslate2 --help
All the supported options with their help are shown.
CTranslate2 specific options
On top of the OpenAI Whisper command line options, there are some specific options provided by CTranslate2 or whiper-ctranslate2.
Quantization
--compute_type
option which accepts default,auto,int8,int8_float16,int16,float16,float32 values indicates the type of quantization to use. On CPU int8 will give the best performance:
whisper-ctranslate2 myfile.mp3 --compute_type int8
Loading the model from a directory
--model_directory
option allows to specify the directory from which you want to load a CTranslate2 Whisper model. For example, if you want to load your own quantified Whisper model version or using your own Whisper fine-tunned version. The model must be in CTranslate2 format.
Using Voice Activity Detection (VAD) filter
--vad_filter
option enables the voice activity detection (VAD) to filter out parts of the audio without speech. This step uses the Silero VAD model:
whisper-ctranslate2 myfile.mp3 --vad_filter True
The VAD filter accepts multiple additional options to determine the filter behavior:
--vad_threshold VALUE (float)
Probabilities above this value are considered as speech.
--vad_min_speech_duration_ms (int)
Final speech chunks shorter min_speech_duration_ms are thrown out.
--vad_max_speech_duration_s VALUE (int)
Maximum duration of speech chunks in seconds. Longer will be split at the timestamp of the last silence.
Print colors
--print_colors True
options prints the transcribed text using an experimental color coding strategy based on whisper.cpp to highlight words with high or low confidence:
whisper-ctranslate2 myfile.mp3 --print_colors True
Live transcribe from your microphone
--live_transcribe True
option activates the live transcription mode from your microphone:
whisper-ctranslate2 --live_transcribe True --language en
https://user-images.githubusercontent.com/309265/231533784-e58c4b92-e9fb-4256-b4cd-12f1864131d9.mov
Need help?
Check our frequently asked questions for common questions.
Contact
Jordi Mas jmas@softcatala.org
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 whisper-ctranslate2-0.3.2.tar.gz
.
File metadata
- Download URL: whisper-ctranslate2-0.3.2.tar.gz
- Upload date:
- Size: 18.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6eb6b755a5693ebebf367e69cd23231f6024a43425789685768d78561f3ec7a |
|
MD5 | 2a0c4a9188461b63a115851a3e7f0e14 |
|
BLAKE2b-256 | 16ab23cc47842ecfaceb30d715a9a6b509890f7b3212ffcd3b34e4a36c047566 |
File details
Details for the file whisper_ctranslate2-0.3.2-py3-none-any.whl
.
File metadata
- Download URL: whisper_ctranslate2-0.3.2-py3-none-any.whl
- Upload date:
- Size: 17.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f3cdd072107f3e6c59a536b1320a20512d0b72a573b76335242aa292f6535d7 |
|
MD5 | fb9753d5f54f93d8ae17b3e15653b2a9 |
|
BLAKE2b-256 | 440707658675bcf260f2835eb0093cdfea9d5cf3e3835b9e468b3a316e1ce129 |