summaryrefslogtreecommitdiff
path: root/candle-wasm-examples/moondream/README.md
diff options
context:
space:
mode:
authorRadamés Ajna <radamajna@gmail.com>2024-04-02 22:11:50 -0700
committerGitHub <noreply@github.com>2024-04-03 07:11:50 +0200
commit26226068a4912891f1d374b036aa2d1f6e5af4d2 (patch)
tree2e6d7033ec5729df8b1a33d8cac7fe461a90dcb8 /candle-wasm-examples/moondream/README.md
parentcd6b9e317c9499ffde396391d8b2b18fa9aa6afb (diff)
downloadcandle-26226068a4912891f1d374b036aa2d1f6e5af4d2.tar.gz
candle-26226068a4912891f1d374b036aa2d1f6e5af4d2.tar.bz2
candle-26226068a4912891f1d374b036aa2d1f6e5af4d2.zip
Moondream WASM (#1999)
* moondream wasm wip * examples, more * fix eos token check * README * cleanip * cleanup, clippy
Diffstat (limited to 'candle-wasm-examples/moondream/README.md')
-rw-r--r--candle-wasm-examples/moondream/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/candle-wasm-examples/moondream/README.md b/candle-wasm-examples/moondream/README.md
new file mode 100644
index 00000000..ca7f7ced
--- /dev/null
+++ b/candle-wasm-examples/moondream/README.md
@@ -0,0 +1,24 @@
+## Running [Moondream 2](https://huggingface.co/vikhyatk/moondream2) Model Example
+
+### 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, { Model } from "./build/m.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.