onnxruntime/nodejs/examples/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

30 lines
700 B
Markdown

# Examples
This folder contains several examples that demonstrate how to use onnxruntime Node.js binding.
## Examples List
### [01 Basic Usage](./01_basic-usage/README.md)
This example is a demonstration of basic usage of ONNX Runtime Node.js binding.
### [02 Create Tensor](./02_create-tensor/README.md)
This example is a demonstration of basic usage of creating tensors.
<!--
### [03 Create Tensor (Advanced)](./03_create-tensor-advanced/README.md)
This example is a demonstration of advanced usage of creating tensors.
-->
### [04 Create InferenceSession](./04_create-inference-session/README.md)
## Usage
In each example's implementation subdirectory, run
```
npm install
node ./
```