【PaddlePaddle Hackathon 3 No.17】为 Paddle 新增 sgn 文档 #5107
Merged
Conversation
This file contains 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
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-5107.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
|
这个 API 应该也能通过 以及可添加 PADDLEPADDLE_PR=44568 以确保文档预览可以正确构建，paddle bot 的回复里也有相关链接，可以参考下～
|
SigureMo
requested changes
Aug 4, 2022
| .. py:function:: paddle.sgn(x, name=None) | ||
|
|
||
| 对输入参数 ``x`` 中每个元素进行正负判断，并且输出正负判断值：1 代表正，-1 代表负，0 代表零。 | ||
| 对于复数张量，此函数返回一个新的张量，其元素与 input 元素的角度相同且绝对值为 1。 |
There was a problem hiding this comment.
这两句与英文的顺序正好是反的，中英文两者顺序也应当是一致的～
以及在 rst 中空一行才能分隔两个段落～可以看下预览里现在的效果～
docs/api/paddle/sgn_cn.rst
Outdated
|
|
||
| 参数 | ||
| :::::::::::: | ||
| - **x** (Tensor) – 输入 Tensor，数据类型为 float16， float32， float64， complex64 或 complex128。 |
There was a problem hiding this comment.
Suggested change
| - **x** (Tensor) – 输入 Tensor，数据类型为 float16， float32， float64， complex64 或 complex128。 | |
| - **x** (Tensor) – 输入 Tensor，数据类型为 float16、float32、float64、complex64 或 complex128。 |
|
|
||
| 返回 | ||
| :::::::::::: | ||
| Tensor，输出正负号或复数的单位向量，数据的 shape 大小及数据类型和输入 ``x`` 一致。 |
There was a problem hiding this comment.
这里的话中文应该没问题，英文有点简单了可以修改下，两者也需要一致～
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.
add docs of paddle.sgn
PADDLEPADDLE_PR=44568