-
Notifications
You must be signed in to change notification settings - Fork 8
feat: added webgpu tensorflow example #624
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| node_modules | ||
| dist | ||
| build | ||
| keys | ||
| /**/generated/** | ||
| *.tgz | ||
| wit/deps/ | ||
| *.log | ||
| **/wit/deps/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| v22.12.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| version: 2.1.0 | ||
|
|
||
| new: | ||
| command: npm install | ||
|
|
||
| build: | ||
| command: npm run build | ||
| component_path: component/dist/component.wasm | ||
|
|
||
| dev: | ||
| wasi_webgpu: true | ||
| service_file: service/dist/service.wasm |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| # TypeScript WebGPU TensorFlow service + component | ||
|
|
||
| A wasmCloud v2 service-and-component example written in [TypeScript][ts] that demonstrates **GPU-accelerated ML inside a wasmCloud workload** — running [TensorFlow.js][tfjs] with the [WebGPU backend][tfjs-webgpu] on top of [`wasi:webgpu`][wasi-webgpu]. | ||
|
|
||
| The example has two parts: | ||
|
|
||
| | Part | Type | What it does | | ||
| |---|---|---| | ||
| | `service/` | wasmCloud **service** workload | TensorFlow.js style-transfer engine. Loads the model into GPU memory once at startup and serves a binary TCP protocol on `127.0.0.1:7878`. | | ||
| | `component/` | wasmCloud **component** workload | HTTP front-end. Serves the browser UI at `/`, forwards `POST /stylize` to the service over loopback TCP, returns the stylized JPEG. | | ||
|
|
||
| Model artifacts under `service/models/` are third-party files licensed under Apache-2.0. | ||
| See `service/models/ATTRIBUTION.md` for source and licensing details. | ||
|
|
||
| ## Architecture | ||
|
|
||
| ``` | ||
| HTTP client | ||
| │ POST /stylize {contentImage: dataUrl, styleImage: dataUrl} | ||
| ▼ | ||
| component (wasi:http/incoming-handler) | ||
| │ TCP connect 127.0.0.1:7878 | ||
| │ send: u32 contentLen | content JPEG | u32 styleLen | style JPEG | ||
| ▼ | ||
| service (wasi:cli/run, wasi:webgpu) | ||
| │ TF.js + WebGPU style transfer | ||
| │ send: u8 status | u32 payloadLen | stylized JPEG | ||
| ▼ | ||
| component | ||
| ▼ | ||
| HTTP client (image/jpeg) | ||
| ``` | ||
|
|
||
| Both workloads run in the same wasmCloud host and share an in-process loopback network. Services bind to `0.0.0.0` but the runtime rewrites that to `127.0.0.1` — services are never reachable from outside the host. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [Wasm Shell (`wash`)](https://wasmcloud.com/docs/installation) **≥ 2.1.0** — WebGPU in services landed in 2.1.0. | ||
| - Node.js ≥ 20 and npm ≥ 10 | ||
| - A GPU on the host machine running `wash dev` | ||
|
|
||
| ## Quickstart | ||
|
|
||
| ```bash | ||
| # Install dependencies (also applies the componentize-js patch) | ||
| npm install | ||
|
|
||
| # Build, deploy, and watch for changes | ||
| wash dev | ||
| ``` | ||
|
|
||
| `wash dev` reads `.wash/config.yaml` and starts the host with `wasi:webgpu` enabled, deploys both `service/dist/service.wasm` and `component/dist/component.wasm`, and watches `service/src` and `component/src` for rebuilds. | ||
|
|
||
| Once it's up, open the UI: | ||
|
|
||
| ```text | ||
| http://localhost:8000/ | ||
| ``` | ||
|
|
||
| Pick a content image and a style image and click **Stylize**. | ||
|
|
||
| ## How it works | ||
|
|
||
| The thing this example demonstrates is GPU-accelerated ML running as a long-lived wasmCloud workload. The component imports `wasi:http`; the service imports `wasi:webgpu` and exports `wasi:cli/run`. The runtime wires `wasi:webgpu` up to the real GPU on the host running `wash dev`. | ||
|
|
||
| ### Roles | ||
|
|
||
| - **Service** ([service/](service/)) — exports `wasi:cli/run`. Started once by the host at deploy and runs continuously. Owns the GPU device, the loaded TF.js models, and the WGSL shader cache. Listens on TCP `127.0.0.1:7878` for stylize requests. | ||
| - **Component** ([component/](component/)) — exports `wasi:http/incoming-handler`. Stateless. Each HTTP request gets a fresh invocation. Serves the UI, validates the request body, opens a TCP connection to the service, forwards the JPEGs, returns the stylized result. | ||
| - **Loopback TCP between them** — both workloads run inside the same wasmCloud host and share an in-process network. The service binds to `0.0.0.0` but the runtime rewrites that to `127.0.0.1`, so the connection never leaves the host. | ||
|
|
||
| ### Warmup | ||
|
|
||
| `Stylizer.initialize()` in [service/src/image-stylizer.ts](service/src/image-stylizer.ts) runs three things at service startup, all paid once: | ||
|
|
||
| 1. Loads model topology and weights from in-memory base64 data URLs (weights are bundled into `service.wasm` at build time). | ||
| 2. Calls `tf.setBackend("webgpu")` and `tf.ready()` to spin up the WebGPU device. | ||
| 3. Runs a dummy `predict()` against zero tensors at the model's expected input shapes. This forces TF.js to compile every WGSL shader and JIT-cache every kernel up front — without it, the *first real request* would pay that ~17s cost and likely time out. | ||
|
|
||
| After warmup the service logs `[stylize-service] ready in <N>ms`. Subsequent inferences run in the tens of milliseconds because the GPU context, compiled shaders, and model weights all stay resident in the long-lived service process. | ||
|
|
||
| ### The plumbing | ||
|
|
||
| - **`wasi_webgpu: true`** in [`.wash/config.yaml`](.wash/config.yaml) tells `wash dev` to start the host with its `wasi:webgpu` runtime enabled. Without it, the service would fail to instantiate. | ||
| - **`service_file:`** in the same config tells the host to run `service/dist/service.wasm` as a service workload alongside the HTTP component. | ||
| - **[`@wasi-gfx/js-webgpu`](https://www.npmjs.com/package/@wasi-gfx/js-webgpu)** installs a `globalThis.navigator.gpu` shim that forwards browser-style WebGPU calls to the `wasi:webgpu` host import, so TensorFlow.js's WebGPU backend "just works". | ||
| - **Model weights are bundled** into `service.wasm` at build time as base64 data URLs. The service is fully self-contained at runtime — no filesystem or network fetch needed. | ||
| - **The model loads once.** Service workloads run continuously and hold state between connections, so the GPU context and the loaded TF model stay warm across requests. | ||
|
|
||
| ## Project structure | ||
|
|
||
| ``` | ||
| webgpu-tensorflow/ | ||
| ├── .wash/config.yaml # wash project config (wasi_webgpu, service_file) | ||
| ├── patches/ # patch-package fixes for componentize-js | ||
| ├── package.json # npm workspace root | ||
| │ | ||
| ├── service/ # TF/WebGPU style-transfer engine | ||
| │ ├── .wash/config.yaml # subpackage anchor for wash wit commands | ||
| │ ├── src/service.ts # wasi:cli/run TCP server | ||
| │ ├── src/image-stylizer.ts # TensorFlow.js + WebGPU model code | ||
| │ ├── models/ # bundled model weights (~52 MB) | ||
| │ ├── polyfill.js # Math.random shim, navigator.gpu placeholder | ||
| │ ├── wit/world.wit # imports wasi:webgpu + sockets, exports wasi:cli/run | ||
| │ └── wit/deps.toml # wit-deps config (webgpu WITs are not on OCI) | ||
| │ | ||
| └── component/ # HTTP front-end | ||
| ├── .wash/config.yaml # subpackage anchor for wash wit commands | ||
| ├── src/component.ts # Hono app + TCP client + static UI | ||
| ├── src/static/ # HTML, CSS, JS, sample JPEGs | ||
| └── wit/world.wit # imports sockets, exports wasi:http | ||
| ``` | ||
|
|
||
| ## Build internals | ||
|
|
||
| ### npm workspaces | ||
|
|
||
| The root `package.json` defines two npm workspaces (`service` and `component`). `npm run build` orchestrates both. | ||
|
|
||
| ### Patched componentize-js | ||
|
|
||
| Building `wasi:sockets` components requires a fix to `@bytecodealliance/componentize-js`. The spidermonkey-embedding-splicer does not generate a JavaScript class for WIT resource types declared in method-less interfaces (such as `wasi:sockets/network`). Without the class, `instanceNetwork()` and socket operations throw a `ReferenceError` at runtime. | ||
|
|
||
| The patch at `patches/@bytecodealliance+componentize-js+0.20.0.patch` injects the missing class definitions. It runs automatically via `patch-package` during `npm install`. | ||
|
|
||
| Each subpackage's `scripts/componentize.js` calls `@bytecodealliance/componentize-js` directly (rather than via `jco componentize`) to ensure the patched top-level version is used. | ||
|
|
||
| ### `.wash/config.yaml` anchors | ||
|
|
||
| The root `.wash/config.yaml` tells `wash dev` how to build, where to find the built component, and which file to load as a service. The `.wash/config.yaml` files in `service/` and `component/` anchor those directories as project roots for `wash wit` commands, which traverse up the directory tree to find their target. | ||
|
|
||
| ### Node polyfills (`unenv`) | ||
|
|
||
| TensorFlow.js was written for the browser and Node, so it pulls in things like `node:util/types`, `node:buffer`, `node:process`, etc. SpiderMonkey-in-wasm has none of those. The service rollup config wires up [`unenv`](https://github.com/unjs/unenv) to provide stub implementations, plus a hand-written [service/node-util-types-polyfill.js](service/node-util-types-polyfill.js) for `node:util/types` (which `unenv` doesn't yet ship — see [unjs/unenv#540](https://github.com/unjs/unenv/pull/540)). Without these, the service won't even load. | ||
|
|
||
| ### TF.js / wasi:webgpu compatibility shim | ||
|
|
||
| [service/src/image-stylizer.ts](service/src/image-stylizer.ts) wraps `GPUAdapter.prototype.requestDevice` to coerce `requiredFeatures` entries to strings before forwarding the call. TF.js currently passes feature names that aren't quite the strings `wasi:webgpu` expects ([tensorflow/tfjs#8639](https://github.com/tensorflow/tfjs/pull/8639)). Once the upstream PR lands, the override can go. | ||
|
|
||
| ## Known limitations | ||
|
|
||
| A few rough edges to be aware of: | ||
|
|
||
| - **`Math.random` is currently constant.** [service/polyfill.js](service/polyfill.js) overrides `globalThis.Math.random` to always return `0.5` as a temporary shim until `wizer` initializes `wasi:random` (support is coming soon upstream). Anything that depends on randomness will be deterministic in unexpected ways in the meantime. | ||
| - **The service uses `wit-deps` instead of `wash wit fetch`.** The component uses the standard `wash wit fetch` flow, but the service falls back to [`wit-deps`](https://github.com/bytecodealliance/wit-deps) because the WebGPU-related WITs aren't yet published to OCI. Once they are, the service should switch over too. | ||
| - **The resulting `service.wasm` is large.** TensorFlow.js, its WebGPU backend, the bundled WGSL shaders, the unenv Node polyfills, and ~52 MB of model weights all get statically linked, so the output is much larger than a typical wasm component — expect tens of MB rather than the usual hundreds of KB. | ||
|
|
||
| ## Customizing | ||
|
|
||
| ### Change the inference logic | ||
|
|
||
| Edit [`service/src/image-stylizer.ts`](service/src/image-stylizer.ts). The `Stylizer` class loads two models and exposes `stylize()` — adjust either to swap the model, change preprocessing, or tune output quality. | ||
|
|
||
| ### Add HTTP routes | ||
|
|
||
| Edit [`component/src/component.ts`](component/src/component.ts). Add routes to the Hono app using the standard Hono API. The `callStylizeService()` helper encapsulates the TCP client logic; extend it or add new helpers that connect to the service for additional inference endpoints. | ||
|
|
||
| ### Change the TCP port | ||
|
|
||
| The port is `const PORT = 7878` in [`service/src/service.ts`](service/src/service.ts). Update `SERVICE_PORT` in [`component/src/component.ts`](component/src/component.ts) to match. | ||
|
|
||
| ## Adding Capabilities | ||
|
|
||
| To learn how to extend this example with additional capabilities, see the [Adding Capabilities](https://wasmcloud.com/docs/tour/adding-capabilities?lang=typescript) section of the wasmCloud documentation. | ||
|
|
||
| [ts]: https://www.typescriptlang.org/ | ||
| [tfjs]: https://www.tensorflow.org/js | ||
| [tfjs-webgpu]: https://www.npmjs.com/package/@tensorflow/tfjs-backend-webgpu | ||
| [wasi-webgpu]: https://github.com/WebAssembly/wasi-gfx | ||
6 changes: 6 additions & 0 deletions
6
examples/components/webgpu-tensorflow/component/.wash/config.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Subpackage anchor — tells wash to treat this directory as the project root | ||
| # when running WIT commands. Build this subpackage via the parent: | ||
| # npm run build --workspace=component | ||
| build: | ||
| command: npm run build | ||
| component_path: dist/component.wasm |
35 changes: 35 additions & 0 deletions
35
examples/components/webgpu-tensorflow/component/package.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| { | ||
| "name": "webgpu-tensorflow-component", | ||
| "version": "0.1.0", | ||
| "description": "HTTP front-end component for the style-transfer service — serves the UI at / and forwards POST /stylize over loopback TCP", | ||
| "private": true, | ||
| "main": "dist/component.js", | ||
| "type": "module", | ||
| "scripts": { | ||
| "fetch:wit": "wash wit fetch", | ||
| "generate:types": "rimraf generated/types && jco guest-types wit/ -o generated/types", | ||
| "setup:wit": "npm run fetch:wit && npm run generate:types", | ||
| "build:ts": "rollup -c", | ||
| "build:component": "node scripts/componentize.js", | ||
| "build": "npm run setup:wit && npm run build:ts && npm run build:component" | ||
| }, | ||
| "keywords": [], | ||
| "author": "", | ||
| "license": "Apache-2.0", | ||
| "dependencies": { | ||
| "@bytecodealliance/jco-std": "^0.1.3", | ||
| "hono": "^4.12.14", | ||
| "zod": "^4.3.6" | ||
| }, | ||
| "devDependencies": { | ||
| "@bytecodealliance/jco": "^1.17.9", | ||
| "@rollup/plugin-commonjs": "^29.0.0", | ||
| "@rollup/plugin-json": "^6.1.0", | ||
| "@rollup/plugin-node-resolve": "^16.0.3", | ||
| "@rollup/plugin-typescript": "^12.3.0", | ||
| "@rollup/plugin-url": "^8.0.2", | ||
| "rimraf": "^6.1.2", | ||
| "rollup": "^4.57.1", | ||
| "typescript": "^5.9.3" | ||
| } | ||
| } |
29 changes: 29 additions & 0 deletions
29
examples/components/webgpu-tensorflow/component/rollup.config.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| import nodeResolve from "@rollup/plugin-node-resolve"; | ||
| import commonjs from "@rollup/plugin-commonjs"; | ||
| import json from "@rollup/plugin-json"; | ||
| import url from "@rollup/plugin-url"; | ||
| import typescript from "@rollup/plugin-typescript"; | ||
|
|
||
| const MEGABYTE = 1024 * 1024; | ||
|
|
||
| export default { | ||
| input: "src/component.ts", | ||
| external: /wasi:.*/, | ||
| output: { | ||
| file: "dist/component.js", | ||
| format: "esm", | ||
| inlineDynamicImports: true, | ||
| }, | ||
| plugins: [ | ||
| url({ | ||
| // Inline the static UI assets as base64 data URLs | ||
| include: ["./src/static/**"], | ||
| exclude: ["./src/static/static.ts"], | ||
| limit: MEGABYTE * 10, | ||
| }), | ||
| typescript(), | ||
| json(), | ||
| nodeResolve(), | ||
| commonjs({ transformMixedEsModules: true }), | ||
| ], | ||
| }; |
33 changes: 33 additions & 0 deletions
33
examples/components/webgpu-tensorflow/component/scripts/componentize.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /** | ||
| * Build script: componentizes dist/component.js → dist/component.wasm. | ||
| * | ||
| * `jco componentize` can't be used. This world imports wasi:[email protected] (pulled | ||
| * in by wasi-gfx) and other WASI packages older than 0.2.10. jco detects | ||
| * that and silently falls back to a bundled, aliased copy of componentize-js | ||
| * @0.19.3 at node_modules/@bytecodealliance/componentize-js-0-19-3/, which | ||
| * patch-package never touches. | ||
| * | ||
| * Calling componentize() directly forces the patched top-level | ||
| * @bytecodealliance/componentize-js. The patch fixes a splicer bug where | ||
| * WIT resource types in interfaces with no callable functions (e.g. | ||
| * wasi:sockets/network) get no JS class generated, causing ReferenceError | ||
| * at runtime. | ||
| */ | ||
|
|
||
| import { componentize } from '@bytecodealliance/componentize-js'; | ||
| import { writeFile } from 'fs/promises'; | ||
| import { resolve, join, dirname } from 'path'; | ||
| import { fileURLToPath } from 'url'; | ||
|
|
||
| const __dirname = dirname(fileURLToPath(import.meta.url)); | ||
| const root = resolve(__dirname, '..'); | ||
|
|
||
| const result = await componentize({ | ||
| sourcePath: join(root, 'dist', 'component.js'), | ||
| witPath: join(root, 'wit'), | ||
| worldName: 'component', | ||
| }); | ||
|
|
||
| const outPath = join(root, 'dist', 'component.wasm'); | ||
| await writeFile(outPath, result.component); | ||
| console.log(`OK Successfully written ${outPath}.`); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding a Known limitations section before the "Adding Capabilities" link covering the rough edges a copy-paster will hit. Suggested content:
Math.randomis currently constant.polyfil.jsoverridesglobalThis.Math.randomto return0.5as a temporary shim untilwizerinitializeswasi:random. We should probably flag this.wit-depsinstead ofwash wit fetch. Mentioned above, but we should probably flag this explicitly.component.wasmis large. Might be worth noting and explaining why.