Skip to content

Fix RegNet links in docs #5937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 4, 2022
Merged

Fix RegNet links in docs #5937

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4995e8
Fix RegNet links in docs
NicolasHug May 3, 2022
1bcc009
Merge branch 'main' into regnetdocsfix
NicolasHug May 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 45 additions & 45 deletions torchvision/models/regnet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -932,16 +932,16 @@ def regnet_y_400mf(*, weights: Optional[RegNet_Y_400MF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_Y_400MF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_Y_400MF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_Y_400MF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_Y_400MF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_Y_400MF_Weights
.. autoclass:: torchvision.models.RegNet_Y_400MF_Weights
:members:
"""
weights = RegNet_Y_400MF_Weights.verify(weights)
Expand All @@ -957,16 +957,16 @@ def regnet_y_800mf(*, weights: Optional[RegNet_Y_800MF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_Y_800MF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_Y_800MF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_Y_800MF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_Y_800MF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_Y_800MF_Weights
.. autoclass:: torchvision.models.RegNet_Y_800MF_Weights
:members:
"""
weights = RegNet_Y_800MF_Weights.verify(weights)
Expand All @@ -982,16 +982,16 @@ def regnet_y_1_6gf(*, weights: Optional[RegNet_Y_1_6GF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_Y_1_6GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_Y_1_6GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_Y_1_6GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_Y_1_6GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_Y_1_6GF_Weights
.. autoclass:: torchvision.models.RegNet_Y_1_6GF_Weights
:members:
"""
weights = RegNet_Y_1_6GF_Weights.verify(weights)
Expand All @@ -1009,16 +1009,16 @@ def regnet_y_3_2gf(*, weights: Optional[RegNet_Y_3_2GF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_Y_3_2GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_Y_3_2GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_Y_3_2GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_Y_3_2GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_Y_3_2GF_Weights
.. autoclass:: torchvision.models.RegNet_Y_3_2GF_Weights
:members:
"""
weights = RegNet_Y_3_2GF_Weights.verify(weights)
Expand All @@ -1036,16 +1036,16 @@ def regnet_y_8gf(*, weights: Optional[RegNet_Y_8GF_Weights] = None, progress: bo
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_Y_8GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_Y_8GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_Y_8GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_Y_8GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_Y_8GF_Weights
.. autoclass:: torchvision.models.RegNet_Y_8GF_Weights
:members:
"""
weights = RegNet_Y_8GF_Weights.verify(weights)
Expand All @@ -1063,16 +1063,16 @@ def regnet_y_16gf(*, weights: Optional[RegNet_Y_16GF_Weights] = None, progress:
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_Y_16GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_Y_16GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_Y_16GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_Y_16GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_Y_16GF_Weights
.. autoclass:: torchvision.models.RegNet_Y_16GF_Weights
:members:
"""
weights = RegNet_Y_16GF_Weights.verify(weights)
Expand All @@ -1090,16 +1090,16 @@ def regnet_y_32gf(*, weights: Optional[RegNet_Y_32GF_Weights] = None, progress:
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_Y_32GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_Y_32GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_Y_32GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_Y_32GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_Y_32GF_Weights
.. autoclass:: torchvision.models.RegNet_Y_32GF_Weights
:members:
"""
weights = RegNet_Y_32GF_Weights.verify(weights)
Expand All @@ -1117,16 +1117,16 @@ def regnet_y_128gf(*, weights: Optional[RegNet_Y_128GF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_Y_128GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_Y_128GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_Y_128GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_Y_128GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_Y_128GF_Weights
.. autoclass:: torchvision.models.RegNet_Y_128GF_Weights
:members:
"""
weights = RegNet_Y_128GF_Weights.verify(weights)
Expand All @@ -1144,16 +1144,16 @@ def regnet_x_400mf(*, weights: Optional[RegNet_X_400MF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_X_400MF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_X_400MF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_X_400MF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_X_400MF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_X_400MF_Weights
.. autoclass:: torchvision.models.RegNet_X_400MF_Weights
:members:
"""
weights = RegNet_X_400MF_Weights.verify(weights)
Expand All @@ -1169,16 +1169,16 @@ def regnet_x_800mf(*, weights: Optional[RegNet_X_800MF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_X_800MF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_X_800MF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_X_800MF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_X_800MF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_X_800MF_Weights
.. autoclass:: torchvision.models.RegNet_X_800MF_Weights
:members:
"""
weights = RegNet_X_800MF_Weights.verify(weights)
Expand All @@ -1194,16 +1194,16 @@ def regnet_x_1_6gf(*, weights: Optional[RegNet_X_1_6GF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_X_1_6GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_X_1_6GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_X_1_6GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_X_1_6GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_X_1_6GF_Weights
.. autoclass:: torchvision.models.RegNet_X_1_6GF_Weights
:members:

Args:
Expand All @@ -1223,16 +1223,16 @@ def regnet_x_3_2gf(*, weights: Optional[RegNet_X_3_2GF_Weights] = None, progress
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_X_3_2GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_X_3_2GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_X_3_2GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_X_3_2GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_X_3_2GF_Weights
.. autoclass:: torchvision.models.RegNet_X_3_2GF_Weights
:members:

Args:
Expand All @@ -1252,16 +1252,16 @@ def regnet_x_8gf(*, weights: Optional[RegNet_X_8GF_Weights] = None, progress: bo
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_X_8GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_X_8GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_X_8GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_X_8GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_X_8GF_Weights
.. autoclass:: torchvision.models.RegNet_X_8GF_Weights
:members:

Args:
Expand All @@ -1281,16 +1281,16 @@ def regnet_x_16gf(*, weights: Optional[RegNet_X_16GF_Weights] = None, progress:
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_X_16GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_X_16GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_X_16GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_X_16GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_X_16GF_Weights
.. autoclass:: torchvision.models.RegNet_X_16GF_Weights
:members:

Args:
Expand All @@ -1310,16 +1310,16 @@ def regnet_x_32gf(*, weights: Optional[RegNet_X_32GF_Weights] = None, progress:
`Designing Network Design Spaces <https://arxiv.org/abs/2003.13678>`_.

Args:
weights (:class:`torchvision.models.regnet.RegNet_X_32GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.regnet.RegNet_X_32GF_Weights` below for more details and possible values.
weights (:class:`~torchvision.models.RegNet_X_32GF_Weights`, optional): The pretrained weights to use.
See :class:`~torchvision.models.RegNet_X_32GF_Weights` below for more details and possible values.
By default, no pretrained weights are used.
progress (bool, optional): If True, displays a progress bar of the download to stderr. Default is True.
**kwargs: parameters passed to either ``torchvision.models.regnet.RegNet`` or
``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/regnet.py>`_
for more detail about the classes.

.. autoclass:: torchvision.models.regnet.RegNet_X_32GF_Weights
.. autoclass:: torchvision.models.RegNet_X_32GF_Weights
:members:

Args:
Expand Down