mirror of
https://github.com/ggml-org/whisper.cpp.git
synced 2026-07-23 11:10:57 -05:00
examples : add note about WHISPER_WASM_SINGLE_FILE [no ci] (#3332)
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
This commit is contained in:
@@ -32,6 +32,16 @@ cp bin/libcommand.js /path/to/html/
|
||||
cp bin/libcommand.worker.js /path/to/html/
|
||||
```
|
||||
|
||||
> 📝 **Note:** By default this example is built with `WHISPER_WASM_SINGLE_FILE=ON`
|
||||
> which 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`:
|
||||
> ```console
|
||||
> emcmake cmake .. -DWHISPER_WASM_SINGLE_FILE=OFF
|
||||
> ```
|
||||
> This will generate a `libcommand.wasm` file 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`.
|
||||
|
||||
Reference in New Issue
Block a user