From d8960cec3bee8a9b633d3ccc8fbddb1101790ca3 Mon Sep 17 00:00:00 2001 From: Yosua Michael Maranatha Date: Wed, 20 Apr 2022 14:42:54 +0100 Subject: [PATCH 1/7] Add docs for regnet, still need to update the comment docs on models --- docs/source/models/regnet.rst | 36 +++++++++++++++++++++++++++++++++++ docs/source/models_new.rst | 1 + 2 files changed, 37 insertions(+) create mode 100644 docs/source/models/regnet.rst diff --git a/docs/source/models/regnet.rst b/docs/source/models/regnet.rst new file mode 100644 index 00000000000..d697c3e5d7e --- /dev/null +++ b/docs/source/models/regnet.rst @@ -0,0 +1,36 @@ +RegNet +====== + +.. currentmodule:: torchvision.models + +Theregnet model is based on the `Designing Network Design Spaces +`__ paper. + + +Model builders +-------------- + +The following model builders can be used to instantiate aregnet model, with or without pre-trained weights. +All the model builders internally rely on the ``torchvision.models.regnet.RegNet`` base class. +Please refer to the `source code `_ for more details about this class. + +.. autosummary:: + :toctree: generated/ + :template: function.rst + + regnet_y_400mf + regnet_y_800mf + regnet_y_1_6gf + regnet_y_3_2gf + regnet_y_8gf + regnet_y_16gf + regnet_y_32gf + regnet_y_128gf + regnet_x_400mf + regnet_x_800mf + regnet_x_1_6gf + regnet_x_3_2gf + regnet_x_8gf + regnet_x_16gf + regnet_x_32gf + diff --git a/docs/source/models_new.rst b/docs/source/models_new.rst index a8fdad8efb0..e935e371e4f 100644 --- a/docs/source/models_new.rst +++ b/docs/source/models_new.rst @@ -36,6 +36,7 @@ weights: .. toctree:: :maxdepth: 1 + models/regnet models/resnet models/squeezenet models/vgg From 8d6fcfbe3c8615de6f7a33717a860b17b8c8ad7d Mon Sep 17 00:00:00 2001 From: Yosua Michael Maranatha Date: Thu, 21 Apr 2022 15:46:58 +0100 Subject: [PATCH 2/7] Fix a little typo on .rst file --- docs/source/models/regnet.rst | 8 +++++--- docs/source/models/resnet.rst | 2 +- docs/source/models/squeezenet.rst | 2 +- docs/source/models/vgg.rst | 2 +- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/source/models/regnet.rst b/docs/source/models/regnet.rst index d697c3e5d7e..f4214f872df 100644 --- a/docs/source/models/regnet.rst +++ b/docs/source/models/regnet.rst @@ -10,9 +10,11 @@ Theregnet model is based on the `Designing Network Design Spaces Model builders -------------- -The following model builders can be used to instantiate aregnet model, with or without pre-trained weights. -All the model builders internally rely on the ``torchvision.models.regnet.RegNet`` base class. -Please refer to the `source code `_ for more details about this class. +The following model builders can be used to instantiate a RegNet model, with or +without pre-trained weights. All the model builders internally rely on the +``torchvision.models.regnet.RegNet`` base class. Please refer to the `source code +`_ for +more details about this class. .. autosummary:: :toctree: generated/ diff --git a/docs/source/models/resnet.rst b/docs/source/models/resnet.rst index 8ab79fe885b..7976eb437e5 100644 --- a/docs/source/models/resnet.rst +++ b/docs/source/models/resnet.rst @@ -10,7 +10,7 @@ The ResNet model is based on the `Deep Residual Learning for Image Recognition Model builders -------------- -The following model builders can be used to instanciate a ResNet model, with or +The following model builders can be used to instantiate a ResNet model, with or without pre-trained weights. All the model builders internally rely on the ``torchvision.models.resnet.ResNet`` base class. Please refer to the `source code diff --git a/docs/source/models/squeezenet.rst b/docs/source/models/squeezenet.rst index a3e8603e92d..9771e5c623a 100644 --- a/docs/source/models/squeezenet.rst +++ b/docs/source/models/squeezenet.rst @@ -11,7 +11,7 @@ paper. Model builders -------------- -The following model builders can be used to instanciate a SqueezeNet model, with or +The following model builders can be used to instantiate a SqueezeNet model, with or without pre-trained weights. All the model builders internally rely on the ``torchvision.models.squeezenet.SqueezeNet`` base class. Please refer to the `source code diff --git a/docs/source/models/vgg.rst b/docs/source/models/vgg.rst index 068bd330c8b..a9fa9aabfb1 100644 --- a/docs/source/models/vgg.rst +++ b/docs/source/models/vgg.rst @@ -10,7 +10,7 @@ Image Recognition `_ paper. Model builders -------------- -The following model builders can be used to instanciate a VGG model, with or +The following model builders can be used to instantiate a VGG model, with or without pre-trained weights. All the model buidlers internally rely on the ``torchvision.models.vgg.VGG`` base class. Please refer to the `source code `_ for From bf9e106000994dabbb872b4e60f490b865ab471e Mon Sep 17 00:00:00 2001 From: Yosua Michael Maranatha Date: Thu, 21 Apr 2022 16:23:52 +0100 Subject: [PATCH 3/7] Update regnet docstring --- torchvision/models/regnet.py | 181 +++++++++++++++++++++++++++++++---- 1 file changed, 160 insertions(+), 21 deletions(-) diff --git a/torchvision/models/regnet.py b/torchvision/models/regnet.py index 9775a92a300..48f00b5791d 100644 --- a/torchvision/models/regnet.py +++ b/torchvision/models/regnet.py @@ -872,8 +872,16 @@ def regnet_y_400mf(*, weights: Optional[RegNet_Y_400MF_Weights] = None, progress `"Designing Network Design Spaces" `_. Args: - weights (RegNet_Y_400MF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_Y_400MF_Weights + :members: """ weights = RegNet_Y_400MF_Weights.verify(weights) @@ -888,8 +896,16 @@ def regnet_y_800mf(*, weights: Optional[RegNet_Y_800MF_Weights] = None, progress `"Designing Network Design Spaces" `_. Args: - weights (RegNet_Y_800MF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_Y_800MF_Weights + :members: """ weights = RegNet_Y_800MF_Weights.verify(weights) @@ -904,8 +920,16 @@ def regnet_y_1_6gf(*, weights: Optional[RegNet_Y_1_6GF_Weights] = None, progress `"Designing Network Design Spaces" `_. Args: - weights (RegNet_Y_1_6GF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_Y_1_6GF_Weights + :members: """ weights = RegNet_Y_1_6GF_Weights.verify(weights) @@ -922,8 +946,16 @@ def regnet_y_3_2gf(*, weights: Optional[RegNet_Y_3_2GF_Weights] = None, progress `"Designing Network Design Spaces" `_. Args: - weights (RegNet_Y_3_2GF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_Y_3_2GF_Weights + :members: """ weights = RegNet_Y_3_2GF_Weights.verify(weights) @@ -940,8 +972,16 @@ def regnet_y_8gf(*, weights: Optional[RegNet_Y_8GF_Weights] = None, progress: bo `"Designing Network Design Spaces" `_. Args: - weights (RegNet_Y_8GF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_Y_8GF_Weights + :members: """ weights = RegNet_Y_8GF_Weights.verify(weights) @@ -958,8 +998,16 @@ def regnet_y_16gf(*, weights: Optional[RegNet_Y_16GF_Weights] = None, progress: `"Designing Network Design Spaces" `_. Args: - weights (RegNet_Y_16GF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_Y_16GF_Weights + :members: """ weights = RegNet_Y_16GF_Weights.verify(weights) @@ -976,8 +1024,16 @@ def regnet_y_32gf(*, weights: Optional[RegNet_Y_32GF_Weights] = None, progress: `"Designing Network Design Spaces" `_. Args: - weights (RegNet_Y_32GF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_Y_32GF_Weights + :members: """ weights = RegNet_Y_32GF_Weights.verify(weights) @@ -992,11 +1048,18 @@ def regnet_y_128gf(*, weights: Optional[RegNet_Y_128GF_Weights] = None, progress """ Constructs a RegNetY_128GF architecture from `"Designing Network Design Spaces" `_. - NOTE: Pretrained weights are not available for this model. Args: - weights (RegNet_Y_128GF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_Y_128GF_Weights + :members: """ weights = RegNet_Y_128GF_Weights.verify(weights) @@ -1013,8 +1076,16 @@ def regnet_x_400mf(*, weights: Optional[RegNet_X_400MF_Weights] = None, progress `"Designing Network Design Spaces" `_. Args: - weights (RegNet_X_400MF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_X_400MF_Weights + :members: """ weights = RegNet_X_400MF_Weights.verify(weights) @@ -1029,8 +1100,16 @@ def regnet_x_800mf(*, weights: Optional[RegNet_X_800MF_Weights] = None, progress `"Designing Network Design Spaces" `_. Args: - weights (RegNet_X_800MF_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_X_800MF_Weights + :members: """ weights = RegNet_X_800MF_Weights.verify(weights) @@ -1044,6 +1123,18 @@ def regnet_x_1_6gf(*, weights: Optional[RegNet_X_1_6GF_Weights] = None, progress Constructs a RegNetX_1.6GF architecture from `"Designing Network Design Spaces" `_. + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_X_1_6GF_Weights + :members: + Args: weights (RegNet_X_1_6GF_Weights, optional): The pretrained weights for the model progress (bool): If True, displays a progress bar of the download to stderr @@ -1060,6 +1151,18 @@ def regnet_x_3_2gf(*, weights: Optional[RegNet_X_3_2GF_Weights] = None, progress Constructs a RegNetX_3.2GF architecture from `"Designing Network Design Spaces" `_. + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_X_3_2GF_Weights + :members: + Args: weights (RegNet_X_3_2GF_Weights, optional): The pretrained weights for the model progress (bool): If True, displays a progress bar of the download to stderr @@ -1076,6 +1179,18 @@ def regnet_x_8gf(*, weights: Optional[RegNet_X_8GF_Weights] = None, progress: bo Constructs a RegNetX_8GF architecture from `"Designing Network Design Spaces" `_. + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_X_8GF_Weights + :members: + Args: weights (RegNet_X_8GF_Weights, optional): The pretrained weights for the model progress (bool): If True, displays a progress bar of the download to stderr @@ -1092,6 +1207,18 @@ def regnet_x_16gf(*, weights: Optional[RegNet_X_16GF_Weights] = None, progress: Constructs a RegNetX_16GF architecture from `"Designing Network Design Spaces" `_. + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_X_16GF_Weights + :members: + Args: weights (RegNet_X_16GF_Weights, optional): The pretrained weights for the model progress (bool): If True, displays a progress bar of the download to stderr @@ -1108,6 +1235,18 @@ def regnet_x_32gf(*, weights: Optional[RegNet_X_32GF_Weights] = None, progress: Constructs a RegNetX_32GF architecture from `"Designing Network Design Spaces" `_. + 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. 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 + `_ for more detail about the classes. + + .. autoclass:: torchvision.models.regnet.RegNet_X_32GF_Weights + :members: + Args: weights (RegNet_X_32GF_Weights, optional): The pretrained weights for the model progress (bool): If True, displays a progress bar of the download to stderr From b007da48fecd82eccdc3bf7fe5730417836cbf0f Mon Sep 17 00:00:00 2001 From: Yosua Michael Maranatha Date: Thu, 21 Apr 2022 16:36:08 +0100 Subject: [PATCH 4/7] Add vision_transformer docs, and fix typo on regnet docs --- docs/source/models/regnet.rst | 5 +- docs/source/models/vision_transformer.rst | 28 ++++++++++ docs/source/models_new.rst | 1 + torchvision/models/vision_transformer.py | 65 +++++++++++++++++++---- 4 files changed, 86 insertions(+), 13 deletions(-) create mode 100644 docs/source/models/vision_transformer.rst diff --git a/docs/source/models/regnet.rst b/docs/source/models/regnet.rst index f4214f872df..907c6b56fce 100644 --- a/docs/source/models/regnet.rst +++ b/docs/source/models/regnet.rst @@ -3,8 +3,8 @@ RegNet .. currentmodule:: torchvision.models -Theregnet model is based on the `Designing Network Design Spaces -`__ paper. +The RegNet model is based on the `Designing Network Design Spaces +`_ paper. Model builders @@ -35,4 +35,3 @@ more details about this class. regnet_x_8gf regnet_x_16gf regnet_x_32gf - diff --git a/docs/source/models/vision_transformer.rst b/docs/source/models/vision_transformer.rst new file mode 100644 index 00000000000..914caa9311e --- /dev/null +++ b/docs/source/models/vision_transformer.rst @@ -0,0 +1,28 @@ +VisionTransformer +================= + +.. currentmodule:: torchvision.models + +The VisionTransformer model is based on the `An Image is Worth 16x16 Words: +Transformers for Image Recognition at Scale `_ paper. + + +Model builders +-------------- + +The following model builders can be used to instantiate a VisionTransformer model, with or +without pre-trained weights. All the model builders internally rely on the +``torchvision.models.vision_transformer.VisionTransformer`` base class. +Please refer to the `source code +`_ for +more details about this class. + +.. autosummary:: + :toctree: generated/ + :template: function.rst + + vit_b_16 + vit_b_32 + vit_l_16 + vit_l_32 + vit_h_14 diff --git a/docs/source/models_new.rst b/docs/source/models_new.rst index e935e371e4f..d512d917d65 100644 --- a/docs/source/models_new.rst +++ b/docs/source/models_new.rst @@ -40,6 +40,7 @@ weights: models/resnet models/squeezenet models/vgg + models/vision_transformer Table of all available classification weights diff --git a/torchvision/models/vision_transformer.py b/torchvision/models/vision_transformer.py index 9837f9b81b4..89616134be5 100644 --- a/torchvision/models/vision_transformer.py +++ b/torchvision/models/vision_transformer.py @@ -519,8 +519,17 @@ def vit_b_16(*, weights: Optional[ViT_B_16_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (ViT_B_16_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + weights (:class:`~torchvision.models.vision_transformer.ViT_B_16_Weights`, optional): The pretrained weights to use. See + :class:`~torchvision.models.vision_transformer.ViT_B_16_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.vision_transformer.VisionTransformer`` + base class. Please refer to the `source code + `_ + for more details about this class. + + .. autoclass:: torchvision.models.vision_transformer.ViT_B_16_Weights + :members: """ weights = ViT_B_16_Weights.verify(weights) @@ -543,8 +552,17 @@ def vit_b_32(*, weights: Optional[ViT_B_32_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (ViT_B_32_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + weights (:class:`~torchvision.models.vision_transformer.ViT_B_32_Weights`, optional): The pretrained weights to use. See + :class:`~torchvision.models.vision_transformer.ViT_B_32_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.vision_transformer.VisionTransformer`` + base class. Please refer to the `source code + `_ + for more details about this class. + + .. autoclass:: torchvision.models.vision_transformer.ViT_B_32_Weights + :members: """ weights = ViT_B_32_Weights.verify(weights) @@ -567,8 +585,17 @@ def vit_l_16(*, weights: Optional[ViT_L_16_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (ViT_L_16_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + weights (:class:`~torchvision.models.vision_transformer.ViT_L_16_Weights`, optional): The pretrained weights to use. See + :class:`~torchvision.models.vision_transformer.ViT_L_16_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.vision_transformer.VisionTransformer`` + base class. Please refer to the `source code + `_ + for more details about this class. + + .. autoclass:: torchvision.models.vision_transformer.ViT_L_16_Weights + :members: """ weights = ViT_L_16_Weights.verify(weights) @@ -591,8 +618,17 @@ def vit_l_32(*, weights: Optional[ViT_L_32_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (ViT_L_32_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + weights (:class:`~torchvision.models.vision_transformer.ViT_L_32_Weights`, optional): The pretrained weights to use. See + :class:`~torchvision.models.vision_transformer.ViT_L_32_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.vision_transformer.VisionTransformer`` + base class. Please refer to the `source code + `_ + for more details about this class. + + .. autoclass:: torchvision.models.vision_transformer.ViT_L_32_Weights + :members: """ weights = ViT_L_32_Weights.verify(weights) @@ -614,8 +650,17 @@ def vit_h_14(*, weights: Optional[ViT_H_14_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (ViT_H_14_Weights, optional): The pretrained weights for the model - progress (bool): If True, displays a progress bar of the download to stderr + weights (:class:`~torchvision.models.vision_transformer.ViT_H_14_Weights`, optional): The pretrained weights to use. See + :class:`~torchvision.models.vision_transformer.ViT_H_14_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.vision_transformer.VisionTransformer`` + base class. Please refer to the `source code + `_ + for more details about this class. + + .. autoclass:: torchvision.models.vision_transformer.ViT_H_14_Weights + :members: """ weights = ViT_H_14_Weights.verify(weights) From be838c62d109c4889a891ab72994ccf4daa4c662 Mon Sep 17 00:00:00 2001 From: Yosua Michael Maranatha Date: Thu, 21 Apr 2022 16:53:21 +0100 Subject: [PATCH 5/7] Update docstring to make sure it does not exceed 120 chars per line --- torchvision/models/regnet.py | 165 ++++++++++++----------- torchvision/models/vision_transformer.py | 30 ++--- 2 files changed, 105 insertions(+), 90 deletions(-) diff --git a/torchvision/models/regnet.py b/torchvision/models/regnet.py index 48f00b5791d..8750ac087ae 100644 --- a/torchvision/models/regnet.py +++ b/torchvision/models/regnet.py @@ -872,13 +872,14 @@ def regnet_y_400mf(*, weights: Optional[RegNet_Y_400MF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_Y_400MF_Weights :members: @@ -896,13 +897,14 @@ def regnet_y_800mf(*, weights: Optional[RegNet_Y_800MF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_Y_800MF_Weights :members: @@ -920,13 +922,14 @@ def regnet_y_1_6gf(*, weights: Optional[RegNet_Y_1_6GF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_Y_1_6GF_Weights :members: @@ -946,13 +949,14 @@ def regnet_y_3_2gf(*, weights: Optional[RegNet_Y_3_2GF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_Y_3_2GF_Weights :members: @@ -972,13 +976,14 @@ def regnet_y_8gf(*, weights: Optional[RegNet_Y_8GF_Weights] = None, progress: bo `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_Y_8GF_Weights :members: @@ -998,13 +1003,14 @@ def regnet_y_16gf(*, weights: Optional[RegNet_Y_16GF_Weights] = None, progress: `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_Y_16GF_Weights :members: @@ -1024,13 +1030,14 @@ def regnet_y_32gf(*, weights: Optional[RegNet_Y_32GF_Weights] = None, progress: `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_Y_32GF_Weights :members: @@ -1050,13 +1057,14 @@ def regnet_y_128gf(*, weights: Optional[RegNet_Y_128GF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_Y_128GF_Weights :members: @@ -1076,13 +1084,14 @@ def regnet_x_400mf(*, weights: Optional[RegNet_X_400MF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_X_400MF_Weights :members: @@ -1100,13 +1109,14 @@ def regnet_x_800mf(*, weights: Optional[RegNet_X_800MF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_X_800MF_Weights :members: @@ -1124,13 +1134,14 @@ def regnet_x_1_6gf(*, weights: Optional[RegNet_X_1_6GF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_X_1_6GF_Weights :members: @@ -1152,13 +1163,14 @@ def regnet_x_3_2gf(*, weights: Optional[RegNet_X_3_2GF_Weights] = None, progress `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_X_3_2GF_Weights :members: @@ -1180,13 +1192,14 @@ def regnet_x_8gf(*, weights: Optional[RegNet_X_8GF_Weights] = None, progress: bo `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_X_8GF_Weights :members: @@ -1208,13 +1221,14 @@ def regnet_x_16gf(*, weights: Optional[RegNet_X_16GF_Weights] = None, progress: `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_X_16GF_Weights :members: @@ -1236,13 +1250,14 @@ def regnet_x_32gf(*, weights: Optional[RegNet_X_32GF_Weights] = None, progress: `"Designing Network Design Spaces" `_. 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. By default, - no pretrained weights are used. + 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. + 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 - `_ for more detail about the classes. + ``torchvision.models.regnet.BlockParams`` class. Please refer to the `source code + `_ + for more detail about the classes. .. autoclass:: torchvision.models.regnet.RegNet_X_32GF_Weights :members: diff --git a/torchvision/models/vision_transformer.py b/torchvision/models/vision_transformer.py index 89616134be5..63e388068a2 100644 --- a/torchvision/models/vision_transformer.py +++ b/torchvision/models/vision_transformer.py @@ -519,9 +519,9 @@ def vit_b_16(*, weights: Optional[ViT_B_16_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_B_16_Weights`, optional): The pretrained weights to use. See - :class:`~torchvision.models.vision_transformer.ViT_B_16_Weights` below for more details and possible values. - By default, no pre-trained weights are used. + weights (:class:`~torchvision.models.vision_transformer.ViT_B_16_Weights`, optional): + The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_B_16_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.vision_transformer.VisionTransformer`` base class. Please refer to the `source code @@ -552,9 +552,9 @@ def vit_b_32(*, weights: Optional[ViT_B_32_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_B_32_Weights`, optional): The pretrained weights to use. See - :class:`~torchvision.models.vision_transformer.ViT_B_32_Weights` below for more details and possible values. - By default, no pre-trained weights are used. + weights (:class:`~torchvision.models.vision_transformer.ViT_B_32_Weights`, optional): + The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_B_32_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.vision_transformer.VisionTransformer`` base class. Please refer to the `source code @@ -585,9 +585,9 @@ def vit_l_16(*, weights: Optional[ViT_L_16_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_L_16_Weights`, optional): The pretrained weights to use. See - :class:`~torchvision.models.vision_transformer.ViT_L_16_Weights` below for more details and possible values. - By default, no pre-trained weights are used. + weights (:class:`~torchvision.models.vision_transformer.ViT_L_16_Weights`, optional): + The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_L_16_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.vision_transformer.VisionTransformer`` base class. Please refer to the `source code @@ -618,9 +618,9 @@ def vit_l_32(*, weights: Optional[ViT_L_32_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_L_32_Weights`, optional): The pretrained weights to use. See - :class:`~torchvision.models.vision_transformer.ViT_L_32_Weights` below for more details and possible values. - By default, no pre-trained weights are used. + weights (:class:`~torchvision.models.vision_transformer.ViT_L_32_Weights`, optional): + The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_L_32_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.vision_transformer.VisionTransformer`` base class. Please refer to the `source code @@ -650,9 +650,9 @@ def vit_h_14(*, weights: Optional[ViT_H_14_Weights] = None, progress: bool = Tru `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_H_14_Weights`, optional): The pretrained weights to use. See - :class:`~torchvision.models.vision_transformer.ViT_H_14_Weights` below for more details and possible values. - By default, no pre-trained weights are used. + weights (:class:`~torchvision.models.vision_transformer.ViT_H_14_Weights`, optional): + The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_H_14_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.vision_transformer.VisionTransformer`` base class. Please refer to the `source code From 4041cacd8c38eb8dfd54af04cf1bb18ff46d4082 Mon Sep 17 00:00:00 2001 From: Yosua Michael Maranatha Date: Fri, 22 Apr 2022 12:24:30 +0100 Subject: [PATCH 6/7] Improve formatting --- docs/source/models/regnet.rst | 2 +- torchvision/models/regnet.py | 30 ++++++++++++------------ torchvision/models/vision_transformer.py | 10 ++++---- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/source/models/regnet.rst b/docs/source/models/regnet.rst index 907c6b56fce..aef4abd2544 100644 --- a/docs/source/models/regnet.rst +++ b/docs/source/models/regnet.rst @@ -4,7 +4,7 @@ RegNet .. currentmodule:: torchvision.models The RegNet model is based on the `Designing Network Design Spaces -`_ paper. +`_ paper. Model builders diff --git a/torchvision/models/regnet.py b/torchvision/models/regnet.py index fb255a4e196..821d86f11f0 100644 --- a/torchvision/models/regnet.py +++ b/torchvision/models/regnet.py @@ -861,7 +861,7 @@ class RegNet_X_32GF_Weights(WeightsEnum): def regnet_y_400mf(*, weights: Optional[RegNet_Y_400MF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetY_400MF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_Y_400MF_Weights`, optional): The pretrained weights to use. @@ -886,7 +886,7 @@ def regnet_y_400mf(*, weights: Optional[RegNet_Y_400MF_Weights] = None, progress def regnet_y_800mf(*, weights: Optional[RegNet_Y_800MF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetY_800MF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_Y_800MF_Weights`, optional): The pretrained weights to use. @@ -911,7 +911,7 @@ def regnet_y_800mf(*, weights: Optional[RegNet_Y_800MF_Weights] = None, progress def regnet_y_1_6gf(*, weights: Optional[RegNet_Y_1_6GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetY_1.6GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_Y_1_6GF_Weights`, optional): The pretrained weights to use. @@ -938,7 +938,7 @@ def regnet_y_1_6gf(*, weights: Optional[RegNet_Y_1_6GF_Weights] = None, progress def regnet_y_3_2gf(*, weights: Optional[RegNet_Y_3_2GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetY_3.2GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_Y_3_2GF_Weights`, optional): The pretrained weights to use. @@ -965,7 +965,7 @@ def regnet_y_3_2gf(*, weights: Optional[RegNet_Y_3_2GF_Weights] = None, progress def regnet_y_8gf(*, weights: Optional[RegNet_Y_8GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetY_8GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_Y_8GF_Weights`, optional): The pretrained weights to use. @@ -992,7 +992,7 @@ def regnet_y_8gf(*, weights: Optional[RegNet_Y_8GF_Weights] = None, progress: bo def regnet_y_16gf(*, weights: Optional[RegNet_Y_16GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetY_16GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_Y_16GF_Weights`, optional): The pretrained weights to use. @@ -1019,7 +1019,7 @@ def regnet_y_16gf(*, weights: Optional[RegNet_Y_16GF_Weights] = None, progress: def regnet_y_32gf(*, weights: Optional[RegNet_Y_32GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetY_32GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_Y_32GF_Weights`, optional): The pretrained weights to use. @@ -1046,7 +1046,7 @@ def regnet_y_32gf(*, weights: Optional[RegNet_Y_32GF_Weights] = None, progress: def regnet_y_128gf(*, weights: Optional[RegNet_Y_128GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetY_128GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_Y_128GF_Weights`, optional): The pretrained weights to use. @@ -1073,7 +1073,7 @@ def regnet_y_128gf(*, weights: Optional[RegNet_Y_128GF_Weights] = None, progress def regnet_x_400mf(*, weights: Optional[RegNet_X_400MF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetX_400MF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_X_400MF_Weights`, optional): The pretrained weights to use. @@ -1098,7 +1098,7 @@ def regnet_x_400mf(*, weights: Optional[RegNet_X_400MF_Weights] = None, progress def regnet_x_800mf(*, weights: Optional[RegNet_X_800MF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetX_800MF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_X_800MF_Weights`, optional): The pretrained weights to use. @@ -1123,7 +1123,7 @@ def regnet_x_800mf(*, weights: Optional[RegNet_X_800MF_Weights] = None, progress def regnet_x_1_6gf(*, weights: Optional[RegNet_X_1_6GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetX_1.6GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_X_1_6GF_Weights`, optional): The pretrained weights to use. @@ -1152,7 +1152,7 @@ def regnet_x_1_6gf(*, weights: Optional[RegNet_X_1_6GF_Weights] = None, progress def regnet_x_3_2gf(*, weights: Optional[RegNet_X_3_2GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetX_3.2GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_X_3_2GF_Weights`, optional): The pretrained weights to use. @@ -1181,7 +1181,7 @@ def regnet_x_3_2gf(*, weights: Optional[RegNet_X_3_2GF_Weights] = None, progress def regnet_x_8gf(*, weights: Optional[RegNet_X_8GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetX_8GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_X_8GF_Weights`, optional): The pretrained weights to use. @@ -1210,7 +1210,7 @@ def regnet_x_8gf(*, weights: Optional[RegNet_X_8GF_Weights] = None, progress: bo def regnet_x_16gf(*, weights: Optional[RegNet_X_16GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetX_16GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_X_16GF_Weights`, optional): The pretrained weights to use. @@ -1239,7 +1239,7 @@ def regnet_x_16gf(*, weights: Optional[RegNet_X_16GF_Weights] = None, progress: def regnet_x_32gf(*, weights: Optional[RegNet_X_32GF_Weights] = None, progress: bool = True, **kwargs: Any) -> RegNet: """ Constructs a RegNetX_32GF architecture from - `"Designing Network Design Spaces" `_. + `Designing Network Design Spaces `_. Args: weights (:class:`torchvision.models.regnet.RegNet_X_32GF_Weights`, optional): The pretrained weights to use. diff --git a/torchvision/models/vision_transformer.py b/torchvision/models/vision_transformer.py index bc6da1ae8c6..bc303654b05 100644 --- a/torchvision/models/vision_transformer.py +++ b/torchvision/models/vision_transformer.py @@ -490,7 +490,7 @@ class ViT_H_14_Weights(WeightsEnum): def vit_b_16(*, weights: Optional[ViT_B_16_Weights] = None, progress: bool = True, **kwargs: Any) -> VisionTransformer: """ Constructs a vit_b_16 architecture from - `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. + `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: weights (:class:`~torchvision.models.vision_transformer.ViT_B_16_Weights`, optional): @@ -523,7 +523,7 @@ def vit_b_16(*, weights: Optional[ViT_B_16_Weights] = None, progress: bool = Tru def vit_b_32(*, weights: Optional[ViT_B_32_Weights] = None, progress: bool = True, **kwargs: Any) -> VisionTransformer: """ Constructs a vit_b_32 architecture from - `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. + `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: weights (:class:`~torchvision.models.vision_transformer.ViT_B_32_Weights`, optional): @@ -556,7 +556,7 @@ def vit_b_32(*, weights: Optional[ViT_B_32_Weights] = None, progress: bool = Tru def vit_l_16(*, weights: Optional[ViT_L_16_Weights] = None, progress: bool = True, **kwargs: Any) -> VisionTransformer: """ Constructs a vit_l_16 architecture from - `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. + `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: weights (:class:`~torchvision.models.vision_transformer.ViT_L_16_Weights`, optional): @@ -589,7 +589,7 @@ def vit_l_16(*, weights: Optional[ViT_L_16_Weights] = None, progress: bool = Tru def vit_l_32(*, weights: Optional[ViT_L_32_Weights] = None, progress: bool = True, **kwargs: Any) -> VisionTransformer: """ Constructs a vit_l_32 architecture from - `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. + `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: weights (:class:`~torchvision.models.vision_transformer.ViT_L_32_Weights`, optional): @@ -621,7 +621,7 @@ def vit_l_32(*, weights: Optional[ViT_L_32_Weights] = None, progress: bool = Tru def vit_h_14(*, weights: Optional[ViT_H_14_Weights] = None, progress: bool = True, **kwargs: Any) -> VisionTransformer: """ Constructs a vit_h_14 architecture from - `"An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale" `_. + `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: weights (:class:`~torchvision.models.vision_transformer.ViT_H_14_Weights`, optional): From bbc308cffc6312fe378a1a66b491df7301f81c44 Mon Sep 17 00:00:00 2001 From: Yosua Michael Maranatha Date: Fri, 22 Apr 2022 12:32:07 +0100 Subject: [PATCH 7/7] Change the new line location for vision_transformer docstring --- torchvision/models/vision_transformer.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/torchvision/models/vision_transformer.py b/torchvision/models/vision_transformer.py index bc303654b05..f85404c4bde 100644 --- a/torchvision/models/vision_transformer.py +++ b/torchvision/models/vision_transformer.py @@ -493,8 +493,8 @@ def vit_b_16(*, weights: Optional[ViT_B_16_Weights] = None, progress: bool = Tru `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_B_16_Weights`, optional): - The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_B_16_Weights` + weights (:class:`~torchvision.models.vision_transformer.ViT_B_16_Weights`, optional): The pretrained + weights to use. See :class:`~torchvision.models.vision_transformer.ViT_B_16_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.vision_transformer.VisionTransformer`` @@ -526,8 +526,8 @@ def vit_b_32(*, weights: Optional[ViT_B_32_Weights] = None, progress: bool = Tru `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_B_32_Weights`, optional): - The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_B_32_Weights` + weights (:class:`~torchvision.models.vision_transformer.ViT_B_32_Weights`, optional): The pretrained + weights to use. See :class:`~torchvision.models.vision_transformer.ViT_B_32_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.vision_transformer.VisionTransformer`` @@ -559,8 +559,8 @@ def vit_l_16(*, weights: Optional[ViT_L_16_Weights] = None, progress: bool = Tru `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_L_16_Weights`, optional): - The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_L_16_Weights` + weights (:class:`~torchvision.models.vision_transformer.ViT_L_16_Weights`, optional): The pretrained + weights to use. See :class:`~torchvision.models.vision_transformer.ViT_L_16_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.vision_transformer.VisionTransformer`` @@ -592,8 +592,8 @@ def vit_l_32(*, weights: Optional[ViT_L_32_Weights] = None, progress: bool = Tru `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_L_32_Weights`, optional): - The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_L_32_Weights` + weights (:class:`~torchvision.models.vision_transformer.ViT_L_32_Weights`, optional): The pretrained + weights to use. See :class:`~torchvision.models.vision_transformer.ViT_L_32_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.vision_transformer.VisionTransformer`` @@ -624,8 +624,8 @@ def vit_h_14(*, weights: Optional[ViT_H_14_Weights] = None, progress: bool = Tru `An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale `_. Args: - weights (:class:`~torchvision.models.vision_transformer.ViT_H_14_Weights`, optional): - The pretrained weights to use. See :class:`~torchvision.models.vision_transformer.ViT_H_14_Weights` + weights (:class:`~torchvision.models.vision_transformer.ViT_H_14_Weights`, optional): The pretrained + weights to use. See :class:`~torchvision.models.vision_transformer.ViT_H_14_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.vision_transformer.VisionTransformer``