Skip to content
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

整理文档中原位(inplace)操作相关 API #5469

Merged
merged 11 commits into from
Dec 26, 2022
85 changes: 62 additions & 23 deletions docs/api/paddle/Overview_cn.rst

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/paddle/Tensor_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1926,7 +1926,7 @@ scale(scale=1.0, bias=0.0, bias_after_scale=True, act=None, name=None)
scale_(scale=1.0, bias=0.0, bias_after_scale=True, act=None, name=None)
:::::::::

Inplace 版本的 :ref:`cn_api_paddle_tensor_unsqueeze` API,对输入 `x` 采用 Inplace 策略。
Inplace 版本的 :ref:`cn_api_fluid_layers_scale` API,对输入 `x` 采用 Inplace 策略。

scatter(index, updates, overwrite=True, name=None)
:::::::::
Expand Down
11 changes: 11 additions & 0 deletions docs/api/paddle/add__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _cn_api_tensor_add_:

add\_
-------------------------------

.. py:function:: paddle.add_(x)
Inplace 版本的 :ref:`cn_api_tensor_add` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/ceil__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_ceil_:

ceil\_
-------------------------------

.. py:function:: paddle.ceil_(x)

Inplace 版本的 :ref:`cn_api_fluid_layers_ceil` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/clip__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_tensor_clip_:

clip\_
-------------------------------

.. py:function:: paddle.clip_(x, min=None, max=None, name=None)

Inplace 版本的 :ref:`cn_api_tensor_clip` 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
5 changes: 5 additions & 0 deletions docs/api/paddle/erfinv__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,9 @@ erfinv\_
-------------------------------

.. py:function:: paddle.erfinv_(x)

Inplace 版本的 :ref:`cn_api_paddle_tensor_erfinv` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/exp__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_exp_:

exp\_
-------------------------------

.. py:function:: paddle.exp_(x, name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_exp` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/flatten__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_paddle_flatten_:

flatten\_
-------------------------------

.. py:function:: paddle.flatten_(x)

Inplace 版本的 :ref:`cn_api_paddle_flatten` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/floor__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_floor_:

floor\_
-------------------------------

.. py:function:: paddle.floor_(name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_floor` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/index_add__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ Inplace 版本的 :ref:`cn_api_tensor_index_add` API,对输入 `x` 采用 Inpl
::::::::::::

COPY-FROM: paddle.index_add_

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

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

lerp\_
-------------------------------

.. py:function:: paddle.lerp_(x, y, weight, name=None)

Inplace 版本的 :ref:`cn_api_paddle_tensor_lerp` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/nn/functional/elu__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ elu\_
.. py:function:: paddle.nn.functional.elu_(x, alpha=1.0, name=None)

Inplace 版本的 :ref:`cn_api_nn_cn_elu` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/nn/functional/relu__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ relu\_
.. py:function:: paddle.nn.functional.relu_(x, name=None)

Inplace 版本的 :ref:`cn_api_nn_cn_relu` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/nn/functional/softmax__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ softmax\_
.. py:function:: paddle.nn.functional.softmax_(x, axis=-1, dtype=None, name=None)

Inplace 版本的 :ref:`cn_api_nn_cn_softmax` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/put_along_axis__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ put_along_axis\_
.. py:function:: paddle.put_along_axis_(indices, value, axis, reduce)

Inplace 版本的 :ref:`cn_api_paddle_tensor_put_along_axis` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/reciprocal__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_reciprocal_:

reciprocal\_
-------------------------------

.. py:function:: paddle.reciprocal_(name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_reciprocal` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/remainder__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ remainder\_
.. py:function:: paddle.remainder_(x, y, name=None)

Inplace 版本的 :ref:`cn_api_tensor_remainder` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/reshape__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ reshape\_
.. py:function:: paddle.reshape_(x, shape, name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_reshape` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/round__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_round_:

round\_
-------------------------------

.. py:function:: paddle.round_(x, name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_round` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/rsqrt__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_rsqrt_:

rsqrt\_
-------------------------------

.. py:function:: paddle.rsqrt_(x, name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_rsqrt` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/scale__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_scale_:

scale\_
-------------------------------

.. py:function:: paddle.scale_(x, scale=1.0, bias=0.0, bias_after_scale=True, act=None, name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_scale` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/scatter__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ scatter\_
.. py:function:: paddle.scatter_(x, index, updates, overwrite=True, name=None)

Inplace 版本的 :ref:`cn_api_paddle_cn_scatter` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/sqrt__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_sqrt_:

sqrt\_
-------------------------------

.. py:function:: paddle.sqrt_(x, name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_sqrt` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/squeeze__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ squeeze\_
.. py:function:: paddle.squeeze_(x, axis=None, name=None)

Inplace 版本的 :ref:`cn_api_paddle_tensor_squeeze` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/subtract__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_paddle_tensor_subtract_:

subtract\_
-------------------------------

.. py:function:: paddle.subtract_(x, y, name=None)

Inplace 版本的 :ref:`cn_api_paddle_tensor_subtract` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/tan__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_fluid_layers_tan_:

tan\_
-------------------------------

.. py:function:: paddle.tan_(x, name=None)

Inplace 版本的 :ref:`cn_api_fluid_layers_tan` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/tanh__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ tanh\_
.. py:function:: paddle.tanh_(x, name=None)

Inplace 版本的 :ref:`cn_api_tensor_tanh` 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
12 changes: 12 additions & 0 deletions docs/api/paddle/uniform__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_tensor_uniform_:

uniform\_
-------------------------------

.. py:function:: paddle.uniform_(x, shape, dtype=None, min=-1.0, max=1.0, seed=0, name=None)

Inplace 版本的 :ref:`cn_api_tensor_uniform` 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
4 changes: 4 additions & 0 deletions docs/api/paddle/unsqueeze__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ unsqueeze\_
.. py:function:: paddle.unsqueeze_(x, axis, name=None)

Inplace 版本的 :ref:`cn_api_paddle_tensor_unsqueeze` 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