onnxruntime/nodejs
Faith Xu b8a255e1b5
Doc Updates for Build (#3976)
* Initial update of readme

* Readme updates

* Review of consolidated README (#3930)

* Proposed updates for readme (#3953)

I found some of the information was duplicated within the doc, so attempted to streamline

* Fix links

* More updates

- fix build instructions
- nodejs doc reorganization
- roadmap update
- version fixes

* Update ORT Server build instructions

* More doc cleanup

* fix python dev notes name

* Update nodejs and some links

* sync eigen version back to master

* Minor fixes

* add nodsjs to sample table of content

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* address PR feedback

* address PR feedback

* nodejs build instruction

* Update Java instructions to include gradle

* Roadmap refresh

Reformat some data, fix link, minor rewording

* Clarify Visual C++ runtime req

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
Co-authored-by: Prasanth Pulavarthi <prasantp@microsoft.com>
Co-authored-by: manashgoswami <magoswam@microsoft.com>
2020-05-18 20:08:36 -07:00
..
.vscode Node.js binding for ONNX Runtime (#3613) 2020-05-05 11:45:12 -07:00
lib [Node.js API] optimize prebuild (#3844) 2020-05-06 15:48:13 -07:00
script [Node.js API] optimize prebuild (#3844) 2020-05-06 15:48:13 -07:00
src [Node.js binding] fix linux build (#3927) 2020-05-14 12:37:32 -07:00
test Node.js binding for ONNX Runtime (#3613) 2020-05-05 11:45:12 -07:00
.clang-format Node.js binding for ONNX Runtime (#3613) 2020-05-05 11:45:12 -07:00
.eslintrc.js Node.js binding for ONNX Runtime (#3613) 2020-05-05 11:45:12 -07:00
.gitignore Node.js binding for ONNX Runtime (#3613) 2020-05-05 11:45:12 -07:00
.npmignore Node.js binding for ONNX Runtime (#3613) 2020-05-05 11:45:12 -07:00
CMakeLists.txt [Node.js binding] fix linux build (#3927) 2020-05-14 12:37:32 -07:00
package-lock.json [Node.js API] optimize prebuild (#3844) 2020-05-06 15:48:13 -07:00
package.json [Node.js API] optimize prebuild (#3844) 2020-05-06 15:48:13 -07:00
README.md Doc Updates for Build (#3976) 2020-05-18 20:08:36 -07:00
tsconfig.json Node.js binding for ONNX Runtime (#3613) 2020-05-05 11:45:12 -07:00

ONNX Runtime Node.js API

Requirements

Node.js version 12.x is required.

Supported Platforms

  • Windows x64 CPU NAPI_v3
  • Linux x64 CPU NAPI_v3
  • MacOS x64 CPU NAPI_v3

Usage

Samples can be found here.

Install the latest stable version: npm install onnxruntime

Install the latest dev version: npm install onnxruntime@dev

Build

See BUILD.MD

License

License information can be found here.