microsoft / microsoft/onnxruntime

[Documentation] Update ONNX Runtime Documentation to Highlight WinML as the Preferred Windows Path

Open
#25,899 1 comment 1 reaction 1 assignee View on GitHub

Nobody has claimed this yet.

documentation ep:DML platform:windows
Dominant language
C++
Stars
21.9k
Forks
4.2k
Avg merge
4d 11h
Merged PRs (30d)
184

Description

### Describe the documentation issue

Revise the ONNX Runtime documentation to clearly reflect that WinML is the preferred and future-safe execution path for Windows developers, replacing DirectML, which is being deprecated.

Relevant branch is gh-pages

Required Changes:

1. Deprecation Notice:
- Add a clear note at the top of the [DirectML Execution Provider page](https://onnxruntime.ai/docs/execution-providers/DirectML-ExecutionProvider.html) stating that DirectML is deprecated.
- Example: "Note: DirectML is deprecated. Please use WinML for Windows-based ONNX Runtime deployments."

2. WinML Highlighting:
- Update the [Windows Getting Started page](https://onnxruntime.ai/docs/get-started/with-windows.html) to prioritize WinML over DirectML.
- Ensure the [WinML install section](https://onnxruntime.ai/docs/install/#cccwinml-installs) is accurate and clearly linked from both the DirectML and Getting Started pages.

3. Developer Guidance: Briefly explain WinML’s relationship to ONNX Runtime:
- WinML uses the same ONNX Runtime APIs.
- It dynamically selects the best execution provider (EP) based on hardware.
- It simplifies deployment for Windows developers.

Reference Link: Include a link to the official WinML overview: [Windows ML Overview](https://learn.microsoft.com/en-us/windows/ai/new-windows-ml/overview)

### Page / URL

_No response_

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.