onnxruntime/docs/index.md
brev 29a7420095
Add the ORT-Web Tutorial, Add link to GitHub ORT Web template on docs home page (#9738)
* adde web blog and template section to home page

* mkae image larger

* fix gif to remove page jump due to dom update

* Update docs/tutorials/web.md

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>

* reivew updates

* add toc

* removed dup jimp import

* fix toc

* change toc location

* fixed name to spellit out

* added ort js examples

* spell out web assembly

* changed webgl and wasm to lowercase

* add new to all array declarations

* formatting fixes in code

* fix line breaks

* fix indent

* fix indent

* fix spacing

* fix spacing

* fix spacing

* Update docs/tutorials/web.md

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>

* change to bullet points to fix number

* change gif size to make it easier to read

* add alt text

* Update docs/tutorials/web.md

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2021-11-19 16:34:43 -06:00

4.4 KiB

title has_children nav_order
ONNX Runtime (ORT) false 0

Welcome to ONNX Runtime (ORT)

{: .no_toc }

ONNX Runtime is an accelerator for machine learning models with multi platform support and a flexible interface to integrate with hardware-specific libraries. ONNX Runtime can be used with models from PyTorch, Tensorflow/Keras, TFLite, scikit-learn, and other frameworks.

How to use ONNX Runtime (ORT)

|:----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------| | Get started with ORT{: .btn .mr-4 target="_blank"} | API Docs{: .btn target="_blank"} | | Tutorials{: .btn target="_blank"} | Ecosystem{: .btn target="_blank"} |

Contribute and Customize

|:----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------| | Build ORT Packages{: .btn .mr-4 target="_blank"} | ONNX Runtime GitHub](https://github.com/microsoft/onnxruntime){: .btn target="_blank"} |


QuickStart Template

|:----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------| | ORT Web JavaScript Site Template using NextJS{: .btn .mr-4 target="_blank"} |


ONNX Runtime for Inferencing

ONNX Runtime Inference powers machine learning models in key Microsoft products and services across Office, Azure, Bing, as well as dozens of community projects.

Examples use cases for ONNX Runtime Inferencing include:

  • Improve inference performance for a wide variety of ML models
  • Run on different hardware and operating systems
  • Train in Python but deploy into a C#/C++/Java app
  • Train and perform inference with models created in different frameworks

How it works

{: .no_toc }

The premise is simple.

  1. Get a model. This can be trained from any framework that supports export/conversion to ONNX format. See the tutorials for some of the popular frameworks/libraries.
  2. Load and run the model with ONNX Runtime. See the basic tutorials for running models in different languages.
  3. (Optional) Tune performance using various runtime configurations or hardware accelerators. There are lots of options here - see How to: Tune Performance as a starting point.

Even without step 3, ONNX Runtime will often provide performance improvements compared to the original framework.

ONNX Runtime applies a number of graph optimizations on the model graph then partitions it into subgraphs based on available hardware-specific accelerators. Optimized computation kernels in core ONNX Runtime provide performance improvements and assigned subgraphs benefit from further acceleration from each Execution Provider.


ONNX Runtime for Training

Released in April 2021, ONNX Runtime Training provides a one-line addition for existing PyTorch training scripts to accelerate training times. The current support is focused on large transformer models on multi-node NVIDIA GPUs, with more to come.

How it works

{: .no_toc }

Using the ORTModule class wrapper, ONNX Runtime for PyTorch runs the forward and backward passes of the training script using an optimized automatically-exported ONNX computation graph. ORT Training uses the same graph optimizations as ORT Inferencing, allowing for model training acceleration.

The ORTModule is instantiated from torch-ort backend in PyTorch. This new interface enables a seamless integration for ONNX Runtime training in a PyTorch training code with minimal changes to the existing code.