saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-05-23 22:13:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/js/web
History
Yulong Wang abdc31de40
[js] change default formatter for JavaScript/TypeScript from clang-format to Prettier (#21728) 
### Description

See
454996d496
for manual changes (excluded auto-generated formatting changes)

### Why

Because the toolsets for old clang-format is out-of-date. This reduces
the development efficiency.

- The NPM package `clang-format` is already in maintenance mode. not
updated since 2 years ago.
- The VSCode extension for clang-format is not maintained for a while,
and a recent Node.js security update made it not working at all in
Windows.

No one in community seems interested in fixing those.

Choose Prettier as it is the most popular TS/JS formatter.

### How to merge

It's easy to break the build:
- Be careful of any new commits on main not included in this PR.
- Be careful that after this PR is merged, other PRs that already passed
CI can merge.

So, make sure there is no new commits before merging this one, and
invalidate js PRs that already passed CI, force them to merge to latest.
2024-08-14 16:51:22 -07:00
..
docs add Gelu opset-20 to webgpu (#21725) 2024-08-14 09:45:05 -07:00
lib [js] change default formatter for JavaScript/TypeScript from clang-format to Prettier (#21728) 2024-08-14 16:51:22 -07:00
script [js] change default formatter for JavaScript/TypeScript from clang-format to Prettier (#21728) 2024-08-14 16:51:22 -07:00
test [js] change default formatter for JavaScript/TypeScript from clang-format to Prettier (#21728) 2024-08-14 16:51:22 -07:00
.gitignore [js/web] optimize module export and deployment (#20165) 2024-05-20 09:51:16 -07:00
.npmignore [js/web] optimize module export and deployment (#20165) 2024-05-20 09:51:16 -07:00
karma.conf.js [js] change default formatter for JavaScript/TypeScript from clang-format to Prettier (#21728) 2024-08-14 16:51:22 -07:00
package-lock.json [js/web] allow op test to use f16 type for inputs/outputs (#21664) 2024-08-08 09:56:37 -07:00
package.json [js/web] allow op test to use f16 type for inputs/outputs (#21664) 2024-08-08 09:56:37 -07:00
README.md [WebNN EP] Add WebNN operators doc to README.md (#20734) 2024-05-20 14:57:40 -07:00
tsconfig.json [js/web] fix ESLint by excluding generated .js from tsconfig.json (#18634) 2023-11-30 09:50:47 -08:00
types.d.ts [js/web] optimize module export and deployment (#20165) 2024-05-20 09:51:16 -07:00

README.md

ONNX Runtime Web

ONNX Runtime Web is a Javascript library for running ONNX models on browsers and on Node.js.

ONNX Runtime Web has adopted WebAssembly and WebGL technologies for providing an optimized ONNX model inference runtime for both CPUs and GPUs.

Why ONNX models

The Open Neural Network Exchange (ONNX) is an open standard for representing machine learning models. The biggest advantage of ONNX is that it allows interoperability across different open source AI frameworks, which itself offers more flexibility for AI frameworks adoption.

Why ONNX Runtime Web

With ONNX Runtime Web, web developers can score models directly on browsers with various benefits including reducing server-client communication and protecting user privacy, as well as offering install-free and cross-platform in-browser ML experience.

ONNX Runtime Web can run on both CPU and GPU. On CPU side, WebAssembly is adopted to execute the model at near-native speed. ONNX Runtime Web compiles the native ONNX Runtime CPU engine into WebAssembly backend by using Emscripten, so it supports most functionalities native ONNX Runtime offers, including full ONNX operator coverage, multi-threading, ONNX Runtime Quantization as well as ONNX Runtime Mobile. For performance acceleration with GPUs, ONNX Runtime Web leverages WebGL, a popular standard for accessing GPU capabilities. We are keeping improving op coverage and optimizing performance in WebGL backend.

See Compatibility and Operators Supported for a list of platforms and operators ONNX Runtime Web currently supports.

Usage

Documents

Development

Refer to the following links for development information:

Compatibility

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-features=WebMachineLearningNeuralNetwork.

Operators

WebAssembly backend

ONNX Runtime Web currently support all operators in ai.onnx and ai.onnx.ml.

WebGL backend

ONNX Runtime Web currently supports a subset of operators in ai.onnx operator set. See webgl-operators.md for a complete, detailed list of which ONNX operators are supported by WebGL backend.

WebGPU backend

WebGPU backend is still an experimental feature. See webgpu-operators.md for a detailed list of which ONNX operators are supported by WebGPU backend.

WebNN backend

WebNN backend is still an experimental feature. See webnn-operators.md for a detailed list of which ONNX operators are supported by WebNN backend.

License

License information can be found here.