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

[Docathon] Fix add API Docs #57434

Merged
merged 3 commits into from
Sep 25, 2023
Merged

[Docathon] Fix add API Docs #57434

merged 3 commits into from
Sep 25, 2023

Conversation

yuchen202
Copy link
Contributor

@yuchen202 yuchen202 commented Sep 18, 2023

PR types

Bug fixes

PR changes

Docs

Description

Issue from:「文档评测」NO.1

涉及到的 API 有:
python\paddle\nn\layer\conv.py
python\paddle\static\input.py
python\paddle\tensor\manipulation.py
python\paddle\tensor\math.py
python\paddle\tensor\random.py
python\paddle\vision\models\resnet.py

关联文档(如有):PaddlePaddle/docs#6197

相关链接:
PaddlePaddle/docs#6187
PaddlePaddle/docs#6165

@sunzhongkai588

@yuchen202 yuchen202 changed the title 修复 paddle\add 等 API 的文档 [Docathon] Fix add API Docs Sep 18, 2023
@paddle-bot paddle-bot bot added the contributor External developers label Sep 18, 2023
@luotao1 luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Sep 19, 2023
@@ -162,6 +162,7 @@ class InputSpec:
uint8. Default: float32.
name (str): The name/alias of the variable, see :ref:`api_guide_Name`
for more details.
stop_gradient ():留空,坐等孙师傅指导。
Copy link
Contributor

Choose a reason for hiding this comment

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

stop_gradient (bool, optional): A boolean that mentions whether gradient should flow. Default is False, means don't stop calculate gradients. 这段不写也没事

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
stop_gradient ():留空,坐等孙师傅指导。

删掉吧

* :math:`Out`: Output value, the shape of :math:`Out` and :math:`X` may be different.
* :math:`Out`: Output value, a 4-D ``Tensor`` with NCHW or NHWC format, the shape of :math:`Out` and :math:`X` may be different.

::note:
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

python/paddle/nn/layer/conv.py Outdated Show resolved Hide resolved
python/paddle/nn/layer/conv.py Show resolved Hide resolved
Copy link
Contributor

@sunzhongkai588 sunzhongkai588 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,
CI static 检测不过是因为相关代码示例还没转换成 google style 样式,后续会在 #55629 清理完成,先豁免吧

@luotao1 luotao1 merged commit 27476e7 into PaddlePaddle:develop Sep 25, 2023
26 of 28 checks passed
Frida-a pushed a commit to Frida-a/Paddle that referenced this pull request Oct 14, 2023
* 0918API

* Apply suggestions from code review

Co-authored-by: zachary sun <[email protected]>

* 0923修改

---------

Co-authored-by: zachary sun <[email protected]>
jiahy0825 pushed a commit to jiahy0825/Paddle that referenced this pull request Oct 16, 2023
* 0918API

* Apply suggestions from code review

Co-authored-by: zachary sun <[email protected]>

* 0923修改

---------

Co-authored-by: zachary sun <[email protected]>
danleifeng pushed a commit to danleifeng/Paddle that referenced this pull request Nov 14, 2023
* 0918API

* Apply suggestions from code review

Co-authored-by: zachary sun <[email protected]>

* 0923修改

---------

Co-authored-by: zachary sun <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor External developers HappyOpenSource 快乐开源活动issue与PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants