@trymirai/uzu 0.1.3 → 0.1.4

package/README.md

@@ -21,16 +21,8 @@ Node package for [uzu](https://github.com/trymirai/uzu), a **high-performance**
 
 ## Quick Start
 
-
 ```bash
-# 1 /  Install TS dependencies (installs @napi-rs/cli locally)
-cd bindings/ts
-pnpm install
-
-# 2 /  Build the native addon in release mode
-pnpm run build
-
-# 3 /  Set your API key in `examples/api_key.ts`, then run the examples
+# Set your API key in `examples/api_key.ts`, then run the examples
 pnpm run chat
 pnpm run summarize
 pnpm run classify
@@ -49,11 +41,15 @@ const engine = new Engine()
 const licenseStatus = await engine.activate('API_KEY')
 ```
 
-### Refresh models registry:
+### Refresh models registry / list cloud models:
 
 ```ts
 const registry = await engine.updateRegistry()
 const modelIdentifiers = registry.map((m) => m.identifier)
+
+// To explore available cloud models:
+const cloudModels = await engine.getCloudModels()
+console.log('Cloud models:', cloudModels)
 ```
 
 ### Download with progress handle
@@ -94,7 +90,19 @@ Possible model state values:
 `Session` is the core entity used to communicate with the model:
 
 ```ts
-const session = engine.createSession({ type: 'Local', id: 'Meta-Llama-3.2-1B-Instruct-bfloat16' })
+import { type ModelID } from './uzu'
+
+const modelIdentifier = 'Meta-Llama-3.2-1B-Instruct-bfloat16'
+
+// Choose one of the two options below by commenting/uncommenting:
+// 1) Local model (default)
+// const modelId: ModelID = { type: 'Local', id: modelIdentifier }
+
+// 2) Cloud model (uncomment and set your repoId; you can list with engine.getCloudModels())
+const cloudRepoId = 'meta-llama/Llama-4-Maverick-17B-128E-Instruct'
+const modelId: ModelID = { type: 'Cloud', id: cloudRepoId }
+
+const session = engine.createSession(modelId)
 ```
 
 `Session` offers different configuration presets that can provide significant performance boosts for common use cases like classification and summarization:

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@trymirai/uzu",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "private": false,
   "main": "uzu.node",
   "types": "uzu.d.ts",
   "packageManager": "pnpm@10.14.0",
   "scripts": {
-    "build": "./build.sh",
     "chat": "ts-node examples/chat_example.ts",
     "summarize": "ts-node examples/summarization_example.ts",
-    "classify": "ts-node examples/classification_example.ts"
+    "classify": "ts-node examples/classification_example.ts",
+    "cloud:list": "ts-node examples/list_cloud_models.ts"
   },
   "devDependencies": {
     "@napi-rs/cli": "3.1.2",