Fix network_type docstring formatting in PerceptualLoss

[aman0311x]

Fixes # .

Description

This pull request fixes incorrect formatting and clarifies the documentation
for the network_type argument in PerceptualLoss.

The docstring now correctly reflects the supported network options
and matches the actual implementation.

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.

No functional behavior is changed.

[coderabbitai]

📝 Walkthrough

Walkthrough

Renames PercetualNetworkType to PerceptualNetworkType in monai/losses/perceptual.py, updating the enum/class name, constructor default, validation checks, error messages, and docstrings/examples. Adds RECOMMENDED_PACKAGES: dict[str, str] to monai/data/image_writer.py and updates resolve_writer to append package installation hints (e.g., "Please install 'X' (e.g., pip install X).") when no writer backend is found.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ❌ 3

❌ Failed checks (3 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	Title mentions only docstring formatting, but changeset includes enum spelling fix (PercetualNetworkType→PerceptualNetworkType) and RECOMMENDED_PACKAGES addition to image_writer.py—understates scope.	Update title to reflect all changes: e.g., 'Fix PerceptualNetworkType enum spelling and add RECOMMENDED_PACKAGES constant' or similar comprehensive summary.
Description check	⚠️ Warning	Description focuses only on PerceptualLoss docstring fixes but omits the enum spelling correction (PercetualNetworkType→PerceptualNetworkType) and RECOMMENDED_PACKAGES addition to image_writer.py—incomplete coverage.	Add details about the enum spelling fix and RECOMMENDED_PACKAGES addition to align description with actual changeset scope.
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

_{✏️ 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 a7d875d and a32e2a8.

📒 Files selected for processing (1)

• monai/losses/perceptual.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/losses/perceptual.py

🧬 Code graph analysis (1)

monai/losses/perceptual.py (1)

monai/utils/enums.py (1)

• StrEnum (68-90)

🔇 Additional comments (4)

monai/losses/perceptual.py (4)

52-72: Docstring formatting improvements look good.

The bulleted list format for network_type options is clearer than inline text. Consistent use of double-backtick RST formatting for defaults.

---

78-78: Default updated correctly.

References the corrected PerceptualNetworkType.alex.

---

101-104: Validation logic is correct.

The check network_type.lower() not in list(PerceptualNetworkType) works because StrEnum iterates over string values. Error message now properly references the corrected enum name.

---

26-34: No breaking change. The enum is not exported from the losses module, so external code cannot import it. The old misspelled name does not exist in the codebase.

Likely an incorrect or invalid review comment.

---

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

monai/losses/perceptual.py (1)

75-75: Update type annotation to match accepted types.

Type annotation specifies str but should be str | PercetualNetworkType to match the docstring and actual usage.

🔎 Proposed fix

-        network_type: str = PercetualNetworkType.alex,
+        network_type: str | PercetualNetworkType = PercetualNetworkType.alex,

📜 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 7ce29a1.

📒 Files selected for processing (1)

• monai/losses/perceptual.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/losses/perceptual.py

🔇 Additional comments (2)

monai/losses/perceptual.py (2)

52-56: Docstring update is accurate but type annotation doesn't match.

The docstring correctly documents that network_type accepts both str and PercetualNetworkType, but the type annotation on line 75 only specifies str.

---

98-102: No issues found. StrEnum members inherit from str, so .lower() works on enum inputs and comparison against list(PercetualNetworkType) succeeds for both string and enum inputs. Logic is correct as written.

[coderabbitai]

Actionable comments posted: 1

📜 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 7ce29a1 and e2d0a02.

📒 Files selected for processing (1)

• monai/losses/perceptual.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/losses/perceptual.py

🧬 Code graph analysis (1)

monai/losses/perceptual.py (1)

monai/utils/enums.py (1)

• StrEnum (68-90)

🔇 Additional comments (1)

monai/losses/perceptual.py (1)

52-60: LGTM: Improved docstring clarity.

The reformatted list of valid network_type values is clearer than the previous inline notation.

[aman0311x]

Hi @virginiafdez,

The spelling/enum issue in PerceptualLoss has been fixed (PercetualNetworkType → PerceptualNetworkType), and all references/docstrings have been updated accordingly.

Additionally, all missing DCO sign-offs have been added via remediation commits. Everything should now be in order for review.

[coderabbitai]

Actionable comments posted: 1

📜 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 3e92d74 and 8be3faa.

📒 Files selected for processing (1)

• e --abort

[dzenanz]

LGTM

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (1)

monai/data/image_writer.py (1)

119-128: Move dictionary to module level.

The dictionary is recreated on every call. Define it as a module-level constant.

🔎 Proposed refactor

Move the dictionary definition outside the function, near the top of the file after line 64:

SUPPORTED_WRITERS: dict = {}

_RECOMMENDED_PACKAGES = {
    "png": "Pillow",
    "jpg": "Pillow",
    "jpeg": "Pillow",
    "nii": "nibabel or SimpleITK",
    "niigz": "nibabel or SimpleITK",
    "nrrd": "pynrrd",
    "tif": "Pillow or tifffile",
    "tiff": "Pillow or tifffile",
}

Then reference it in the function at line 131:

-        RECOMMENDED_PACKAGES = {
-            "png": "Pillow",
-            "jpg": "Pillow",
-            "jpeg": "Pillow",
-            "nii": "nibabel or SimpleITK",
-            "nii.gz": "nibabel or SimpleITK",
-            "nrrd": "pynrrd",
-            "tif": "Pillow or tifffile",
-            "tiff": "Pillow or tifffile",
-        }
-
         fmt_clean = fmt.replace(".", "").lower()
-        package_hint = RECOMMENDED_PACKAGES.get(fmt_clean, "")
+        package_hint = _RECOMMENDED_PACKAGES.get(fmt_clean, "")

Note: Also see the critical bug in line 130 regarding "nii.gz" handling.

📜 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 8be3faa and 7ad4d87.

📒 Files selected for processing (2)

• monai/data/image_writer.py
• monai/losses/perceptual.py

🚧 Files skipped from review as they are similar to previous changes (1)

• monai/losses/perceptual.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/data/image_writer.py

🧬 Code graph analysis (1)

monai/data/image_writer.py (1)

monai/utils/module.py (1)

• OptionalImportError (309-312)

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

[aman0311x]

The CI is consistently failing at the dependency installation step with:
"OSError: [Errno 28] No space left on device".

All other jobs have completed successfully.

[ericspod]

Hi @aman0311x thanks for this contribution. I had a very minor comment but otherwise I think it's good to go. Please update when you can and hopefully we'll have the CICD issues sorted.

[aman0311x]

All CI/CD checks have passed successfully . Ready for merge! @ericspod

[KumoLiu]

Hi @aman0311x, could you please help resolve the confict, then I will trigger the blossom to merge the pr, thanks!

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In @monai/losses/perceptual.py:
- Around line 52-60: Update the docstring for the network_type parameter to use
the corrected enum name PerceptualNetworkType (replace the misspelled
PercetualNetworkType) and convert the current type+list block into a
Google-style parameter description: remove the inline type signature and instead
document network_type: PerceptualNetworkType — one of "alex", "vgg", "squeeze",
"radimagenet_resnet50", "medicalnet_resnet10_23datasets",
"medicalnet_resnet50_23datasets", or "resnet50". Also ensure the default is
noted (PerceptualNetworkType.alex) and the docstring matches the function or
class that defines network_type (search for network_type and
PerceptualNetworkType in perceptual.py).

📜 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 33e12ac and ad454d3.

📒 Files selected for processing (1)

• monai/losses/perceptual.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/losses/perceptual.py

🧬 Code graph analysis (1)

monai/losses/perceptual.py (1)

monai/utils/enums.py (1)

• StrEnum (68-90)

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

🔇 Additional comments (3)

monai/losses/perceptual.py (3)

26-34: LGTM!

Spelling correction from PercetualNetworkType to PerceptualNetworkType is correct.

---

79-79: LGTM!

Default parameter correctly uses the renamed PerceptualNetworkType enum.

---

102-105: LGTM!

Validation and error message correctly reference the renamed PerceptualNetworkType enum.

[aman0311x]

Hi @KumoLiu, Conflicts are resolved and pushed. Ready for blossom trigger. Thanks!