From b852b73e84ff1f2d4e0462e682aac026b492b2e0 Mon Sep 17 00:00:00 2001 From: Yulong Wang Date: Fri, 21 May 2021 11:42:36 -0700 Subject: [PATCH] [js][doc] update some part of documents. (#7768) * [js][doc] update some part of documents. * resolve comments --- js/README.md | 2 +- js/node/README.md | 2 +- js/web/README.md | 96 ++--------------------------------------------- 3 files changed, 6 insertions(+), 94 deletions(-) diff --git a/js/README.md b/js/README.md index 488b025cc6..cbc7fb588f 100644 --- a/js/README.md +++ b/js/README.md @@ -138,7 +138,7 @@ Node.js v12+ (recommended v14+) ./build.sh --config Release --build_wasm --skip_tests --disable_wasm_exception_catching --disable_rtti ``` - To build with multi-thread support, append flag ` --enable_wasm_threads` to the command. + To build with multi-thread support, append flag ` --enable_wasm_threads` to the command. Make sure to build both single-thread and multi-thread before next step. 3. Copy following files from build output folder to `/js/web/dist/`: diff --git a/js/node/README.md b/js/node/README.md index c5bec8043f..d2f616696c 100644 --- a/js/node/README.md +++ b/js/node/README.md @@ -10,7 +10,7 @@ Install the latest stable version: npm install onnxruntime-node ``` -Refer to [Node.js samples](../../samples/nodejs/README.md) for samples and tutorials. +Refer to [ONNX Runtime JavaScript examples](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js) for samples and tutorials. ## Requirements diff --git a/js/web/README.md b/js/web/README.md index 40d8fab5df..a59c84db11 100644 --- a/js/web/README.md +++ b/js/web/README.md @@ -16,105 +16,17 @@ ONNX Runtime Web can run on both CPU and GPU. For running on CPU, [WebAssembly]( See [Compatibility](#Compatibility) and [Operators Supported](#Operators) for a list of platforms and operators ONNX Runtime Web currently supports. -## Getting Started +## Usage -There are multiple ways to use ONNX Runtime Web in a project: - -### Using ` - - - - -``` - - - -### Using NPM and bundling tools - -Modern browser based applications are usually built by frameworks like [Angular](https://angular.io/), [React](https://reactjs.org/), [Vue.js](https://vuejs.org/) and so on. This solution usually builds the source code into one or more bundle file(s). The following TypeScript example shows how to use ONNX Runtime Web in an async context: - -1. Import `Tensor` and `InferenceSession`. - -```ts -import { Tensor, InferenceSession } from "onnxruntime-web"; -``` - -2. Create an instance of `InferenceSession` and load ONNX model. - -```ts -// use the following in an async method -const url = "./data/models/resnet/model.onnx"; -const session = await InferenceSession.create(url); -``` - -3. Create your input Tensor(s) similar to the example below. You need to do any pre-processing required by - your model at this stage. For that refer to the documentation of the model you have: - -```javascript -// creating an array of input Tensors is the easiest way. For other options see the API documentation -const input0 = new Tensor(new Float32Array([1.0, 2.0, 3.0, 4.0]), [2, 2]); -``` - -4. Run the model with the input Tensors. The output Tensor(s) are available once the run operation is complete: - -```javascript -// run this in an async method: -// assume model's input name is 'input_0' and output name is 'output_0' -const outputs = await session.run({ input_0: input0 }); -const outputTensor = outputs.output_0; -``` - -5. Bundle your code. All web application frameworks offer bundling tools and instructions. Specifically, you can specify onnxruntime-web as an external dependency: - -```js - // a webpack example - externals: { - 'onnxruntime-web': 'ort', // add this line in your webpack.config.js - // ... - } -``` - -so that you can consume the file `ort.min.js` from a CDN provider demonstrated as above. - - +Refer to [ONNX Runtime JavaScript examples](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js) for samples and tutorials. ## Documents ### Developers - +Refer to [Using VSCode](../README.md#Using-VSCode) for setting up development environment. -For information on ONNX.js development, please check [Development](./docs/development.md) - -For API reference, please check [API](./docs/api.md). +For information about building ONNX Runtime Web development, please check [Build](../README.md#build-2). ### Getting ONNX models