edge-intelligence-sdk 0.3.9 → 0.3.10

package/README.md

@@ -3,8 +3,44 @@
 Generated Web and React Native bindings for the Edge Intelligence SDK.
 
 This package contains the WASM/TypeScript browser surface, React Native
-TypeScript bindings, and native Android/iOS libraries assembled by the
-release pipeline.
+TypeScript bindings, and native Android/iOS libraries assembled by the release
+pipeline.
 
-Source, crate documentation, and release notes live in the Edge
-Intelligence repository.
+## Usage
+
+Copy the Qwen2.5 0.5B GGUF into app storage and pass that local path to the SDK
+facade.
+
+Browser / WASM:
+
+```ts
+import init, { EdgeLlm } from "edge-intelligence-sdk";
+
+await init();
+
+const qwen05b = "/models/qwen2.5-0.5b-instruct-q4_k_m.gguf";
+const sdk = new EdgeLlm(qwen05b);
+const reply = sdk.ask_wasm("Summarize edge inference in one sentence.");
+
+console.log(reply);
+```
+
+React Native:
+
+```ts
+import { EdgeLlm } from "edge-intelligence-sdk";
+
+const qwen05b = "/data/user/0/com.example.app/files/models/qwen2.5-0.5b-instruct-q4_k_m.gguf";
+const sdk = EdgeLlm.local(qwen05b);
+
+const reply = sdk.ask("Summarize edge inference in one sentence.");
+let streamed = "";
+sdk.ask_stream_cb("Give me two deployment tips.", {
+  on_token(token) {
+    streamed += token;
+  },
+});
+```
+
+Source, crate documentation, and release notes live in the Edge Intelligence
+repository.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-intelligence-sdk",
-  "version": "0.3.9",
+  "version": "0.3.10",
   "description": "Edge-native LLM inference SDK — Web (WASM) + React Native",
   "exports": {
     ".": {

package/src/web/README.md

@@ -34,19 +34,74 @@ No `unsafe` (`#![forbid(unsafe_code)]`). The crate is `cdylib` + `staticlib` +
 
 ## Usage (Rust side)
 
+Use the Qwen2.5 0.5B GGUF as the local model URI when constructing the facade.
+Native package bindings use the same model path after copying the file into app
+storage. For full Rust ChatML/tokenizer control, use
+`el_engine_candle::QwenChatProvider` directly.
+
 ```rust
 use el_ffi::EdgeLlm;
 
-// Empty path → deterministic toy model; exercises the full binding layer.
-let sdk = EdgeLlm::local(String::new())?;
-let reply = sdk.ask("hello".into())?;
+const QWEN_0_5B_GGUF: &str = "models/qwen2.5-0.5b-instruct-q4_k_m.gguf";
+
+let sdk = EdgeLlm::local(QWEN_0_5B_GGUF.into())?;
+let reply = sdk.ask("Summarize edge inference in one sentence.".into())?;
 assert!(!reply.is_empty());
 
 // Streaming (Flutter / closure form):
-sdk.ask_stream("hi".into(), |fragment| print!("{fragment}"))?;
+sdk.ask_stream("Give me two deployment tips.".into(), |fragment| print!("{fragment}"))?;
 # Ok::<(), el_ffi::SdkError>(())
 ```
 
+## Usage (npm / web)
+
+The npm package exposes the wasm-bindgen browser surface. The local web path
+currently exercises the generated API shape while Candle-on-wasm is being wired;
+native React Native builds load the GGUF through the same package.
+
+```ts
+import init, { EdgeLlm } from "edge-intelligence-sdk";
+
+await init();
+
+const qwen05b = "/models/qwen2.5-0.5b-instruct-q4_k_m.gguf";
+const sdk = new EdgeLlm(qwen05b);
+const reply = sdk.ask_wasm("Summarize edge inference in one sentence.");
+
+console.log(reply);
+```
+
+## Usage (React Native)
+
+```ts
+import { EdgeLlm } from "edge-intelligence-sdk";
+
+const qwen05b = "/data/user/0/com.example.app/files/models/qwen2.5-0.5b-instruct-q4_k_m.gguf";
+const sdk = EdgeLlm.local(qwen05b);
+
+const reply = sdk.ask("Summarize edge inference in one sentence.");
+let streamed = "";
+sdk.ask_stream_cb("Give me two deployment tips.", {
+  on_token(token) {
+    streamed += token;
+  },
+});
+```
+
+## Usage (pub.dev / Flutter)
+
+```dart
+import "package:edge_intelligence/edge_intelligence.dart";
+
+final qwen05b = "/path/to/app/models/qwen2.5-0.5b-instruct-q4_k_m.gguf";
+final sdk = await EdgeLlm.local(qwen05b);
+
+final reply = await sdk.ask("Summarize edge inference in one sentence.");
+await for (final token in sdk.askStream("Give me two deployment tips.")) {
+  stdout.write(token);
+}
+```
+
 ## Building the bindings
 
 The Rust binding *surfaces* compile on the host; the cross-target builds and

package/src/web/package.json

@@ -2,7 +2,7 @@
   "name": "el-ffi",
   "type": "module",
   "description": "Host bindings: uniffi-bindgen-react-native (RN), flutter_rust_bridge v2 (Flutter), wasm-bindgen (web) — ADR-001/009.",
-  "version": "0.3.9",
+  "version": "0.3.10",
   "license": "Apache-2.0",
   "files": [
     "el_ffi_bg.wasm",