mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-05-16 21:00:14 +00:00

History

Yulong Wang c144acc534 Replace 'master' branch ref to 'main' in the code (#12547 )		2022-08-22 10:48:12 -07:00
..
lib	[js] upgrade async@3.2.3 /js/ (#11421 )	2022-05-03 23:41:36 -07:00
script	Add Node.js binding support to packaging pipeline (#9577 )	2021-11-05 15:29:40 -07:00
src	[js] upgrade async@3.2.3 /js/ (#11421 )	2022-05-03 23:41:36 -07:00
test	prepare test folder from GitHub (#12220 )	2022-07-20 22:01:08 -07:00
.gitignore	[node.js binding] aggregate binaries for multiple platforms in single NPM package (#9501 )	2021-10-25 20:16:10 -07:00
.npmignore	[node.js binding] aggregate binaries for multiple platforms in single NPM package (#9501 )	2021-10-25 20:16:10 -07:00
CMakeLists.txt	[node.js binding] enable CI for macOS arm64 (#9532 )	2021-10-26 16:42:19 -07:00
package-lock.json	[js/node] upgrade terser version (#12351 )	2022-08-02 15:50:44 -07:00
package.json	Bump ort version number (#11948 )	2022-07-22 12:55:53 -07:00
README.md	Replace 'master' branch ref to 'main' in the code (#12547 )	2022-08-22 10:48:12 -07:00
tsconfig.json	optimize js package folder structure (#7989 )	2021-06-08 16:49:06 -07:00

README.md

ONNX Runtime Node.js Binding

ONNX Runtime Node.js binding enables Node.js applications to run ONNX model inference.

Usage

Install the latest stable version:

npm install onnxruntime-node

Refer to ONNX Runtime JavaScript examples for samples and tutorials.

Requirements

ONNXRuntime works on Node.js v12.x+ or Electron v5.x+.

Following platforms are supported with pre-built binaries:

Windows x64 CPU NAPI_v3
Linux x64 CPU NAPI_v3
MacOS x64 CPU NAPI_v3

To use on platforms without pre-built binaries, you can build Node.js binding from source and consume it by npm install <onnxruntime_repo_root>/js/node/. See also instructions for building ONNX Runtime Node.js binding locally.

License

License information can be found here.