Commit 9a45627
authored
## Description
This PR improves the docstring for `LocalNormalizedCrossCorrelationLoss`
to address the ambiguities identified in
#8350.
## Problem
The current docstring does not clearly document:
- The range of returned loss values
- Whether the loss should be minimized or maximized
- How to interpret high vs. low loss values
## Solution
Enhanced the class docstring with comprehensive documentation including
Returns section (value range, optimization
direction) and Note section (implementation details, interpretation
guidelines).
## Changes
- Added `Returns` section with explicit value range and optimization
direction
- Added `Note` section explaining transformations and interpretation
- Reorganized Args to class level for better discoverability
- Followed MONAI formatting conventions
## Testing
- [x] Verified docstring syntax is correct
- [x] Confirmed technical accuracy by analyzing implementation
- [x] Validated all three issue requirements are addressed
Signed-off-by: Mohamed Salah <eng.mohamed.tawab@gmail.com>
1 parent 865b0e7 commit 9a45627
1 file changed
+30
-15
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
| 54 | + | |
54 | 55 | | |
55 | 56 | | |
56 | 57 | | |
| |||
59 | 60 | | |
60 | 61 | | |
61 | 62 | | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
62 | 92 | | |
63 | 93 | | |
64 | 94 | | |
| |||
70 | 100 | | |
71 | 101 | | |
72 | 102 | | |
73 | | - | |
74 | | - | |
75 | | - | |
76 | | - | |
77 | | - | |
78 | | - | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
83 | | - | |
84 | | - | |
85 | | - | |
86 | | - | |
87 | | - | |
88 | 103 | | |
89 | 104 | | |
90 | 105 | | |
| |||
0 commit comments