2717c178cc
* Migrate winml to Microsoft Namespace (packaging changes are pending) * add ns_prefix toggle * fix packaging * Users/sheilk/add missing raw header (#3484) * add dualapipartition * wrong variable for repo root Co-authored-by: Sheil Kumar <sheilk@microsoft.com> * remove existence check to force failures * extra paren * dualapipartition needs to be referenced from the source * add microsoft.ai.machinelearning.dll to the output dir * rename the idl file so that assembly info is correctly added into the winmd * fix namespaces * update namespaces * default to microsoft, and add namespace override as build argument * update cmakesetings.json as well * remove from cmakelists.txt Co-authored-by: Sheil Kumar <sheilk@microsoft.com> Co-authored-by: Changming Sun <chasun@microsoft.com>
2.5 KiB
Windows Machine Learning WinRT API
New in the ONNX Runtime Nuget package is 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.
Many customers have asked for a way to use this offering as an application redistributable package.
With our new layered architecture you can now do this, with some limitations. The WinML APIs have been lifted and mirrored into the Microsoft.AI.MachineLearning namespace in the redistributable.
NuGet Package
The Microsoft.ML.OnnxRuntime Nuget package includes the precompiled binaries for using the ONNX runtime with the WinRT API. Support is compiled directly into onnxruntime.dll
Note: As of the 1.2 release, you can use all of the CPU functionality from these binaries. In order to get GPU funtionality using DirectML, you will need to build the binary yourself using these instructions.
Sample Code
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. Check out these existing samples in github.
Deciding on whether to use WinML in the Windows SDK or the Redist
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 |
See here for more about opsets and ONNX version details in Windows OS distributons.