Skip to content

Commit 2fc7bc3

Browse files
authored
[Docathon][Add Inplace CN Doc No.19-22] (#7131)
* [Docathon][Add Inplace CN Doc No.19-22] 新增 greater_equal_, greater_than_, i0_, lcm_中文文档;更新Overview.rst中对应的补充,修正Overvi.rst中equal_api的位置。 * Update Overview_cn.rst 规范文档描述 * overviewr添加i0—, lcm—,修正引用下划线,并修正下划线转义 * 修正0402
1 parent 490b2a0 commit 2fc7bc3

File tree

5 files changed

+62
-1
lines changed

5 files changed

+62
-1
lines changed

docs/api/paddle/Overview_cn.rst

100644100755
Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ paddle 目录下包含 tensor、device、framework 相关 API 以及某些高层
88
- :ref:`tensor 数学操作 <tensor_math>`
99
- :ref:`tensor 数学操作原位(inplace)版本 <tensor_math_inplace>`
1010
- :ref:`tensor 逻辑操作 <tensor_logic>`
11+
- :ref:`tensor 逻辑操作原位(inplace)版本 <tensor_logic_inplace>`
1112
- :ref:`tensor 属性相关 <tensor_attribute>`
1213
- :ref:`tensor 创建相关 <tensor_creation>`
1314
- :ref:`tensor 元素查找相关 <tensor_search>`
@@ -178,6 +179,7 @@ tensor 数学操作
178179
" :ref:`paddle.combinations <cn_api_paddle_combinations>` ", "对输入 Tensor 计算长度为 r 的情况下的所有组合"
179180
" :ref:`paddle.select_scatter <cn_api_paddle_select_scatter>` ", "根据 axis 和 index(整数) 填充 value 值至输入 Tensor"
180181
" :ref:`paddle.reduce_as <cn_api_paddle_reduce_as>` ", "对 x 在某些维度上求和,使其结果与 target 的 shape 一致"
182+
181183
.. _tensor_math_inplace:
182184

183185
tensor 数学操作原位(inplace)版本
@@ -204,7 +206,6 @@ tensor 数学操作原位(inplace)版本
204206
" :ref:`paddle.cumprod_ <cn_api_paddle_cumprod_>` ", "Inplace 版本的 cumprod API,对输入 x 采用 Inplace 策略"
205207
" :ref:`paddle.cumsum_ <cn_api_paddle_cumsum_>` ", "Inplace 版本的 cumsum API,对输入 x 采用 Inplace 策略"
206208
" :ref:`paddle.divide_ <cn_api_paddle_divide_>` ", "Inplace 版本的 divide API,对输入 x 采用 Inplace 策略"
207-
" :ref:`paddle.equal_ <cn_api_paddle_equal_>` ", "Inplace 版本的 equal API,对输入 x 采用 Inplace 策略"
208209
" :ref:`paddle.exp_ <cn_api_paddle_exp_>` ", "Inplace 版本的 exp API,对输入 x 采用 Inplace 策略"
209210
" :ref:`paddle.expm1_ <cn_api_paddle_expm1_>` ", "Inplace 版本的 expm1 API,对输入 x 采用 Inplace 策略"
210211
" :ref:`paddle.flatten_ <cn_api_paddle_flatten_>` ", "Inplace 版本的 flatten API,对输入 x 采用 Inplace 策略"
@@ -250,6 +251,8 @@ tensor 数学操作原位(inplace)版本
250251
" :ref:`paddle.normal_ <cn_api_paddle_normal_>` ", "Inplace 版本的 normal API,对输入 x 采用 Inplace 策略"
251252
" :ref:`paddle.neg_ <cn_api_paddle_neg_>` ", "Inplace 版本的 neg API,对输入 x 采用 Inplace 策略"
252253
" :ref:`paddle.nan_to_num_ <cn_api_paddle_nan_to_num_>` ", "Inplace 版本的 nan_to_num API,对输入 x 采用 Inplace 策略"
254+
" :ref:`paddle.i0_ <cn_api_paddle_i0_>` ", "Inplace 版本的 i0 API,对输入 x 采用 Inplace 策略"
255+
" :ref:`paddle.lcm_ <cn_api_paddle_lcm_>` ", "Inplace 版本的 lcm API,对输入 x 采用 Inplace 策略"
253256

254257

255258

@@ -272,6 +275,20 @@ tensor 逻辑操作
272275
" :ref:`paddle.isneginf <cn_api_paddle_isneginf>` ", "返回输入 tensor 的每一个值是否为 -INF"
273276
" :ref:`paddle.isreal <cn_api_paddle_isreal>` ", "返回输入 tensor 的每一个值是否为实数类型"
274277

278+
.. _tensor_logic_inplace:
279+
280+
tensor 逻辑操作原位(inplace)版本
281+
::::::::::::::::::::
282+
283+
.. csv-table::
284+
:header: "API 名称", "API 功能"
285+
:widths: 10, 30
286+
287+
" :ref:`paddle.equal_ <cn_api_paddle_equal_>` ", "Inplace 版本的 equal API,对输入 x 采用 Inplace 策略"
288+
" :ref:`paddle.greater_equal_ <cn_api_paddle_greater_equal_>` ", "Inplace 版本的 greater_equal API,对输入 x 采用 Inplace 策略"
289+
" :ref:`paddle.greater_than_ <cn_api_paddle_greater_than_>` ", "Inplace 版本的 greater_than API,对输入 x 采用 Inplace 策略"
290+
291+
275292
.. _tensor_attribute:
276293

277294
tensor 属性相关

docs/api/paddle/greater_equal__cn.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _cn_api_paddle_greater_equal_:
2+
3+
greater\_equal\_
4+
-------------------------------
5+
6+
.. py:function:: paddle.greater_equal_(x, y, name=None)
7+
Inplace 版本的 :ref:`cn_api_paddle_greater_equal` API,对输入 x 采用 Inplace 策略。
8+
9+
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
10+
11+
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/greater_than__cn.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _cn_api_paddle_greater_than_:
2+
3+
greater\_than\_
4+
-------------------------------
5+
6+
.. py:function:: paddle.greater_than_(x, y, name=None)
7+
Inplace 版本的 :ref:`cn_api_paddle_greater_than` API,对输入 x 采用 Inplace 策略。
8+
9+
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
10+
11+
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/i0__cn.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _cn_api_paddle_i0_:
2+
3+
i0\_
4+
-------------------------------
5+
6+
.. py:function:: paddle.i0_(x, name=None)
7+
Inplace 版本的 :ref:`cn_api_paddle_i0` API,对输入 x 采用 Inplace 策略。
8+
9+
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
10+
11+
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/lcm__cn.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _cn_api_paddle_lcm_:
2+
3+
lcm\_
4+
-------------------------------
5+
6+
.. py:function:: paddle.lcm_(x, y, name=None)
7+
Inplace 版本的 :ref:`cn_api_paddle_lcm` API,对输入 x 采用 Inplace 策略。
8+
9+
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
10+
11+
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

0 commit comments

Comments
 (0)