onnxruntime/docs/reference/api/nodejs-api.md
Faith Xu 0f6f0d9bbb
Major updates/restructure for documentation (#7609)
* Update documentation.

Updates documentation.

* Update tf-get-started.md
2021-05-10 15:19:37 -07:00

1.2 KiB

title parent grand_parent nav_order
Node.js API API docs Reference 4

ONNX Runtime Node.js API

{: .no_toc }

ONNX Runtime Node.js binding enables Node.js applications to run ONNX model inference.

Contents

{: .no_toc }

  • TOC placeholder {:toc}

Supported Versions

Node.js v12.x+ or Electron v5.x+

API Reference

See Typescript declarations and refer to samples for reference.

Builds

Builds are published to npm and can be installed using npm install

Artifact Description Supported Platforms
onnxruntime CPU (Release) Windows x64 CPU NAPI_v3, Linux x64 CPU NAPI_v3, MacOS x64 CPU NAPI_v3
onnxruntime@dev CPU (Dev) 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 using npm install <onnxruntime_repo_root>/nodejs/.

Samples

See Tutorials: Basics - NodeJS