docs: 增加 docstring 内容丰富中英文文档 #59271
Merged
docs: 增加 docstring 内容丰富中英文文档 #59271
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
你的PR提交成功，感谢你对开源项目的贡献! |
|
✅ This PR's description meets the template requirements! |
26 tasks
There was a problem hiding this comment.
试一试加 seed 能不能固定住输出？
There was a problem hiding this comment.
已用我手动输入的 Tensor 解决了随机的问题
python/paddle/optimizer/lr.py
Outdated
| @@ -55,6 +55,26 @@ class LRScheduler: | |||
|
|
|||
| LRScheduler Base class. Define the common interface of a learning rate scheduler. | |||
|
|
|||
| There are currently 14 strategies implemented in paddle based on this base class, which are: | |||
There was a problem hiding this comment.
列了 17 种
Suggested change
| There are currently 14 strategies implemented in paddle based on this base class, which are: | |
| There are currently 17 strategies implemented in paddle based on this base class, which are: |
python/paddle/optimizer/lr.py
Outdated
| @@ -55,6 +55,26 @@ class LRScheduler: | |||
|
|
|||
| LRScheduler Base class. Define the common interface of a learning rate scheduler. | |||
|
|
|||
| There are currently 14 strategies implemented in paddle based on this base class, which are: | |||
|
|
|||
| - ``NoamDecay``: Related algorithms are derived from `*Attention Is All You Need* <http://blog.inkypy.com>`_ . Please refer to :ref:`en_api_paddle_optimizer_lr_NoamDecay`. | |||
There was a problem hiding this comment.
在英文文档中，英文 api 文档的 label 是由路径转化来的，如该例中的 paddle.optimizer.lr.NoamDecay，label应该是api_paddle_optimizer_lr_NoamDecay，中文的label则会在前面加 cn_。
Suggested change
| - ``NoamDecay``: Related algorithms are derived from `*Attention Is All You Need* <http://blog.inkypy.com>`_ . Please refer to :ref:`en_api_paddle_optimizer_lr_NoamDecay`. | |
| - ``NoamDecay``: Related algorithms are derived from `*Attention Is All You Need* <http://blog.inkypy.com>`_ . Please refer to :ref:`api_paddle_optimizer_lr_NoamDecay`. |
下面每一条都按上述修改～
增加 class: LRScheduler 中文文档中介绍的 17 种策略至 docstring
修改 RandomHorizontalFlip 和 RandomVerticalFlip docstring 的示例代码
SigureMo
pushed a commit
to gouzil/Paddle
that referenced
this pull request
Dec 5, 2023
* docs(paddle.lr): 丰富 docstring 内容 增加 class: LRScheduler 中文文档中介绍的 17 种策略至 docstring * docs(paddle.vision.transforms): 增加docstring更具体的示例 修改 RandomHorizontalFlip 和 RandomVerticalFlip docstring 的示例代码
24 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR types
Function optimization
PR changes
Docs
Description
涉及到的 API 有
paddle.vision.transforms.RandomHorizontalFlip
paddle.vision.transforms.RandomVerticalFlip
paddle.lr.LRScheduler
相关 中英文文档
paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/optimizer/lr/LRScheduler_cn.html
paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/vision/transforms/RandomHorizontalFlip_cn.html
paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/vision/transforms/RandomVerticalFlip_cn.html