[Docathon][Add Inplace CN Doc No.31] #7187
Closed
Conversation
This file contains hidden or 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-7187.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
|
|
QuarryFlow
changed the title
好的，已修改，请再次审阅，谢谢 |
| @@ -0,0 +1,50 @@ | |||
| .. _api_paddle_logical_and__cn: | |||
There was a problem hiding this comment.
Suggested change
| .. _api_paddle_logical_and__cn: | |
| .. _cn_api_paddle_logical_and_: |
| @@ -0,0 +1,50 @@ | |||
| .. _api_paddle_logical_and__cn: | |||
|
|
|||
| logical_and_ | |||
There was a problem hiding this comment.
Suggested change
| logical_and_ | |
| logical\_and\_ |
需要转义
| logical_and_ | ||
| ------------------------------- | ||
|
|
||
| .. py:function:: paddle.logical_and_(x: Tensor, y: Tensor, name: str|None = None) → Tensor |
There was a problem hiding this comment.
Suggested change
| .. py:function:: paddle.logical_and_(x: Tensor, y: Tensor, name: str|None = None) → Tensor | |
| .. py:function:: paddle.logical_and_(x, y, name = None) |
Comment on lines
+8
to
+49
| 该 API 是 `paddle.logical_and` 的 **Inplace 版本**，输出结果将直接覆盖输入 Tensor ``x`` 的内存，功能与非 Inplace 版本一致。 | ||
|
|
||
| 逐元素对 ``x`` 和 ``y`` 进行逻辑与运算，计算公式为： | ||
|
|
||
| .. math:: | ||
| \text{out}_i = \text{x}_i \ \&\& \ \text{y}_i | ||
|
|
||
| .. note:: | ||
| **Inplace 警告**：此操作会直接修改输入 Tensor ``x`` 的值，若需保留原始数据，请使用非 Inplace 版本 `paddle.logical_and`。 | ||
|
|
||
| **广播机制**：``x`` 和 ``y`` 的形状需满足广播规则，如您想了解更多，请参考tensor介绍 `<../../guides/beginner/tensor_cn.html#id7>`_。 | ||
|
|
||
| 参数 | ||
| ::::::::: | ||
| - **x** (Tensor) - 输入的 Tensor，支持的数据类型为 bool、int8、int16、int32、int64、bfloat16、float16、float32、float64、complex64、complex128。 | ||
| - **y** (Tensor) - 输入的 Tensor，数据类型需与 ``x`` 一致。 | ||
| - **name** (str|None, 可选) - 操作的名称，默认值为 None，表示自动命名。 | ||
|
|
||
| 返回 | ||
| ::::::::: | ||
| **Tensor**，与输入 ``x`` 共享内存的 Tensor，存储运算后的布尔值结果（直接覆盖 ``x``）。 | ||
|
|
||
| 代码示例 | ||
| ::::::::: | ||
|
|
||
| .. code-block:: python | ||
|
|
||
| import paddle | ||
|
|
||
| # 示例 1：基础用法 | ||
| x = paddle.to_tensor([True, False, True, False]) | ||
| y = paddle.to_tensor([True, True, False, False]) | ||
| paddle.logical_and_(x, y) | ||
| print(x) # 输出: [True, False, False, False] | ||
|
|
||
| # 示例 2：广播机制 | ||
| x = paddle.to_tensor([[True], [False]]) | ||
| y = paddle.to_tensor([True, False]) | ||
| paddle.logical_and_(x, y) # 广播为 [[True, False], [False, False]] | ||
| print(x) | ||
| # 输出: | ||
| # [[True, False], |
There was a problem hiding this comment.
文档内容直接参考其他 inplace API 的写法，如
docs/docs/api/paddle/clip__cn.rst
Lines 8 to 12 in 31f275f
| @@ -251,11 +251,13 @@ tensor 数学操作原位（inplace）版本 | |||
| " :ref:`paddle.normal_ <cn_api_paddle_normal_>` ", "Inplace 版本的 normal API，对输入 x 采用 Inplace 策略" | |||
| " :ref:`paddle.neg_ <cn_api_paddle_neg_>` ", "Inplace 版本的 neg API，对输入 x 采用 Inplace 策略" | |||
| " :ref:`paddle.nan_to_num_ <cn_api_paddle_nan_to_num_>` ", "Inplace 版本的 nan_to_num API，对输入 x 采用 Inplace 策略" | |||
| " :ref:`paddle.logical_and_ <cn_api_paddle_logical_and_>` ", "Inplace 版本的 logical_and API，对输入 x 采用 Inplace 策略）" | |||
There was a problem hiding this comment.
移到上面的 log_normal_ 下吧
|
@luotao1 The PR can be closed due to the following PR is merged: |
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.
描述
为
paddle.logical_and_添加中文文档增加
logical_and__cn.rst文件
修改
在Overview_cn.rst中新增新添加的API相关信息（在“tensor 数学操作原位（inplace）版本”标题下）
issue
Issue #7090
英文文档
logic_and_en: https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/logical_and__en.html
@sunzhongkai588 感谢审阅