Skip to content

Conversation

ReganYue
Copy link
Contributor

@ReganYue ReganYue commented Jul 1, 2022

中英文文档参数不一致。

删除多个API中【返回类型】

  • 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中文文档没有此问题。

对应英文文档PR: PaddlePaddle/Paddle#43996

PADDLEPADDLE_PR=43996

@ReganYue ReganYue changed the title 修复paddle.amax、paddle.amin的参数问题 修复paddle.amax、paddle.amin的参数问题,删除多个API中【返回类型】 Jul 21, 2022
@SigureMo
Copy link
Member

paddle.static.save_inference_model中文文档需要修改,没有找到中文文档的文件。

全局搜索,屡试不爽(๑>؂<๑)

image

roi_perspective_transform没有在Web文档找到此API。但是有对应的文档文件碎片。

https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/fluid/layers/roi_perspective_transform_cn.html

是说这个嘛?貌似是个 fluid API 啊,fluid API 文档还需要修复嘛?

返回类型
::::::::::::
Variable
Tensor, 输入input经过conv2d和pool2d之后输入的结果,数据类型与input相同
Copy link
Member

Choose a reason for hiding this comment

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

中文里应当用全角逗号()吧

上面也有一个

Copy link
Contributor Author

Choose a reason for hiding this comment

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

收到,马上修改

@ReganYue
Copy link
Contributor Author

paddle.static.save_inference_model中文文档需要修改,没有找到中文文档的文件。

全局搜索,屡试不爽(๑>؂<๑)

image

roi_perspective_transform没有在Web文档找到此API。但是有对应的文档文件碎片。

https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/fluid/layers/roi_perspective_transform_cn.html

是说这个嘛?貌似是个 fluid API 啊,fluid API 文档还需要修复嘛?

我也不知道,我是全局搜索,搜到这个API。

Copy link
Member

@SigureMo SigureMo left a comment

Choose a reason for hiding this comment

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

这些没有必要的空格可以删掉啦~

返回类型
::::::::::::
Variable
Tensor, 输入input经过conv2d和pool2d之后输入的结果,数据类型与input相同

This comment was marked as outdated.

@@ -84,7 +84,8 @@ ctc_greedy_decoder

返回
::::::::::::
对于输入为LoDTensor的情况,返回CTC贪婪解码器的结果,即2-D LoDTensor,形状为[Lp,1],数据类型为int64。“Lp”是所有输出序列长度的总和。如果结果中的所有序列均为空,则结果LoDTensor将为[-1],其中LoD为[[]]。对于输入为Tensor的情况,返回一个元组,(output, output_length),其中,output是一个形状为 [batch_size, N],类型为int64的Tensor。output_length是一个形状为[batch_size, 1],类型为int64的Tensor,表示Tensor输入下,每个输出序列的长度。
对于输入为LoDTensor的情况,返回CTC贪婪解码器的结果,即2-D LoDTensor,形状为[Lp,1],数据类型为int64。“Lp”是所有输出序列长度的总和。如果结果中的所有序列均为空,则结果LoDTensor将为[-1],其中LoD为[[]]。
对于输入为Tensor的情况,返回一个元组,(output, output_length),其中,output是一个形状为 [batch_size, N],类型为int64的Tensor。output_length是一个形状为[batch_size, 1],类型为int64的Tensor,表示Tensor输入下,每个输出序列的长度。
Copy link
Member

@SigureMo SigureMo Jul 27, 2022

Choose a reason for hiding this comment

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

对于 rst 来说,空一行才是拆分段落。仅仅换行只是为了美观折断过长的行,这样并不会渲染成两个段落(<p>),只会在两行间加一个空格

这是一个段落这是一个段落这是一个段落这是一个段落这是一个段落
这是一个段落这是一个段落这是一个段落这是一个段落这是一个段落

这是一个段落这是一个段落这是一个段落这是一个段落这是一个段落

最终会渲染为

<p>这是一个段落这是一个段落这是一个段落这是一个段落这是一个段落 这是一个段落这是一个段落这是一个段落这是一个段落这是一个段落</p>
<p>这是一个段落这是一个段落这是一个段落这是一个段落这是一个段落</p>

ref: https://www.sphinx-doc.org/zh_CN/master/usage/restructuredtext/basics.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

😁😁😁😁

Copy link
Member

Choose a reason for hiding this comment

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

PS: 嫌麻烦咱可以直接把这个文件恢复了,毕竟是 fluid 下的 😂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

没事没事 感谢大佬指导我学习!

Copy link
Collaborator

Choose a reason for hiding this comment

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

对,这个是fluid下的api,后面会逐步废弃

- **axis** (list | int,可选)- 求最大值运算的维度。如果为None,则计算所有元素的最大值并返回包含单个元素的Tensor变量,否则必须在 :math:`[-x.ndim, x.ndim]` 范围内。如果 :math:`axis[i] <0`,则维度将变为 :math:`x.ndim+axis[i]`,默认值为None。
- **keepdim** (bool)- 是否在输出Tensor中保留减小的维度。如果keepdim 为 False,结果张量的维度将比输入张量的小,默认值为False。
- **x** (Tensor) - Tensor,支持数据类型为float32,float64,int32,int64,维度不超过4维。
- **axis** (int | list | tuple,可选) - 求最大值运算的维度。如果为None,则计算所有元素的最大值并返回包含单个元素的Tensor变量,否则必须在 :math:`[-x.ndim, x.ndim]` 范围内。如果 :math:`axis[i] <0`,则维度将变为 :math:`x.ndim+axis[i]`,默认值为None。
Copy link
Collaborator

Choose a reason for hiding this comment

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

(int|list|tuple,可选)
多余的空格删一下吧
另外数据类型之间用、隔开

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.

LGTM for amin、amax

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

@Ligoml Ligoml merged commit 5ab0761 into PaddlePaddle:develop Aug 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants