Update README.md
Browse files
README.md
CHANGED
|
@@ -1,569 +1,118 @@
|
|
| 1 |
-
---
|
| 2 |
-
language:
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
---
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
#
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
|
| 102 |
-
|
| 103 |
-
)
|
| 104 |
-
|
| 105 |
-
|
| 106 |
-
|
| 107 |
-
|
| 108 |
-
|
| 109 |
-
|
| 110 |
-
|
| 111 |
-
|
| 112 |
-
|
| 113 |
-
|
| 114 |
-
|
| 115 |
-
|
| 116 |
-
|
| 117 |
-
|
| 118 |
-
|
| 119 |
-
|
| 120 |
-
Distil-Whisper uses a chunked algorithm to transcribe long-form audio files (> 30-seconds). In practice, this chunked long-form algorithm
|
| 121 |
-
is 9x faster than the sequential algorithm proposed by OpenAI in the Whisper paper (see Table 7 of the [Distil-Whisper paper](https://arxiv.org/abs/2311.00430)).
|
| 122 |
-
|
| 123 |
-
To enable chunking, pass the `chunk_length_s` parameter to the `pipeline`. For Distil-Whisper, a chunk length of 15-seconds
|
| 124 |
-
is optimal. To activate batching, pass the argument `batch_size`:
|
| 125 |
-
|
| 126 |
-
```python
|
| 127 |
-
import torch
|
| 128 |
-
from transformers import AutoModelForSpeechSeq2Seq, AutoProcessor, pipeline
|
| 129 |
-
from datasets import load_dataset
|
| 130 |
-
|
| 131 |
-
|
| 132 |
-
device = "cuda:0" if torch.cuda.is_available() else "cpu"
|
| 133 |
-
torch_dtype = torch.float16 if torch.cuda.is_available() else torch.float32
|
| 134 |
-
|
| 135 |
-
model_id = "distil-whisper/distil-small.en"
|
| 136 |
-
|
| 137 |
-
model = AutoModelForSpeechSeq2Seq.from_pretrained(
|
| 138 |
-
model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True
|
| 139 |
-
)
|
| 140 |
-
model.to(device)
|
| 141 |
-
|
| 142 |
-
processor = AutoProcessor.from_pretrained(model_id)
|
| 143 |
-
|
| 144 |
-
pipe = pipeline(
|
| 145 |
-
"automatic-speech-recognition",
|
| 146 |
-
model=model,
|
| 147 |
-
tokenizer=processor.tokenizer,
|
| 148 |
-
feature_extractor=processor.feature_extractor,
|
| 149 |
-
max_new_tokens=128,
|
| 150 |
-
chunk_length_s=15,
|
| 151 |
-
batch_size=16,
|
| 152 |
-
torch_dtype=torch_dtype,
|
| 153 |
-
device=device,
|
| 154 |
-
)
|
| 155 |
-
|
| 156 |
-
dataset = load_dataset("distil-whisper/librispeech_long", "default", split="validation")
|
| 157 |
-
sample = dataset[0]["audio"]
|
| 158 |
-
|
| 159 |
-
result = pipe(sample)
|
| 160 |
-
print(result["text"])
|
| 161 |
-
```
|
| 162 |
-
|
| 163 |
-
<!---
|
| 164 |
-
**Tip:** The pipeline can also be used to transcribe an audio file from a remote URL, for example:
|
| 165 |
-
|
| 166 |
-
```python
|
| 167 |
-
result = pipe("https://huggingface.co/datasets/sanchit-gandhi/librispeech_long/resolve/main/audio.wav")
|
| 168 |
-
```
|
| 169 |
-
--->
|
| 170 |
-
|
| 171 |
-
### Speculative Decoding
|
| 172 |
-
|
| 173 |
-
Distil-Whisper can be used as an assistant model to Whisper for [speculative decoding](https://huggingface.co/blog/whisper-speculative-decoding).
|
| 174 |
-
Speculative decoding mathematically ensures the exact same outputs as Whisper are obtained while being 2 times faster.
|
| 175 |
-
This makes it the perfect drop-in replacement for existing Whisper pipelines, since the same outputs are guaranteed.
|
| 176 |
-
|
| 177 |
-
In the following code-snippet, we load the assistant Distil-Whisper model standalone to the main Whisper pipeline. We then
|
| 178 |
-
specify it as the "assistant model" for generation:
|
| 179 |
-
|
| 180 |
-
```python
|
| 181 |
-
from transformers import pipeline, AutoModelForSpeechSeq2Seq, AutoProcessor
|
| 182 |
-
import torch
|
| 183 |
-
from datasets import load_dataset
|
| 184 |
-
|
| 185 |
-
device = "cuda:0" if torch.cuda.is_available() else "cpu"
|
| 186 |
-
torch_dtype = torch.float16 if torch.cuda.is_available() else torch.float32
|
| 187 |
-
|
| 188 |
-
assistant_model_id = "distil-whisper/distil-small.en"
|
| 189 |
-
|
| 190 |
-
assistant_model = AutoModelForSpeechSeq2Seq.from_pretrained(
|
| 191 |
-
assistant_model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True
|
| 192 |
-
)
|
| 193 |
-
assistant_model.to(device)
|
| 194 |
-
|
| 195 |
-
model_id = "openai/whisper-medium.en"
|
| 196 |
-
|
| 197 |
-
model = AutoModelForSpeechSeq2Seq.from_pretrained(
|
| 198 |
-
model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True
|
| 199 |
-
)
|
| 200 |
-
model.to(device)
|
| 201 |
-
|
| 202 |
-
processor = AutoProcessor.from_pretrained(model_id)
|
| 203 |
-
|
| 204 |
-
pipe = pipeline(
|
| 205 |
-
"automatic-speech-recognition",
|
| 206 |
-
model=model,
|
| 207 |
-
tokenizer=processor.tokenizer,
|
| 208 |
-
feature_extractor=processor.feature_extractor,
|
| 209 |
-
max_new_tokens=128,
|
| 210 |
-
generate_kwargs={"assistant_model": assistant_model},
|
| 211 |
-
torch_dtype=torch_dtype,
|
| 212 |
-
device=device,
|
| 213 |
-
)
|
| 214 |
-
|
| 215 |
-
dataset = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
|
| 216 |
-
sample = dataset[0]["audio"]
|
| 217 |
-
|
| 218 |
-
result = pipe(sample)
|
| 219 |
-
print(result["text"])
|
| 220 |
-
```
|
| 221 |
-
|
| 222 |
-
## Additional Speed & Memory Improvements
|
| 223 |
-
|
| 224 |
-
You can apply additional speed and memory improvements to Distil-Whisper which we cover in the following.
|
| 225 |
-
|
| 226 |
-
### Flash Attention
|
| 227 |
-
|
| 228 |
-
We recommend using [Flash-Attention 2](https://huggingface.co/docs/transformers/main/en/perf_infer_gpu_one#flashattention-2) if your GPU allows for it.
|
| 229 |
-
To do so, you first need to install [Flash Attention](https://github.com/Dao-AILab/flash-attention):
|
| 230 |
-
|
| 231 |
-
```
|
| 232 |
-
pip install flash-attn --no-build-isolation
|
| 233 |
-
```
|
| 234 |
-
|
| 235 |
-
and then all you have to do is to pass `use_flash_attention_2=True` to `from_pretrained`:
|
| 236 |
-
|
| 237 |
-
```diff
|
| 238 |
-
- model = AutoModelForSpeechSeq2Seq.from_pretrained(model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True)
|
| 239 |
-
+ model = AutoModelForSpeechSeq2Seq.from_pretrained(model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True, use_flash_attention_2=True)
|
| 240 |
-
```
|
| 241 |
-
|
| 242 |
-
### Torch Scale-Product-Attention (SDPA)
|
| 243 |
-
|
| 244 |
-
If your GPU does not support Flash Attention, we recommend making use of [BetterTransformers](https://huggingface.co/docs/transformers/main/en/perf_infer_gpu_one#bettertransformer).
|
| 245 |
-
To do so, you first need to install optimum:
|
| 246 |
-
|
| 247 |
-
```
|
| 248 |
-
pip install --upgrade optimum
|
| 249 |
-
```
|
| 250 |
-
|
| 251 |
-
And then convert your model to a "BetterTransformer" model before using it:
|
| 252 |
-
|
| 253 |
-
```diff
|
| 254 |
-
model = AutoModelForSpeechSeq2Seq.from_pretrained(model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True, use_safetensors=True)
|
| 255 |
-
+ model = model.to_bettertransformer()
|
| 256 |
-
```
|
| 257 |
-
|
| 258 |
-
### Running Distil-Whisper in `openai-whisper`
|
| 259 |
-
|
| 260 |
-
To use the model in the original Whisper format, first ensure you have the [`openai-whisper`](https://pypi.org/project/openai-whisper/) package installed:
|
| 261 |
-
|
| 262 |
-
```bash
|
| 263 |
-
pip install --upgrade openai-whisper
|
| 264 |
-
```
|
| 265 |
-
|
| 266 |
-
The following code-snippet demonstrates how to transcribe a sample file from the LibriSpeech dataset loaded using
|
| 267 |
-
🤗 Datasets:
|
| 268 |
-
|
| 269 |
-
```python
|
| 270 |
-
import torch
|
| 271 |
-
from datasets import load_dataset
|
| 272 |
-
from huggingface_hub import hf_hub_download
|
| 273 |
-
from whisper import load_model, transcribe
|
| 274 |
-
|
| 275 |
-
distil_small_en = hf_hub_download(repo_id="distil-whisper/distil-small.en", filename="original-model.bin")
|
| 276 |
-
model = load_model(distil_small_en)
|
| 277 |
-
|
| 278 |
-
dataset = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
|
| 279 |
-
sample = dataset[0]["audio"]["array"]
|
| 280 |
-
sample = torch.from_numpy(sample).float()
|
| 281 |
-
|
| 282 |
-
pred_out = transcribe(model, audio=sample)
|
| 283 |
-
print(pred_out["text"])
|
| 284 |
-
```
|
| 285 |
-
|
| 286 |
-
Note that the model weights will be downloaded and saved to your cache the first time you run the example. Subsequently,
|
| 287 |
-
you can re-use the same example, and the weights will be loaded directly from your cache without having to download them
|
| 288 |
-
again.
|
| 289 |
-
|
| 290 |
-
To transcribe a local audio file, simply pass the path to the audio file as the `audio` argument to transcribe:
|
| 291 |
-
|
| 292 |
-
```python
|
| 293 |
-
pred_out = transcribe(model, audio="audio.mp3")
|
| 294 |
-
```
|
| 295 |
-
|
| 296 |
-
### Whisper.cpp
|
| 297 |
-
|
| 298 |
-
Distil-Whisper can be run from the [Whisper.cpp](https://github.com/ggerganov/whisper.cpp) repository with the original
|
| 299 |
-
sequential long-form transcription algorithm. In a [provisional benchmark](https://github.com/ggerganov/whisper.cpp/pull/1424#issuecomment-1793513399)
|
| 300 |
-
on Mac M1, `distil-small.en` is over 4x faster than `large-v2`, while performing to within 1.4% WER over long-form audio.
|
| 301 |
-
|
| 302 |
-
Steps for getting started:
|
| 303 |
-
1. Clone the Whisper.cpp repository:
|
| 304 |
-
```
|
| 305 |
-
git clone https://github.com/ggerganov/whisper.cpp.git
|
| 306 |
-
cd whisper.cpp
|
| 307 |
-
```
|
| 308 |
-
2. Download the ggml weights for `distil-small.en` from the Hugging Face Hub:
|
| 309 |
-
|
| 310 |
-
```bash
|
| 311 |
-
python -c "from huggingface_hub import hf_hub_download; hf_hub_download(repo_id='distil-whisper/distil-small.en', filename='ggml-distil-small.en.bin', local_dir='./models')"
|
| 312 |
-
```
|
| 313 |
-
|
| 314 |
-
Note that if you do not have the `huggingface_hub` package installed, you can also download the weights with `wget`:
|
| 315 |
-
|
| 316 |
-
```bash
|
| 317 |
-
wget https://huggingface.co/distil-whisper/distil-small.en/resolve/main/ggml-distil-small.en.bin -P ./models
|
| 318 |
-
```
|
| 319 |
-
|
| 320 |
-
3. Run inference using the provided sample audio:
|
| 321 |
-
|
| 322 |
-
```bash
|
| 323 |
-
make -j && ./main -m models/ggml-distil-small.en.bin -f samples/jfk.wav
|
| 324 |
-
```
|
| 325 |
-
|
| 326 |
-
### Transformers.js
|
| 327 |
-
|
| 328 |
-
Distil-Whisper can even run completely in your web browser with [Transformers.js](http://github.com/xenova/transformers.js):
|
| 329 |
-
|
| 330 |
-
1. Install Transformers.js from [NPM](https://www.npmjs.com/package/@xenova/transformers):
|
| 331 |
-
```bash
|
| 332 |
-
npm i @xenova/transformers
|
| 333 |
-
```
|
| 334 |
-
|
| 335 |
-
2. Import the library and perform inference with the pipeline API.
|
| 336 |
-
```js
|
| 337 |
-
import { pipeline } from '@xenova/transformers';
|
| 338 |
-
|
| 339 |
-
const transcriber = await pipeline('automatic-speech-recognition', 'distil-whisper/distil-small.en');
|
| 340 |
-
|
| 341 |
-
const url = 'https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/main/jfk.wav';
|
| 342 |
-
const output = await transcriber(url);
|
| 343 |
-
// { text: " And so my fellow Americans, ask not what your country can do for you. Ask what you can do for your country." }
|
| 344 |
-
```
|
| 345 |
-
|
| 346 |
-
Check out the online [Distil-Whisper Web demo](https://huggingface.co/spaces/Xenova/distil-whisper-web) to try it out yourself. As you'll see, it runs locally in your browser: no server required!
|
| 347 |
-
|
| 348 |
-
See the [docs](https://huggingface.co/docs/transformers.js/api/pipelines#module_pipelines.AutomaticSpeechRecognitionPipeline) for more information.
|
| 349 |
-
|
| 350 |
-
### Candle
|
| 351 |
-
|
| 352 |
-
Coming soon!
|
| 353 |
-
|
| 354 |
-
<!---
|
| 355 |
-
|
| 356 |
-
Through an integration with Hugging Face [Candle](https://github.com/huggingface/candle/tree/main) 🕯️, Distil-Whisper is
|
| 357 |
-
now available in the Rust library 🦀
|
| 358 |
-
|
| 359 |
-
Benefit from:
|
| 360 |
-
* Optimised CPU backend with optional MKL support for x86 and Accelerate for Macs
|
| 361 |
-
* CUDA backend for efficiently running on GPUs, multiple GPU distribution via NCCL
|
| 362 |
-
* WASM support: run Distil-Whisper in a browser
|
| 363 |
-
|
| 364 |
-
Steps for getting started:
|
| 365 |
-
1. Install [`candle-core`](https://github.com/huggingface/candle/tree/main/candle-core) as explained [here](https://huggingface.github.io/candle/guide/installation.html)
|
| 366 |
-
2. Clone the `candle` repository locally:
|
| 367 |
-
```
|
| 368 |
-
git clone https://github.com/huggingface/candle.git
|
| 369 |
-
```
|
| 370 |
-
3. Enter the example directory for [Whisper](https://github.com/huggingface/candle/tree/main/candle-examples/examples/whisper):
|
| 371 |
-
```
|
| 372 |
-
cd candle/candle-examples/examples/whisper
|
| 373 |
-
```
|
| 374 |
-
4. Run an example:
|
| 375 |
-
```
|
| 376 |
-
cargo run --example whisper --release -- --model distil-small.en
|
| 377 |
-
```
|
| 378 |
-
5. To specify your own audio file, add the `--input` flag:
|
| 379 |
-
```
|
| 380 |
-
cargo run --example whisper --release -- --model distil-small.en --input audio.wav
|
| 381 |
-
```
|
| 382 |
-
|
| 383 |
-
--->
|
| 384 |
-
|
| 385 |
-
### 8bit & 4bit Quantization
|
| 386 |
-
|
| 387 |
-
Coming soon!
|
| 388 |
-
|
| 389 |
-
## Model Details
|
| 390 |
-
|
| 391 |
-
Distil-Whisper inherits the encoder-decoder architecture from Whisper. The encoder maps a sequence of speech vector
|
| 392 |
-
inputs to a sequence of hidden-state vectors. The decoder auto-regressively predicts text tokens, conditional on all
|
| 393 |
-
previous tokens and the encoder hidden-states. Consequently, the encoder is only run forward once, whereas the decoder
|
| 394 |
-
is run as many times as the number of tokens generated. In practice, this means the decoder accounts for over 90% of
|
| 395 |
-
total inference time. Thus, to optimise for latency, the focus is on minimising the inference time of the decoder.
|
| 396 |
-
|
| 397 |
-
To distill the Whisper model, we reduce the number of decoder layers while keeping the encoder fixed.
|
| 398 |
-
The encoder (shown in green) is entirely copied from the teacher to the student and frozen during training.
|
| 399 |
-
The student's decoder consists of a subset of the teacher decoder layers, which are intialised from maximally spaced layers.
|
| 400 |
-
The model is then trained on a weighted sum of the KL divergence and pseudo-label loss terms.
|
| 401 |
-
|
| 402 |
-
<p align="center">
|
| 403 |
-
<img src="https://huggingface.co/datasets/distil-whisper/figures/resolve/main/architecture.png?raw=true" width="600"/>
|
| 404 |
-
</p>
|
| 405 |
-
|
| 406 |
-
## Evaluation
|
| 407 |
-
|
| 408 |
-
The following code-snippets demonstrates how to evaluate the Distil-Whisper model on the LibriSpeech validation.clean
|
| 409 |
-
dataset with [streaming mode](https://huggingface.co/blog/audio-datasets#streaming-mode-the-silver-bullet), meaning no
|
| 410 |
-
audio data has to be downloaded to your local device.
|
| 411 |
-
|
| 412 |
-
First, we need to install the required packages, including 🤗 Datasets to stream and load the audio data, and 🤗 Evaluate to
|
| 413 |
-
perform the WER calculation:
|
| 414 |
-
|
| 415 |
-
```bash
|
| 416 |
-
pip install --upgrade pip
|
| 417 |
-
pip install --upgrade transformers datasets[audio] evaluate jiwer
|
| 418 |
-
```
|
| 419 |
-
|
| 420 |
-
Evaluation can then be run end-to-end with the following example:
|
| 421 |
-
|
| 422 |
-
```python
|
| 423 |
-
from transformers import AutoModelForSpeechSeq2Seq, AutoProcessor
|
| 424 |
-
from transformers.models.whisper.english_normalizer import EnglishTextNormalizer
|
| 425 |
-
from datasets import load_dataset
|
| 426 |
-
from evaluate import load
|
| 427 |
-
import torch
|
| 428 |
-
from tqdm import tqdm
|
| 429 |
-
|
| 430 |
-
# define our torch configuration
|
| 431 |
-
device = "cuda:0" if torch.cuda.is_available() else "cpu"
|
| 432 |
-
torch_dtype = torch.float16 if torch.cuda.is_available() else torch.float32
|
| 433 |
-
|
| 434 |
-
model_id = "distil-whisper/distil-small.en"
|
| 435 |
-
|
| 436 |
-
# load the model + processor
|
| 437 |
-
model = AutoModelForSpeechSeq2Seq.from_pretrained(model_id, torch_dtype=torch_dtype, use_safetensors=True, low_cpu_mem_usage=True)
|
| 438 |
-
model = model.to(device)
|
| 439 |
-
processor = AutoProcessor.from_pretrained(model_id)
|
| 440 |
-
|
| 441 |
-
# load the dataset with streaming mode
|
| 442 |
-
dataset = load_dataset("librispeech_asr", "clean", split="validation", streaming=True)
|
| 443 |
-
|
| 444 |
-
# define the evaluation metric
|
| 445 |
-
wer_metric = load("wer")
|
| 446 |
-
normalizer = EnglishTextNormalizer(processor.tokenizer.english_spelling_normalizer)
|
| 447 |
-
|
| 448 |
-
def inference(batch):
|
| 449 |
-
# 1. Pre-process the audio data to log-mel spectrogram inputs
|
| 450 |
-
audio = [sample["array"] for sample in batch["audio"]]
|
| 451 |
-
input_features = processor(audio, sampling_rate=batch["audio"][0]["sampling_rate"], return_tensors="pt").input_features
|
| 452 |
-
input_features = input_features.to(device, dtype=torch_dtype)
|
| 453 |
-
|
| 454 |
-
# 2. Auto-regressively generate the predicted token ids
|
| 455 |
-
pred_ids = model.generate(input_features, max_new_tokens=128)
|
| 456 |
-
|
| 457 |
-
# 3. Decode the token ids to the final transcription
|
| 458 |
-
batch["transcription"] = processor.batch_decode(pred_ids, skip_special_tokens=True)
|
| 459 |
-
batch["reference"] = batch["text"]
|
| 460 |
-
return batch
|
| 461 |
-
|
| 462 |
-
dataset = dataset.map(function=inference, batched=True, batch_size=16)
|
| 463 |
-
|
| 464 |
-
all_transcriptions = []
|
| 465 |
-
all_references = []
|
| 466 |
-
|
| 467 |
-
# iterate over the dataset and run inference
|
| 468 |
-
for i, result in tqdm(enumerate(dataset), desc="Evaluating..."):
|
| 469 |
-
all_transcriptions.append(result["transcription"])
|
| 470 |
-
all_references.append(result["reference"])
|
| 471 |
-
|
| 472 |
-
# normalize predictions and references
|
| 473 |
-
all_transcriptions = [normalizer(transcription) for transcription in all_transcriptions]
|
| 474 |
-
all_references = [normalizer(reference) for reference in all_references]
|
| 475 |
-
|
| 476 |
-
# compute the WER metric
|
| 477 |
-
wer = 100 * wer_metric.compute(predictions=all_transcriptions, references=all_references)
|
| 478 |
-
print(wer)
|
| 479 |
-
|
| 480 |
-
```
|
| 481 |
-
**Print Output:**
|
| 482 |
-
```
|
| 483 |
-
3.4326070294536297
|
| 484 |
-
```
|
| 485 |
-
|
| 486 |
-
## Intended Use
|
| 487 |
-
|
| 488 |
-
Distil-Whisper is intended to be a drop-in replacement for Whisper on English speech recognition. In particular, it
|
| 489 |
-
achieves comparable WER results over out-of-distribution test data, while being 6x faster over both short and long-form
|
| 490 |
-
audio.
|
| 491 |
-
|
| 492 |
-
## Data
|
| 493 |
-
|
| 494 |
-
Distil-Whisper is trained on 22,000 hours of audio data from 9 open-source, permissively licensed speech datasets on the
|
| 495 |
-
Hugging Face Hub:
|
| 496 |
-
|
| 497 |
-
| Dataset | Size / h | Speakers | Domain | Licence |
|
| 498 |
-
|-----------------------------------------------------------------------------------------|----------|----------|-----------------------------|-----------------|
|
| 499 |
-
| [People's Speech](https://huggingface.co/datasets/MLCommons/peoples_speech) | 12,000 | unknown | Internet Archive | CC-BY-SA-4.0 |
|
| 500 |
-
| [Common Voice 13](https://huggingface.co/datasets/mozilla-foundation/common_voice_13_0) | 3,000 | unknown | Narrated Wikipedia | CC0-1.0 |
|
| 501 |
-
| [GigaSpeech](https://huggingface.co/datasets/speechcolab/gigaspeech) | 2,500 | unknown | Audiobook, podcast, YouTube | apache-2.0 |
|
| 502 |
-
| Fisher | 1,960 | 11,900 | Telephone conversations | LDC |
|
| 503 |
-
| [LibriSpeech](https://huggingface.co/datasets/librispeech_asr) | 960 | 2,480 | Audiobooks | CC-BY-4.0 |
|
| 504 |
-
| [VoxPopuli](https://huggingface.co/datasets/facebook/voxpopuli) | 540 | 1,310 | European Parliament | CC0 |
|
| 505 |
-
| [TED-LIUM](https://huggingface.co/datasets/LIUM/tedlium) | 450 | 2,030 | TED talks | CC-BY-NC-ND 3.0 |
|
| 506 |
-
| SwitchBoard | 260 | 540 | Telephone conversations | LDC |
|
| 507 |
-
| [AMI](https://huggingface.co/datasets/edinburghcstr/ami) | 100 | unknown | Meetings | CC-BY-4.0 |
|
| 508 |
-
||||||
|
| 509 |
-
| **Total** | 21,770 | 18,260+ | | |
|
| 510 |
-
|
| 511 |
-
The combined dataset spans 10 distinct domains and over 50k speakers. The diversity of this dataset is crucial to ensuring
|
| 512 |
-
the distilled model is robust to audio distributions and noise.
|
| 513 |
-
|
| 514 |
-
The audio data is then pseudo-labelled using the Whisper large-v2 model: we use Whisper to generate predictions for all
|
| 515 |
-
the audio in our training set and use these as the target labels during training. Using pseudo-labels ensures that the
|
| 516 |
-
transcriptions are consistently formatted across datasets and provides sequence-level distillation signal during training.
|
| 517 |
-
|
| 518 |
-
## WER Filter
|
| 519 |
-
|
| 520 |
-
The Whisper pseudo-label predictions are subject to mis-transcriptions and hallucinations. To ensure we only train on
|
| 521 |
-
accurate pseudo-labels, we employ a simple WER heuristic during training. First, we normalise the Whisper pseudo-labels
|
| 522 |
-
and the ground truth labels provided by each dataset. We then compute the WER between these labels. If the WER exceeds
|
| 523 |
-
a specified threshold, we discard the training example. Otherwise, we keep it for training.
|
| 524 |
-
|
| 525 |
-
Section 9.2 of the [Distil-Whisper paper](https://arxiv.org/abs/2311.00430) demonstrates the effectiveness of this filter for improving downstream performance
|
| 526 |
-
of the distilled model. We also partially attribute Distil-Whisper's robustness to hallucinations to this filter.
|
| 527 |
-
|
| 528 |
-
## Training
|
| 529 |
-
|
| 530 |
-
The model was trained for 50,000 optimisation steps (or 12 epochs) with batch size 2056. The Tensorboard training logs can
|
| 531 |
-
be found under: https://huggingface.co/distil-whisper/distil-small.en/tensorboard?params=scalars#frame
|
| 532 |
-
|
| 533 |
-
## Results
|
| 534 |
-
|
| 535 |
-
The distilled model performs to within 1% WER of Whisper on out-of-distribution (OOD) short-form audio, and outperforms Whisper
|
| 536 |
-
by 0.1% on OOD long-form audio. This performance gain is attributed to lower hallucinations.
|
| 537 |
-
|
| 538 |
-
For a detailed per-dataset breakdown of the evaluation results, refer to Tables 16 and 17 of the [Distil-Whisper paper](https://arxiv.org/abs/2311.00430)
|
| 539 |
-
|
| 540 |
-
Distil-Whisper is also evaluated on the [ESB benchmark](https://arxiv.org/abs/2210.13352) datasets as part of the [OpenASR leaderboard](https://huggingface.co/spaces/hf-audio/open_asr_leaderboard),
|
| 541 |
-
where it performs to within 0.2% WER of Whisper.
|
| 542 |
-
|
| 543 |
-
## Reproducing Distil-Whisper
|
| 544 |
-
|
| 545 |
-
Training and evaluation code to reproduce Distil-Whisper is available under the Distil-Whisper repository: https://github.com/huggingface/distil-whisper/tree/main/training
|
| 546 |
-
|
| 547 |
-
## License
|
| 548 |
-
|
| 549 |
-
Distil-Whisper inherits the [MIT license](https://github.com/huggingface/distil-whisper/blob/main/LICENSE) from OpenAI's Whisper model.
|
| 550 |
-
|
| 551 |
-
## Citation
|
| 552 |
-
|
| 553 |
-
If you use this model, please consider citing the [Distil-Whisper paper](https://arxiv.org/abs/2311.00430):
|
| 554 |
-
```
|
| 555 |
-
@misc{gandhi2023distilwhisper,
|
| 556 |
-
title={Distil-Whisper: Robust Knowledge Distillation via Large-Scale Pseudo Labelling},
|
| 557 |
-
author={Sanchit Gandhi and Patrick von Platen and Alexander M. Rush},
|
| 558 |
-
year={2023},
|
| 559 |
-
eprint={2311.00430},
|
| 560 |
-
archivePrefix={arXiv},
|
| 561 |
-
primaryClass={cs.CL}
|
| 562 |
-
}
|
| 563 |
-
```
|
| 564 |
-
|
| 565 |
-
## Acknowledgements
|
| 566 |
-
* OpenAI for the Whisper [model](https://huggingface.co/openai/whisper-large-v2) and [original codebase](https://github.com/openai/whisper)
|
| 567 |
-
* Hugging Face 🤗 [Transformers](https://github.com/huggingface/transformers) for the model integration
|
| 568 |
-
* Google's [TPU Research Cloud (TRC)](https://sites.research.google/trc/about/) programme for Cloud TPU v4s
|
| 569 |
-
* [`@rsonavane`](https://huggingface.co/rsonavane/distil-whisper-large-v2-8-ls) for releasing an early iteration of Distil-Whisper on the LibriSpeech dataset
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language: en
|
| 3 |
+
license: apache-2.0
|
| 4 |
+
library_name: ctranslate2
|
| 5 |
+
pipeline_tag: automatic-speech-recognition
|
| 6 |
+
tags:
|
| 7 |
+
- whisper
|
| 8 |
+
- ctranslate2
|
| 9 |
+
- speech-recognition
|
| 10 |
+
- transcription
|
| 11 |
+
- float16
|
| 12 |
+
base_model: distil-whisper/distil-small.en
|
| 13 |
+
---
|
| 14 |
+
|
| 15 |
+
# 🗣️ Distil-Whisper Small.en — CTranslate2 (`float16`)
|
| 16 |
+
|
| 17 |
+
This is [HuggingFace's distil-small.en](https://huggingface.co/distil-whisper/distil-small.en) converted to [CTranslate2](https://github.com/OpenNMT/CTranslate2) format with `float16` precision.
|
| 18 |
+
|
| 19 |
+
> [!TIP]
|
| 20 |
+
> Also available in other precisions:
|
| 21 |
+
> [`float32`](https://huggingface.co/ctranslate2-4you/distil-whisper-small.en-ct2-float32) · [`bfloat16`](https://huggingface.co/ctranslate2-4you/distil-whisper-small.en-ct2-bfloat16)
|
| 22 |
+
|
| 23 |
+
---
|
| 24 |
+
|
| 25 |
+
## 📋 Details
|
| 26 |
+
|
| 27 |
+
| | |
|
| 28 |
+
|---|---|
|
| 29 |
+
| **Base model** | [distil-whisper/distil-small.en](https://huggingface.co/distil-whisper/distil-small.en) |
|
| 30 |
+
| **Format** | CTranslate2 |
|
| 31 |
+
| **Precision** | `float16` |
|
| 32 |
+
| **Language** | English |
|
| 33 |
+
| **Task** | Automatic Speech Recognition |
|
| 34 |
+
|
| 35 |
+
---
|
| 36 |
+
|
| 37 |
+
## ⚡ Quick Start
|
| 38 |
+
|
| 39 |
+
Install the inference library:
|
| 40 |
+
|
| 41 |
+
```bash
|
| 42 |
+
pip install whisper-s2t-reborn
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
Transcribe an audio file:
|
| 46 |
+
|
| 47 |
+
```python
|
| 48 |
+
import whisper_s2t
|
| 49 |
+
|
| 50 |
+
model = whisper_s2t.load_model(
|
| 51 |
+
model_identifier="distil-small.en",
|
| 52 |
+
compute_type="float16",
|
| 53 |
+
device="cuda",
|
| 54 |
+
)
|
| 55 |
+
|
| 56 |
+
result = model.transcribe_with_vad(
|
| 57 |
+
["audio.wav"],
|
| 58 |
+
lang_codes=["en"],
|
| 59 |
+
tasks=["transcribe"],
|
| 60 |
+
initial_prompts=[None],
|
| 61 |
+
batch_size=1, # increase this to significantly improve throughput
|
| 62 |
+
)
|
| 63 |
+
|
| 64 |
+
for segment in result[0]:
|
| 65 |
+
print(segment["text"])
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
> [!NOTE]
|
| 69 |
+
> Models are **auto-downloaded** from this repo the first time you run inference. No manual download required.
|
| 70 |
+
|
| 71 |
+
*See the [whisper-s2t-reborn](https://github.com/BBC-Esq/WhisperS2T-reborn) repository for the full list of available parameters.*
|
| 72 |
+
|
| 73 |
+
---
|
| 74 |
+
|
| 75 |
+
## 📦 All Available CTranslate2 Whisper Models
|
| 76 |
+
|
| 77 |
+
Every model below is hosted at [huggingface.co/ctranslate2-4you](https://huggingface.co/ctranslate2-4you) and works with [whisper-s2t-reborn](https://github.com/BBC-Esq/WhisperS2T-reborn).
|
| 78 |
+
|
| 79 |
+
### 🌍 Standard Whisper (Multilingual)
|
| 80 |
+
|
| 81 |
+
| Model | `float32` | `float16` | `bfloat16` |
|
| 82 |
+
|---|:---:|:---:|:---:|
|
| 83 |
+
| **tiny** | [Link](https://huggingface.co/ctranslate2-4you/whisper-tiny-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-tiny-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-tiny-ct2-bfloat16) |
|
| 84 |
+
| **base** | [Link](https://huggingface.co/ctranslate2-4you/whisper-base-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-base-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-base-ct2-bfloat16) |
|
| 85 |
+
| **small** | [Link](https://huggingface.co/ctranslate2-4you/whisper-small-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-small-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-small-ct2-bfloat16) |
|
| 86 |
+
| **medium** | [Link](https://huggingface.co/ctranslate2-4you/whisper-medium-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-medium-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-medium-ct2-bfloat16) |
|
| 87 |
+
| **large-v3** | [Link](https://huggingface.co/ctranslate2-4you/whisper-large-v3-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-large-v3-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-large-v3-ct2-bfloat16) |
|
| 88 |
+
|
| 89 |
+
### 🇺🇸 Whisper English-Only
|
| 90 |
+
|
| 91 |
+
| Model | `float32` | `float16` | `bfloat16` |
|
| 92 |
+
|---|:---:|:---:|:---:|
|
| 93 |
+
| **tiny.en** | [Link](https://huggingface.co/ctranslate2-4you/whisper-tiny.en-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-tiny.en-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-tiny.en-ct2-bfloat16) |
|
| 94 |
+
| **base.en** | [Link](https://huggingface.co/ctranslate2-4you/whisper-base.en-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-base.en-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-base.en-ct2-bfloat16) |
|
| 95 |
+
| **small.en** | [Link](https://huggingface.co/ctranslate2-4you/whisper-small.en-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-small.en-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-small.en-ct2-bfloat16) |
|
| 96 |
+
| **medium.en** | [Link](https://huggingface.co/ctranslate2-4you/whisper-medium.en-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-medium.en-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-medium.en-ct2-bfloat16) |
|
| 97 |
+
|
| 98 |
+
### ⚡ Distilled Whisper
|
| 99 |
+
|
| 100 |
+
| Model | `float32` | `float16` | `bfloat16` |
|
| 101 |
+
|---|:---:|:---:|:---:|
|
| 102 |
+
| **distil-small.en** | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-small.en-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-small.en-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-small.en-ct2-bfloat16) |
|
| 103 |
+
| **distil-medium.en** | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-medium.en-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-medium.en-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-medium.en-ct2-bfloat16) |
|
| 104 |
+
| **distil-large-v3** | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-large-v3-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-large-v3-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/distil-whisper-large-v3-ct2-bfloat16) |
|
| 105 |
+
|
| 106 |
+
### 🚀 Whisper Large-v3 Turbo
|
| 107 |
+
|
| 108 |
+
| Model | `float32` | `float16` | `bfloat16` |
|
| 109 |
+
|---|:---:|:---:|:---:|
|
| 110 |
+
| **large-v3-turbo** | [Link](https://huggingface.co/ctranslate2-4you/whisper-large-v3-turbo-ct2-float32) | [Link](https://huggingface.co/ctranslate2-4you/whisper-large-v3-turbo-ct2-float16) | [Link](https://huggingface.co/ctranslate2-4you/whisper-large-v3-turbo-ct2-bfloat16) |
|
| 111 |
+
|
| 112 |
+
---
|
| 113 |
+
|
| 114 |
+
## 🔗 Links
|
| 115 |
+
|
| 116 |
+
- 📦 **Inference library** — [whisper-s2t-reborn](https://github.com/BBC-Esq/WhisperS2T-reborn)
|
| 117 |
+
- 🏗️ **CTranslate2** — [github.com/OpenNMT/CTranslate2](https://github.com/OpenNMT/CTranslate2)
|
| 118 |
+
- 🧠 **Original model** — [distil-whisper/distil-small.en](https://huggingface.co/distil-whisper/distil-small.en)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|