Commit 1dc47a5
authored
Docs: add spatial shape constraints to SegResNetDS docstring (Project-MONAI#8797)
Fixes Project-MONAI#6771
### Description
Adds spatial shape constraint documentation to the SegResNetDS class
docstring.
Documents that input spatial dimensions must be divisible by 2 **
(len(blocks_down) - 1),
with a worked example and pointers to the existing shape_factor() and
is_valid_shape() methods.
### Types of changes
- [x] 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`.
- [x] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.
---------
Signed-off-by: Talhax55z <muhammadtalha223@gmail.com>1 parent a537499 commit 1dc47a5
1 file changed
Lines changed: 14 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
254 | 254 | | |
255 | 255 | | |
256 | 256 | | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
257 | 271 | | |
258 | 272 | | |
259 | 273 | | |
| |||
0 commit comments