From f17543620534582451293a85c5b01cfc8cbec047 Mon Sep 17 00:00:00 2001 From: Wenqi Li Date: Mon, 13 Sep 2021 14:05:56 +0100 Subject: [PATCH] enhance docstring Signed-off-by: Wenqi Li --- monai/networks/nets/autoencoder.py | 4 ++++ monai/networks/nets/varautoencoder.py | 17 +++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/monai/networks/nets/autoencoder.py b/monai/networks/nets/autoencoder.py index 08b84d0566..ed5e351779 100644 --- a/monai/networks/nets/autoencoder.py +++ b/monai/networks/nets/autoencoder.py @@ -22,6 +22,10 @@ class AutoEncoder(nn.Module): + """ + Base class for the architecture implementing :py:class:`monai.networks.nets.VarAutoEncoder`. + """ + @deprecated_arg( name="dimensions", new_name="spatial_dims", since="0.6", msg_suffix="Please use `spatial_dims` instead." ) diff --git a/monai/networks/nets/varautoencoder.py b/monai/networks/nets/varautoencoder.py index 31e187106f..3baa59531a 100644 --- a/monai/networks/nets/varautoencoder.py +++ b/monai/networks/nets/varautoencoder.py @@ -28,6 +28,23 @@ class VarAutoEncoder(AutoEncoder): """ Variational Autoencoder based on the paper - https://arxiv.org/abs/1312.6114 + .. code-block:: python + + from monai.networks.nets import VarAutoEncoder + + model = VarAutoEncoder( + dimensions=2, + in_shape=(32, 32), # image spatial shape + out_channels=1, + latent_size=2, + channels=(16, 32, 64), + strides=(1, 2, 2), + ) + + see also: + - Variational autoencoder network with MedNIST Dataset + https://github.com/Project-MONAI/tutorials/blob/master/modules/varautoencoder_mednist.ipynb + .. deprecated:: 0.6.0 ``dimensions`` is deprecated, use ``spatial_dims`` instead. """