Fix incorrect docstring defaults for DiffusionModelUNet

[eitag-uni]

Fixes #
Fix incorrect defaults for use_combined_linear and add default for use_flash_attention in docstring

Description

The DiffusionModelUNet docstring listed use_combined_linear as default True, while the class signature sets it to False. It also omitted the default for use_flash_attention, which is False in the signature. This PR updates the Args section to match the actual defaults.

Types of changes

• Non-breaking change (fix or new feature that would not break existing functionality).
• 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

Docstring updates in monai/networks/nets/diffusion_model_unet.py for DiffusionModelUNet. Corrected documented default of use_combined_linear to False and clarified use_flash_attention default as False. No code, signature, behavior, or control-flow changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly and accurately describes the primary change — correcting incorrect docstring defaults for DiffusionModelUNet — and directly matches the changeset, making it clear to reviewers scanning history. It is concise, specific, and free of extraneous information.
Description Check	✅ Passed	The PR description follows the repository template by including a Description section that clearly explains the docstring fixes and a filled Types of changes checklist noting tests and documentation updates, so it is largely complete and informative. The only minor issue is the placeholder "Fixes #" which lacks a concrete issue number.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

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

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

monai/networks/nets/diffusion_model_unet.py (1)

1530-1533: Nit: tighten phrasing and fix capitalization.

Suggest consistent “Defaults to …” phrasing and “PyTorch” capitalization.

Apply this diff:

-        use_combined_linear: whether to use a single linear layer for qkv projection, default to False.
-        use_flash_attention: if True, use Pytorch's inbuilt flash attention for a memory efficient attention mechanism
-            (see https://pytorch.org/docs/2.2/generated/torch.nn.functional.scaled_dot_product_attention.html), default to False.
+        use_combined_linear: whether to use a single linear layer for qkv projection. Defaults to False.
+        use_flash_attention: if True, use PyTorch's built-in flash attention for a memory-efficient attention mechanism
+            (see https://pytorch.org/docs/2.2/generated/torch.nn.functional.scaled_dot_product_attention.html). Defaults to False.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

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

📥 Commits

Reviewing files that changed from the base of the PR and between fd13c1b and 44bbd54.

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

monai/networks/nets/diffusion_model_unet.py (1)

1530-1533: Docstring defaults corrected — matches signature.

use_combined_linear=False and use_flash_attention=False now align with __init__ defaults. LGTM.

[ericspod]

Thanks the contribution, this looks good to me. Please look at the DCO issue and hopefully we can merge this one quickly.