[onnx] Add features to use ONNX build options by luncliff · Pull Request #38879 · microsoft/vcpkg

PARK DongHa (luncliff) · 2024-05-22T14:54:11Z

Changes

Make the following CMake build options to features in vcpkg.json

https://github.com/onnx/onnx/blob/b86cc54efce19530fb953e4b21f57e6b3888534c/CMakeLists.txt#L27-L28

References

Checklist

Changes comply with the maintainer guide.
SHA512s are updated for each updated download.
The "supports" clause reflects platforms that may be fixed by this new version.
Any fixed CI baseline entries are removed from that file.
Any patches that are no longer applied are deleted from the port's directory.
The version database is fixed by rerunning ./vcpkg x-add-version --all and committing the result.
Only one version is added to each modified port's versions file.

Alexander Neumann (Neumann-A) · 2024-05-22T15:22:01Z

    FEATURES
        pybind11 BUILD_ONNX_PYTHON
+        disable-exception ONNX_DISABLE_EXCEPTIONS
+        disable-static-generation ONNX_DISABLE_STATIC_REGISTRATION


should probably be made a positive feature instead since it gives a shorter feature name.

Good idea. I will change them

Changed their names in 02fe04d

Based on the discussion, the revert feature here may cause fail when it's being enabled by other ports (means NO ONNX_DISABLE_STATIC_REGISTRATION).

Back to disable-static-registration in f339729
(note disable-static-generation was wrong name 😱 )

WangWeiLin-MV

Looks like it disables function, will enabling these two features cause failed for consumers? - do-not-use-features-to-control-alternatives-in-published-interfaces

PARK DongHa (luncliff) · 2024-05-25T05:14:35Z

Looks like it disables function, will enabling these two features cause failed for consumers? - do-not-use-features-to-control-alternatives-in-published-interfaces

Honestly. I didn't check deeply for the part because I haven't encountered build errors in my team.
Let me check it

PARK DongHa (luncliff) · 2024-05-25T06:59:48Z

ONNX_DISABLE_STATIC_REGISTRATION doesn't affect the public interface, but the implementation's behavior.

https://github.com/onnx/onnx/blob/b86cc54efce19530fb953e4b21f57e6b3888534c/onnx/defs/schema.cc#L1100-L1102

PARK DongHa (luncliff) · 2024-05-30T02:27:15Z

Sorry for being late.
I added static-registration for default-features to make ONNX_DISABLE_STATIC_REGISTRATION=OFF just like the upstream's default option

Kai Pastor (dg0yt) · 2024-05-30T05:21:50Z

I added static-registration for default-features to make ONNX_DISABLE_STATIC_REGISTRATION=OFF just like the upstream's default option

Note that there are three ports which currently depend on plain "onnx", i.e. implicitly with default features enabled.

PARK DongHa (luncliff) · 2024-05-30T05:24:42Z

Yes. static-registration is the default feature. The user ports won't be affected

Kai Pastor (dg0yt) · 2024-05-30T05:26:53Z

The point is that without updating the other ports, it is not possible to disable the feature when you use one of these ports.

PARK DongHa (luncliff) · 2024-05-30T05:31:04Z

Understood. I can change the `static-generation` to `disable-static-generation` if the part can cause some problem. Do you think it's a better option?

…

On Thu, May 30, 2024 at 2:27 PM Kai Pastor ***@***.***> wrote: The point is that without updating the other ports, it is not possible to disable the feature when you use one of these ports. — Reply to this email directly, view it on GitHub <#38879 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADLSYE6JO5PEXVF32EAKWJ3ZE22DHAVCNFSM6AAAAABID2NBY2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZYG4YDQOBSGA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

-- *Profile*Facebook: fb.com/luncliff GitHub: github.com/luncliff LinkedIn: linkedin.com/in/dong-ha-park-171481229/

Kai Pastor (dg0yt) · 2024-05-30T05:35:44Z

