[EP ABI] support `Graph_GetModelMetadata` by wcy123 · Pull Request #25768 · microsoft/onnxruntime

Chunye Wang@AMD (wcy123) · 2025-08-16T16:28:16Z

Description

Add a new API Graph_GetModelMetadata

Motivation and Context

VitisAI EP would convert ONNX IR to another IR which is suitable for AMD AI compilers.
The metadata in a OrtModel contains many important infomation produced by other tools, e.g. Olive.

This API potentially used by many other execution providers which need to access the same information.

Hector Li (HectorSVC) · 2025-08-18T20:03:24Z

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline,Windows x64 QNN CI Pipeline

azure-pipelines · 2025-08-18T20:03:45Z

Azure Pipelines successfully started running 5 pipeline(s).

Copilot

Pull Request Overview

This PR adds a new API Graph_GetModelMetadata to enable execution providers to access model metadata from an OrtGraph. This is specifically needed by the VitisAI execution provider to access important metadata information produced by tools like Olive when converting ONNX IR to other IRs suitable for AMD AI compilers.

Key changes:

Adds Graph_GetModelMetadata API function declaration and implementation
Implements the virtual method in both EpGraph and ModelEditorGraph classes
Updates the C API structure to include the new function

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
onnxruntime/core/session/ort_apis.h	Adds function declaration for Graph_GetModelMetadata
onnxruntime/core/session/onnxruntime_c_api.cc	Implements Graph_GetModelMetadata API function and adds it to the API structure
onnxruntime/core/graph/model_editor_api_types.h	Implements GetModelMetadata method for ModelEditorGraph class
onnxruntime/core/graph/ep_api_types.h	Adds GetModelMetadata method declaration to EpGraph class
onnxruntime/core/graph/ep_api_types.cc	Implements GetModelMetadata method for EpGraph class
onnxruntime/core/graph/abi_graph_types.h	Adds pure virtual GetModelMetadata method to OrtGraph base class
include/onnxruntime/core/session/onnxruntime_c_api.h	Adds Graph_GetModelMetadata to public C API with documentation

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

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

Hector Li (HectorSVC) · 2025-08-19T14:41:04Z

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline,Windows x64 QNN CI Pipeline

azure-pipelines · 2025-08-19T14:41:29Z

Azure Pipelines successfully started running 5 pipeline(s).

Hector Li (HectorSVC) · 2025-08-20T02:09:27Z

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline,Windows x64 QNN CI Pipeline

azure-pipelines · 2025-08-20T02:09:46Z

Azure Pipelines successfully started running 5 pipeline(s).

Hector Li (HectorSVC) · 2025-08-20T03:25:18Z

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline,Windows x64 QNN CI Pipeline

azure-pipelines · 2025-08-20T03:25:39Z

Azure Pipelines successfully started running 5 pipeline(s).

Should just return error status for ORT_MINIMAL_BUILD

Hector Li (HectorSVC) · 2025-08-20T05:04:09Z

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline,Windows x64 QNN CI Pipeline

azure-pipelines · 2025-08-20T05:04:30Z

Azure Pipelines successfully started running 5 pipeline(s).

…imal build

Hector Li (HectorSVC) · 2025-08-20T06:05:40Z

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline,Windows x64 QNN CI Pipeline

azure-pipelines · 2025-08-20T06:06:02Z

Azure Pipelines successfully started running 5 pipeline(s).

Hector Li (HectorSVC) · 2025-08-20T18:48:21Z

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline,Windows x64 QNN CI Pipeline

azure-pipelines · 2025-08-20T18:48:41Z

Azure Pipelines successfully started running 5 pipeline(s).

Hector Li (HectorSVC)

Hector Li (HectorSVC) · 2025-08-20T20:19:30Z

/azp run Linux QNN CI Pipeline,Win_TRT_Minimal_CUDA_Test_CI,Windows ARM64 QNN CI Pipeline,Windows GPU Doc Gen CI Pipeline,Windows x64 QNN CI Pipeline

azure-pipelines · 2025-08-20T20:19:50Z

Azure Pipelines successfully started running 5 pipeline(s).

Hector Li (HectorSVC)

got Dmitri's approval offline

### Description Add a new API `Graph_GetModelMetadata` ### Motivation and Context VitisAI EP would convert ONNX IR to another IR which is suitable for AMD AI compilers. The metadata in a OrtModel contains many important infomation produced by other tools, e.g. Olive. This API potentially used by many other execution providers which need to access the same information.

### Description Cherry-pick the following PRs into the `rel-1.23.0` branch: - #25592 - #25622 - #25688 - #25729 - #25743 - #25769 - #25745 - #25761 - #25751 - #25716 - #25228 - #25768 - #25788 - #25747 - #25800 - #25818 - #25762 - #25749 - #25831 ### Motivation and Context  --------- Co-authored-by: quic-tirupath <quic_tirupath@quicinc.com> Co-authored-by: quic-calvnguy <quic_calvnguy@quicinc.com> Co-authored-by: qti-kromero <kromero@qti.qualcomm.com> Co-authored-by: Jeff Kilpatrick <jkilpatrick@qti.qualcomm.com> Co-authored-by: Scott McKay <skottmckay@gmail.com> Co-authored-by: David Fan <30608893+jiafatom@users.noreply.github.com> Co-authored-by: kuanyul-qti <kuanyul@qti.qualcomm.com> Co-authored-by: Dmitri Smirnov <yuslepukhin@users.noreply.github.com> Co-authored-by: Chi Lo <54722500+chilo-ms@users.noreply.github.com> Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com> Co-authored-by: Chunye Wang@AMD <chunywan@amd.com> Co-authored-by: minfhong-qti <minfhong@qti.qualcomm.com> Co-authored-by: Vishal Agarwal <vishala@nvidia.com> Co-authored-by: Maximilian Müller <maximilianm@nvidia.com> Co-authored-by: Maximilian Müller <44298237+gedoensmax@users.noreply.github.com> Co-authored-by: Changming Sun <chasun@microsoft.com> Co-authored-by: adrastogi <aditya.rastogi@microsoft.com> Co-authored-by: Aditya Rastogi <adityar@ntdev.microsoft.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

