@jax-js/jax 0.1.9 → 0.1.11

package/README.md

@@ -43,18 +43,37 @@ way to get started on a blank HTML page.
 </script>
 ```
 
+### Platforms
+
+This table refers to latest versions of each browser. WebGPU has gained wide support in browsers as
+of late 2025.
+
+| Platform            | CPU (Wasm) | GPU (WebGPU)   | GPU (WebGL) |
+| ------------------- | ---------- | -------------- | ----------- |
+| Chrome / Edge       | ✅         | ✅             | ✅          |
+| Firefox             | ✅         | ✅ - macOS 26+ | ✅          |
+| Safari              | ✅         | ✅ - macOS 26+ | ✅          |
+| iOS                 | ✅         | ✅ - iOS 26+   | ✅          |
+| Chrome for Android  | ✅         | ✅             | ✅          |
+| Firefox for Android | ✅         | ❌             | ✅          |
+| Node.js             | ✅         | ❌             | ❌          |
+| Deno                | ✅         | ✅ - async     | ❌          |
+
 ## Examples
 
-Cool things that the community has made with jax-js:
+Community usage:
 
+- [**autoresearch-webgpu**: autoresesarch, in the browser](https://autoresearch.lucasgelfond.online/)
 - [**tanh.xyz**: Interactive ML visualizations](https://tanh.xyz/)
+- [**jax-js-bayes**: Declarative Bayesian modeling library](https://github.com/StefanSko/jax-js-bayes)
 
-And some more demos on the official website.
+Demos on the jax-js website:
 
 - [Training neural networks on MNIST](https://jax-js.com/mnist)
 - [Voice cloning: Kyutai Pocket TTS](https://jax-js.com/tts)
 - [CLIP embeddings for books in-browser](https://jax-js.com/mobileclip)
 - [Object detection: DETR ResNet-50 (ONNX)](https://jax-js.com/detr-resnet-50)
+- [Fluid simulation (Navier-Stokes)](https://jax-js.com/fluid-sim)
 - [In-browser REPL](https://jax-js.com/repl)
 - [Matmul benchmark](https://jax-js.com/bench/matmul)
 - [Conv2d benchmark](https://jax-js.com/bench/conv2d)
@@ -292,7 +311,9 @@ and determines how to execute compiled operations on them.
 There are currently 4 devices in jax-js:
 
 - `cpu`: Slow, interpreted JS, only meant for debugging.
-- `wasm`: [WebAssembly](https://webassembly.org/), currently single-threaded and blocking.
+- `wasm`: [WebAssembly](https://webassembly.org/), multi-threaded when
+  [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer)
+  is available.
 - `webgpu`: [WebGPU](https://developer.mozilla.org/en-US/docs/Web/API/WebGPU_API), available on
   [supported browsers](https://caniuse.com/webgpu) (Chrome, Firefox, Safari, iOS).
 - `webgl`: [WebGL2](https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext), via
@@ -337,6 +358,8 @@ self-contained way in other projects.
 
 ### Performance
 
+To see per-kernel traces in browser development tools, call `jax.profiler.startTrace()`.
+
 The WebGPU runtime includes an ML compiler with tile-aware optimizations, tuned for indiidual
 browsers. Also, this library uniquely has the `jit()` feature that fuses operations together and
 records an execution graph. jax-js achieves **over 7000 GFLOP/s** for matrix multiplication on an
@@ -367,19 +390,6 @@ pnpm install
 pnpm run build:watch
 ```
 
-The `pnpm install` command automatically sets up Git hooks via
-[Husky](https://typicode.github.io/husky/). Pre-commit hooks will run ESLint and Prettier on staged
-files to ensure code quality.
-
-You can also run linting and formatting manually:
-
-```bash
-pnpm lint          # Run ESLint
-pnpm format        # Format all files with Prettier
-pnpm format:check  # Check formatting without writing
-pnpm check         # Run TypeScript type checking
-```
-
 Then you can run tests in a headless browser using [Vitest](https://vitest.dev/).
 
 ```bash
@@ -396,6 +406,15 @@ To start a Vite dev server running the website, demos and REPL:
 pnpm -C website dev
 ```
 
+You can run the linter, code formatter, and type checker with:
+
+```bash
+pnpm lint          # Run ESLint
+pnpm format        # Format all files with Prettier
+pnpm format:check  # Check formatting without writing
+pnpm check         # Run TypeScript type checking
+```
+
 ## Future work / help wanted
 
 Contributions are welcomed! Some fruitful areas to look into:
@@ -403,9 +422,6 @@ Contributions are welcomed! Some fruitful areas to look into:
 - Adding support for more JAX functions and operations, see [compatibility table](./FEATURES.md).
 - Improving performance of the WebGPU and Wasm runtimes, generating better kernels, and using SIMD
   and multithreading. (Even single-threaded Wasm could be ~20x faster.)
-- Adding support for `jax.profiling`, in particular the start and end trace functions. We should be
-  able to generate `traceEvents` from backends (especially on GPU, with precise timestamp queries)
-  to help with model performance debugging.
 - Helping the JIT compiler to fuse operations in more cases, like `tanh` branches.
 - Making a fast transformer inference engine, comparing against onnxruntime-web.