?

No. Non-additive features aren't accepted, for good reasons.
It is probably the best to add "default-features": false to the other three ports. (Use git grep '"onnx"' ports/*/vcpkg.json.)

WangWeiLin-MV

The revert feature may cause failure when it's being enabled by other ports (enable inverted feature static-registrationmeans means NO ONNX_DISABLE_STATIC_REGISTRATION=0).

It is probably the best to add "default-features": false to the other three ports.

This is a fragile workaround causes incompatibility in a case vcpkg install onnx[static-registrationmeans] onnxruntime according to the discussion.

Kai Pastor (dg0yt) · 2024-05-30T09:59:35Z

AFAIU:
(A) It is convenient and expected to have static registration in onnx when it is used directly.
(B) It is not possible to have static registration in onnx when onnxruntime is used.

(A) can only be achieved by a default-enabled capability, like a default-feature.
(B) requires the user (i.e. the top-level manifest) to disable onnx static registration when the project uses onnxruntime.

In vcpkg CI, we have both (A) and (B).

It is probably the best to add "default-features": false to the other three ports.

This is a fragile workaround causes incompatibility in a case vcpkg install onnx[static-registration] onnxruntime according to the discussion.

When you ask for failure, you get failure. Maybe the diagnostics could signal this early.

The alternative is to not change anything and require triplet customization in order to use onnxruntime.

PARK DongHa (luncliff) · 2024-05-31T02:48:03Z

For existing ports and vcpkg CI,
I think removing the default-features (like what we did previously) and adding disable-static-registration feature is more simple because the other ports don't need to care about onnx changes.

Thankfully, ONNX_DISABLE_STATIC_REGISTRATION doesn't change the interface.
Unless vcpkg CI runs executables which requires ONNX, the port builds & installations will be fine.

WangWeiLin-MV

The port features installation tests pass with the following triplets:

x64-windows

Billy O'Neal (BillyONeal) · 2024-06-10T22:21:00Z

Kai Pastor (@dg0yt) 's analysis in #38879 (comment) seems correct to me; I think this needs to be controlled with an overlay-port rather than features.

PARK DongHa (luncliff) · 2024-06-13T15:47:50Z

Seems like no more comment.

You can close the PR with the team's decision.

Billy O'Neal (BillyONeal) · 2024-06-13T21:44:33Z

Related: #36850 . The discussion of the features-as-alternatives problem appears to have been discussed there.

### Description Changes vcpkg manifest and configuration file (vcpkg.json & vcpkg-configuration.json) * Update vcpkg version to https://github.com/microsoft/vcpkg/releases/tag/2024.12.16 * Use protobuf 3.21.12(= `v21.12`) to sync with [cmake/deps.txt](https://github.com/microsoft/onnxruntime/blob/main/cmake/deps.txt) * Resolve #22750 * Add `onnx` to vcpkg manifest so `find_package(ONNX)` and `find_dependency(Protobuf)` can work as expected. * Currently, It uses 1.16.2 * v1.17.0 will become available after microsoft/vcpkg#42942 However, `onnx` in vcpkg doesn't configure `ONNX_DISABLE_STATIC_REGISTRATION` build option. * microsoft/vcpkg#38879 * Create "cmake/vcpkg-triplets/" folder and triplet files which use `VCPKG_CMAKE_CONFIGURE_OPTIONS` for the option * This requires `VCPKG_OVERLAY_TRIPLETS` environment variable for CI steps, which is a bit inconvenient. I will try to find simple way to get same result ### Motivation and Context * Help #23158 * "ONNX is not consumed from vcpkg" * "Mismatch protobuf version. When vcpkg is enabled , we should not fetch protoc from Github which may cause version mismatches." * microsoft/vcpkg#43126 * #21348

### Description Changes vcpkg manifest and configuration file (vcpkg.json & vcpkg-configuration.json) * Update vcpkg version to https://github.com/microsoft/vcpkg/releases/tag/2024.12.16 * Use protobuf 3.21.12(= `v21.12`) to sync with [cmake/deps.txt](https://github.com/microsoft/onnxruntime/blob/main/cmake/deps.txt) * Resolve microsoft#22750 * Add `onnx` to vcpkg manifest so `find_package(ONNX)` and `find_dependency(Protobuf)` can work as expected. * Currently, It uses 1.16.2 * v1.17.0 will become available after microsoft/vcpkg#42942 However, `onnx` in vcpkg doesn't configure `ONNX_DISABLE_STATIC_REGISTRATION` build option. * microsoft/vcpkg#38879 * Create "cmake/vcpkg-triplets/" folder and triplet files which use `VCPKG_CMAKE_CONFIGURE_OPTIONS` for the option * This requires `VCPKG_OVERLAY_TRIPLETS` environment variable for CI steps, which is a bit inconvenient. I will try to find simple way to get same result ### Motivation and Context * Help microsoft#23158 * "ONNX is not consumed from vcpkg" * "Mismatch protobuf version. When vcpkg is enabled , we should not fetch protoc from Github which may cause version mismatches." * microsoft/vcpkg#43126 * microsoft#21348

### Description Changes vcpkg manifest and configuration file (vcpkg.json & vcpkg-configuration.json) * Update vcpkg version to https://github.com/microsoft/vcpkg/releases/tag/2024.12.16 * Use protobuf 3.21.12(= `v21.12`) to sync with [cmake/deps.txt](https://github.com/microsoft/onnxruntime/blob/main/cmake/deps.txt) * Resolve #22750 * Add `onnx` to vcpkg manifest so `find_package(ONNX)` and `find_dependency(Protobuf)` can work as expected. * Currently, It uses 1.16.2 * v1.17.0 will become available after microsoft/vcpkg#42942 However, `onnx` in vcpkg doesn't configure `ONNX_DISABLE_STATIC_REGISTRATION` build option. * microsoft/vcpkg#38879 * Create "cmake/vcpkg-triplets/" folder and triplet files which use `VCPKG_CMAKE_CONFIGURE_OPTIONS` for the option * This requires `VCPKG_OVERLAY_TRIPLETS` environment variable for CI steps, which is a bit inconvenient. I will try to find simple way to get same result ### Motivation and Context * Help #23158 * "ONNX is not consumed from vcpkg" * "Mismatch protobuf version. When vcpkg is enabled , we should not fetch protoc from Github which may cause version mismatches." * microsoft/vcpkg#43126 * #21348

Alexander Neumann (Neumann-A) reviewed May 22, 2024

View reviewed changes

Comment thread ports/onnx/portfile.cmake Outdated

Alexander Neumann (Neumann-A) reviewed May 22, 2024

View reviewed changes

MonicaLiu (MonicaLiu0311) assigned WangWeiLin-MV May 23, 2024

WangWeiLin-MV added the category:port-feature The issue is with a library, which is requesting new capabilities that didn’t exist label May 23, 2024

WangWeiLin-MV suggested changes May 24, 2024

View reviewed changes

PARK DongHa (luncliff) marked this pull request as draft May 25, 2024 05:14

PARK DongHa (luncliff) changed the title ~~[onnx] Support disable-static-generation, disable-exception feature~~ [onnx] Add features to use ONNX build options May 25, 2024

PARK DongHa (luncliff) marked this pull request as ready for review May 30, 2024 02:26

PARK DongHa (luncliff) requested review from Alexander Neumann (Neumann-A) and WangWeiLin-MV May 30, 2024 02:27

WangWeiLin-MV suggested changes May 30, 2024

View reviewed changes

WangWeiLin-MV approved these changes May 31, 2024

View reviewed changes

WangWeiLin-MV added the info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this. label May 31, 2024

Victor Romero (vicroms) added the requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. label Jun 3, 2024

Billy O'Neal (BillyONeal) removed the info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this. label Jun 10, 2024

Billy O'Neal (BillyONeal) removed the requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. label Jun 13, 2024

Billy O'Neal (BillyONeal) marked this pull request as draft June 13, 2024 21:55

Billy O'Neal (BillyONeal) mentioned this pull request Jun 27, 2024

[onnxruntime] new ports for microsoft/onnxruntime v1.23.2 #36850

Merged

11 tasks

PARK DongHa (luncliff) mentioned this pull request Aug 9, 2024

[onnxruntime] Update to v1.18.1, redesign portfile luncliff/vcpkg-registry#227

Merged

PARK DongHa (luncliff) added 2 commits January 6, 2025 23:07

[onnx] remove @only parts in ONNXConfig.cmake.in

0c4eb74

[onnx] update baseline

205f9f7

PARK DongHa (luncliff) force-pushed the port/onnx branch from f339729 to 205f9f7 Compare January 6, 2025 14:10

PARK DongHa (luncliff) closed this Jan 6, 2025

PARK DongHa (luncliff) deleted the port/onnx branch January 6, 2025 14:11

PARK DongHa (luncliff) mentioned this pull request Jan 8, 2025

Correct ONNX and Protobuf version in vcpkg build microsoft/onnxruntime#23285

Merged

PARK DongHa (luncliff) mentioned this pull request May 17, 2025

If you include onnx/defs/xxx.cc in your build, the operator schemas may be registered multiple times. luncliff/vcpkg-registry#382

Closed

PARK DongHa (luncliff) mentioned this pull request Jan 3, 2026

[onnx/onnxruntime] ONNX_DISABLE_STATIC_REGISTRATION=ON is required for onnx when used with onnxruntime? #49060

Open

Uh oh!

Conversation

PARK DongHa (luncliff) commented May 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

References

Checklist

Uh oh!

Uh oh!

Alexander Neumann (Neumann-A) May 22, 2024

Choose a reason for hiding this comment

Uh oh!

PARK DongHa (luncliff) May 25, 2024

Choose a reason for hiding this comment

Uh oh!

PARK DongHa (luncliff) May 25, 2024

Choose a reason for hiding this comment

Uh oh!

WangWeiLin-MV May 27, 2024

Choose a reason for hiding this comment

Uh oh!

PARK DongHa (luncliff) May 31, 2024

Choose a reason for hiding this comment

Uh oh!

WangWeiLin-MV left a comment

Choose a reason for hiding this comment

Uh oh!

PARK DongHa (luncliff) commented May 25, 2024

Uh oh!

PARK DongHa (luncliff) commented May 25, 2024

Uh oh!

PARK DongHa (luncliff) commented May 30, 2024

Uh oh!

Kai Pastor (dg0yt) commented May 30, 2024

Uh oh!

PARK DongHa (luncliff) commented May 30, 2024

Uh oh!

Kai Pastor (dg0yt) commented May 30, 2024

Uh oh!

PARK DongHa (luncliff) commented May 30, 2024 via email

Uh oh!

Kai Pastor (dg0yt) commented May 30, 2024

Uh oh!

WangWeiLin-MV left a comment

Choose a reason for hiding this comment

Uh oh!

Kai Pastor (dg0yt) commented May 30, 2024

Uh oh!

PARK DongHa (luncliff) commented May 31, 2024

Uh oh!

WangWeiLin-MV left a comment

Choose a reason for hiding this comment

Uh oh!

Billy O'Neal (BillyONeal) commented Jun 10, 2024

Uh oh!

PARK DongHa (luncliff) commented Jun 13, 2024

Uh oh!

Billy O'Neal (BillyONeal) commented Jun 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

PARK DongHa (luncliff) commented May 22, 2024 •

edited

Loading

Billy O'Neal (BillyONeal) commented Jun 13, 2024 •

edited

Loading