Skip to content

Conversation

@Liyulingyue
Copy link
Contributor

@Liyulingyue Liyulingyue commented Apr 28, 2022

PR types

Others

PR changes

Docs

Describe

  • for Normalize
  1. modified the code-example
  2. add mark of code-example for citation
  • for alexnet
  1. modified the code-example
  2. add mark of code-example for citation
  3. add returns and return type
  • for others
  1. 给示例代码加上code-example标签
  2. 更改部分示例代码文本表述

@paddle-bot-old
Copy link

你的PR提交成功,感谢你对开源项目的贡献!
请关注后续CI自动化测试结果,详情请参考Paddle-CI手册
Your PR has been submitted. Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

@Liyulingyue Liyulingyue changed the title fix en docs of paddle.vision.transforms.Normalize fix en docs of paddle.vision.transforms.Normalize and paddle.vision.models.alexnet Apr 29, 2022
Returns:
the model of alexnet
Return Type:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Return Type: 删掉

@paddle-bot-old
Copy link

paddle-bot-old bot commented May 8, 2022

Sorry to inform you that a67eb00's CIs have passed for more than 7 days. To prevent PR conflicts, you need to re-run all CIs manually.

@Liyulingyue Liyulingyue changed the title fix en docs of paddle.vision.transforms.Normalize and paddle.vision.models.alexnet fix en docs of paddle.vision.transforms.Normalize, paddle.vision.models.alexnet, paddle.vision.models.mobilenet, ops apis May 18, 2022
.. code-block:: python
:name: code-example
import numpy as np
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 示例代码中的输入数据需要换成paddle的方式
  • 参数需要注意是否optional

num_classes (int): output dim of last fc layer. If num_classes <=0, last fc layer
will not be defined. Default: 1000.
with_pool (bool): use pool before the last fc layer or not. Default: True.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这三个参数都是optional哦

num_classes (int): output dim of last fc layer. If num_classes <=0, last fc layer
will not be defined. Default: 1000.
with_pool (bool): use pool before the last fc layer or not. Default: True.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这三个参数也都是optional哦

num_classes (int): Output dim of last fc layer. If num_classes <=0, last fc layer
will not be defined. Default: 1000.
with_pool (bool): Use pool before the last three fc layer or not. Default: True.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

后两个参数是optional哦

AlexNet model
Args:
pretrained (bool): If True, returns a model pre-trained on ImageNet. Default: False.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • pretrained参数是optional哦
  • 是不是缺了**kwargs

.. code-block:: python
:name: code-example1
import paddle
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

示例代码增加一些输出数据展示?

Returns:
None
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • spatial_scale是optional哦
  • Returns:
    None. 加个.

Returns:
4-D Tensor. The pooled ROIs with shape (num_rois, output_channels, pooled_h, pooled_w).
The output_channels equal to C / (pooled_h * pooled_w), where C is the channels of input.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spatial_scale是可选参数

name(str, optional): For detailed information, please refer to :
ref:`api_guide_Name`. Usually name is no need to set and None by
default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 描述中去掉「This operator」
  • 注意参数是否optional
  • 句尾需要加.

Ligoml
Ligoml previously approved these changes Jun 17, 2022
@Ligoml
Copy link
Contributor

Ligoml commented Jun 17, 2022

image

需要重新merge一下develop的代码

@Ligoml Ligoml merged commit 4ba2023 into PaddlePaddle:develop Jun 17, 2022
sneaxiy pushed a commit to sneaxiy/Paddle that referenced this pull request Jun 27, 2022
…ls.alexnet, paddle.vision.models.mobilenet, ops apis (PaddlePaddle#42380)

* Normalize; test=document_fix

* alexnet; test=document_fix

* alexnet; test=document_fix

* vgg; test=document_fix

* mobilenetv2; test=document_fix

* mobilenetv1; test=document_fix

* alexnet; test=document_fix

* PSRoIPool; test=document_fix

* psroi_pool; test=document_fix

* roi_align; test=document_fix

* RoIAlign; test=document_fix

* alexnet; test=document_fix

* MobileNetV1; test=document_fix

* mobilenetv2;test=document_fix

* vgg; test=document_fix

* psroi_pool;test=document_fix

* ops; test=document_fix

* Normalize;test=document_fix

* normlize;test=document_fix

* Update alexnet.py

* for ci;test=document_fix

* for ci;test=document_fix

Co-authored-by: Ligoml <[email protected]>
@Liyulingyue Liyulingyue deleted the for_Normalize branch November 27, 2022 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor External developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants