Skip to content

Commit

Permalink
fix paddle.vision.models.* cn docs (PaddlePaddle#4936)
Browse files Browse the repository at this point in the history
* begin a pr (just a placeholder)

* add a blank line

* add space between cn and en char

* "sing `COPY-FROM`

* add a blank line between h2 and p

* refine returns

* fix the case of proper

* refine parameter `pretrained`

* add parameter `kwargs`

* refine parameter `num_classes`

* missing parameter `with_pool`

* CRLF -> LF

@Ainavo 出来挨打,为什么你写的全是 CRLF 的……

* add some missing api labels

* `默认值:` -> `默认值为 `

* refine returns

* :math:\`0.0\`
  • Loading branch information
SigureMo authored Jun 23, 2022
1 parent d096b9d commit b5f69de
Show file tree
Hide file tree
Showing 52 changed files with 572 additions and 393 deletions.
67 changes: 51 additions & 16 deletions docs/api/api_label
Original file line number Diff line number Diff line change
Expand Up @@ -1042,36 +1042,67 @@ paddle.utils.download.get_weights_path_from_url .. _api_paddle_utils_download_ge
paddle.utils.profiler.get_profiler .. _api_paddle_utils_profiler_get_profiler:
paddle.utils.profiler.Profiler .. _api_paddle_utils_profiler_Profiler:
paddle.utils.profiler.ProfilerOptions .. _api_paddle_utils_profiler_ProfilerOptions:
paddle.vision.AlexNet .. _api_paddle_vision_AlexNet:
paddle.vision.alexnet .. _api_paddle_vision_alexnet:
paddle.vision.DenseNet .. _api_paddle_vision_DenseNet:
paddle.vision.densenet121 .. _api_paddle_vision_densenet121:
paddle.vision.densenet161 .. _api_paddle_vision_densenet161:
paddle.vision.densenet169 .. _api_paddle_vision_densenet169:
paddle.vision.densenet201 .. _api_paddle_vision_densenet201:
paddle.vision.densenet264 .. _api_paddle_vision_densenet264:
paddle.vision.FashionMNIST .. _api_paddle_vision_FashionMNIST:
paddle.vision.Flowers .. _api_paddle_vision_Flowers:
paddle.vision.resnet34 .. _api_paddle_vision_resnet34:
paddle.vision.MobileNetV2 .. _api_paddle_vision_MobileNetV2:
paddle.vision.RandomResizedCrop .. _api_paddle_vision_RandomResizedCrop:
paddle.vision.GoogLeNet .. _api_paddle_vision_GoogLeNet:
paddle.vision.googlenet .. _api_paddle_vision_googlenet:
paddle.vision.inception_v3 .. _api_paddle_vision_inception_v3:
paddle.vision.InceptionV3 .. _api_paddle_vision_InceptionV3:
paddle.vision.HueTransform .. _api_paddle_vision_HueTransform:
paddle.vision.to_tensor .. _api_paddle_vision_to_tensor:
paddle.vision.ResNet .. _api_paddle_vision_ResNet:
paddle.vision.RandomResizedCrop .. _api_paddle_vision_RandomResizedCrop:
paddle.vision.RandomCrop .. _api_paddle_vision_RandomCrop:
paddle.vision.ResNet .. _api_paddle_vision_ResNet:
paddle.vision.resnet101 .. _api_paddle_vision_resnet101:
paddle.vision.resnet152 .. _api_paddle_vision_resnet152:
paddle.vision.resnet18 .. _api_paddle_vision_resnet18:
paddle.vision.resnet34 .. _api_paddle_vision_resnet34:
paddle.vision.resnet50 .. _api_paddle_vision_resnet50:
paddle.vision.resnext101_32x4d .. _api_paddle_vision_resnext101_32x4d:
paddle.vision.resnext101_64x4d .. _api_paddle_vision_resnext101_64x4d:
paddle.vision.resnext152_32x4d .. _api_paddle_vision_resnext152_32x4d:
paddle.vision.resnext152_64x4d .. _api_paddle_vision_resnext152_64x4d:
paddle.vision.resnext50_32x4d .. _api_paddle_vision_resnext50_32x4d:
paddle.vision.resnext50_64x4d .. _api_paddle_vision_resnext50_64x4d:
paddle.vision.shufflenet_v2_swish .. _api_paddle_vision_shufflenet_v2_swish:
paddle.vision.shufflenet_v2_x0_25 .. _api_paddle_vision_shufflenet_v2_x0_25:
paddle.vision.shufflenet_v2_x0_33 .. _api_paddle_vision_shufflenet_v2_x0_33:
paddle.vision.shufflenet_v2_x0_5 .. _api_paddle_vision_shufflenet_v2_x0_5:
paddle.vision.shufflenet_v2_x1_0 .. _api_paddle_vision_shufflenet_v2_x1_0:
paddle.vision.shufflenet_v2_x1_5 .. _api_paddle_vision_shufflenet_v2_x1_5:
paddle.vision.shufflenet_v2_x2_0 .. _api_paddle_vision_shufflenet_v2_x2_0:
paddle.vision.ShuffleNetV2 .. _api_paddle_vision_ShuffleNetV2:
paddle.vision.SqueezeNet .. _api_paddle_vision_SqueezeNet:
paddle.vision.squeezenet1_0 .. _api_paddle_vision_squeezenet1_0:
paddle.vision.squeezenet1_1 .. _api_paddle_vision_squeezenet1_1:
paddle.vision.to_tensor .. _api_paddle_vision_to_tensor:
paddle.vision.ToTensor .. _api_paddle_vision_ToTensor:
paddle.vision.Cifar100 .. _api_paddle_vision_Cifar100:
paddle.vision.DatasetFolder .. _api_paddle_vision_DatasetFolder:
paddle.vision.crop .. _api_paddle_vision_crop:
paddle.vision.RandomHorizontalFlip .. _api_paddle_vision_RandomHorizontalFlip:
paddle.vision.resize .. _api_paddle_vision_resize:
paddle.vision.resnet50 .. _api_paddle_vision_resnet50:
paddle.vision.Resize .. _api_paddle_vision_Resize:
paddle.vision.CenterCrop .. _api_paddle_vision_CenterCrop:
paddle.vision.adjust_hue .. _api_paddle_vision_adjust_hue:
paddle.vision.image_load .. _api_paddle_vision_image_load:
paddle.vision.MNIST .. _api_paddle_vision_MNIST:
paddle.vision.mobilenet_v1 .. _api_paddle_vision_mobilenet_v1:
paddle.vision.get_image_backend .. _api_paddle_vision_get_image_backend:
paddle.vision.resnet101 .. _api_paddle_vision_resnet101:
paddle.vision.Grayscale .. _api_paddle_vision_Grayscale:
paddle.vision.VGG .. _api_paddle_vision_VGG:
paddle.vision.vgg11 .. _api_paddle_vision_vgg11:
paddle.vision.vgg13 .. _api_paddle_vision_vgg13:
paddle.vision.vgg16 .. _api_paddle_vision_vgg16:
paddle.vision.vgg19 .. _api_paddle_vision_vgg19:
paddle.vision.VOC2012 .. _api_paddle_vision_VOC2012:
paddle.vision.Transpose .. _api_paddle_vision_Transpose:
paddle.vision.resnet18 .. _api_paddle_vision_resnet18:
paddle.vision.vgg11 .. _api_paddle_vision_vgg11:
paddle.vision.center_crop .. _api_paddle_vision_center_crop:
paddle.vision.adjust_brightness .. _api_paddle_vision_adjust_brightness:
paddle.vision.set_image_backend .. _api_paddle_vision_set_image_backend:
Expand All @@ -1080,27 +1111,31 @@ paddle.vision.Pad .. _api_paddle_vision_Pad:
paddle.vision.normalize .. _api_paddle_vision_normalize:
paddle.vision.Cifar10 .. _api_paddle_vision_Cifar10:
paddle.vision.ColorJitter .. _api_paddle_vision_ColorJitter:
paddle.vision.MobileNetV1 .. _api_paddle_vision_MobileNetV1:
paddle.vision.pad .. _api_paddle_vision_pad:
paddle.vision.vflip .. _api_paddle_vision_vflip:
paddle.vision.RandomVerticalFlip .. _api_paddle_vision_RandomVerticalFlip:
paddle.vision.adjust_contrast .. _api_paddle_vision_adjust_contrast:
paddle.vision.models.LeNet .. _api_paddle_vision_models_LeNet:
paddle.vision.mobilenet_v1 .. _api_paddle_vision_mobilenet_v1:
paddle.vision.mobilenet_v2 .. _api_paddle_vision_mobilenet_v2:
paddle.vision.mobilenet_v3_large .. _api_paddle_vision_mobilenet_v3_large:
paddle.vision.mobilenet_v3_small .. _api_paddle_vision_mobilenet_v3_small:
paddle.vision.MobileNetV1 .. _api_paddle_vision_MobileNetV1:
paddle.vision.MobileNetV2 .. _api_paddle_vision_MobileNetV2:
paddle.vision.MobileNetV3Large .. _api_paddle_vision_MobileNetV3Large:
paddle.vision.MobileNetV3Small .. _api_paddle_vision_MobileNetV3Small:
paddle.vision.Compose .. _api_paddle_vision_Compose:
paddle.vision.vgg13 .. _api_paddle_vision_vgg13:
paddle.vision.BaseTransform .. _api_paddle_vision_BaseTransform:
paddle.vision.to_grayscale .. _api_paddle_vision_to_grayscale:
paddle.vision.BrightnessTransform .. _api_paddle_vision_BrightnessTransform:
paddle.vision.RandomRotation .. _api_paddle_vision_RandomRotation:
paddle.vision.rotate .. _api_paddle_vision_rotate:
paddle.vision.vgg16 .. _api_paddle_vision_vgg16:
paddle.vision.resnet152 .. _api_paddle_vision_resnet152:
paddle.vision.ImageFolder .. _api_paddle_vision_ImageFolder:
paddle.vision.vgg19 .. _api_paddle_vision_vgg19:
paddle.vision.hflip .. _api_paddle_vision_hflip:
paddle.vision.ContrastTransform .. _api_paddle_vision_ContrastTransform:
paddle.vision.mobilenet_v2 .. _api_paddle_vision_mobilenet_v2:
paddle.vision.Normalize .. _api_paddle_vision_Normalize:
paddle.vision.wide_resnet101_2 .. _api_paddle_vision_wide_resnet101_2:
paddle.vision.wide_resnet50_2 .. _api_paddle_vision_wide_resnet50_2:
paddle.vision.ops.yolo_loss .. _api_paddle_vision_ops_yolo_loss:
paddle.vision.ops.yolo_box .. _api_paddle_vision_ops_yolo_box:
paddle.vision.ops.decode_jpeg .. _api_paddle_vision_ops_decode_jpeg:
Expand Down
18 changes: 10 additions & 8 deletions docs/api/paddle/vision/models/AlexNet_cn.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
.. _cn_api_paddle_vision_models_alexnet:
.. _cn_api_paddle_vision_models_AlexNet:

alexnet
AlexNet
-------------------------------

.. py:function:: paddle.vision.models.alexnet(pretrained=False, **kwargs)
.. py:function:: paddle.vision.models.AlexNet(num_classes=1000)
AlexNet模型,来自论文 `"ImageNet Classification with Deep Convolutional Neural Networks" <https://papers.nips.cc/paper/2012/file/c399862d3b9d6b76c8436e924a68c45b-Paper.pdf>`_ 。
AlexNet 模型,来自论文 `"ImageNet Classification with Deep Convolutional Neural Networks" <https://papers.nips.cc/paper/2012/file/c399862d3b9d6b76c8436e924a68c45b-Paper.pdf>`_ 。

参数
:::::::::
- **pretrained** (bool,可选) - 是否加载在imagenet数据集上的预训练权重。默认值:False。
- **\*\*kwargs** (可选) - 附加的关键字参数,具体可选参数请参见 :ref:`AlexNet <cn_api_paddle_vision_models_AlexNet>`。

- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于等于 0,则不定义最后一个全连接层。默认值为 1000。

返回
:::::::::
alexnet模型,Layer的实例。

:ref:`cn_api_fluid_dygraph_Layer`,AlexNet 模型实例。

代码示例
:::::::::

COPY-FROM: paddle.vision.models.alexnet:code-example
COPY-FROM: paddle.vision.models.AlexNet
22 changes: 13 additions & 9 deletions docs/api/paddle/vision/models/DenseNet_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,26 @@
DenseNet
-------------------------------

.. py:class:: paddle.vision.models.DenseNet(layers=121, bn_size=4, dropout=0., num_classes=1000)
.. py:class:: paddle.vision.models.DenseNet(layers=121, bn_size=4, dropout=0., num_classes=1000, with_pool=True)
DenseNet模型,来自论文 `"Densely Connected Convolutional Networks" <https://arxiv.org/abs/1608.06993>`_ 。
DenseNet 模型,来自论文 `"Densely Connected Convolutional Networks" <https://arxiv.org/abs/1608.06993>`_ 。

参数
:::::::::
- **layers** (int,可选) - densenet的层数。默认值:121。
- **bn_size** (int,可选) - 中间层growth rate的拓展倍数。默认值:4。
- **dropout** (float,可选) - dropout rate。默认值:0.。
- **num_classes** (int,可选) - 类别数目,即最后一个全连接层输出的维度。默认值:1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值:True。

- **layers** (int,可选) - DenseNet 的层数。默认值为 121。
- **bn_size** (int,可选) - 中间层 growth rate 的拓展倍数。默认值为 4。
- **dropout** (float,可选) - dropout rate。默认值为 :math:`0.0`。
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于等于 0,则不定义最后一个全连接层。默认值为 1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值为 True。

返回
:::::::::
DenseNet模型,Layer的实例。

:ref:`cn_api_fluid_dygraph_Layer`,DenseNet 模型实例。

代码示例
:::::::::
COPY-FROM: paddle.vision.models.DenseNet

COPY-FROM: paddle.vision.models.DenseNet
31 changes: 11 additions & 20 deletions docs/api/paddle/vision/models/GoogLeNet_cn.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,25 @@
.. _cn_api_paddle_vision_models_googlenet:
.. _cn_api_paddle_vision_models_GoogLeNet:

googlenet
GoogLeNet
-------------------------------

.. py:function:: paddle.vision.models.googlenet(pretrained=False, **kwargs)
.. py:function:: paddle.vision.models.googlenet(num_classes=1000, with_pool=True)
GoogLeNet(Inception v1)模型,来自论文 `"Going Deeper with Convolutions" <https://arxiv.org/pdf/1409.4842.pdf>`_ 。
GoogLeNet(Inception v1)模型,来自论文 `"Going Deeper with Convolutions" <https://arxiv.org/pdf/1409.4842.pdf>`_ 。

参数
:::::::::
- **pretrained** (bool,可选) - 是否加载在imagenet数据集上的预训练权重。默认值:False。

- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于等于 0,则不定义最后一个全连接层。默认值为 1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值为 True。

返回
:::::::::
GoogLeNet模型,Layer的实例。

:ref:`cn_api_fluid_dygraph_Layer`,GoogLeNet(Inception v1)模型实例。

代码示例
:::::::::
.. code-block:: python
import paddle
from paddle.vision.models import googlenet
# build model
model = googlenet()
# build model and load imagenet pretrained weight
# model = googlenet(pretrained=True)
x = paddle.rand([1, 3, 224, 224])
out, out1, out2 = model(x)

print(out.shape)
COPY-FROM: paddle.vision.models.GoogLeNet
14 changes: 9 additions & 5 deletions docs/api/paddle/vision/models/InceptionV3_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,21 @@ InceptionV3

.. py:class:: paddle.vision.models.InceptionV3(num_classes=1000, with_pool=True)
InceptionV3模型,来自论文 `"Rethinking the Inception Architecture for Computer Vision" <https://arxiv.org/pdf/1512.00567.pdf>`_ 。
Inception v3 模型,来自论文 `"Rethinking the Inception Architecture for Computer Vision" <https://arxiv.org/pdf/1512.00567.pdf>`_ 。

参数
:::::::::
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于0,则不定义最后一个全连接层。默认值:1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值:True。

- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于等于 0,则不定义最后一个全连接层。默认值为 1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值为 True。

返回
:::::::::
InceptionV3模型,Layer的实例。

:ref:`cn_api_fluid_dygraph_Layer`,Inception v3 模型实例。

代码示例
:::::::::
COPY-FROM: paddle.vision.models.InceptionV3

COPY-FROM: paddle.vision.models.InceptionV3
13 changes: 10 additions & 3 deletions docs/api/paddle/vision/models/LeNet_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,20 @@ LeNet

.. py:class:: paddle.vision.models.LeNet(num_classes=10)
LeNet模型,来自论文 `"Gradient-based learning applied to document recognition" <https://ieeexplore.ieee.org/document/726791>`_ 。
LeNet 模型,来自论文 `"Gradient-based learning applied to document recognition" <https://ieeexplore.ieee.org/document/726791>`_ 。

参数
:::::::::
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。默认值:10。

- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于等于 0,则不定义最后一个全连接层。默认值为 10。

返回
:::::::::

:ref:`cn_api_fluid_dygraph_Layer`,LeNet 模型实例。

代码示例
:::::::::
COPY-FROM: paddle.vision.models.LeNet

COPY-FROM: paddle.vision.models.LeNet
16 changes: 9 additions & 7 deletions docs/api/paddle/vision/models/MobileNetV1_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,22 @@ MobileNetV1
.. py:class:: paddle.vision.models.MobileNetV1(scale=1.0, num_classes=1000, with_pool=True)
MobileNetV1模型,来自论文 `"MobileNets: Efficient Convolutional Neural Networks for Mobile Vision Applications" <https://arxiv.org/abs/1704.04861>`_ 。
MobileNetV1 模型,来自论文 `"MobileNets: Efficient Convolutional Neural Networks for Mobile Vision Applications" <https://arxiv.org/abs/1704.04861>`_ 。

参数
:::::::::
- **scale** (float,可选) - 模型通道数的缩放比例。默认值:1.0。
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于0,则不定义最后一个全连接层。默认值:1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值:True。

- **scale** (float,可选) - 模型通道数的缩放比例。默认值为 1.0。
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于等于 0,则不定义最后一个全连接层。默认值为 1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值为 True。

返回
:::::::::
mobilenetv1模型,Layer的实例。

:ref:`cn_api_fluid_dygraph_Layer`,MobileNetV1 模型实例。

代码示例
:::::::::
COPY-FROM: paddle.vision.models.MobileNetV1:code-example1

COPY-FROM: paddle.vision.models.MobileNetV1

16 changes: 9 additions & 7 deletions docs/api/paddle/vision/models/MobileNetV2_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,22 @@ MobileNetV2
.. py:class:: paddle.vision.models.MobileNetV2(scale=1.0, num_classes=1000, with_pool=True)
MobileNetV2模型,来自论文 `"MobileNetV2: Inverted Residuals and Linear Bottlenecks" <https://arxiv.org/abs/1801.04381>`_ 。
MobileNetV2 模型,来自论文 `"MobileNetV2: Inverted Residuals and Linear Bottlenecks" <https://arxiv.org/abs/1801.04381>`_ 。

参数
:::::::::
- **scale** (float,可选) - 模型通道数的缩放比例。默认值:1.0。
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于0,则不定义最后一个全连接层。默认值:1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值:True。

- **scale** (float,可选) - 模型通道数的缩放比例。默认值为 1.0。
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于等于 0,则不定义最后一个全连接层。默认值为 1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值为 True。

返回
:::::::::
mobilenetv2模型,Layer的实例。

:ref:`cn_api_fluid_dygraph_Layer`,MobileNetV2 模型实例。

代码示例
:::::::::
COPY-FROM: paddle.vision.models.MobileNetV2:code-example1

COPY-FROM: paddle.vision.models.MobileNetV2

15 changes: 9 additions & 6 deletions docs/api/paddle/vision/models/MobileNetV3Large_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,22 @@ MobileNetV3Large

.. py:class:: paddle.vision.models.MobileNetV3Large(scale=1.0, num_classes=1000, with_pool=True)
MobileNetV3Large模型,来自论文 `"Searching for MobileNetV3" <https://arxiv.org/abs/1905.02244>`_ 。
MobileNetV3 Large 架构模型,来自论文 `"Searching for MobileNetV3" <https://arxiv.org/abs/1905.02244>`_ 。

参数
:::::::::
- **scale** (float,可选) - 模型通道数的缩放比例。默认值:1.0。
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于0,则不定义最后一个全连接层。默认值:1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值:True。

- **scale** (float,可选) - 模型通道数的缩放比例。默认值为 1.0。
- **num_classes** (int,可选) - 最后一个全连接层输出的维度。如果该值小于等于 0,则不定义最后一个全连接层。默认值为 1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值为 True。

返回
:::::::::
mobilenetv3 large模型,Layer的实例。

:ref:`cn_api_fluid_dygraph_Layer`,MobileNetV3 Large 架构模型实例。

代码示例
:::::::::

COPY-FROM: paddle.vision.models.MobileNetV3Large
COPY-FROM: paddle.vision.models.MobileNetV3Large
Loading

0 comments on commit b5f69de

Please sign in to comment.