【Fix en docs】 Fix document formatting*test=document_fix #43996

ReganYue · 2022-07-01T02:50:24Z

PR types

Others

PR changes

Docs

Describe

【Fix en docs】 Fix document formatting
· Returns
· Return Type

PR of the Chinese document about this pr：PaddlePaddle/docs#4978

paddle.static.save_inference_model不需要修改。
roi_perspective_transform已进行修改。
paddle.static.data 中文文档不需要修改
py_reader 没有在Web文档找到此API，但是找到了对应的文档文件，进行了修改。
paddle.nn.functional.square_error_cost中文文档没有此问题。
paddle.nn.functional.mse_loss中文文档没有此问题。
paddle.fluid.layers.ctc_greedy_decoder 没有在Web文档找到该API，在文件中找到并进行了修改。
paddle.fluid.layers.im2sequence 没有在Web文档找到该API，在文件中找到并进行了修改。
paddle.vision.transforms.pad中文文档没有此问题。
paddle.fluid.layers.pad_constant_like 没有在Web文档找到该API，在文件中找到并进行了修改。
paddle.crop中文文档没有此问题。
paddle.nn.Pad2D中文文档没有此问题。
paddle.clip中文文档没有此问题。
paddle.fluid.layers.space_to_depth没有在Web文档找到该API，在文件中找到并进行了修改。
paddle.vision.ops.psroi_pool中文文档没有此问题。
paddle.nn.functional.unfold中文文档没有此问题。
paddle.static.nn.sequence_conv中文文档没有此问题。
paddle.static.nn.sequence_softmax中文文档没有此问题。
paddle.static.nn.sequence_pool中文文档没有此问题。
paddle.static.nn.sequence_concat中文文档没有此问题。
paddle.static.nn.sequence_first_step中文文档没有此问题。
paddle.static.nn.sequence_last_step中文文档没有此问题。
paddle.static.nn.sequence_slice中文文档没有此问题。
paddle.static.nn.sequence_expand中文文档没有此问题。
paddle.static.nn.sequence_expand_as中文文档没有此问题。
paddle.static.nn.sequence_pad中文文档没有此问题。
paddle.static.nn.sequence_enumerate中文文档没有此问题。
paddle.nn.functional.sequence_mask中文文档没有此问题。
paddle.fluid.nets.simple_img_conv_pool没有在Web文档找到该API，在文件中找到并进行了修改。
paddle.fluid.nets.sequence_conv_pool没有在Web文档找到该API，在文件中找到并进行了修改。
paddle.nn.functional.unfold中文文档没有此问题。
paddle.nn.functional.zeropad2d中文文档没有此问题。
paddle.nn.functional.cosine_similarity中文文档没有此问题。
paddle.nn.functional.sequence_mask中文文档没有此问题。
paddle.nn.functional.square_error_cost中文文档没有此问题。
paddle.nn.functional.smooth_l1_loss中文文档没有此问题。
paddle.nn.functional.margin_ranking_loss中文文档没有此问题。
paddle.nn.functional.mse_loss中文文档没有此问题。
class paddle.nn.SmoothL1Loss中文文档没有此问题。
paddle.clone中文文档没有此问题。
paddle.utils.cpp_extension.setup中文文档没有此问题。

修复Returns格式问题

修复Returns和Return Type格式问题。

…ganYue

为了解决中英文不一致的问题，统一将Returns内容第一个标点符号改成逗号。删掉Return Type

…ganYue

paddle-bot-old · 2022-07-09T02:48:11Z

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

SigureMo · 2022-07-22T11:42:19Z

emmmm，CI 里有不少 fluid API 的示例代码挂掉了，这些 fluid API 是修复任务里的吗？

ReganYue · 2022-07-23T02:07:20Z

emmmm，CI 里有不少 fluid API 的示例代码挂掉了，这些 fluid API 是修复任务里的吗？

是我全量搜索然后进行修改的，是的，示例代码挂掉了 ^ ^

SigureMo · 2022-07-23T05:24:55Z

我看了下，有 20 个示例代码错误，全是 fluid 的，fluid 的 API 还有必要修复吗 @Ligoml

SigureMo · 2022-07-23T05:35:39Z

@ReganYue 梦柳刚刚说「fluid下的API不用管」（微信上回复我的 😂），要不辛苦恢复一下？

python/paddle/nn/functional/common.py

SigureMo · 2022-07-23T07:03:37Z

python/paddle/nn/functional/loss.py

