Skip to content

[Docathon][Add Inplace CN Doc No.5、6] 新增not/or中文文档 #7137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,9 @@ tensor 数学操作原位(inplace)版本

" :ref:`paddle.remainder_ <cn_api_paddle_remainder_>` ", "Inplace 版本的 remainder API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.abs_ <cn_api_paddle_abs_>` ", "Inplace 版本的 abs API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.bitwise_not_ <cn_api_paddle_bitwise_not_>` ", "Inplace 版本的 bitwise_not API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.bitwise_or_ <cn_api_paddle_bitwise_or_>` ", "Inplace 版本的 bitwise_or API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.baddbmm_ <cn_api_paddle_baddbmm_>` ", "Inplace 版本的 baddbmm API,对输入 input 采用 Inplace 策略"
" :ref:`paddle.bernoulli_ <cn_api_paddle_bernoulli_>` ", "Inplace 版本的 bernoulli API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.tanh_ <cn_api_paddle_tanh_>` ", "Inplace 版本的 tanh API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.erf_ <cn_api_paddle_erf_>` ", "Inplace 版本的 erf API,对输入 x 采用 Inplace 策略"
Expand Down
11 changes: 11 additions & 0 deletions docs/api/paddle/bitwise_not__cn.rst
Copy link
Collaborator

Choose a reason for hiding this comment

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

参考其他 inplace API 的标准写法

https://github.com/PaddlePaddle/docs/blob/ee3124fff354fda64cc29c2f7268e89cac11f22a/docs/api/paddle/abs__cn.rst#L1-L12

也可以看看其他合入的 PR 是怎么写的

Copy link
Author

Choose a reason for hiding this comment

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

好的

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _cn_api_paddle_bitwise_not_:

bitwise_not\_
-------------------------------

.. py:function:: paddle.bitwise_not_(x, out = None, name = None)
Inplace 版本的 :ref:`cn_api_paddle_bitwise_not` API,对输入 `x` 采用 Inplace 策略。

更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3
11 changes: 11 additions & 0 deletions docs/api/paddle/bitwise_or__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _cn_api_paddle_bitwise_or_:

bitwise_or\_
-------------------------------

.. py:function:: paddle.bitwise_or_(x, y, name = None)
Inplace 版本的 :ref:`cn_api_paddle_bitwise_or` API,对输入 `x` 采用 Inplace 策略。

更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3