Unverified Commit 728ac510 authored by Aditya Oke's avatar Aditya Oke Committed by GitHub
Browse files

Add lraspp docs (#5923)



* add docs

* Small fix

* Update docs/source/models/lraspp.rst
Co-authored-by: default avatarNicolas Hug <contact@nicolas-hug.com>
parent 2942bfa4
LRASPP
======
.. currentmodule:: torchvision.models.segmentation
The LRASPP model is based on the `Searching for MobileNetV3 <https://arxiv.org/abs/1905.02244>`_ paper.
Model builders
--------------
The following model builders can be used to instantiate a FCN model, with or
without pre-trained weights. All the model builders internally rely on the
``torchvision.models.segmentation.LRASPP`` base class. Please refer to the `source
code
<https://github.com/pytorch/vision/blob/main/torchvision/models/segmentation/lraspp.py>`_ for
more details about this class.
.. autosummary::
:toctree: generated/
:template: function.rst
lraspp_mobilenet_v3_large
......@@ -74,7 +74,7 @@ pre-trained weights:
models/deeplabv3
models/fcn
models/lraspp
Table of all available semantic segmentation weights
----------------------------------------------------
......
......@@ -123,13 +123,28 @@ def lraspp_mobilenet_v3_large(
weights_backbone: Optional[MobileNet_V3_Large_Weights] = MobileNet_V3_Large_Weights.IMAGENET1K_V1,
**kwargs: Any,
) -> LRASPP:
"""Constructs a Lite R-ASPP Network model with a MobileNetV3-Large backbone.
"""Constructs a Lite R-ASPP Network model with a MobileNetV3-Large backbone from
`Searching for MobileNetV3 <https://arxiv.org/abs/1905.02244>`_ paper.
Args:
weights (LRASPP_MobileNet_V3_Large_Weights, optional): The pretrained weights for the model
progress (bool): If True, displays a progress bar of the download to stderr
num_classes (int, optional): number of output classes of the model (including the background)
weights_backbone (MobileNet_V3_Large_Weights, optional): The pretrained weights for the backbone
weights (:class:`~torchvision.models.segmentation.LRASPP_MobileNet_V3_Large_Weights`, optional): The
pretrained weights to use. See
:class:`~torchvision.models.segmentation.LRASPP_MobileNet_V3_Large_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.
num_classes (int, optional): number of output classes of the model (including the background).
aux_loss (bool, optional): If True, it uses an auxiliary loss.
weights_backbone (:class:`~torchvision.models.MobileNet_V3_Large_Weights`, optional): The pretrained
weights for the backbone.
**kwargs: parameters passed to the ``torchvision.models.segmentation.LRASPP``
base class. Please refer to the `source code
<https://github.com/pytorch/vision/blob/main/torchvision/models/segmentation/lraspp.py>`_
for more details about this class.
.. autoclass:: torchvision.models.segmentation.LRASPP_MobileNet_V3_Large_Weights
:members:
"""
if kwargs.pop("aux_loss", False):
raise NotImplementedError("This model does not use auxiliary loss")
......
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