Get started with ORT for JavaScript
ONNX Runtime JavaScript API is the unified interface used by ONNX Runtime Node.js binding, ONNX Runtime Web and ONNX Runtime for React Native.
Contents
ONNX Runtime Node.js binding
Install
# install latest release version
npm install onnxruntime-node
Import
// use ES6 style import syntax (recommended)
import * as ort from 'onnxruntime-node';
// or use CommonJS style import syntax
const ort = require('onnxruntime-node');
Examples
Supported Versions
Node.js v12.x+ or Electron v5.x+
ONNX Runtime Web
Install
# install latest release version
npm install onnxruntime-web
# install nightly build dev version
npm install onnxruntime-web@dev
Import
// use ES6 style import syntax (recommended)
import * as ort from 'onnxruntime-web';
// or use CommonJS style import syntax
const ort = require('onnxruntime-web');
ONNX Runtime Web can also be imported via a script tag in a HTML file, from a CDN server. See examples below for detail.
Examples
Supported Versions
mainstream modern browsers on Windows, macOS, Android and iOS.
ONNX Runtime for React Native
Install
# install latest release version
npm install onnxruntime-react-native
Import
// use ES6 style import syntax (recommended)
import * as ort from 'onnxruntime-react-native';
// or use CommonJS style import syntax
const ort = require('onnxruntime-react-native');
Builds
Builds are published to npm and can be installed using npm install
Package | Artifact | Description | Supported Platforms |
---|---|---|---|
Node.js binding | onnxruntime-node | CPU (Release) | Windows x64 CPU NAPI_v3, Linux x64 CPU NAPI_v3, MacOS x64 CPU NAPI_v3 |
Web | onnxruntime-web | CPU and GPU | Browsers (wasm, webgl), Node.js (wasm) |
React Native | onnxruntime-react-native | CPU | Android, iOS |
For Node.js binding, to use on platforms without pre-built binaries, you can build Node.js binding from source and consume using npm install <onnxruntime_repo_root>/js/node/
.
API Reference
See ONNX Runtime JavaScript API for API reference.
See also:
-
Typescript declarations for Inference Session, Tensor and Environment Flags for reference.