Skip to content

Conversation

SigureMo
Copy link
Member

@SigureMo SigureMo commented Jun 16, 2022

PR 内容

paddle.vision.models API 文档修复

英文文档同步更新 PR

PaddlePaddle/Paddle#43636

PADDLEPADDLE_PR=43636

等待的前置 PR

现在只是把需要的工作列出来~还在等一些 PR merge 再开始工作~

相关 issue

总结存在的问题:

  • 英文文档:

    • 代码示例缺少输出common
    • 英文文档无返回值
    • optional 和 可选common
    • pretrained 参数中英文描述不一致
    • 参数 kwargs
    • 句首字母大写common
    • 「ShuffleNetV2」参数 scale 和 act 描述不全
    • 「squeezenet1_0、squeezenet1_0、DenseNet、VGG、InceptionV3」英文文档无论文链接
    • 「SqueezeNet」示例有报错
    • 「LeNet」中英文论文链接格式不一致
  • 中文文档:

    • COPY-FROM 英文文档common
    • 中文介绍没有和函数定义间隔一行common
    • 中英文使用空格隔开的规范问题common
    • 专有名词大小写问题common
    • CRLF -> LF
    • 「InceptionV3」「小于0」 改为「小于等于0」 统一 num_classes 的描述
    • 参数及参数表复核

可 close 的 issue:

fixes #4885, fixes #4884, fixes #4883, fixes #4835, fixes #4834, fixes #4833, fixes #4831, fixes #4830, fixes #4829, fixes #4828, fixes #4832, fixes #4827, fixes #4803, fixes #4795, fixes #4779, fixes #4772, fixes #4770, fixes #4765, fixes #4719, fixes #4696, fixes #4240

其它

更新了下当时忘记添加的 api labels,因为顺序有点乱稍微排了下序

@paddle-bot-old
Copy link

感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-4936.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明,请参考:[Beta]飞桨文档预览工具

@SigureMo SigureMo changed the title [WIP, Don't review] fix paddle.vision.models.* cn docs [WIP, Don't review] fix paddle.vision.models.* paddle.hub.* cn docs Jun 16, 2022
@SigureMo SigureMo changed the title [WIP, Don't review] fix paddle.vision.models.* paddle.hub.* cn docs [WIP, Don't review] fix paddle.vision.models.* cn docs Jun 16, 2022
@SigureMo SigureMo force-pushed the fix-vision-models-cn-docs branch from ee4e749 to 307947a Compare June 17, 2022 09:00
@SigureMo SigureMo marked this pull request as ready for review June 17, 2022 14:44
@SigureMo SigureMo changed the title [WIP, Don't review] fix paddle.vision.models.* cn docs fix paddle.vision.models.* cn docs Jun 17, 2022
@Ainavo 出来挨打,为什么你写的全是 CRLF 的……
@SigureMo

This comment was marked as outdated.

Copy link
Collaborator

@Ligoml Ligoml left a comment

Choose a reason for hiding this comment

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

good job!
LGTM


- **layers** (int,可选) - DenseNet 的层数。默认值为 121。
- **bn_size** (int,可选) - 中间层 growth rate 的拓展倍数。默认值为 4。
- **dropout** (float,可选) - dropout rate。默认值为 0.。
Copy link
Collaborator

Choose a reason for hiding this comment

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

可以这样写,默认值为 :math:`0.0`。 参考#4844 ,文档效果:paddle.nn.initializer.TruncatedNormal

Copy link
Member Author

Choose a reason for hiding this comment

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

这个的话,有一个具体的规范吗,是说所有数字都要(比如上面的 121 和 4)这样呢,还是说仅这种浮点数需要这样呢?

Copy link
Collaborator

Choose a reason for hiding this comment

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

个人建议所有的数字都这样写,会好看一些,这个规则可以大家讨论一起定一下

Copy link
Member Author

Choose a reason for hiding this comment

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

如果这样的话,建议在之后的 PR 进行全量更新吧,对所有的 API 文档~(主要是 en merge 了我也不合适在这里改了 😂)

@Ligoml Ligoml merged commit b5f69de into PaddlePaddle:develop Jun 23, 2022
@SigureMo SigureMo deleted the fix-vision-models-cn-docs branch June 23, 2022 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment