candle

mirror of https://github.com/huggingface/candle.git synced 2025-06-14 09:57:10 +00:00

Files

Laurent Mazare 9d31361c4f Fix for clippy 1.86. (#2864 )

* Fix for clippy 1.86.

* More clippy fixes.

* More fixes.

2025-04-03 19:38:27 +02:00

src

Fix for clippy 1.86. (#2864 )

2025-04-03 19:38:27 +02:00

build-lib.sh

Improve Whisper WASM UI example (#669 )

2023-08-30 20:35:41 +02:00

Cargo.toml

Clippy fixes. (#2415 )

2024-08-14 10:13:53 +02:00

index.html

Whisper quantized wasm (#1028 )

2023-10-04 20:22:57 +01:00

lib-example.html

add distil-whisper link (#1261 )

2023-11-03 21:34:42 +01:00

main.js

Re-organize the wasm examples (#231 )

2023-07-24 12:36:02 +01:00

README.md

Whisper quantized wasm (#1028 )

2023-10-04 20:22:57 +01:00

whisperWorker.js

Whisper quantized wasm (#1028 )

2023-10-04 20:22:57 +01:00

README.md

Running Whisper Examples

Here, we provide two examples of how to run Whisper using a Candle-compiled WASM binary and runtimes.

Pure Rust UI

To build and test the UI made in Rust you will need Trunk From the candle-wasm-examples/whisper directory run:

Download assets:

# mel filters
wget -c https://huggingface.co/spaces/lmz/candle-whisper/resolve/main/mel_filters.safetensors
# Model and tokenizer tiny.en
wget -c https://huggingface.co/openai/whisper-tiny.en/resolve/main/model.safetensors -P whisper-tiny.en 
wget -c https://huggingface.co/openai/whisper-tiny.en/raw/main/tokenizer.json -P whisper-tiny.en
wget -c https://huggingface.co/openai/whisper-tiny.en/raw/main/config.json -P whisper-tiny.en
# model and tokenizer tiny multilanguage
wget -c https://huggingface.co/openai/whisper-tiny/resolve/main/model.safetensors -P whisper-tiny
wget -c https://huggingface.co/openai/whisper-tiny/raw/main/tokenizer.json -P whisper-tiny
wget -c https://huggingface.co/openai/whisper-tiny/raw/main/config.json -P whisper-tiny

#quantized 
wget -c https://huggingface.co/lmz/candle-whisper/resolve/main/model-tiny-en-q80.gguf -P quantized
wget -c https://huggingface.co/lmz/candle-whisper/raw/main/tokenizer-tiny-en.json -P quantized
wget -c https://huggingface.co/lmz/candle-whisper/raw/main/config-tiny-en.json -P quantized



# Audio samples
wget -c https://huggingface.co/datasets/Narsil/candle-examples/resolve/main/samples_gb0.wav -P audios
wget -c https://huggingface.co/datasets/Narsil/candle-examples/resolve/main/samples_a13.wav -P audios
wget -c https://huggingface.co/datasets/Narsil/candle-examples/resolve/main/samples_gb1.wav -P audios
wget -c https://huggingface.co/datasets/Narsil/candle-examples/resolve/main/samples_hp0.wav -P audios
wget -c https://huggingface.co/datasets/Narsil/candle-examples/resolve/main/samples_jfk.wav -P audios
wget -c https://huggingface.co/datasets/Narsil/candle-examples/resolve/main/samples_mm0.wav -P audios

Run hot reload server:

trunk serve --release --public-url / --port 8080

Vanilla JS and WebWorkers

To build and test the UI made in Vanilla JS and WebWorkers, first we need to build the WASM library:

sh build-lib.sh

This will bundle the library under ./build and we can import it inside our WebWorker like a normal JS module:

import init, { Decoder } from "./build/m.js";

The full example can be found under ./lib-example.html. All needed assets are fetched from the web, so no need to download anything. Finally, you can preview the example by running a local HTTP server. For example:

python -m http.server

Then open http://localhost:8000/lib-example.html in your browser.