fixes grid_sample, interpolate URLs (#3712)

* fixes grid_sample, interpolate URLs Signed-off-by: Wenqi Li <wenqil@nvidia.com> * update based on comments Signed-off-by: Wenqi Li <wenqil@nvidia.com>
Project-MONAI · Feb 9, 2022 · 966b7fa · 966b7fa
1 parent 647a100
commit 966b7fa
Show file tree

Hide file tree

Showing 18 changed files with 120 additions and 118 deletions.
diff --git a/monai/apps/deepgrow/transforms.py b/monai/apps/deepgrow/transforms.py
@@ -777,7 +777,7 @@ class RestoreLabeld(MapTransform):
             One of the listed string values or a user supplied function for padding. Defaults to ``"constant"``.
             See also: https://numpy.org/doc/1.18/reference/generated/numpy.pad.html
         align_corners: Geometrically, we consider the pixels of the input as squares rather than points.
-            See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+            See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             It also can be a sequence of bool, each element corresponds to a key in ``keys``.
         meta_keys: explicitly indicate the key of the corresponding meta data dictionary.
             for example, for data with key `image`, the metadata by default is in `image_meta_dict`.

diff --git a/monai/data/nifti_saver.py b/monai/data/nifti_saver.py
@@ -60,13 +60,13 @@ def __init__(
             mode: {``"bilinear"``, ``"nearest"``}
                 This option is used when ``resample = True``.
                 Interpolation mode to calculate output values. Defaults to ``"bilinear"``.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             padding_mode: {``"zeros"``, ``"border"``, ``"reflection"``}
                 This option is used when ``resample = True``.
                 Padding mode for outside grid values. Defaults to ``"border"``.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             align_corners: Geometrically, we consider the pixels of the input as squares rather than points.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             dtype: data type for resampling computation. Defaults to ``np.float64`` for best precision.
                 If None, use the data type of input data.
             output_dtype: data type for saving data. Defaults to ``np.float32``.

diff --git a/monai/data/nifti_writer.py b/monai/data/nifti_writer.py
@@ -87,13 +87,13 @@ def write_nifti(
         mode: {``"bilinear"``, ``"nearest"``}
             This option is used when ``resample = True``.
             Interpolation mode to calculate output values. Defaults to ``"bilinear"``.
-            See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+            See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
         padding_mode: {``"zeros"``, ``"border"``, ``"reflection"``}
             This option is used when ``resample = True``.
             Padding mode for outside grid values. Defaults to ``"border"``.
-            See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+            See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
         align_corners: Geometrically, we consider the pixels of the input as squares rather than points.
-            See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+            See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
         dtype: data type for resampling computation. Defaults to ``np.float64`` for best precision.
             If None, use the data type of input data.
         output_dtype: data type for saving data. Defaults to ``np.float32``.

diff --git a/monai/data/png_saver.py b/monai/data/png_saver.py
@@ -52,7 +52,7 @@ def __init__(
             resample: whether to resample and resize if providing spatial_shape in the metadata.
             mode: {``"nearest"``, ``"linear"``, ``"bilinear"``, ``"bicubic"``, ``"trilinear"``, ``"area"``}
                 The interpolation mode. Defaults to ``"nearest"``.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#interpolate
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.interpolate.html
             scale: {``255``, ``65535``} postprocess data by clipping to [0, 1] and scaling
                 [0, 255] (uint8) or [0, 65535] (uint16). Default is None to disable scaling.
             data_root_dir: if not empty, it specifies the beginning parts of the input file's

diff --git a/monai/data/png_writer.py b/monai/data/png_writer.py
@@ -39,7 +39,7 @@ def write_png(
         output_spatial_shape: spatial shape of the output image.
         mode: {``"nearest"``, ``"linear"``, ``"bilinear"``, ``"bicubic"``, ``"trilinear"``, ``"area"``}
             The interpolation mode. Defaults to ``"bicubic"``.
-            See also: https://pytorch.org/docs/stable/nn.functional.html#interpolate
+            See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.interpolate.html
         scale: {``255``, ``65535``} postprocess data by clipping to [0, 1] and scaling to
             [0, 255] (uint8) or [0, 65535] (uint16). Default is None to disable scaling.
 

diff --git a/monai/handlers/segmentation_saver.py b/monai/handlers/segmentation_saver.py
@@ -72,16 +72,16 @@ def __init__(
 
                 - NIfTI files {``"bilinear"``, ``"nearest"``}
                     Interpolation mode to calculate output values.
-                    See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                    See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
                 - PNG files {``"nearest"``, ``"linear"``, ``"bilinear"``, ``"bicubic"``, ``"trilinear"``, ``"area"``}
                     The interpolation mode.
-                    See also: https://pytorch.org/docs/stable/nn.functional.html#interpolate
+                    See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.interpolate.html
 
             padding_mode: This option is used when ``resample = True``. Defaults to ``"border"``.
 
                 - NIfTI files {``"zeros"``, ``"border"``, ``"reflection"``}
                     Padding mode for outside grid values.
-                    See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                    See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
                 - PNG files
                     This option is ignored.
 

diff --git a/monai/inferers/inferer.py b/monai/inferers/inferer.py
@@ -109,7 +109,7 @@ class SlidingWindowInferer(Inferer):
             spatial dimensions.
         padding_mode: {``"constant"``, ``"reflect"``, ``"replicate"``, ``"circular"``}
             Padding mode when ``roi_size`` is larger than inputs. Defaults to ``"constant"``
-            See also: https://pytorch.org/docs/stable/nn.functional.html#pad
+            See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.pad.html
         cval: fill value for 'constant' padding mode. Default: 0
         sw_device: device for the window data.
             By default the device (and accordingly the memory) of the `inputs` is used.

diff --git a/monai/inferers/utils.py b/monai/inferers/utils.py
@@ -65,7 +65,7 @@ def sliding_window_inference(
             spatial dimensions.
         padding_mode: {``"constant"``, ``"reflect"``, ``"replicate"``, ``"circular"``}
             Padding mode for ``inputs``, when ``roi_size`` is larger than inputs. Defaults to ``"constant"``
-            See also: https://pytorch.org/docs/stable/nn.functional.html#pad
+            See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.pad.html
         cval: fill value for 'constant' padding mode. Default: 0
         sw_device: device for the window data.
             By default the device (and accordingly the memory) of the `inputs` is used.

diff --git a/monai/networks/blocks/upsample.py b/monai/networks/blocks/upsample.py
@@ -72,7 +72,7 @@ def __init__(
                 If ends with ``"linear"`` will use ``spatial dims`` to determine the correct interpolation.
                 This corresponds to linear, bilinear, trilinear for 1D, 2D, and 3D respectively.
                 The interpolation mode. Defaults to ``"linear"``.
-                See also: https://pytorch.org/docs/stable/nn.html#upsample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.Upsample.html
             align_corners: set the align_corners parameter of `torch.nn.Upsample`. Defaults to True.
                 Only used in the "nontrainable" mode.
             bias: whether to have a bias term in the default preconv and deconv layers. Defaults to True.

diff --git a/monai/networks/blocks/warp.py b/monai/networks/blocks/warp.py
@@ -37,7 +37,7 @@ def __init__(self, mode=GridSampleMode.BILINEAR.value, padding_mode=GridSamplePa
             - mode: ``"nearest"``, ``"bilinear"``, ``"bicubic"``.
             - padding_mode: ``"zeros"``, ``"border"``, ``"reflection"``
 
-        See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+        See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
 
         For MONAI C++/CUDA extensions, the possible values are:
 

diff --git a/monai/networks/layers/spatial_transforms.py b/monai/networks/layers/spatial_transforms.py
@@ -446,11 +446,11 @@ def __init__(
                 coordinates.
             mode: {``"bilinear"``, ``"nearest"``}
                 Interpolation mode to calculate output values. Defaults to ``"bilinear"``.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             padding_mode: {``"zeros"``, ``"border"``, ``"reflection"``}
                 Padding mode for outside grid values. Defaults to ``"zeros"``.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
-            align_corners: see also https://pytorch.org/docs/stable/nn.functional.html#grid-sample.
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
+            align_corners: see also https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html.
             reverse_indexing: whether to reverse the spatial indexing of image and coordinates.
                 set to `False` if `theta` follows pytorch's default "D, H, W" convention.
                 set to `True` if `theta` follows `scipy.ndimage` default "i, j, k" convention.

diff --git a/monai/transforms/croppad/dictionary.py b/monai/transforms/croppad/dictionary.py
@@ -286,8 +286,8 @@ def __init__(
                 ``"mean"``, ``"median"``, ``"minimum"``, ``"reflect"``, ``"symmetric"``, ``"wrap"``, ``"empty"``}
                 available modes for PyTorch Tensor: {``"constant"``, ``"reflect"``, ``"replicate"``, ``"circular"``}.
                 One of the listed string values or a user supplied function. Defaults to ``"constant"``.
-                See also: https://numpy.org/doc/1.18/reference/generated/numpy.pad.html
-                https://pytorch.org/docs/stable/generated/torch.nn.functional.pad.html
+                See also: https://numpy.org/doc/1.18/reference/ghttps://pytorch.orgenerated/numpy.pad.html
+                /docs/stable/generated/torch.nn.functional.pad.html
                 It also can be a sequence of string, each element corresponds to a key in ``keys``.
             method: {``"symmetric"``, ``"end"``}
                 Pad image symmetrically on every side or only pad at the end sides. Defaults to ``"symmetric"``.

diff --git a/monai/transforms/io/array.py b/monai/transforms/io/array.py
@@ -248,16 +248,16 @@ class SaveImage(Transform):
 
             - NIfTI files {``"bilinear"``, ``"nearest"``}
                 Interpolation mode to calculate output values.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             - PNG files {``"nearest"``, ``"linear"``, ``"bilinear"``, ``"bicubic"``, ``"trilinear"``, ``"area"``}
                 The interpolation mode.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#interpolate
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.interpolate.html
 
         padding_mode: This option is used when ``resample = True``. Defaults to ``"border"``.
 
             - NIfTI files {``"zeros"``, ``"border"``, ``"reflection"``}
                 Padding mode for outside grid values.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             - PNG files
                 This option is ignored.
 

diff --git a/monai/transforms/io/dictionary.py b/monai/transforms/io/dictionary.py
@@ -167,16 +167,16 @@ class SaveImaged(MapTransform):
 
             - NIfTI files {``"bilinear"``, ``"nearest"``}
                 Interpolation mode to calculate output values.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             - PNG files {``"nearest"``, ``"linear"``, ``"bilinear"``, ``"bicubic"``, ``"trilinear"``, ``"area"``}
                 The interpolation mode.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#interpolate
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.interpolate.html
 
         padding_mode: This option is used when ``resample = True``. Defaults to ``"border"``.
 
             - NIfTI files {``"zeros"``, ``"border"``, ``"reflection"``}
                 Padding mode for outside grid values.
-                See also: https://pytorch.org/docs/stable/nn.functional.html#grid-sample
+                See also: https://pytorch.org/docs/stable/generated/torch.nn.functional.grid_sample.html
             - PNG files
                 This option is ignored.