@@ -1098,7 +1094,8 @@ def margin_ranking_loss(input,
        reduction (str, optional): Indicate the reduction to apply to the loss, the candicates are ``'none'``, ``'mean'``, ``'sum'``.If :attr:`reduction` is ``'none'``, the unreduced loss is returned; If :attr:`reduction` is ``'mean'``, the reduced mean loss is returned. If :attr:`reduction` is ``'sum'``, the reduced sum loss is returned. Default is ``'mean'``.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

-    Returns: Tensor, if :attr:`reduction` is ``'mean'`` or ``'sum'``, the out shape is :math:`[1]`, otherwise the shape is the same as `input` .The same dtype as input tensor.
+    Returns: 
+        Tensor, if :attr:`reduction` is ``'mean'`` or ``'sum'``, the out shape is :math:`[1]`, otherwise the shape is the same as `input` .The same dtype as input tensor.


emmm，这行有点长，最好折断下。

还有上面那个参数 reduction 那行，也太长了，非常影响阅读体验……可以参考其他几个函数折断下（目测都是一样的，可以直接 copy）

Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>

SigureMo · 2022-07-24T14:08:01Z

看来偏离主线太久了，需要重新 merge 下主线了

Ligoml

good job! LGTM

ReganYue · 2022-08-03T12:30:31Z

good job! LGTM

梦柳姐辛苦啦~

zhiqiu

LGTM

JiabinYang

LGTM

ReganYue added 9 commits July 1, 2022 10:37

Update creation.py

41e7ce1

修复Returns格式问题

Merge branch 'PaddlePaddle:develop' into ReganYue

c40c576

【Fix en docs】 Fix document formatting

eea53b4

修复Returns和Return Type格式问题。

Merge branch 'ReganYue' of https://github.com/ReganYue/Paddle into Re…

c8b12ae

…ganYue

修复格式，解决中英文文档不一致问题

f3b6766

为了解决中英文不一致的问题，统一将Returns内容第一个标点符号改成逗号。删掉Return Type

Merge branch 'PaddlePaddle:develop' into ReganYue

9818434

fix大量与 Return Type 和 Return相关的文档

9ecd895

Merge branch 'ReganYue' of https://github.com/ReganYue/Paddle into Re…

a7e1af3

…ganYue

Convert Variable and LoDTensor to Tensor

e1c2b51

TCChenlong added the contributor External developers label Jul 4, 2022

ReganYue changed the title ~~【Fix en docs】 Fix document formatting~~ 【Fix en docs】 Fix document formatting test=document_fix Jul 20, 2022

ReganYue mentioned this pull request Jul 21, 2022

修复paddle.amax、paddle.amin的参数问题，删除多个API中【返回类型】 PaddlePaddle/docs#4978

Merged

41 tasks

SigureMo requested changes Jul 23, 2022

View reviewed changes

Update python/paddle/nn/functional/common.py

3fd7924

Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>

ReganYue added 10 commits July 24, 2022 22:27

Update detection.py

55c3e4c

Update io.py

5bff1a3

Update io.py

3818774

Update loss.py

09d95d7

Update loss.py

4c58a08

Update io.py

d484121

Update io.py

a7884c1

Update nn.py

783fba7

Update nn.py

254de68

Update nn.py

59f9c1a

ReganYue and others added 9 commits August 3, 2022 16:56

Update common.py

f3fe88c

Update common.py

8cab350

update*test=document_fix

c52af3c

update*test=document_fix

dd8fa2a

Update loss.py

b311989

Update loss.py

88cbd55

update*test=document_fix

0b9c29f

paddle.crop

eeda1a8

for ci;test=document_fix

0b8dc46

Ligoml previously approved these changes Aug 3, 2022

View reviewed changes

update io;test=document_fix

43d585e

Ligoml dismissed their stale review via 43d585e August 3, 2022 13:32

Ligoml approved these changes Aug 3, 2022

View reviewed changes

Ligoml previously approved these changes Aug 4, 2022

View reviewed changes

zhiqiu previously approved these changes Aug 4, 2022

View reviewed changes

Update io.py

3a04dca

Ligoml dismissed stale reviews from zhiqiu and themself via 3a04dca August 4, 2022 11:04

update sequence_expand docs;test=document_fix

b38b3bf

Ligoml previously approved these changes Aug 4, 2022

View reviewed changes

ReganYue and others added 2 commits August 4, 2022 19:10

Merge branch 'PaddlePaddle:develop' into ReganYue

564b4cd

update note typos;test=document_fix

a10e413

Ligoml dismissed their stale review via a10e413 August 4, 2022 11:24

JiabinYang approved these changes Aug 5, 2022

View reviewed changes

Ligoml approved these changes Aug 5, 2022

View reviewed changes

luotao1 assigned Ligoml Aug 5, 2022

Ligoml merged commit 8537eda into PaddlePaddle:develop Aug 8, 2022

SigureMo mentioned this pull request Sep 7, 2022

【社区治理】SigureMo 发起 Committer 身份申请 #45841

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

【Fix en docs】 Fix document formatting*test=document_fix #43996

【Fix en docs】 Fix document formatting*test=document_fix #43996

ReganYue commented Jul 1, 2022 •

edited

paddle-bot-old bot commented Jul 9, 2022

SigureMo commented Jul 22, 2022

ReganYue commented Jul 23, 2022

SigureMo commented Jul 23, 2022

SigureMo commented Jul 23, 2022 •

edited

SigureMo Jul 23, 2022

ReganYue Jul 24, 2022

SigureMo commented Jul 24, 2022

Ligoml left a comment

ReganYue commented Aug 3, 2022

zhiqiu left a comment

JiabinYang left a comment

【Fix en docs】 Fix document formatting*test=document_fix #43996

【Fix en docs】 Fix document formatting*test=document_fix #43996

Conversation

ReganYue commented Jul 1, 2022 • edited

PR types

PR changes

Describe

paddle-bot-old bot commented Jul 9, 2022

SigureMo commented Jul 22, 2022

ReganYue commented Jul 23, 2022

SigureMo commented Jul 23, 2022

SigureMo commented Jul 23, 2022 • edited

SigureMo Jul 23, 2022

Choose a reason for hiding this comment

ReganYue Jul 24, 2022

Choose a reason for hiding this comment

SigureMo commented Jul 24, 2022

Ligoml left a comment

Choose a reason for hiding this comment

ReganYue commented Aug 3, 2022

zhiqiu left a comment

Choose a reason for hiding this comment

JiabinYang left a comment

Choose a reason for hiding this comment

ReganYue commented Jul 1, 2022 •

edited

SigureMo commented Jul 23, 2022 •

edited