7de8dd783f
This commit adds a note to the README files of the WASM examples about the `WHISPER_WASM_SINGLE_FILE` option. The motivation for this is that currently this option is not documented and might be surprising to users who expect a separate .wasm file to be generated. Refs: https://github.com/ggml-org/whisper.cpp/issues/3290
bench.wasm
Benchmark the performance of whisper.cpp in the browser using WebAssembly
Link: https://ggml.ai/whisper.cpp/bench.wasm/
Terminal version: examples/bench
Build instructions
# build using Emscripten (v3.1.2)
git clone https://github.com/ggerganov/whisper.cpp
cd whisper.cpp
mkdir build-em && cd build-em
emcmake cmake ..
make -j
The example can then be started by running a local HTTP server:
python3 examples/server.py
And then opening a browser to the following URL: http://localhost:8000/bench.wasm
To run the example in a different server, you need to copy the following files to the server's HTTP path:
# copy the produced page to your HTTP path
cp bin/bench.wasm/* /path/to/html/
cp bin/libbench.js /path/to/html/
cp bin/libbench.worker.js /path/to/html/
📝 Note: By default this example is built with
WHISPER_WASM_SINGLE_FILE=ONwhich means that that a separate .wasm file will not be generated. Instead, the WASM module is embedded in the main JS file as a base64 encoded string. To generate a separate .wasm file, you need to disable this option by passing-DWHISPER_WASM_SINGLE_FILE=OFF:emcmake cmake .. -DWHISPER_WASM_SINGLE_FILE=OFFThis will generate a
libbench.wasmfile in the build/bin directory.
📝 Note: As of Emscripten 3.1.58 (April 2024), separate worker.js files are no longer generated and the worker is embedded in the main JS file. So the worker file will not be geneated for versions later than
3.1.58.