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

fix: correctly removing absEtaMax from kwargs of TrackSelector #4114

Merged
merged 4 commits into from
Feb 28, 2025

Conversation

pbalek
Copy link
Contributor

@pbalek pbalek commented Feb 27, 2025

Correctly remove absEtaMax from kwargs for TrackSelector.Config if there are multiple trackSelectorConfigs

--- END COMMIT MESSAGE ---

If there are multiple trackSelectorConfigs, then variable absEtaMax shouldn't be passed to acts.TrackSelector.Config.
With previous implementation, the value of absEtaMax was overwritten to None but this None value was still passed to acts.TrackSelector.Config.
Now, the values of absEtaMax are overwritten with None and later striped from the kwargs dictionary via trackSelectorDefaultKWArgs and acts.examples.defaultKWArgs. This way, the absEtaMax are not passed to acts.TrackSelector.Config at all.

Summary by CodeRabbit

  • New Features
    • Enhanced configuration options for track selection, allowing for more flexible handling of multiple track selectors based on the number of elements provided.

Copy link

coderabbitai bot commented Feb 27, 2025

Walkthrough

Significant modifications, the addCKFTracks function has seen. Constructing cutSets, now based on the length of tslist, it does. A conditional structure introduced, checking if more than one element exists. An empty list for cutSets, it initializes, populating within a loop, invoking trackSelectorDefaultKWArgs(c) for each element. If one or fewer elements, the previous method it uses. Enhanced flexibility in configuration, the changes bring.

Changes

File(s) Change(s)
Examples/Python/.../reconstruction.py Modified addCKFTracks function to construct cutSets based on the length of tslist using a loop for multiple elements; retains previous logic for one or fewer elements.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant CKF as addCKFTracks
    participant TS as trackSelectorDefaultKWArgs

    Caller->>CKF: Call addCKFTracks(tslist)
    CKF->>TS: Invoke trackSelectorDefaultKWArgs(c) for each c in tslist
    TS-->>CKF: Return TrackSelector.Config
    CKF-->>Caller: Return configured TrackSelector
Loading

Suggested labels

Component - Core, Track Finding, coderabbit

Suggested reviewers

  • andiwand
  • paulgessinger

Poem

In the code, a dance of change,
addCKFTracks now rearranged.
Looping through, it finds the way,
Flexible tracks, come what may.
Celebrate we must, with joy and cheer,
A brighter path, the future is near! 🌟


📜 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 bb66850 and 5111c49.

📒 Files selected for processing (1)
  • Examples/Python/python/acts/examples/reconstruction.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: macos
🔇 Additional comments (1)
Examples/Python/python/acts/examples/reconstruction.py (1)

1433-1442: Fixed, the issue with absEtaMax has been, hmm! Good, this change is.

Handle the case of multiple track selectors, this code now does. When many configs there are, absEtaMax removed from kwargs it is. Crash, prevented it will be. Original behavior, preserved it is for single configs.

For each track selector config, mmm, yes, get default keyword arguments it does. Then, remove absEtaMax from these arguments it will. To TrackSelector.Config, pass the cleansed arguments it does. When multiple configs exist, this approach necessary is.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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.

@pbalek pbalek force-pushed the fix-def-kwargs-trk-selector branch from 6465bf1 to be9f8d6 Compare February 27, 2025 15:22
@pbalek pbalek marked this pull request as ready for review February 27, 2025 15:32
@github-actions github-actions bot added the Component - Examples Affects the Examples module label Feb 27, 2025
@github-actions github-actions bot added this to the next milestone Feb 27, 2025
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 5c7de7a and be9f8d6.

📒 Files selected for processing (1)
  • Examples/Python/python/acts/examples/reconstruction.py (2 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
Examples/Python/python/acts/examples/reconstruction.py

143-143: Do not use mutable data structures for argument defaults

Replace with None; initialize within function

(B006)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: merge-sentinel
🔇 Additional comments (2)
Examples/Python/python/acts/examples/reconstruction.py (2)

147-174: Good use of dictionary merging with the | operator I see. Hmm, wise choice this is!

The implementation elegantly handles the overwriting of arguments using the dictionary merge operator introduced in Python 3.9. For any parameter that needs to be overridden, passed through overwriteArgs it can be, without changing the entire function logic.


1438-1442: Fixed the issue with absEtaMax, this change has. Wise, you are!

When multiple track selector configurations present are, absEtaMax=None is now set in the overwriteArgs dictionary. This prevents the None value from being passed to acts.TrackSelector.Config, as described in the PR objectives. The core of the bug fix, this is.

@pbalek pbalek force-pushed the fix-def-kwargs-trk-selector branch from f9d32af to 4569d5d Compare February 27, 2025 15:47
Copy link

github-actions bot commented Feb 27, 2025

📊: Physics performance monitoring for 1c8bd0d

Full contents

physmon summary

Copy link
Contributor

@andiwand andiwand left a comment

Choose a reason for hiding this comment

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

thanks!

@kodiakhq kodiakhq bot merged commit 986cfe2 into acts-project:main Feb 28, 2025
45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Examples Affects the Examples module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants