Skip to content

fix hapi doc bugs #3124

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/paddle/api/alias_api_mapping
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ paddle.hapi.callbacks.ReduceLROnPlateau paddle.callbacks.ReduceLROnPlateau
paddle.hapi.callbacks.LRScheduler paddle.callbacks.LRScheduler
paddle.hapi.callbacks.EarlyStopping paddle.callbacks.EarlyStopping
paddle.hapi.model_summary.summary paddle.summary
paddle.hapi.model_flops.flops paddle.flops
paddle.hapi.dynamic_flops.flops paddle.flops
paddle.vision.models.resnet.ResNet paddle.vision.models.ResNet,paddle.vision.ResNet
paddle.vision.models.resnet.resnet18 paddle.vision.models.resnet18,paddle.vision.resnet18
paddle.vision.models.resnet.resnet34 paddle.vision.models.resnet34,paddle.vision.resnet34
Expand Down Expand Up @@ -550,4 +550,4 @@ paddle.fluid.io.set_program_state paddle.static.set_program_state
paddle.tensor.attribute.real paddle.real,paddle.tensor.real
paddle.tensor.attribute.imag paddle.imag,paddle.tensor.imag
paddle.fluid.layers.BeamSearchDecoder paddle.nn.BeamSearchDecoder
paddle.fluid.layers.dynamic_decode paddle.nn.dynamic_decode
paddle.fluid.layers.dynamic_decode paddle.nn.dynamic_decode
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,20 @@ flops

``flops`` 函数能够打印网络的基础结构和参数信息。

参数
- **net** (paddle.nn.Layer||paddle.static.Program) - 网络实例,必须是 paddle.nn.Layer
的子类或者静态图下的 paddle.static.Program。
参数
:::::::::
- **net** (paddle.nn.Layer||paddle.static.Program) - 网络实例,必须是 paddle.nn.Layer 的子类或者静态图下的 paddle.static.Program。
- **input_size** (list) - 输入张量的大小。注意:仅支持batch_size=1。
- **custom_ops** (dict,可选) - 字典,用于实现对自定义网络层的统计。字典的key为自定义网络
层的class,value为统计网络层flops的函数,函数实现方法见示例代码。
此参数仅在 'net' 为paddle.nn.Layer时生效。默认值:None。
- **print_detail (bool, 可选) - bool值,用于控制是否打印每个网络层的细节。默认值:False
返回:整型,网络模型的计算量。
- **custom_ops** (dict,可选) - 字典,用于实现对自定义网络层的统计。字典的key为自定义网络层的class,value为统计网络层flops的函数,函数实现方法见示例代码。此参数仅在 'net' 为paddle.nn.Layer时生效。默认值:None。
- **print_detail** (bool, 可选) - bool值,用于控制是否打印每个网络层的细节。默认值:False

返回
:::::::::
整型,网络模型的计算量。

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

**代码示例**:
.. code-block:: python

import paddle
Expand Down
13 changes: 12 additions & 1 deletion doc/paddle/api/paddle/hapi/model/Model_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,18 @@ Model

.. py:class:: paddle.Model()

``Model`` 对象是一个具备训练、测试、推理的神经网络。该对象同时支持静态图和动态图模式,通过 ``paddle.enable_static()`` 来切换。需要注意的是,该开关需要在实例化 ``Model`` 对象之前使用。输入需要使用 ``paddle.static.InputSpec`` 来定义。
``Model`` 对象是一个具备训练、测试、推理的神经网络。该对象同时支持静态图和动态图模式,飞桨框架默认为动态图模式,通过 ``paddle.enable_static()`` 来切换到静态图模式。需要注意的是,需要在实例化 ``Model`` 对象之前完成切换。

参数
:::::::::

- **network** (paddle.nn.Layer): 是 ``paddle.nn.Layer`` 的一个实例
- **inputs** (InputSpec|list|dict|None, 可选): ``network`` 的输入,可以是 ``InputSpec`` 的实例,或者是一个 ``InputSpec`` 的 ``list`` ,或者是格式为 ``{name: InputSpec}`` 的 ``dict`` ,或者为 ``None`` . 默认值为 ``None`` .
- **labels** (InputSpec|list|None, 可选): ``network`` 的标签,可以是 ``InputSpec`` 的实例,或者是一个 ``InputSpec`` 的 ``list`` ,或者为 ``None``. 默认值为 ``None`` .

.. note::

在动态图中, ``inputs`` 和 ``labels`` 都可以设置为 ``None``. 但是,在静态图中, ``input`` 不能设置为 ``None`` . 而如果损失函数需要标签(label)作为输入,则必须设置 ``labels`` ,否则,可以为 ``None`` 。

代码示例
:::::::::
Expand Down
4 changes: 2 additions & 2 deletions doc/paddle/api/paddle/nn/functional/common/interpolate_cn.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _cn_api_paddle_nn_functional_interpolate:

Interpolate
interpolate
-------------------------------

.. py:function:: paddle.nn.functioanl.interpolate(x, size=None, scale_factor=None, mode='nearest', align_corners=False, align_mode=0, data_format='NCHW', name=None)
.. py:function:: paddle.nn.functional.interpolate(x, size=None, scale_factor=None, mode='nearest', align_corners=False, align_mode=0, data_format='NCHW', name=None)



Expand Down
9 changes: 5 additions & 4 deletions doc/paddle/api/paddle/vision/models/lenet/LeNet_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ LeNet

.. py:class:: paddle.vision.models.LeNet(num_classes=10)

LeNet模型,来自论文`"LeCun Y, Bottou L, Bengio Y, et al. Gradient-based learning applied to document recognition[J]. Proceedings of the IEEE, 1998, 86(11): 2278-2324.`_
LeNet模型,来自论文 `"Gradient-based learning applied to document recognition" <https://ieeexplore.ieee.org/document/726791>`_

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


**代码示例**:

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,20 @@ 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。

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

**代码示例**:
返回
:::::::::
mobilenetv1模型,Layer的实例。

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,19 @@ mobilenet_v1

.. py:function:: paddle.vision.models.mobilenet_v1(pretrained=False, scale=1.0, **kwargs)

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>`_

参数:
参数
:::::::::
- **pretrained** (bool,可选) - 是否加载在imagenet数据集上的预训练权重。默认值:False。
- **scale** (float,可选) - 模型通道数的缩放比例。默认值:1.0。

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

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

.. code-block:: python

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,20 @@ 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。

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

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

.. code-block:: python

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,19 @@ mobilenet_v2

.. py:function:: paddle.vision.models.mobilenet_v2(pretrained=False, scale=1.0, **kwargs)

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>`_

参数:
参数
:::::::::
- **pretrained** (bool,可选) - 是否加载在imagenet数据集上的预训练权重。默认值:False。
- **scale** (float,可选) - 模型通道数的缩放比例。默认值:1.0。

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

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

.. code-block:: python

Expand Down
13 changes: 8 additions & 5 deletions doc/paddle/api/paddle/vision/models/resnet/ResNet_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,21 @@ ResNet

.. py:class:: paddle.vision.models.ResNet(Block, depth=50, num_classes=1000, with_pool=True)

ResNet模型,来自论文`"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_。
ResNet模型,来自论文 `"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_

参数:
参数
:::::::::
- **Block** (BasicBlock|BottleneckBlock) - 模型的残差模块。
- **depth** (int,可选) - resnet模型的深度。默认值:50
- **num_classes** (int, 可选) - 最后一个全连接层输出的维度。如果该值小于0,则不定义最后一个全连接层。默认值:1000。
- **with_pool** (bool,可选) - 是否定义最后一个全连接层之前的池化层。默认值:True。

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

**代码示例**:
返回
:::::::::
ResNet模型,Layer的实例。

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
13 changes: 8 additions & 5 deletions doc/paddle/api/paddle/vision/models/resnet/resnet101_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@ resnet101

.. py:function:: paddle.vision.models.resnet101(pretrained=False, **kwargs)

101层的resnet模型,来自论文`"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_。
101层的resnet模型,来自论文 `"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_

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

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

**代码示例**:
返回
:::::::::
resnet101模型,Layer的实例。

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
13 changes: 8 additions & 5 deletions doc/paddle/api/paddle/vision/models/resnet/resnet152_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@ resnet152

.. py:function:: paddle.vision.models.resnet152(pretrained=False, **kwargs)

152层的resnet模型,来自论文`"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_。
152层的resnet模型,来自论文 `"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_

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

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

**代码示例**:
返回
:::::::::
resnet152模型,Layer的实例。

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
13 changes: 8 additions & 5 deletions doc/paddle/api/paddle/vision/models/resnet/resnet18_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@ resnet18

.. py:function:: paddle.vision.models.resnet18(pretrained=False, **kwargs)

18层的resnet模型,来自论文`"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_。
18层的resnet模型,来自论文 `"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_

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

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

**代码示例**:
返回
:::::::::
resnet18模型,Layer的实例。

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
13 changes: 8 additions & 5 deletions doc/paddle/api/paddle/vision/models/resnet/resnet34_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@ resnet34

.. py:function:: paddle.vision.models.resnet34(pretrained=False, **kwargs)

34层的resnet模型,来自论文`"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_。
34层的resnet模型,来自论文 `"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_

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

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

**代码示例**:
返回
:::::::::
resnet34模型,Layer的实例。

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
13 changes: 8 additions & 5 deletions doc/paddle/api/paddle/vision/models/resnet/resnet50_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,18 @@ resnet50

.. py:function:: paddle.vision.models.resnet50(pretrained=False, **kwargs)

50层的resnet模型,来自论文`"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_。
50层的resnet模型,来自论文 `"Deep Residual Learning for Image Recognition" <https://arxiv.org/pdf/1512.03385.pdf>`_

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

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

**代码示例**:
返回
:::::::::
resnet50模型,Layer的实例。

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
12 changes: 8 additions & 4 deletions doc/paddle/api/paddle/vision/models/vgg/VGG_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,20 @@ VGG

.. py:class:: paddle.vision.models.VGG(features, num_classes=1000)

VGG模型,来自论文`"Very Deep Convolutional Networks For Large-Scale Image Recognition" <https://arxiv.org/pdf/1409.1556.pdf>`_。
VGG模型,来自论文 `"Very Deep Convolutional Networks For Large-Scale Image Recognition" <https://arxiv.org/pdf/1409.1556.pdf>`_

参数:
参数
:::::::::
- **features** (Layer) - vgg模型的特征层。由函数make_layers产生。
- **num_classes** (int, 可选) - 最后一个全连接层输出的维度。如果该值小于等于0,则不定义最后一个全连接层。默认值:1000。
- **with_pool** (bool,可选): - 是否在最后三个全连接层前使用池化. 默认值: True.

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

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

.. code-block:: python

Expand Down
13 changes: 8 additions & 5 deletions doc/paddle/api/paddle/vision/models/vgg/vgg11_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,19 @@ vgg11

.. py:function:: paddle.vision.models.vgg11(pretrained=False, batch_norm=False, **kwargs)

vgg11模型,来自论文`"Very Deep Convolutional Networks For Large-Scale Image Recognition" <https://arxiv.org/pdf/1409.1556.pdf>`_。
vgg11模型,来自论文 `"Very Deep Convolutional Networks For Large-Scale Image Recognition" <https://arxiv.org/pdf/1409.1556.pdf>`_

参数:
参数
:::::::::
- **pretrained** (bool,可选) - 是否加载在imagenet数据集上的预训练权重。默认值:False。
- **batch_norm** (bool, 可选) - 是否在每个卷积层后添加批归一化层。默认值:False。

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

**代码示例**:
返回
:::::::::
vgg11模型,Layer的实例。

代码示例
:::::::::
.. code-block:: python

import paddle
Expand Down
Loading