kjarni-wasm 0.1.5 → 0.1.6

package/README.md

@@ -15,6 +15,59 @@ Or without a bundler, straight from a CDN:
 </script>
 ```
 
+## Copy this and it runs
+
+One file, nothing installed. Save it as `quickstart.html`, serve the directory,
+open it: a real model downloads and ranks three sentences by meaning.
+
+```bash
+curl -sO https://raw.githubusercontent.com/olafurjohannsson/kjarni/main/crates/kjarni-wasm/examples/quickstart.html
+python3 -m http.server 8000
+# then open http://localhost:8000/quickstart.html
+```
+
+A server is needed because ES modules do not load over `file://`. Any static
+server will do.
+
+```html
+<pre id="out">starting…</pre>
+<script type="module">
+  import init, { WasmModel } from "https://cdn.jsdelivr.net/npm/kjarni-wasm@0.1.4/pkg/kjarni_wasm.js";
+  await init();
+
+  const url = "https://huggingface.co/olafuraron/all-MiniLM-L6-v2-q8/resolve/main/all-MiniLM-L6-v2-q8.kjq";
+  const model = WasmModel.from_quantized(new Uint8Array(await (await fetch(url)).arrayBuffer()));
+
+  const texts = [
+    "How do I get my money back?",
+    "What is your refund policy?",
+    "The weather in Reykjavik is unpredictable.",
+  ];
+
+  // Normalised, so a dot product is the cosine similarity.
+  const flat = model.encode(texts, true);
+  const dim = flat.length / texts.length;
+  const vec = (i) => flat.subarray(i * dim, (i + 1) * dim);
+  const cosine = (a, b) => a.reduce((sum, x, i) => sum + x * b[i], 0);
+
+  out.textContent = `related:   ${cosine(vec(0), vec(1)).toFixed(4)}\n`
+                  + `unrelated: ${cosine(vec(0), vec(2)).toFixed(4)}`;
+</script>
+```
+
+```
+related:   0.5268
+unrelated: -0.0470
+```
+
+This imports the wasm module directly rather than the `Kjarni` wrapper, so it runs
+on the main thread with no Worker: fine for a page that encodes a few sentences,
+not for chat. Use `Kjarni` for anything larger, and see the Chat section.
+
+Scores differ slightly from the native library (0.5510 / -0.0630) because the
+browser model is int8-quantised. The ranking is the same, which is what a search
+uses.
+
 ## Quick tour
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kjarni-wasm",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Local AI inference in the browser: embeddings, classification, reranking, semantic search and chat, running in a Web Worker.",
   "type": "module",
   "main": "./dist/index.js",

package/pkg/kjarni_wasm.d.ts

@@ -248,8 +248,8 @@ export interface InitOutput {
     readonly wasmsearch_add_chunk: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
     readonly __wbg_wasmreranker_free: (a: number, b: number) => void;
     readonly __wbg_wasmsearch_free: (a: number, b: number) => void;
-    readonly __wasm_bindgen_func_elem_5449: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_5465: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_5495: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_5511: (a: number, b: number, c: number, d: number) => void;
     readonly __wbindgen_export: (a: number, b: number) => number;
     readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_export3: (a: number) => void;

package/pkg/kjarni_wasm.js

@@ -1092,7 +1092,7 @@ function __wbg_get_imports() {
                     const a = state0.a;
                     state0.a = 0;
                     try {
-                        return __wasm_bindgen_func_elem_5465(a, state0.b, arg0, arg1);
+                        return __wasm_bindgen_func_elem_5511(a, state0.b, arg0, arg1);
                     } finally {
                         state0.a = a;
                     }
@@ -1206,8 +1206,8 @@ function __wbg_get_imports() {
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 2043, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
-            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_5449);
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 2058, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+            const ret = makeMutClosure(arg0, arg1, __wasm_bindgen_func_elem_5495);
             return addHeapObject(ret);
         },
         __wbindgen_cast_0000000000000002: function(arg0) {
@@ -1244,10 +1244,10 @@ function __wbg_get_imports() {
     };
 }
 
-function __wasm_bindgen_func_elem_5449(arg0, arg1, arg2) {
+function __wasm_bindgen_func_elem_5495(arg0, arg1, arg2) {
     try {
         const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        wasm.__wasm_bindgen_func_elem_5449(retptr, arg0, arg1, addHeapObject(arg2));
+        wasm.__wasm_bindgen_func_elem_5495(retptr, arg0, arg1, addHeapObject(arg2));
         var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
         var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
         if (r1) {
@@ -1258,8 +1258,8 @@ function __wasm_bindgen_func_elem_5449(arg0, arg1, arg2) {
     }
 }
 
-function __wasm_bindgen_func_elem_5465(arg0, arg1, arg2, arg3) {
-    wasm.__wasm_bindgen_func_elem_5465(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
+function __wasm_bindgen_func_elem_5511(arg0, arg1, arg2, arg3) {
+    wasm.__wasm_bindgen_func_elem_5511(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
 
 const WasmChatFinalization = (typeof FinalizationRegistry === 'undefined')

package/pkg/kjarni_wasm_bg.wasm.d.ts

@@ -45,8 +45,8 @@ export const wasmsearch_doc_count: (a: number) => number;
 export const wasmsearch_add_chunk: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => void;
 export const __wbg_wasmreranker_free: (a: number, b: number) => void;
 export const __wbg_wasmsearch_free: (a: number, b: number) => void;
-export const __wasm_bindgen_func_elem_5449: (a: number, b: number, c: number, d: number) => void;
-export const __wasm_bindgen_func_elem_5465: (a: number, b: number, c: number, d: number) => void;
+export const __wasm_bindgen_func_elem_5495: (a: number, b: number, c: number, d: number) => void;
+export const __wasm_bindgen_func_elem_5511: (a: number, b: number, c: number, d: number) => void;
 export const __wbindgen_export: (a: number, b: number) => number;
 export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
 export const __wbindgen_export3: (a: number) => void;