Skip to content

docs: add missing upsample_mode parameter documentation to SegResNetDS and SegResNetDS2 - #9131

Open
Talhax55z wants to merge 1 commit into
Project-MONAI:devfrom
Talhax55z:docs/fix-segresnetds-upsample-mode-docstring
Open

Talhax55z wants to merge 1 commit into
Project-MONAI:devfrom
Talhax55z:docs/fix-segresnetds-upsample-mode-docstring

Conversation

@Talhax55z

Copy link
Copy Markdown
Contributor

Description

Add missing documentation for the upsample_mode parameter in both SegResNetDS and SegResNetDS2 docstrings.

The parameter is present in both __init__ signatures (default "deconv") but was not documented in the class docstrings. This PR adds the missing entries, describing the supported values ("deconv", "deconvgroup", "nontrainable", "pixelshuffle") and linking to monai.utils.enums.UpsampleMode.

No functional changes.

Types of changes

  • Non-breaking change (docstring only)

Checklist

  • I have read the CONTRIBUTING guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.

@coderabbitai

coderabbitai Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: Project-MONAI/MONAI/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: facc53d9-85b8-4e8a-bfda-eac889be65dd

📥 Commits

Reviewing files that changed from the base of the PR and between c7e5ea0 and fbb03dc.

📒 Files selected for processing (1)
  • monai/networks/nets/segresnet_ds.py

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The SegResNetDS and SegResNetDS2 documentation now describes the upsample_mode default, supported modes, and UpsampleMode reference.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 1d9c6

This documentation-only change accurately describes the available upsampling modes and defaults, with no identified issue blocking merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the documentation change for both SegResNet classes.
Description check ✅ Passed The description explains the change, its scope, and that it has no functional impact. It omits the template’s issue reference and some repository-specific checklist items, but is otherwise complete.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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

Comment @coderabbitai help to get the list of available commands.

@Talhax55z
Talhax55z force-pushed the docs/fix-segresnetds-upsample-mode-docstring branch 2 times, most recently from 972665f to 5107fc5 Compare September 23, 2026 09:28
…S and SegResNetDS2

Signed-off-by: Talhax55z <muhammadtalha223@gmail.com>
@Talhax55z
Talhax55z force-pushed the docs/fix-segresnetds-upsample-mode-docstring branch from 5107fc5 to 183ee65 Compare September 23, 2026 09:29

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant