Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: Use CONFIG mode for onnxruntime #4086

Merged
merged 4 commits into from
Feb 14, 2025

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Feb 12, 2025

Switch to using CMake's CONFIG mode for finding ONNX. This also deletes the find module we ship as of now.

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

  • Chores
    • Modernized the build configuration to improve runtime dependency management.
    • Enhanced library linking and updated header inclusion paths for better compatibility.
    • Streamlined the build process by deprecating legacy dependency scripts.
    • Removed installation steps for outdated CMake configuration files.

@paulgessinger paulgessinger added this to the next milestone Feb 12, 2025
Copy link

coderabbitai bot commented Feb 12, 2025

Walkthrough

Modified, the CMake configuration has been. Changed, the find_package command now uses onnxruntime in CONFIG mode rather than OnnxRuntime. Updated, the target linkage in the plugin now references onnxruntime::onnxruntime. Revised, the include paths in header files now point to the nested directory structure. Removed, the custom FindOnnxRuntime.cmake module is. Factual these changes are, yes.

Changes

File(s) Change Summary
CMakeLists.txt Updated find_package(OnnxRuntime ${_acts_onnxruntime_version} REQUIRED) to find_package(onnxruntime ${_acts_onnxruntime_version} CONFIG REQUIRED).
Plugins/Onnx/CMakeLists.txt Modified target_link_libraries to link with onnxruntime::onnxruntime instead of OnnxRuntime.
Plugins/Onnx/include/Acts/Plugins/Onnx/OnnxRuntimeBase.hpp
Plugins/Onnx/include/Acts/Plugins/Onnx/SeedClassifier.hpp
Changed include directives from <onnxruntime_cxx_api.h> to <onnxruntime/onnxruntime_cxx_api.h>.
cmake/FindOnnxRuntime.cmake Deleted the custom CMake module for locating ONNX Runtime.
cmake/ActsCreatePackageConfig.cmake Removed installation step for FindOnnxRuntime.cmake.

Sequence Diagram(s)

sequenceDiagram
    participant CMake as CMake Build
    participant Config as OnnxRuntime Config
    participant Target as ActsPluginOnnx

    CMake->>Config: find_package(onnxruntime CONFIG REQUIRED)
    Config-->>CMake: Provide configuration details
    CMake->>Target: Link target with onnxruntime::onnxruntime
Loading

Suggested reviewers

  • benjaminhuth

Poem

In code, the force of change does flow,
New paths and links, the project now does grow.
Headers find their proper nest, they do,
Configured well, the build shines through.
Old ways banished, fresh light we ignite –
May the build be strong, in the force of night!
✨🚀 Yes, hmmm.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a5a9ce0 and 37ab947.

📒 Files selected for processing (1)
  • CMakeLists.txt (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CMakeLists.txt
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: merge-sentinel
  • GitHub Check: CI Bridge / build_exatrkx
  • GitHub Check: CI Bridge / build_exatrkx_cpu
  • GitHub Check: CI Bridge / clang_tidy
  • GitHub Check: macos

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added Infrastructure Changes to build tools, continous integration, ... Component - Plugins Affects one or more Plugins labels Feb 12, 2025
@paulgessinger
Copy link
Member Author

@benjaminhuth @Corentin-Allaire I don't fully know if this will work as is, I only tested with spack.

@Corentin-Allaire
Copy link
Contributor

@benjaminhuth @Corentin-Allaire I don't fully know if this will work as is, I only tested with spack.

I can test it with cmake tomorrow morning if you want

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 36cc0cb and b2fc9d2.

📒 Files selected for processing (5)
  • CMakeLists.txt (1 hunks)
  • Plugins/Onnx/CMakeLists.txt (1 hunks)
  • Plugins/Onnx/include/Acts/Plugins/Onnx/OnnxRuntimeBase.hpp (1 hunks)
  • Plugins/Onnx/include/Acts/Plugins/Onnx/SeedClassifier.hpp (1 hunks)
  • cmake/FindOnnxRuntime.cmake (0 hunks)
💤 Files with no reviewable changes (1)
  • cmake/FindOnnxRuntime.cmake
✅ Files skipped from review due to trivial changes (2)
  • Plugins/Onnx/include/Acts/Plugins/Onnx/OnnxRuntimeBase.hpp
  • Plugins/Onnx/include/Acts/Plugins/Onnx/SeedClassifier.hpp
⏰ Context from checks skipped due to timeout of 90000ms (21)
  • GitHub Check: merge-sentinel
  • GitHub Check: CI Bridge / lcg_106a: [alma9, clang16]
  • GitHub Check: CI Bridge / lcg_105: [alma9, clang16]
  • GitHub Check: CI Bridge / lcg_106a: [alma9, gcc14]
  • GitHub Check: CI Bridge / lcg_105: [alma9, gcc13]
  • GitHub Check: CI Bridge / lcg_106a: [alma9, gcc13]
  • GitHub Check: CI Bridge / clang_tidy
  • GitHub Check: CI Bridge / build_exatrkx_cpu
  • GitHub Check: CI Bridge / build_linux_ubuntu
  • GitHub Check: CI Bridge / linux_ubuntu_2204_clang
  • GitHub Check: CI Bridge / linux_ubuntu_2204
  • GitHub Check: CI Bridge / build_exatrkx
  • GitHub Check: unused_files
  • GitHub Check: missing_includes
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, clang++)
  • GitHub Check: CI Bridge / build_gnn_tensorrt
  • GitHub Check: macos
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, g++)
  • GitHub Check: build_debug
  • GitHub Check: linux_ubuntu
  • GitHub Check: docs
🔇 Additional comments (1)
Plugins/Onnx/CMakeLists.txt (1)

21-21: Correct, this change is! Modern CMake practices, it follows!

The namespaced target onnxruntime::onnxruntime aligns with CONFIG mode and modern CMake best practices.

@benjaminhuth
Copy link
Member

I don't have much of an opinion, since the ONNX version of the pipeline is not to well maintained at the moment.

Copy link

github-actions bot commented Feb 13, 2025

📊: Physics performance monitoring for 37ab947

Full contents

physmon summary

@Corentin-Allaire
Copy link
Contributor

@benjaminhuth @Corentin-Allaire I don't fully know if this will work as is, I only tested with spack.

I can test it with cmake tomorrow morning if you want

It works as is on my machine

@paulgessinger
Copy link
Member Author

@Corentin-Allaire Brilliant! Can you approve this one?

Copy link
Contributor

@Corentin-Allaire Corentin-Allaire left a comment

Choose a reason for hiding this comment

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

LGTM

@kodiakhq kodiakhq bot merged commit e4606c6 into acts-project:main Feb 14, 2025
43 checks passed
@acts-project-service acts-project-service added the Fails Athena tests This PR causes a failure in the Athena tests label Feb 14, 2025
@paulgessinger paulgessinger modified the milestones: next, v39.1.0 Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Plugins Affects one or more Plugins Fails Athena tests This PR causes a failure in the Athena tests Infrastructure Changes to build tools, continous integration, ...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants