Throw exception on invalid images in retinanet detector

[emmanuel-ferdman]

Fixes # .

Description

This small PR throws an exception on invalid images in retinanet detector.

Types of changes

• Non-breaking change (fix or new feature that would not break existing functionality).
• Breaking change (fix or new feature that would cause existing functionality to change).
• New tests added to cover the changes.
• Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
• Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
• In-line docstrings updated.
• Documentation updated, tested make html command in the docs/ folder.

Summary by CodeRabbit

• Bug Fixes

  • Corrected an issue where an exception was not properly raised for unsupported image dimensions.

• Documentation

  • Fixed a typo in the method description to improve clarity.

[coderabbitai]

Walkthrough

A typo in the docstring of the set_atss_matcher method within the RetinaNetDetector class was corrected. Additionally, an exception in the _reshape_maps method was fixed to properly raise a ValueError when images are not 2D or 3D.

Changes

File	Change Summary
monai/apps/detection/networks/retinanet_detector.py	Fixed docstring typo and corrected exception raising syntax.

Poem

A typo found, now set to right,
And errors raised with proper might.
RetinaNet hops on, code refined—
Bugs and slips left far behind.
With every fix, the code feels new,
A rabbit’s cheer: “Good job, monai crew!” 🐇✨

---

📜 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 e0be5d2 and d3317d0.

📒 Files selected for processing (1)

• monai/apps/detection/networks/retinanet_detector.py (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (18)

• GitHub Check: flake8-py3 (pytype)
• GitHub Check: packaging
• GitHub Check: quick-py3 (ubuntu-latest)
• GitHub Check: min-dep-pytorch (2.5.1)
• GitHub Check: build-docs
• GitHub Check: quick-py3 (macOS-latest)
• GitHub Check: min-dep-pytorch (2.4.1)
• GitHub Check: flake8-py3 (mypy)
• GitHub Check: flake8-py3 (codeformat)
• GitHub Check: quick-py3 (windows-latest)
• GitHub Check: min-dep-py3 (3.12)
• GitHub Check: min-dep-py3 (3.10)
• GitHub Check: min-dep-pytorch (2.6.0)
• GitHub Check: min-dep-py3 (3.11)
• GitHub Check: min-dep-py3 (3.9)
• GitHub Check: min-dep-os (windows-latest)
• GitHub Check: min-dep-os (ubuntu-latest)
• GitHub Check: min-dep-os (macOS-latest)

🔇 Additional comments (2)

monai/apps/detection/networks/retinanet_detector.py (2)

360-360: LGTM! Good documentation improvement.

The typo correction from "withing" to "within" improves the docstring clarity and readability.

---

614-614: Excellent bug fix! This properly handles invalid image dimensions.

The addition of raise before ValueError is crucial - the previous code would have created an exception object but never raised it, allowing invalid images to continue processing silently. This fix ensures that invalid images (not 2D or 3D) are properly flagged with an exception, which aligns perfectly with the PR objectives.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

[KumoLiu]

Thanks for the update, LGTM.

[KumoLiu]

/build