fix(metrics): Corrected dimension count in MS-SSIM error message for 3D images.

[akshatsinha0]

Fixes # .

Description

A few sentences describing the changes proposed in this pull request.

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.

[coderabbitai]

📝 Walkthrough

Walkthrough

Corrected a dimensionality validation error message in the compute_ms_ssim function within monai/metrics/regression.py. The message now accurately reflects that when spatial_dims is 3, the expected input tensor dimensionality is 5 dimensions rather than 4. This is a single-line fix with no changes to function logic or control flow.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description uses the template structure but the actual description content is entirely placeholder text with no specific details about the MS-SSIM fix.	Replace placeholder text with a clear description of the dimension validation bug, explain why the message was incorrect, and detail the fix applied.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: correcting a dimension count error in the MS-SSIM validation message for 3D images, matching the actual changeset.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 57fdd59 and 72aaf1c.

📒 Files selected for processing (1)

• monai/metrics/regression.py

🧰 Additional context used

📓 Path-based instructions (1)

**/*.py

⚙️ CodeRabbit configuration file

Review the Python code for quality and correctness. Ensure variable names adhere to PEP8 style guides, are sensible and informative in regards to their function, though permitting simple names for loop and comprehension variables. Ensure routine names are meaningful in regards to their function and use verbs, adjectives, and nouns in a semantically appropriate way. Docstrings should be present for all definition which describe each variable, return value, and raised exception in the appropriate section of the Google-style of docstrings. Examine code for logical error or inconsistencies, and suggest what may be changed to addressed these. Suggest any enhancements for code improving efficiency, maintainability, comprehensibility, and correctness. Ensure new or modified definitions will be covered by existing or new unit tests.

Files:

• monai/metrics/regression.py

⏰ 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). (19)

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

🔇 Additional comments (1)

monai/metrics/regression.py (1)

540-544: Error message correction is accurate.

The validation correctly requires 5 dimensions for 3D images (batch, channel, height, width, depth) and the error message matches this requirement. Aligns with SSIMMetric's consistent validation at lines 304-308.

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[akshatsinha0]

@rijobro