Unverified Commit a767cbf6 authored by Yassine Alouini's avatar Yassine Alouini Committed by GitHub
Browse files

Revamp docs for Efficientnetv2 (#5864)



* [FEAT] Add efficientnetv2 doc.

* [FIX] Precommits fix.

* Apply suggestions from code review
Co-authored-by: default avatarNicolas Hug <contact@nicolas-hug.com>
parent 9b44e993
EfficientNetV2
============
.. currentmodule:: torchvision.models
The EfficientNetV2 model is based on the `EfficientNetV2: Smaller Models and Faster Training <https://arxiv.org/abs/2104.00298>`__
paper.
Model builders
--------------
The following model builders can be used to instanciate an EfficientNetV2 model, with or
without pre-trained weights. All the model builders internally rely on the
``torchvision.models.efficientnet.EfficientNet`` base class. Please refer to the `source
code
<https://github.com/pytorch/vision/blob/main/torchvision/models/efficientnet.py>`_ for
more details about this class.
.. autosummary::
:toctree: generated/
:template: function.rst
efficientnet_v2_s
efficientnet_v2_m
efficientnet_v2_l
...@@ -37,6 +37,7 @@ weights: ...@@ -37,6 +37,7 @@ weights:
:maxdepth: 1 :maxdepth: 1
models/efficientnet models/efficientnet
models/efficientnetv2
models/regnet models/regnet
models/resnet models/resnet
models/squeezenet models/squeezenet
......
...@@ -925,11 +925,22 @@ def efficientnet_v2_s( ...@@ -925,11 +925,22 @@ def efficientnet_v2_s(
) -> EfficientNet: ) -> EfficientNet:
""" """
Constructs an EfficientNetV2-S architecture from Constructs an EfficientNetV2-S architecture from
`"EfficientNetV2: Smaller Models and Faster Training" <https://arxiv.org/abs/2104.00298>`_. `EfficientNetV2: Smaller Models and Faster Training <https://arxiv.org/abs/2104.00298>`_.
Args: Args:
weights (EfficientNet_V2_S_Weights, optional): The pretrained weights for the model weights (:class:`~torchvision.models.EfficientNet_V2_S_Weights`, optional): The
progress (bool): If True, displays a progress bar of the download to stderr pretrained weights to use. See
:class:`~torchvision.models.EfficientNet_V2_S_Weights` below for
more details, and possible values. By default, no pre-trained
weights are used.
progress (bool, optional): If True, displays a progress bar of the
download to stderr. Default is True.
**kwargs: parameters passed to the ``torchvision.models.efficientnet.EfficientNet``
base class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/efficientnet.py>`_
for more details about this class.
.. autoclass:: torchvision.models.EfficientNet_V2_S_Weights
:members:
""" """
weights = EfficientNet_V2_S_Weights.verify(weights) weights = EfficientNet_V2_S_Weights.verify(weights)
...@@ -951,11 +962,22 @@ def efficientnet_v2_m( ...@@ -951,11 +962,22 @@ def efficientnet_v2_m(
) -> EfficientNet: ) -> EfficientNet:
""" """
Constructs an EfficientNetV2-M architecture from Constructs an EfficientNetV2-M architecture from
`"EfficientNetV2: Smaller Models and Faster Training" <https://arxiv.org/abs/2104.00298>`_. `EfficientNetV2: Smaller Models and Faster Training <https://arxiv.org/abs/2104.00298>`_.
Args: Args:
weights (EfficientNet_V2_M_Weights, optional): The pretrained weights for the model weights (:class:`~torchvision.models.EfficientNet_V2_M_Weights`, optional): The
progress (bool): If True, displays a progress bar of the download to stderr pretrained weights to use. See
:class:`~torchvision.models.EfficientNet_V2_M_Weights` below for
more details, and possible values. By default, no pre-trained
weights are used.
progress (bool, optional): If True, displays a progress bar of the
download to stderr. Default is True.
**kwargs: parameters passed to the ``torchvision.models.efficientnet.EfficientNet``
base class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/efficientnet.py>`_
for more details about this class.
.. autoclass:: torchvision.models.EfficientNet_V2_M_Weights
:members:
""" """
weights = EfficientNet_V2_M_Weights.verify(weights) weights = EfficientNet_V2_M_Weights.verify(weights)
...@@ -977,11 +999,22 @@ def efficientnet_v2_l( ...@@ -977,11 +999,22 @@ def efficientnet_v2_l(
) -> EfficientNet: ) -> EfficientNet:
""" """
Constructs an EfficientNetV2-L architecture from Constructs an EfficientNetV2-L architecture from
`"EfficientNetV2: Smaller Models and Faster Training" <https://arxiv.org/abs/2104.00298>`_. `EfficientNetV2: Smaller Models and Faster Training <https://arxiv.org/abs/2104.00298>`_.
Args: Args:
weights (EfficientNet_V2_L_Weights, optional): The pretrained weights for the model weights (:class:`~torchvision.models.EfficientNet_V2_L_Weights`, optional): The
progress (bool): If True, displays a progress bar of the download to stderr pretrained weights to use. See
:class:`~torchvision.models.EfficientNet_V2_L_Weights` below for
more details, and possible values. By default, no pre-trained
weights are used.
progress (bool, optional): If True, displays a progress bar of the
download to stderr. Default is True.
**kwargs: parameters passed to the ``torchvision.models.efficientnet.EfficientNet``
base class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/efficientnet.py>`_
for more details about this class.
.. autoclass:: torchvision.models.EfficientNet_V2_L_Weights
:members:
""" """
weights = EfficientNet_V2_L_Weights.verify(weights) weights = EfficientNet_V2_L_Weights.verify(weights)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment