Skip to content

Commit feefcaa

Browse files
author
Fabio Ferreira
committed
docs: update docstrings
1 parent e66e357 commit feefcaa

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

monai/networks/nets/unet.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727

2828

2929
class _ActivationCheckpointWrapper(nn.Module):
30+
"""Apply activation checkpointing to the wrapped module during training."""
3031
def __init__(self, module: nn.Module) -> None:
3132
super().__init__()
3233
self.module = module
@@ -86,6 +87,8 @@ class UNet(nn.Module):
8687
if a conv layer is directly followed by a batch norm layer, bias should be False.
8788
adn_ordering: a string representing the ordering of activation (A), normalization (N), and dropout (D).
8889
Defaults to "NDA". See also: :py:class:`monai.networks.blocks.ADN`.
90+
use_checkpointing: if True, apply activation checkpointing to internal sub-blocks during training to reduce memory
91+
at the cost of extra compute. Checkpointing is bypassed in eval and when gradients are disabled. Defaults to False.
8992
9093
Examples::
9194

0 commit comments

Comments
 (0)