Skip to content
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

fix docstrings: paddle.nn.Conv3DTranspose, etc. #49149

Merged
merged 18 commits into from
Dec 23, 2022

Conversation

LearningPawn
Copy link
Contributor

@LearningPawn LearningPawn commented Dec 18, 2022

PR types

Bug fixes

PR changes

Docs

Describe

  1. 修复了 python/paddle/nn/layer/conv.py 中出现的 Tex 语法问题;
  2. 为 python/paddle/nn/functional/conv.py 修复 Tex 语法问题,修改 note 及参数说明格式,尝试添加论文链接;
  3. 修改 python/paddle/nn/layer/loss.py、python/paddle/nn/functional/loss.py 中参数说明的格式;
  4. 修改 python/paddle/nn/layer/common.py、python/paddle/nn/functional/common.py 中参数说明的格式,添加 optional 说明。

涉及到的 API 有

  • paddle.nn.Conv3DTranspose
  • paddle.nn.functional.conv3d_transpose
  • paddle.nn.CTCLoss
  • paddle.nn.functional.ctc_loss
  • paddle.nn.Dropout
  • paddle.nn.functional.dropout
  • paddle.nn.Dropout2D
  • paddle.nn.functional.dropout2d
  • paddle.nn.Dropout3D
  • paddle.nn.functional.dropout3d

对应的中文文档修复为:PaddlePaddle/docs#5526

1. 修复了 python/paddle/nn/layer/conv.py 中出现的 Tex 语法问题;
2. 为 python/paddle/nn/functional/conv.py 修复 Tex 语法问题,修改 note 及参数说明格式,尝试添加论文链接;
3. 修改 python/paddle/nn/layer/loss.py、python/paddle/nn/functional/loss.py 中参数说明的格式;
4. 修改 python/paddle/nn/layer/common.py、python/paddle/nn/functional/common.py 中参数说明的格式,添加 optional 说明。
@paddle-bot
Copy link

paddle-bot bot commented Dec 18, 2022

你的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.

python/paddle/nn/layer/loss.py Outdated Show resolved Hide resolved
python/paddle/nn/layer/common.py Show resolved Hide resolved
@paddle-bot
Copy link

paddle-bot bot commented Dec 20, 2022

See the preview results: http://preview-paddle-pr-49149.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/en/api/index_en.html
You may need to wait a while for the preview task to complete.
For more information about the preview tool: [Beta] PaddlePaddle document preview tool

@LearningPawn
Copy link
Contributor Author

@Ligoml 您辛苦了,我已经根据您的 Review 意见进行了修改:

  1. CTCLoss 的 Shapes: 已经使用 - 修改;
  2. Dropout 的 Parameters 现已无报错。

Ligoml
Ligoml previously approved these changes Dec 23, 2022
Copy link
Contributor

@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 for docs

Ligoml
Ligoml previously approved these changes Dec 23, 2022
Ligoml
Ligoml previously approved these changes Dec 23, 2022
Copy link
Contributor

@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.

LGTM for docs
检查预览后合入

@Ligoml Ligoml merged commit baa98d1 into PaddlePaddle:develop Dec 23, 2022
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.

None yet

2 participants