onnxruntime/nodejs/README.md
Yulong Wang 5dfc91db51
Node.js binding for ONNX Runtime (#3613)
* initial commit for Node.js binding

* add c++ code

* add inference session impl

* e2e working

* add settings.json

* add test data

* adjust binding declaration

* refine tensor constructor declaration

* update tests

* enable onnx tests

* simply refine readme

* refine cpp impl

* refine tests

* formatting

* add linting

* move bin folder

* fix linux build

* manually update test filter list

* update C++ API headers: fix crash in release build

* make (manually) prebuild work

* add test into prepack script

* specify prebuild runtime type (N-API)

* build.ts: update rebuild and include regex

* fix lazy load on electron.js

* update dev version, git link and binary host

* support session options and run options

* bump dev version

* update README

* add 1 example

* move folder

* adjust path

* update document for examples

* rename example 01

* add example 02

* add session option: log severity level

* add example 04

* resolve comments

* fix typo

* remove double guard in header files

* add copyright banner

* move BUILD outside from README

* consume test filter list from onnxruntime
2020-05-05 11:45:12 -07:00

35 lines
624 B
Markdown

# ONNX Runtime Node.js API
This directory contains the Node.js binding for the ONNX runtime.
## Installation
Install the latest stable version:
```
npm install onnxruntime
```
Install the latest dev version:
```
npm install onnxruntime@dev
```
## Get Started
Refer to [examples](./examples/README.md) for usage and instructions.
## Supported Platforms
- Windows x64 CPU NAPI_v3
- Linux x64 CPU NAPI_v3
- MacOS x64 CPU NAPI_v3
## Building
Refer to [BUILD](./BUILD.md) for instructions to build ONNX Runtime Node.js binding.
## License
[MIT License](https://github.com/Microsoft/onnxruntime/blob/master/LICENSE)