a0f3e30de6
* initial setup and rename "how to" to "setup" * move API to main nav * move api to main nav * add get starated, rework nav order * rename to install move mds out of install section * update api nav and home page * add install docs and python qs updates * python get started work * remove c and obj c for now * move java, python, and obj-c docs under api folder * move java api html to iframe (ugh) * remove api docs w/o details, move api text getstar * remove api docs wo detail updates get started * remvoe iframes * move eco system to main nav * fix api buttons * added more examples moved intro to ORT * fix links * fix get started titles * fix get started titles * fix more links * fix more links * more link fixes * fix nav remove inferencing and training subnav * fix top nav remove inference and training nav * fix title * fix tutorials nav hierarchy * fix python api button * add tenorflow keras example * fix quickstart toc * add imports fix spacing * fix links * update nav and python get started page * move ort training example, add coming soon for iot * update C# get started * fix spacing on quantization * Add some js get started content * fix formatting * fix typo * removed onnx-pytorch and onnx-tf * updated pip install torch and added links iot page * added pytorch tutorial heirarchy * updated web to docs soon added release blog link * add web link
2.6 KiB
| title | parent | toc | nav_order |
|---|---|---|---|
| WinRT | Get Started | true | 10 |
Get started with ORT for Windows Machine Learning WinRT
{: .no_toc }
The ONNX Runtime Nuget package provides the ability to use the full WinML API. This allows scenarios such as passing a Windows.Media.VideoFrame from your connected camera directly into the runtime for realtime inference.
The WinML API is a WinRT API that shipped inside the Windows OS starting with build 1809 (RS5) in the Windows.AI.MachineLearning namespace. It embedded a version of the ONNX Runtime.
In addition to using the in-box version of WinML, WinML can also be installed as an application redistributable package (see layered architecture for technical details).
Contents
{: .no_toc }
- TOC placeholder {:toc}
Supported Versions
Windows 8.1+
Builds
| Artifact | Description | Supported Platforms |
|---|---|---|
| Microsoft.AI.MachineLearning | WinRT - CPU, GPU (DirectML) | Windows 8.1+ |
API Reference
Samples
Any code already written for the Windows.AI.MachineLearning API can be easily modified to run against the Microsoft.ML.OnnxRuntime package. All types originally referenced by inbox customers via the Windows namespace will need to be updated to now use the Microsoft namespace.
Should I use the in-box vs NuGet WinML version?
For a comparison, see Windows Machine Learning: In-box vs NuGet WinML solutions.
To detect if a particular OS version of Windows has the WinML APIs, use the IsApiContractPresent method. This can be called from either UWP or native apps.
If the OS does not have the runtime you need you can switch to use the redist binaries instead.
| Release | API contract version |
|---|---|
| Windows OS 1809 | 1 |
| Windows OS 1903 | 2 |
| Windows OS 1909 | 2 |
| ORT release 1.2 | 3 |
| ORT release 1.3 | 3 |
| ORT release 1.4 | 3 |
See here for more about opsets and ONNX version details in Windows OS distributions.