mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-16 21:00:14 +00:00
009f342caf
* working on re-organizing js code for ortweb * remove dup files * move folder * fix common references * fix common es5 * add webpack to common * split interfact/impl * use cjs for node * add npmignore for common * update sourcemap config for common * update node * adjust folder/path in CI and build * update folder * nit: readme * add bundle for dev * correct nodejs paths * enable ORT_API_MANUAL_INIT * set name for umd library * correct name for commonjs export * add priority into registerBackend() * fix npm ci pwd * update eslintrc * revise code * revert package-lock lockfileVersion 2->1 * update prebuild * resolve comments * update document * revise eslint config * update eslint for typescript rules * revert changes by mistake in backend.ts * add env * resolve comments
35 lines
945 B
Markdown
35 lines
945 B
Markdown
# ONNX Runtime Node.js API
|
|
|
|
ONNX Runtime Node.js binding enables Node.js applications to run ONNX model inference.
|
|
|
|
## Usage
|
|
|
|
Install the latest stable version:
|
|
|
|
```
|
|
npm install onnxruntime
|
|
```
|
|
|
|
Install the latest dev version:
|
|
|
|
```
|
|
npm install onnxruntime@dev
|
|
```
|
|
|
|
Refer to [Node.js samples](../../samples/nodejs/README.md) 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](https://www.onnxruntime.ai/docs/how-to/build.html#apis-and-language-bindings) for building ONNX Runtime Node.js binding locally.
|
|
|
|
## License
|
|
|
|
License information can be found [here](../README.md#license).
|