mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-15 18:23:41 +00:00
9e8d795344
* Update ORT Mobile documentation for both the pre-built package and custom build usage Add info on pre-built package and CoreML EP Refer to operator kernels and contrib ops documentation in github so we can point to the version specific content Tweak some aspects like not specifying nav_order in places (items sort alphabetically by default) * merge previous unmerged ios doc updates * Address PR comments * Minor tweaks * Address PR comments Co-authored-by: Guoyu Wang <wanggy@outlook.com>
37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
---
|
|
title: Node.js API
|
|
parent: API docs
|
|
grand_parent: Reference
|
|
---
|
|
|
|
# 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](https://github.com/microsoft/onnxruntime/blob/master/nodejs/lib/inference-session.ts) and refer to [samples](#samples) for reference.
|
|
|
|
## Builds
|
|
Builds are published to **npm** and can be installed using `npm install`
|
|
|
|
| Artifact | Description | Supported Platforms |
|
|
|----------- |-------------|---------------------|
|
|
|[onnxruntime](https://www.npmjs.com/package/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]((../../how-to/build.md#apis-and-language-bindings)) and consume using `npm install <onnxruntime_repo_root>/nodejs/`.
|
|
|
|
## Samples
|
|
See [Tutorials: Basics - NodeJS](../../tutorials/inferencing/api-basics.md#nodejs)
|
|
|
|
|