### Description Add a new API `Graph_GetModelMetadata` ### Motivation and Context VitisAI EP would convert ONNX IR to another IR which is suitable for AMD AI compilers. The metadata in a OrtModel contains many important infomation produced by other tools, e.g. Olive. This API potentially used by many other execution providers which need to access the same information.

Hector Li (HectorSVC) requested review from Adrian Lizarraga (adrianlizarraga), Copilot and Dmitri Smirnov (yuslepukhin) and removed request for Adrian Lizarraga (adrianlizarraga) and Copilot August 18, 2025 20:04

Copilot AI reviewed Aug 18, 2025

View reviewed changes

Dmitri Smirnov (yuslepukhin) suggested changes Aug 18, 2025

View reviewed changes

Comment thread onnxruntime/core/session/onnxruntime_c_api.cc

Comment thread onnxruntime/core/graph/abi_graph_types.h

Comment thread onnxruntime/core/graph/ep_api_types.h Outdated

Comment thread onnxruntime/core/graph/model_editor_api_types.h Outdated

Hector Li (HectorSVC) added the release:1.23.0 label Aug 18, 2025

support Graph_GetModelMetadata

40f399b

Chunye Wang@AMD (wcy123) force-pushed the br-new-abi-graph-get-metadata branch from af71f04 to 40f399b Compare August 19, 2025 03:39

George Wu (jywu-mysoft) added the ep:VitisAI issues related to Vitis AI execution provider label Aug 19, 2025

Chunye Wang@AMD (wcy123) and others added 3 commits August 19, 2025 05:03

move reinterpret_cast to the boundary of C API

453b46e

Update onnxruntime/core/session/onnxruntime_c_api.cc

8d7f134

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

add cxx api and unit test

f09a5d8

Dmitri Smirnov (yuslepukhin) previously requested changes Aug 19, 2025

View reviewed changes

Chunye Wang@AMD (wcy123) added 2 commits August 20, 2025 02:17

add empty line

a02e768

No need for testing C API, just test the CXX wrapper.

248087c

move Graph_GetModelMetadata to the end for compatibility

92d6da0

Hector Li (HectorSVC) reviewed Aug 20, 2025

View reviewed changes

Comment thread onnxruntime/core/graph/ep_api_types.cc

GetModel is not available for ORT_MINIMAL_BUILD.

3d623cc

Should just return error status for ORT_MINIMAL_BUILD

Chunye Wang@AMD (wcy123) added 2 commits August 20, 2025 07:02

throw ORT_NOT_IMPLEMENTED and return nullptr. fix build error for min…

c00500f

…imal build

do not throw exception which is not user friendly

1603a64

update comments

d229817

Hector Li (HectorSVC) previously approved these changes Aug 20, 2025

View reviewed changes

add empty line

bc8a8cd

Hector Li (HectorSVC) dismissed their stale review via bc8a8cd August 20, 2025 20:19

Hector Li (HectorSVC) approved these changes Aug 20, 2025

View reviewed changes

Chunye Wang@AMD (wcy123) requested a review from Dmitri Smirnov (yuslepukhin) August 21, 2025 01:31

George Wu (jywu-mysoft) approved these changes Aug 21, 2025

View reviewed changes

Hector Li (HectorSVC) merged commit 75f8480 into microsoft:main Aug 21, 2025
86 checks passed

Adrian Lizarraga (adrianlizarraga) mentioned this pull request Aug 21, 2025

ORT 1.23.0 cherry-pick prs 25592 - 25831 #25805

Merged

George Wu (jywu-mysoft) removed the release:1.23.0 label Aug 28, 2025

Uh oh!

Conversation

Chunye Wang@AMD (wcy123) commented Aug 16, 2025

Description

Motivation and Context

Uh oh!

Hector Li (HectorSVC) commented Aug 18, 2025

Uh oh!

azure-pipelines Bot commented Aug 18, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Hector Li (HectorSVC) commented Aug 19, 2025

Uh oh!

azure-pipelines Bot commented Aug 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Hector Li (HectorSVC) commented Aug 20, 2025

Uh oh!

azure-pipelines Bot commented Aug 20, 2025

Uh oh!

Hector Li (HectorSVC) commented Aug 20, 2025

Uh oh!

azure-pipelines Bot commented Aug 20, 2025

Uh oh!

Uh oh!

Hector Li (HectorSVC) commented Aug 20, 2025

Uh oh!

azure-pipelines Bot commented Aug 20, 2025

Uh oh!

Hector Li (HectorSVC) commented Aug 20, 2025

Uh oh!

azure-pipelines Bot commented Aug 20, 2025

Uh oh!

Hector Li (HectorSVC) commented Aug 20, 2025

Uh oh!

azure-pipelines Bot commented Aug 20, 2025

Uh oh!

Hector Li (HectorSVC) left a comment

Choose a reason for hiding this comment

Uh oh!

Hector Li (HectorSVC) commented Aug 20, 2025

Uh oh!

azure-pipelines Bot commented Aug 20, 2025

Uh oh!

Hector Li (HectorSVC) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants