summaryrefslogtreecommitdiff
path: root/candle-wasm-examples/t5/README.md
diff options
context:
space:
mode:
authorRadamés Ajna <radamajna@gmail.com>2023-09-22 07:31:10 -0700
committerGitHub <noreply@github.com>2023-09-22 15:31:10 +0100
commit19e52e5007e10816eefb2e1a1968be760c5d11a4 (patch)
treef0d9cad35d261c3a28d2c4fa5a8ff1af84a4631f /candle-wasm-examples/t5/README.md
parent8601537e31af610c0bbd32ee8c8ee17ed802427c (diff)
downloadcandle-19e52e5007e10816eefb2e1a1968be760c5d11a4.tar.gz
candle-19e52e5007e10816eefb2e1a1968be760c5d11a4.tar.bz2
candle-19e52e5007e10816eefb2e1a1968be760c5d11a4.zip
T5 Wasm (#918)
* init t5 wasm model * split workers for each model * clean up * add some ui * readme * index * typo * remove cache param, clear_kv_cache * add max_length as param * add model tasks option to ui * add method to load quantized gguf from buffer * Add quantized wasm module * add quantized models to UI, dynamic import wasms * link to quantized * fix copy * fix ModelEncoder * fix README.md
Diffstat (limited to 'candle-wasm-examples/t5/README.md')
-rw-r--r--candle-wasm-examples/t5/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/candle-wasm-examples/t5/README.md b/candle-wasm-examples/t5/README.md
new file mode 100644
index 00000000..9a9f5bce
--- /dev/null
+++ b/candle-wasm-examples/t5/README.md
@@ -0,0 +1,32 @@
+## Running T5 with Candle and WASM
+
+Here, we provide two examples of how to run Bert using a Candle-compiled WASM binary and runtime.
+
+### Vanilla JS and WebWorkers
+
+To build and test the UI made in Vanilla JS and WebWorkers, first we need to build the WASM library:
+
+```bash
+sh build-lib.sh
+```
+
+This will bundle the library under `./build` and we can import it inside our WebWorker like a normal JS module:
+
+```js
+import init, { ModelConditionalGeneration, ModelEncoder } from "./build/m.js";
+```
+
+For the quantized version, we need to import the quantized module:
+
+```js
+import init, { ModelConditionalGeneration, ModelEncoder } from "./build/m-quantized.js";
+```
+
+The full example can be found under `./index.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:
+
+```bash
+python -m http.server
+```
+
+Then open `http://localhost:8000/index.html` in your browser.