diff --git a/doc/fluid/api/paddle/argmax.rst b/doc/fluid/api/paddle/argmax.rst index c159ec02d9a369f193c363ee562a93e718b4a9c7..dc1665f9f199d4b288686710fa60d25eadd075c3 100644 --- a/doc/fluid/api/paddle/argmax.rst +++ b/doc/fluid/api/paddle/argmax.rst @@ -1,7 +1,11 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + .. _api_paddle_argmax: argmax -------------------------------- -:doc_source: paddle.fluid.layers.argmax +------ +.. autofunction:: paddle.tensor.search.argmax + :noindex: diff --git a/doc/fluid/api/paddle/argmin.rst b/doc/fluid/api/paddle/argmin.rst index 7368362db56ed7895697fe7d235f9ae9a45cf10c..18c2334659a92457e4be4f739d94a5f8c633442e 100644 --- a/doc/fluid/api/paddle/argmin.rst +++ b/doc/fluid/api/paddle/argmin.rst @@ -1,7 +1,12 @@ +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + .. _api_paddle_argmin: argmin -------------------------------- -:doc_source: paddle.fluid.layers.argmin +------ + +.. autofunction:: paddle.tensor.search.argmin + :noindex: diff --git a/doc/fluid/api/tensor/argmax.rst b/doc/fluid/api/tensor/argmax.rst index 87d33a51bc5c287cf33e06b4503b281737f0800c..8c4e15720bdeb2540f4d01026a5d68985cd32f05 100644 --- a/doc/fluid/api/tensor/argmax.rst +++ b/doc/fluid/api/tensor/argmax.rst @@ -1,7 +1,11 @@ -.. _api_tensor_cn_argmax: +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +.. _api_tensor_argmax: argmax -------------------------------- -:doc_source: paddle.fluid.layers.argmax +------ +.. autofunction:: paddle.tensor.search.argmax + :noindex: diff --git a/doc/fluid/api/tensor/argmin.rst b/doc/fluid/api/tensor/argmin.rst index 3bfac20b5c48f98925d1db8c116cf5b489cde1e9..c23f6127472a2a33acddfb35b7f8a21be9353f42 100644 --- a/doc/fluid/api/tensor/argmin.rst +++ b/doc/fluid/api/tensor/argmin.rst @@ -1,7 +1,12 @@ -.. _api_tensor_cn_argmin: +.. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` + !DO NOT EDIT THIS FILE MANUALLY! + +.. _api_tensor_argmin: argmin -------------------------------- -:doc_source: paddle.fluid.layers.argmin +------ + +.. autofunction:: paddle.tensor.search.argmin + :noindex: diff --git a/doc/fluid/api_cn/tensor_cn/argmax_cn.rst b/doc/fluid/api_cn/tensor_cn/argmax_cn.rst index 2b3a7857b80b29ecffbccb5f697267ef05afd81b..157806c38000bd4ae1866e55e4ecbe5bd90e7882 100644 --- a/doc/fluid/api_cn/tensor_cn/argmax_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/argmax_cn.rst @@ -3,67 +3,42 @@ argmax ------------------------------- -.. py:function:: paddle.argmax(input, axis=None, dtype=None, out=None, keepdims=False, name=None) +.. py:function:: paddle.argmax(x, axis=None, dtype=None, keepdim=False, name=None) -:alias_main: paddle.argmax -:alias: paddle.argmax,paddle.tensor.argmax,paddle.tensor.search.argmax -:update_api: paddle.fluid.layers.argmax +该OP沿 ``axis`` 计算输入 ``x`` 的最大元素的索引。 +参数 +:::::::: + - **x** （Tensor） - 输入的多维 ``Tensor`` ，支持的数据类型：float32、float64、int16、int32、int64、uint8。 + - **axis** （int，可选） - 指定对输入Tensor进行运算的轴， ``axis`` 的有效范围是[-R, R），R是输入 ``x`` 的维度个数， ``axis`` 为负数时，进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为None, 将会对输入的 `x` 进行平铺展开，返回最大值的索引。 + - **dtype** （np.dtype|str）- 输出Tensor的数据类型，可选值为int32，int64，默认值为None，将返回int64类型的结果。 + - **keepdim** （bool，可选）- 是否保留进行最大值索引操作的轴，默认值为False。 + - **name** （str，可选） – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 +返回 +:::::::: +``Tensor``, 如果设置 :attr:`dtype` 为 `int32` 时，返回的tensor的数据类型为 `int32` ，其它情况将返回的tensor的数据类型为 `int64` 。 -该OP沿 ``axis`` 计算输入 ``input`` 的最大元素的索引。 -参数： - - **input** (Variable) - 输入的多维 ``Tensor`` ，支持的数据类型：float32、float64、int8、int16、int32、int64。 - - **axis** (int，可选) - 指定对输入Tensor进行运算的轴， ``axis`` 的有效范围是[-R, R)，R是输入 ``input`` 的Rank， ``axis`` -R与绝对值相同的R等价。默认值为0。 - - **dtype** (np.dtype|core.VarDesc.VarType|str)- 输出Tensor的数据类型，可选值为int32，int64，默认值为None，将返回int64类型的结果。 - - **out** (Variable, 可选) – 指定存储运算结果的Tensor。如果设置为None或者不设置，将创建新的Tensor存储运算结果，默认值为None。 - - **keepdims** （bool，可选）- 是否保留进行max index操作的维度，默认值为False。 - - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 - -返回： ``Tensor`` ，数据类型int64 - -返回类型：Variable - -**代码示例**： +示例代码 +:::::::: .. code-block:: python - import paddle - import paddle.fluid as fluid - import numpy as np - - in1 = np.array([[[5,8,9,5], - [0,0,1,7], - [6,9,2,4]], - [[5,2,4,2], - [4,7,7,9], - [1,7,0,6]]]) - with fluid.dygraph.guard(): - x = fluid.dygraph.to_variable(in1) - out1 = paddle.argmax(input=x, axis=-1) - out2 = paddle.argmax(input=x, axis=0) - out3 = paddle.argmax(input=x, axis=1) - out4 = paddle.argmax(input=x, axis=2) - out5 = paddle.argmax(input=x, axis=2, keepdims=True) - print(out1.numpy()) - # [[2 3 1] - # [0 3 1]] - print(out2.numpy()) - # [[0 0 0 0] - # [1 1 1 1] - # [0 0 0 1]] - print(out3.numpy()) - # [[2 2 0 1] - # [0 1 1 1]] - print(out4.numpy()) - # [[2 3 1] - # [0 3 1]] - print(out5.numpy()) - #array([[[2], - # [3], - # [1]], - # [[0], - # [3], - # [1]]]) + import numpy as np + import paddle + + paddle.disable_static() + data = [[5,8,9,5], + [0,0,1,7], + [6,9,2,4]] + x = paddle.to_tensor(data) + out1 = paddle.argmax(x) + print(out1.numpy()) # 2 + out2 = paddle.argmax(x, axis=1) + print(out2.numpy()) + # [2 3 1] + out3 = paddle.argmax(x, axis=-1) + print(out3.numpy()) + # [2 3 1] diff --git a/doc/fluid/api_cn/tensor_cn/argmin_cn.rst b/doc/fluid/api_cn/tensor_cn/argmin_cn.rst index 95842cc525cc87c3b8d7f8c84520feca1d5352fb..14082c452382ba2e7c17eb11306e190b087e0c70 100644 --- a/doc/fluid/api_cn/tensor_cn/argmin_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/argmin_cn.rst @@ -1,7 +1,43 @@ -.. _cn_api_tensor_cn_argmin: +.. _cn_api_tensor_argmin: argmin ------------------------------- -:doc_source: paddle.fluid.layers.argmin +.. py:function:: paddle.argmin(x, axis=None, dtype=None, keepdim=False, name=None) + +该OP沿 ``axis`` 计算输入 ``x`` 的最小元素的索引。 + +参数 +:::::::: + - **x** （Tensor） - 输入的多维 ``Tensor`` ，支持的数据类型：float32、float64、int16、int32、int64、uint8。 + - **axis** （int，可选） - 指定对输入Tensor进行运算的轴， ``axis`` 的有效范围是[-R, R），R是输入 ``x`` 的维度个数， ``axis`` 为负数时，进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为None, 将会对输入的 `x` 进行平铺展开，返回最小值的索引。 + - **dtype** （np.dtype|str）- 输出Tensor的数据类型，可选值为int32，int64，默认值为None，将返回int64类型的结果。 + - **keepdim** （bool，可选）- 是否保留进行最小值索引操作的轴，默认值为False。 + - **name** （str，可选） – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + +返回 +:::::::: +``Tensor``, 如果设置 :attr:`dtype` 为 `int32` 时，返回的tensor的数据类型为 `int32` ，其它情况将返回的tensor的数据类型为 `int64` 。 + +示例代码 +:::::::: + +.. code-block:: python + + import numpy as np + import paddle + + paddle.disable_static() + data = [[5,8,9,5], + [0,0,1,7], + [6,9,2,4]] + x = paddle.to_tensor(data) + out1 = paddle.argmin(x) + print(out1.numpy()) # 4 + out2 = paddle.argmin(x, axis=1) + print(out2.numpy()) + # [0 0 2] + out3 = paddle.argmin(x, axis=-1) + print(out3.numpy()) + # [0 0 2]