Get started with ORT for Windows Machine Learning WinRT

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

• Supported Versions
• Builds
• API Reference
• Samples
• Should I use the in-box vs NuGet WinML version?

Supported Versions

Windows 8.1+

Builds

API Reference

Windows.AI.MachineLearning

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.

• Samples in Github

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.

See here for more about opsets and ONNX version details in Windows OS distributions.

---