mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-14 18:12:05 +00:00

[doc] Update "Get Started" page for ORT web (#19568 )

### Description
This PR re-arranges documentation of ORT web.

Current doc: https://onnxruntime.ai/docs/
Change preview: https://fs-eire.github.io/onnxruntime/docs/

- split `Doc -> Get Started -> JavaScript` from single page into
multiple pages, to make it easier to split from web, node and
react-native
- remove `Doc -> Get Started -> with Web`. The page was a few links and
now they are moved to other places
- add a few contents into `Doc -> Get Started -> JavaScript -> Web`. Now
this is the main page for ORT web doc.
- rename `Tutorials -> deploy on Web` to `Tutorials -> Web`. "deploy" is
confusing as it's not the accurate term to describe the content.

=================================================================


### Discussions:
TBD


=================================================================


### ORT web documentation work item list:

- [ ] Update `Get Started` page for ORT web at onnxruntime.ai **( this
PR )**
    - to make it easier for users to navigate
- [ ] Update `Tutorials` page for ORT web at onnxruntime.ai
- The purpose of this page is unclear. It contains descriptive
information and step-by-step instructions on an E2E examples. It can be
a good Blog, but not good for documentation, which usually has a
well-structured content.
- The [index
page](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/) has
duplicated contents with its child page ["Build a web application with
ONNX
Runtime"](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/build-web-app.html)
    - Some contents are out-of-dated.
- [ ] Update [`API Usage -
SessionOptions`](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js/api-usage_session-options)
on onnxruntime-inference-examples repo.
- Add explaination and examples if necessary for all new WebGPU session
options.
- [ ] Update [`API usage - ort.env
flags`](https://github.com/microsoft/onnxruntime-inference-examples/blob/main/js/api-usage_ort-env-flags)
on onnxruntime-inference-examples repo.
    - Add all newly introduced flags.

2024-02-22 16:41:35 -08:00

1.4 KiB

Raw Blame History

title	parent	grand_parent	has_children	nav_order
Node.js binding	JavaScript	Get Started	false	2

Get started with ONNX Runtime Node.js binding

{: .no_toc }

TOC placeholder {:toc}

Install

# install latest release version
npm install onnxruntime-node

Import

// use ES6 style import syntax (recommended)
import * as ort from 'onnxruntime-node';

// or use CommonJS style import syntax
const ort = require('onnxruntime-node');

Examples

Follow the Quick Start instructions for ONNX Runtime Node.js binding.

Supported Versions

The following table lists the supported versions of ONNX Runtime Node.js binding provided with pre-built binaries.

EPs/Platforms	Windows x64	Windows arm64	Linux x64	Linux arm64	MacOS x64	MacOS arm64
CPU	✔️	✔️	✔️	✔️	✔️	✔️
DirectML	✔️	✔️	❌	❌	❌	❌
CUDA	❌	❌	✔️^[1]	❌	❌	❌

[1]: CUDA v11.8.

For platforms not on the list or want a custom build, you can build Node.js binding from source and consume using npm install <onnxruntime_repo_root>/js/node/.

1.4 KiB Raw Blame History