2021-04-27 07:04:25 +00:00
# ONNX Runtime Node.js Binding
2020-05-05 18:45:12 +00:00
2020-05-27 20:30:22 +00:00
ONNX Runtime Node.js binding enables Node.js applications to run ONNX model inference.
## Usage
Install the latest stable version:
```
2021-04-27 07:04:25 +00:00
npm install onnxruntime-node
2020-05-27 20:30:22 +00:00
```
2021-05-21 18:42:36 +00:00
Refer to [ONNX Runtime JavaScript examples ](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js ) for samples and tutorials.
2020-05-27 20:30:22 +00:00
2020-05-19 03:08:36 +00:00
## Requirements
2020-05-05 18:45:12 +00:00
2020-05-27 20:30:22 +00:00
ONNXRuntime works on Node.js v12.x+ or Electron v5.x+.
2020-05-05 18:45:12 +00:00
2020-05-27 20:30:22 +00:00
Following platforms are supported with pre-built binaries:
2020-05-05 18:45:12 +00:00
- Windows x64 CPU NAPI_v3
- Linux x64 CPU NAPI_v3
- MacOS x64 CPU NAPI_v3
2021-04-16 08:33:10 +00:00
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 ](https://www.onnxruntime.ai/docs/how-to/build.html#apis-and-language-bindings ) for building ONNX Runtime Node.js binding locally.
2020-05-19 03:08:36 +00:00
## License
2020-05-27 20:30:22 +00:00
2021-05-04 01:31:55 +00:00
License information can be found [here ](https://github.com/microsoft/onnxruntime/blob/master/README.md#license ).
