[Docathon][Add Inplace CN Doc No.9] #7230
Open
+29
−0
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-7230.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
superdonkey007
changed the title
docs/api/paddle/Overview_cn.rst
Outdated
| @@ -254,6 +254,7 @@ tensor 数学操作原位（inplace）版本 | |||
| " :ref:`paddle.nan_to_num_ <cn_api_paddle_nan_to_num_>` ", "Inplace 版本的 nan_to_num API，对输入 x 采用 Inplace 策略" | |||
| " :ref:`paddle.i0_ <cn_api_paddle_i0_>` ", "Inplace 版本的 i0 API，对输入 x 采用 Inplace 策略" | |||
| " :ref:`paddle.lcm_ <cn_api_paddle_lcm_>` ", "Inplace 版本的 lcm API，对输入 x 采用 Inplace 策略" | |||
| " :ref:`paddle.cauchy_ <cn_api_paddle_cauchy_>` ", 对现有张量``x``进行原地修改,将所有元素替换为从柯西分布中随机采样的数值。 | |||
docs/api/paddle/cauchy__cn.rst
Outdated
| cauchy\_ | ||
| ------------------------------- | ||
|
|
||
| .. py:function:: paddle.cauchy_(x: paddle.Tensor, loc: Numeric = 0, scale: Numeric = 1, name: str | None = None) |
There was a problem hiding this comment.
Suggested change
| .. py:function:: paddle.cauchy_(x: paddle.Tensor, loc: Numeric = 0, scale: Numeric = 1, name: str | None = None) | |
| .. py:function:: paddle.cauchy_(x, loc = 0, scale = 1, name = None) |
docs/api/paddle/cauchy__cn.rst
Outdated
|
|
||
|
|
||
|
|
||
| 对现有张量``x``进行原地修改,将所有元素替换为从柯西分布中随机采样的数值。 |
There was a problem hiding this comment.
逗号用中文的。对现有张量``x``进行原地修改 赶紧语句有些不通顺，改成如 直接修改输入张量
docs/api/paddle/cauchy__cn.rst
Outdated
| :::::::::::: | ||
|
|
||
| - **x** (Tensor) - 输入的 Tensor，支持的数据类型为：float32、float64。 | ||
| - **loc** (scalar|可选) - 分布峰值的位置参数，数据类型为 float32 或 float64。 |
There was a problem hiding this comment.
参考 API 文档的参数写法，可选参数写为 可选，并且参数说明里要写清楚默认值和默认值的含义
Suggested change
| - **loc** (scalar|可选) - 分布峰值的位置参数，数据类型为 float32 或 float64。 | |
| - **loc** (scalar，可选) - 分布峰值的位置参数，数据类型为 float32 或 float64。 |
There was a problem hiding this comment.
已经按要求和规范进行了修改，感谢您的指正 @sunzhongkai588
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.
@sunzhongkai588
新增cauchy_.rst中文文档，同时在Overview_cn.rst中新增cauchy_相关信息（在“tensor 数学操作原位（inplace）版本”标题下）
issue：#7090
英文文档链接：https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/cauchy__en.html