Skip to content

Add example and documentation for kOrtEpDevice_EpMetadataKey_OSDriverVersion#28282

Merged
skottmckay merged 3 commits into
mainfrom
adrastogi/driver_version_clarifications
May 23, 2026
Merged

Add example and documentation for kOrtEpDevice_EpMetadataKey_OSDriverVersion#28282
skottmckay merged 3 commits into
mainfrom
adrastogi/driver_version_clarifications

Conversation

@adrastogi

Copy link
Copy Markdown
Contributor

Description

This change provides details on the expected value for kOrtEpDevice_EpMetadataKey_OSDriverVersion and provides an example in the plugin EP tests.

Motivation and Context

We introduced a new EP metadata key called kOrtEpDevice_EpMetadataKey_OSDriverVersion in #26616 but neglected to provide sufficient detail to guide EP authors in how to fill in the value for this key. This PR is an attempt to address that gap.

@mingmingtasd

Copy link
Copy Markdown
Contributor

Thanks for the improvement!

Do you know what the process is to get EP authors to adopt this change? Should I file an internal feature request to OV EP team?

@adrastogi

Copy link
Copy Markdown
Contributor Author

Do you know what the process is to get EP authors to adopt this change? Should I file an internal feature request to OV EP team?

Sure, that works (there's a feature request process I can initiate from my end which can do the same thing- but if you have the means of filing one directly, that works too (if you'd want me to do it for any reason, please let me know and I'll get it taken care of)).

@adrastogi adrastogi requested a review from skottmckay May 21, 2026 04:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR clarifies how plugin Execution Providers should populate the kOrtEpDevice_EpMetadataKey_OSDriverVersion metadata key by documenting the expected value format and providing a concrete example via the example plugin EP and its associated tests.

Changes:

  • Documented the expected os_driver_version value format in onnxruntime_ep_device_ep_metadata_keys.h (4-part dot-separated string).
  • Updated the example plugin EP to populate os_driver_version in its EP metadata.
  • Extended the auto-EP registration test to assert the example plugin EP reports the expected os_driver_version value.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
onnxruntime/test/autoep/test_registration.cc Adds an assertion for the example EP’s os_driver_version metadata value.
onnxruntime/test/autoep/library/example_plugin_ep/ep_factory.cc Populates os_driver_version in the example EP metadata and documents where it would come from in a real EP.
include/onnxruntime/core/session/onnxruntime_ep_device_ep_metadata_keys.h Adds documentation describing the expected format/meaning of os_driver_version.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread onnxruntime/test/autoep/test_registration.cc Outdated
Comment thread include/onnxruntime/core/session/onnxruntime_ep_device_ep_metadata_keys.h Outdated
@mingmingtasd

Copy link
Copy Markdown
Contributor

Sure, that works (there's a feature request process I can initiate from my end which can do the same thing- but if you have the means of filing one directly, that works too (if you'd want me to do it for any reason, please let me know and I'll get it taken care of)).

Oh sorry, I missed your reply. Yeah, that's great if you could initiate the feature request from your end! Thanks! @adrastogi

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@adrastogi

Copy link
Copy Markdown
Contributor Author

@skottmckay FYI if you can help me get this over the finish line. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants