Fix missing closing parenthesis in SSIM formula documentation

[Marshall-mk]

Fixes # .

Fixed missing closing parenthesis in SSIM formula LaTeX documentation

[coderabbitai]

Walkthrough

This PR corrects the mathematical formula representation in the SSIMMetric docstring within monai/metrics/regression.py. The change adjusts parentheses grouping and formatting in the SSIM formula's denominator, specifically around the terms containing μx², μy², and c1 in the first factor. No logic or functional code is modified.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Documentation-only change with no logic modifications
• Single file affected with minimal scope
• Formula formatting clarification in docstring

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	Description is incomplete. It lacks required sections like comprehensive explanation, types of changes checklist, and testing confirmation details.	Complete the description template by adding detailed explanation, filling out the types of changes checklist, and confirming test execution.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	Title clearly and specifically describes the main change: fixing a missing closing parenthesis in SSIM formula documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 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 15fd428 and df85164.

📒 Files selected for processing (1)

• monai/metrics/regression.py (1 hunks)

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

🔇 Additional comments (1)

monai/metrics/regression.py (1)

233-235: SSIM LaTeX formula and parentheses now match implementation

The added closing parenthesis and grouping in the SSIM formula are correct and consistent with compute_ssim_and_cs (same numerator and product of denominators). No further changes needed.

---

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.}

[ericspod]

Hi @Marshall-mk thanks for the fix, we'll integrate this soon after sorting out the CICD issues.