From 36fb6ca55d8f5e64bd2ceb6c0d96440f76cfbc8a Mon Sep 17 00:00:00 2001 From: Qiutong Shen Date: Fri, 10 Apr 2026 16:40:52 +0800 Subject: [PATCH 1/2] Fix internal consistency issues in Windows ML documentation Fix 5 internal consistency issues found by automated documentation review: - api-reference: Remove extra closing parenthesis in markdown link - api-reference: Add missing period after vc redistributable link - initialize-execution-providers: Add MIGraphXExecutionProvider to C++/WinRT and C/C++ tabs - logs: Add missing period after 'suppressed' - model-catalog-source: Renumber best practices list sequentially Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/new-windows-ml/api-reference.md | 4 ++-- docs/new-windows-ml/initialize-execution-providers.md | 4 +++- docs/new-windows-ml/logs.md | 2 +- docs/new-windows-ml/model-catalog/model-catalog-source.md | 2 +- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/new-windows-ml/api-reference.md b/docs/new-windows-ml/api-reference.md index b4c827b8..c9ae2c31 100644 --- a/docs/new-windows-ml/api-reference.md +++ b/docs/new-windows-ml/api-reference.md @@ -7,7 +7,7 @@ ms.topic: article # Windows ML APIs -For conceptual guidance, see [Run ONNX models with Windows ML)](./run-onnx-models.md). +For conceptual guidance, see [Run ONNX models with Windows ML](./run-onnx-models.md). You can think of the APIs in the *Microsoft.WindowsAppSDK.ML* NuGet package as being the superset of these two sets: @@ -73,7 +73,7 @@ The ONNX runtime is designed in a way where the Python and native environments a **Remove pywinrt's packed vcruntime** -The pywinrt project includes a msvcp140.dll in the winrt-runtime package. This may conflict with other packages. Please remove this dll to avoid this problem and install the missing vcruntime libraries with the [vc redistributable](/cpp/windows/latest-supported-vc-redist) +The pywinrt project includes a msvcp140.dll in the winrt-runtime package. This may conflict with other packages. Please remove this dll to avoid this problem and install the missing vcruntime libraries with the [vc redistributable](/cpp/windows/latest-supported-vc-redist). ## See also diff --git a/docs/new-windows-ml/initialize-execution-providers.md b/docs/new-windows-ml/initialize-execution-providers.md index 4f44118b..d4455ab5 100644 --- a/docs/new-windows-ml/initialize-execution-providers.md +++ b/docs/new-windows-ml/initialize-execution-providers.md @@ -436,7 +436,8 @@ std::vector targetProviders; for (auto const& p : allProviders) { auto name = p.Name(); - if (name == L"VitisAIExecutionProvider" || + if (name == L"MIGraphXExecutionProvider" || + name == L"VitisAIExecutionProvider" || name == L"OpenVINOExecutionProvider" || name == L"QNNExecutionProvider" || name == L"NvTensorRtRtxExecutionProvider") @@ -497,6 +498,7 @@ else // List of provider names our app supports const char* targetProviderNames[] = { + "MIGraphXExecutionProvider", "VitisAIExecutionProvider", "OpenVINOExecutionProvider", "QNNExecutionProvider", diff --git a/docs/new-windows-ml/logs.md b/docs/new-windows-ml/logs.md index b512a3c0..e47650e7 100644 --- a/docs/new-windows-ml/logs.md +++ b/docs/new-windows-ml/logs.md @@ -145,7 +145,7 @@ WindowsAppSDK.ML Version (2024/01/15 10:30:45.100): Version = 2.0.0 ``` -Shows the Windows App SDK Windows ML version used by the application. Duplicate entries with the same version are suppressed +Shows the Windows App SDK Windows ML version used by the application. Duplicate entries with the same version are suppressed. #### Driver info diff --git a/docs/new-windows-ml/model-catalog/model-catalog-source.md b/docs/new-windows-ml/model-catalog/model-catalog-source.md index 1c82acc4..1d66fd92 100644 --- a/docs/new-windows-ml/model-catalog/model-catalog-source.md +++ b/docs/new-windows-ml/model-catalog/model-catalog-source.md @@ -326,7 +326,7 @@ The Windows ML Model Catalog follows the JSON Schema specification (draft 2020-1 1. **Use semantic versioning**: Follow semantic versioning (e.g., "1.2.3") for the `version` field 2. **Provide accurate SHA256 hashes**: Always include correct SHA256 hashes for integrity verification -5. **Consistent naming**: Use consistent naming conventions for IDs and names across model versions +3. **Consistent naming**: Use consistent naming conventions for IDs and names across model versions 4. **Clear descriptions**: Write helpful descriptions that explain model capabilities and use cases 5. **Proper licensing**: Always include complete license information (type, URI, and text) 6. **Test accessibility**: Ensure all URIs are accessible and return the expected content From c7c6da8d719225207116f9e079c047bb9fa65c51 Mon Sep 17 00:00:00 2001 From: Qiutong Shen Date: Fri, 10 Apr 2026 16:43:44 +0800 Subject: [PATCH 2/2] Fix non-descriptive link text in multiple-onnx-versions Replace generic 'this sample' link text with descriptive 'CSharpConsoleDesktop Windows ML sample' for better accessibility. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- docs/new-windows-ml/multiple-onnx-versions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/new-windows-ml/multiple-onnx-versions.md b/docs/new-windows-ml/multiple-onnx-versions.md index 72b7a7f3..f0868bbe 100644 --- a/docs/new-windows-ml/multiple-onnx-versions.md +++ b/docs/new-windows-ml/multiple-onnx-versions.md @@ -11,7 +11,7 @@ Some apps might need to use multiple different versions of ONNX Runtime. For exa In these cases, you can run Windows ML's ONNX Runtime alongside another ONNX Runtime by running Windows ML in a separate process. -As an example of how to do this, say you wanted to take advantage of Windows ML's ability to run SqueezeNet. You would first build [this sample](https://github.com/microsoft/WindowsAppSDK-Samples/tree/main/Samples/WindowsML/cs/CSharpConsoleDesktop). +As an example of how to do this, say you wanted to take advantage of Windows ML's ability to run SqueezeNet. You would first build the [CSharpConsoleDesktop Windows ML sample](https://github.com/microsoft/WindowsAppSDK-Samples/tree/main/Samples/WindowsML/cs/CSharpConsoleDesktop). This sample accepts an image file as a command-line argument and outputs its interpretation of the image contents.