From b1085b51ca4c730c7a15ee8525c72d790ba75ddf Mon Sep 17 00:00:00 2001 From: Yulong Wang <7679871+fs-eire@users.noreply.github.com> Date: Mon, 29 Apr 2024 17:56:23 -0700 Subject: [PATCH] [js/web] update README (#20492) ### Description Update README.md in /js/web/ - update compatibility table - update links to onnxruntime.ai --- js/web/README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/js/web/README.md b/js/web/README.md index 906c78a1b7ec4..56182d5ed35b8 100644 --- a/js/web/README.md +++ b/js/web/README.md @@ -18,7 +18,11 @@ See [Compatibility](#Compatibility) and [Operators Supported](#Operators) for a ## Usage -Refer to [ONNX Runtime JavaScript examples](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js) for samples and tutorials. +- See [Get started](https://onnxruntime.ai/docs/get-started/with-javascript/web.html) as a landing page for ONNX Runtime Web documentation. + +- Refer to [ONNX Runtime JavaScript examples](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js) for samples and tutorials. + +- See also [ONNX Runtime Web API reference](https://onnxruntime.ai/docs/api/js/index.html) for detailed API documentation. ## Documents @@ -34,13 +38,18 @@ Refer to the following links for development information: ### Compatibility -| OS/Browser | Chrome | Edge | Safari | Electron | Node.js | -| :--------------: | :---------: | :---------: | :---------: | :---------: | :-----: | -| Windows 10 | wasm, webgl | wasm, webgl | - | wasm, webgl | wasm | -| macOS | wasm, webgl | wasm, webgl | wasm, webgl | wasm, webgl | wasm | -| Ubuntu LTS 18.04 | wasm, webgl | wasm, webgl | - | wasm, webgl | wasm | -| iOS | wasm, webgl | wasm, webgl | wasm, webgl | - | - | -| Android | wasm, webgl | wasm, webgl | - | - | - | +| EPs/Browsers | Chrome/Edge (Windows) | Chrome/Edge (Android) | Chrome/Edge (MacOS) | Chrome/Edge (iOS) | Safari (MacOS) | Safari (iOS) | Firefox (Windows) | Node.js | +| ----------------- | --------------------- | --------------------- | ------------------- | ----------------- | ----------------- | ----------------- | ----------------- | ----------------- | +| WebAssembly (CPU) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️\[1] | +| WebGPU | ✔️\[2] | ✔️\[3] | ✔️ | ❌ | ❌ | ❌ | ❌ | ❌ | +| WebGL | ✔️\[4] | ✔️\[4] | ✔️\[4] | ✔️\[4] | ✔️\[4] | ✔️\[4] | ✔️\[4] | ❌ | +| WebNN | ✔️\[5] | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | + +- \[1]: Node.js only support single-threaded `wasm` EP. +- \[2]: WebGPU requires Chromium v113 or later on Windows. Float16 support requires Chrome v121 or later, and Edge v122 or later. +- \[3]: WebGPU requires Chromium v121 or later on Windows. +- \[4]: WebGL support is in maintenance mode. It is recommended to use WebGPU for better performance. +- \[5]: Requires to launch browser with commandline flag `--enable-experimental-web-platform-features`. ### Operators