From b399bd19e8774e00a9cd5221880b9d9efe9e3fd8 Mon Sep 17 00:00:00 2001 From: wawltor Date: Thu, 30 Jul 2020 23:24:09 +0800 Subject: [PATCH] fix compare ops api doc for the api 2.0 (#2273) Fix the compare ops doc for the api2.0 --- doc/fluid/api/paddle.rst | 2 +- doc/fluid/api/paddle/elementwise_equal.rst | 7 --- doc/fluid/api/paddle/equal_all.rst | 7 +++ doc/fluid/api/paddle/greater_equal.rst | 2 +- doc/fluid/api/paddle/greater_than.rst | 2 +- doc/fluid/api/paddle/less_equal.rst | 2 +- doc/fluid/api/paddle/less_than.rst | 2 +- doc/fluid/api/paddle/not_equal.rst | 2 +- doc/fluid/api/tensor.rst | 2 +- doc/fluid/api/tensor/elementwise_equal.rst | 7 --- doc/fluid/api/tensor/equal_all.rst | 7 +++ doc/fluid/api/tensor/greater_equal.rst | 2 +- doc/fluid/api/tensor/greater_than.rst | 2 +- doc/fluid/api/tensor/less_equal.rst | 2 +- doc/fluid/api/tensor/less_than.rst | 2 +- doc/fluid/api/tensor/not_equal.rst | 2 +- doc/fluid/api_cn/layers_cn/equal_cn.rst | 7 ++- .../api_cn/layers_cn/greater_equal_cn.rst | 3 +- .../api_cn/layers_cn/greater_than_cn.rst | 3 +- doc/fluid/api_cn/layers_cn/less_equal_cn.rst | 3 +- doc/fluid/api_cn/layers_cn/less_than_cn.rst | 3 +- doc/fluid/api_cn/layers_cn/not_equal_cn.rst | 4 +- .../api_cn/paddle_cn/elementwise_equal_cn.rst | 7 --- doc/fluid/api_cn/paddle_cn/equal_all_cn.rst | 7 +++ .../api_cn/paddle_cn/greater_equal_cn.rst | 2 +- .../api_cn/paddle_cn/greater_than_cn.rst | 2 +- doc/fluid/api_cn/paddle_cn/less_equal_cn.rst | 2 +- doc/fluid/api_cn/paddle_cn/less_than_cn.rst | 2 +- doc/fluid/api_cn/paddle_cn/not_equal_cn.rst | 2 +- doc/fluid/api_cn/tensor_cn.rst | 2 +- .../api_cn/tensor_cn/elementwise_equal_cn.rst | 35 ------------- doc/fluid/api_cn/tensor_cn/equal_all_cn.rst | 40 +++++++++++++++ doc/fluid/api_cn/tensor_cn/equal_cn.rst | 49 ++++++------------- .../api_cn/tensor_cn/greater_equal_cn.rst | 32 +++++++++++- .../api_cn/tensor_cn/greater_than_cn.rst | 30 +++++++++++- doc/fluid/api_cn/tensor_cn/less_equal_cn.rst | 32 +++++++++++- doc/fluid/api_cn/tensor_cn/less_than_cn.rst | 32 +++++++++++- doc/fluid/api_cn/tensor_cn/not_equal_cn.rst | 34 ++++++++++++- 38 files changed, 261 insertions(+), 124 deletions(-) delete mode 100644 doc/fluid/api/paddle/elementwise_equal.rst create mode 100644 doc/fluid/api/paddle/equal_all.rst delete mode 100644 doc/fluid/api/tensor/elementwise_equal.rst create mode 100644 doc/fluid/api/tensor/equal_all.rst delete mode 100644 doc/fluid/api_cn/paddle_cn/elementwise_equal_cn.rst create mode 100644 doc/fluid/api_cn/paddle_cn/equal_all_cn.rst delete mode 100644 doc/fluid/api_cn/tensor_cn/elementwise_equal_cn.rst create mode 100644 doc/fluid/api_cn/tensor_cn/equal_all_cn.rst diff --git a/doc/fluid/api/paddle.rst b/doc/fluid/api/paddle.rst index c4af78701..6e224daa0 100644 --- a/doc/fluid/api/paddle.rst +++ b/doc/fluid/api/paddle.rst @@ -45,7 +45,6 @@ paddle paddle/dot.rst paddle/elementwise_add.rst paddle/elementwise_div.rst - paddle/elementwise_equal.rst paddle/elementwise_floordiv.rst paddle/elementwise_max.rst paddle/elementwise_min.rst @@ -56,6 +55,7 @@ paddle paddle/elementwise_sum.rst paddle/enable_imperative.rst paddle/equal.rst + paddle/equal_all.rst paddle/erf.rst paddle/ExecutionStrategy.rst paddle/Executor.rst diff --git a/doc/fluid/api/paddle/elementwise_equal.rst b/doc/fluid/api/paddle/elementwise_equal.rst deleted file mode 100644 index 485738ee2..000000000 --- a/doc/fluid/api/paddle/elementwise_equal.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _api_paddle_elementwise_equal: - -elementwise_equal -------------------------------- -:doc_source: paddle.fluid.layers.equal - - diff --git a/doc/fluid/api/paddle/equal_all.rst b/doc/fluid/api/paddle/equal_all.rst new file mode 100644 index 000000000..58fc331ac --- /dev/null +++ b/doc/fluid/api/paddle/equal_all.rst @@ -0,0 +1,7 @@ +.. _api_paddle_equal_all + +equal_all +------------------------------- +:doc_source: paddle.tensor.equal_all + + diff --git a/doc/fluid/api/paddle/greater_equal.rst b/doc/fluid/api/paddle/greater_equal.rst index 8739113f3..54afe57ff 100644 --- a/doc/fluid/api/paddle/greater_equal.rst +++ b/doc/fluid/api/paddle/greater_equal.rst @@ -2,6 +2,6 @@ greater_equal ------------------------------- -:doc_source: paddle.fluid.layers.greater_equal +:doc_source: paddle.tensor.greater_equal diff --git a/doc/fluid/api/paddle/greater_than.rst b/doc/fluid/api/paddle/greater_than.rst index f54f0e026..04a874dd9 100644 --- a/doc/fluid/api/paddle/greater_than.rst +++ b/doc/fluid/api/paddle/greater_than.rst @@ -2,6 +2,6 @@ greater_than ------------------------------- -:doc_source: paddle.fluid.layers.greater_than +:doc_source: paddle.tensor.greater_than diff --git a/doc/fluid/api/paddle/less_equal.rst b/doc/fluid/api/paddle/less_equal.rst index 16cc1a647..3fc5e2ce2 100644 --- a/doc/fluid/api/paddle/less_equal.rst +++ b/doc/fluid/api/paddle/less_equal.rst @@ -2,6 +2,6 @@ less_equal ------------------------------- -:doc_source: paddle.fluid.layers.less_equal +:doc_source: paddle.tensor.less_equal diff --git a/doc/fluid/api/paddle/less_than.rst b/doc/fluid/api/paddle/less_than.rst index 2c13074ad..7df6eb441 100644 --- a/doc/fluid/api/paddle/less_than.rst +++ b/doc/fluid/api/paddle/less_than.rst @@ -2,6 +2,6 @@ less_than ------------------------------- -:doc_source: paddle.fluid.layers.less_than +:doc_source: paddle.tensor.less_than diff --git a/doc/fluid/api/paddle/not_equal.rst b/doc/fluid/api/paddle/not_equal.rst index fb5de71d0..4fd1cbe80 100644 --- a/doc/fluid/api/paddle/not_equal.rst +++ b/doc/fluid/api/paddle/not_equal.rst @@ -2,6 +2,6 @@ not_equal ------------------------------- -:doc_source: paddle.fluid.layers.not_equal +:doc_source: paddle.tensor.not_equal diff --git a/doc/fluid/api/tensor.rst b/doc/fluid/api/tensor.rst index 73ce3e9d6..b13c5961b 100644 --- a/doc/fluid/api/tensor.rst +++ b/doc/fluid/api/tensor.rst @@ -26,7 +26,6 @@ paddle.tensor tensor/div.rst tensor/elementwise_add.rst tensor/elementwise_div.rst - tensor/elementwise_equal.rst tensor/elementwise_floordiv.rst tensor/elementwise_max.rst tensor/elementwise_min.rst @@ -34,6 +33,7 @@ paddle.tensor tensor/elementwise_mul.rst tensor/elementwise_pow.rst tensor/elementwise_sub.rst + tensor/equal_all.rst tensor/erf.rst tensor/exp.rst tensor/expand.rst diff --git a/doc/fluid/api/tensor/elementwise_equal.rst b/doc/fluid/api/tensor/elementwise_equal.rst deleted file mode 100644 index ae7944446..000000000 --- a/doc/fluid/api/tensor/elementwise_equal.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _api_tensor_cn_elementwise_equal: - -elementwise_equal -------------------------------- -:doc_source: paddle.fluid.layers.equal - - diff --git a/doc/fluid/api/tensor/equal_all.rst b/doc/fluid/api/tensor/equal_all.rst new file mode 100644 index 000000000..5149e6101 --- /dev/null +++ b/doc/fluid/api/tensor/equal_all.rst @@ -0,0 +1,7 @@ +.. _api_tensor_cn_equal_all: + +equal_all +------------------------------- +:doc_source: paddle.tensor.equal_all + + diff --git a/doc/fluid/api/tensor/greater_equal.rst b/doc/fluid/api/tensor/greater_equal.rst index ab967838e..1a1394de0 100644 --- a/doc/fluid/api/tensor/greater_equal.rst +++ b/doc/fluid/api/tensor/greater_equal.rst @@ -2,6 +2,6 @@ greater_equal ------------------------------- -:doc_source: paddle.fluid.layers.greater_equal +:doc_source: paddle.tensor.greater_equal diff --git a/doc/fluid/api/tensor/greater_than.rst b/doc/fluid/api/tensor/greater_than.rst index 789f212a7..b0ff74910 100644 --- a/doc/fluid/api/tensor/greater_than.rst +++ b/doc/fluid/api/tensor/greater_than.rst @@ -2,6 +2,6 @@ greater_than ------------------------------- -:doc_source: paddle.fluid.layers.greater_than +:doc_source: paddle.tensor.greater_than diff --git a/doc/fluid/api/tensor/less_equal.rst b/doc/fluid/api/tensor/less_equal.rst index 5e7c7180a..4adbeb1cc 100644 --- a/doc/fluid/api/tensor/less_equal.rst +++ b/doc/fluid/api/tensor/less_equal.rst @@ -2,6 +2,6 @@ less_equal ------------------------------- -:doc_source: paddle.fluid.layers.less_equal +:doc_source: paddle.tensor.less_equal diff --git a/doc/fluid/api/tensor/less_than.rst b/doc/fluid/api/tensor/less_than.rst index c4614acf5..592dc48d6 100644 --- a/doc/fluid/api/tensor/less_than.rst +++ b/doc/fluid/api/tensor/less_than.rst @@ -2,6 +2,6 @@ less_than ------------------------------- -:doc_source: paddle.fluid.layers.less_than +:doc_source: paddle.tensor.less_than diff --git a/doc/fluid/api/tensor/not_equal.rst b/doc/fluid/api/tensor/not_equal.rst index d4f506f99..8aeac42d7 100644 --- a/doc/fluid/api/tensor/not_equal.rst +++ b/doc/fluid/api/tensor/not_equal.rst @@ -2,6 +2,6 @@ not_equal ------------------------------- -:doc_source: paddle.fluid.layers.not_equal +:doc_source: paddle.tensor.not_equal diff --git a/doc/fluid/api_cn/layers_cn/equal_cn.rst b/doc/fluid/api_cn/layers_cn/equal_cn.rst index 14b36d094..9a66e76ce 100644 --- a/doc/fluid/api_cn/layers_cn/equal_cn.rst +++ b/doc/fluid/api_cn/layers_cn/equal_cn.rst @@ -3,9 +3,7 @@ equal ------------------------------- -.. py:function:: paddle.fluid.layers.equal(x,y,cond=None) - - +.. py:function:: paddle.fluid.layers.equal(x, y, cond=None, name=None) 该OP返回 :math:`x==y` 逐元素比较x和y是否相等，x和y的维度应该相同。 @@ -13,7 +11,8 @@ equal 参数： - **x** (Variable) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 - **y** (Variable) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 - - **cond** (Variable，可选) - 逐元素比较的结果Tensor，可以是程序中已经创建的任何Variable。默认值为None，此时将创建新的Variable来保存输出结果。 + - **cond** (Variable，可选) – 如果为None，则创建一个Tensor来作为进行比较的输出结果，该Tensor的shape和数据类型和输入x一致；如果不为None，则将Tensor作为该OP的输出，数据类型和数据shape需要和输入x一致。默认值为None。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 返回：输出结果的Tensor，输出Tensor的shape和输入一致，Tensor数据类型为bool。 diff --git a/doc/fluid/api_cn/layers_cn/greater_equal_cn.rst b/doc/fluid/api_cn/layers_cn/greater_equal_cn.rst index 607e3ab0b..714171841 100644 --- a/doc/fluid/api_cn/layers_cn/greater_equal_cn.rst +++ b/doc/fluid/api_cn/layers_cn/greater_equal_cn.rst @@ -3,7 +3,7 @@ greater_equal ------------------------------- -.. py:function:: paddle.fluid.layers.greater_equal(x, y, cond=None) +.. py:function:: paddle.fluid.layers.greater_equal(x, y, cond=None, name=None) :alias_main: paddle.greater_equal :alias: paddle.greater_equal,paddle.tensor.greater_equal,paddle.tensor.logic.greater_equal @@ -18,6 +18,7 @@ greater_equal - **x** (Variable) – 进行比较的第一个输入，是一个多维的Tensor，数据类型可以是float32，float64，int32，int64。 - **y** (Variable) – 进行比较的第二个输入，是一个多维的Tensor，数据类型可以是float32，float64，int32，int64。 - **cond** (Variable，可选) – 如果为None，则创建一个Tensor来作为进行比较的输出结果，该Tensor的shape，数据类型和输入x一致；如果不为None，则将Tensor作为该OP的输出，数据shape和数据类型需要和输入x一致。默认值为None。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 返回：输出结果的Tensor，数据的shape和输入x一致。 diff --git a/doc/fluid/api_cn/layers_cn/greater_than_cn.rst b/doc/fluid/api_cn/layers_cn/greater_than_cn.rst index 29bb93d92..3f208e21a 100644 --- a/doc/fluid/api_cn/layers_cn/greater_than_cn.rst +++ b/doc/fluid/api_cn/layers_cn/greater_than_cn.rst @@ -3,7 +3,7 @@ greater_than ------------------------------- -.. py:function:: paddle.fluid.layers.greater_than(x, y, cond=None) +.. py:function:: paddle.fluid.layers.greater_than(x, y, cond=None, name=None) :alias_main: paddle.greater_than :alias: paddle.greater_than,paddle.tensor.greater_than,paddle.tensor.logic.greater_than @@ -17,6 +17,7 @@ greater_than - **x** (Variable) – 进行比较的第一个输入，是一个多维的Tensor，数据类型可以是float32，float64，int32，int64。 - **y** (Variable) – 进行比较的第二个输入，是一个多维的Tensor，数据类型可以是float32，float64，int32，int64。 - **cond** (Variable，可选) – 如果为None，则创建一个Tensor来作为进行比较的输出结果，该Tensor的shape和数据类型和输入x一致；如果不为None，则将Tensor作为该OP的输出，数据类型和数据shape需要和输入x一致。默认值为None。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 返回：输出结果的Tensor，数据的shape和输入x一致。 diff --git a/doc/fluid/api_cn/layers_cn/less_equal_cn.rst b/doc/fluid/api_cn/layers_cn/less_equal_cn.rst index 88add2c7f..da8b1b833 100644 --- a/doc/fluid/api_cn/layers_cn/less_equal_cn.rst +++ b/doc/fluid/api_cn/layers_cn/less_equal_cn.rst @@ -3,7 +3,7 @@ less_equal ------------------------------- -.. py:function:: paddle.fluid.layers.less_equal(x, y, cond=None) +.. py:function:: paddle.fluid.layers.less_equal(x, y, cond=None, name=None) :alias_main: paddle.less_equal :alias: paddle.less_equal,paddle.tensor.less_equal,paddle.tensor.logic.less_equal @@ -17,6 +17,7 @@ less_equal - **x** (Variable) – 进行比较的第一个输入，是一个多维的Tensor，数据类型可以是float32，float64，int32，int64。 - **y** (Variable) – 进行比较的第二个输入，是一个多维的Tensor，数据类型可以是float32，float64，int32，int64。 - **cond** (Variable，可选) – 如果为None，则创建一个Tensor来作为进行比较的输出结果，该Tensor的shape和数据类型和输入x一致；如果不为None，则将Tensor作为该OP的输出，数据类型和数据shape需要和输入x一致。默认值为None。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 返回：输出结果的Tensor，数据的shape和输入x一致。 diff --git a/doc/fluid/api_cn/layers_cn/less_than_cn.rst b/doc/fluid/api_cn/layers_cn/less_than_cn.rst index be39cae55..6ad375773 100644 --- a/doc/fluid/api_cn/layers_cn/less_than_cn.rst +++ b/doc/fluid/api_cn/layers_cn/less_than_cn.rst @@ -3,7 +3,7 @@ less_than ------------------------------- -.. py:function:: paddle.fluid.layers.less_than(x, y, force_cpu=None, cond=None) +.. py:function:: paddle.fluid.layers.less_than(x, y, force_cpu=None, cond=None, name=None) :alias_main: paddle.less_than :alias: paddle.less_than,paddle.tensor.less_than,paddle.tensor.logic.less_than @@ -20,6 +20,7 @@ less_than - **y** (Variable) - 进行比较的第二个输入，是一个多维的LoDTensor/Tensor，数据类型可以是float32，float64，int32，int64。 - **force_cpu** (bool) – 如果为True则强制将输出变量写入CPU内存中，否则将其写入目前所在的运算设备上。默认值为False。注意：该属性已弃用，其值始终是False。 - **cond** (Variable，可选) – 指定算子输出结果的LoDTensor/Tensor，可以是程序中已经创建的任何Variable。默认值为None，此时将创建新的Variable来保存输出结果。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 返回：输出结果的LoDTensor/Tensor，数据的shape和输入x一致。 diff --git a/doc/fluid/api_cn/layers_cn/not_equal_cn.rst b/doc/fluid/api_cn/layers_cn/not_equal_cn.rst index 9ec0336e9..5a9cedf60 100644 --- a/doc/fluid/api_cn/layers_cn/not_equal_cn.rst +++ b/doc/fluid/api_cn/layers_cn/not_equal_cn.rst @@ -3,7 +3,7 @@ not_equal ------------------------------- -.. py:function:: paddle.fluid.layers.not_equal(x, y, cond=None) +.. py:function:: paddle.fluid.layers.not_equal(x, y, cond=None, name=None) :alias_main: paddle.not_equal :alias: paddle.not_equal,paddle.tensor.not_equal,paddle.tensor.logic.not_equal @@ -17,7 +17,7 @@ not_equal - **x** (Variable) – 进行比较的第一个输入，是一个多维的Tensor，数据类型可以是float32，float64，int32，int64。 - **y** (Variable) – 进行比较的第二个输入，是一个多维的Tensor，数据类型可以是float32，float64，int32，int64。 - **cond** (Variable，可选) – 如果为None，则创建一个Tensor来作为进行比较的输出结果，该Tensor的shape和数据类型和输入x一致；如果不为None，则将Tensor作为该OP的输出，数据类型和数据shape需要和输入x一致。默认值为None。 - + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 返回：输出结果的Tensor，数据的shape和输入x一致。 返回类型：变量（Variable），数据类型为bool类型。 diff --git a/doc/fluid/api_cn/paddle_cn/elementwise_equal_cn.rst b/doc/fluid/api_cn/paddle_cn/elementwise_equal_cn.rst deleted file mode 100644 index 4c0f65404..000000000 --- a/doc/fluid/api_cn/paddle_cn/elementwise_equal_cn.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _cn_api_paddle_cn_elementwise_equal: - -elementwise_equal -------------------------------- -:doc_source: paddle.fluid.layers.equal - - diff --git a/doc/fluid/api_cn/paddle_cn/equal_all_cn.rst b/doc/fluid/api_cn/paddle_cn/equal_all_cn.rst new file mode 100644 index 000000000..72c333de0 --- /dev/null +++ b/doc/fluid/api_cn/paddle_cn/equal_all_cn.rst @@ -0,0 +1,7 @@ +.. _cn_api_paddle_cn_equal_all: + +equal_all +------------------------------- +:doc_source: paddle.tensor.equal_all + + diff --git a/doc/fluid/api_cn/paddle_cn/greater_equal_cn.rst b/doc/fluid/api_cn/paddle_cn/greater_equal_cn.rst index 8fb516705..1f4367acc 100644 --- a/doc/fluid/api_cn/paddle_cn/greater_equal_cn.rst +++ b/doc/fluid/api_cn/paddle_cn/greater_equal_cn.rst @@ -2,6 +2,6 @@ greater_equal ------------------------------- -:doc_source: paddle.fluid.layers.greater_equal +:doc_source: paddle.tensor.greater_equal diff --git a/doc/fluid/api_cn/paddle_cn/greater_than_cn.rst b/doc/fluid/api_cn/paddle_cn/greater_than_cn.rst index f228df1de..f15865d06 100644 --- a/doc/fluid/api_cn/paddle_cn/greater_than_cn.rst +++ b/doc/fluid/api_cn/paddle_cn/greater_than_cn.rst @@ -2,6 +2,6 @@ greater_than ------------------------------- -:doc_source: paddle.fluid.layers.greater_than +:doc_source: paddle.tensor.greater_than diff --git a/doc/fluid/api_cn/paddle_cn/less_equal_cn.rst b/doc/fluid/api_cn/paddle_cn/less_equal_cn.rst index ca9bb26b7..481e3f286 100644 --- a/doc/fluid/api_cn/paddle_cn/less_equal_cn.rst +++ b/doc/fluid/api_cn/paddle_cn/less_equal_cn.rst @@ -2,6 +2,6 @@ less_equal ------------------------------- -:doc_source: paddle.fluid.layers.less_equal +:doc_source: paddle.tensor.less_equal diff --git a/doc/fluid/api_cn/paddle_cn/less_than_cn.rst b/doc/fluid/api_cn/paddle_cn/less_than_cn.rst index 0085d27a7..3f0802843 100644 --- a/doc/fluid/api_cn/paddle_cn/less_than_cn.rst +++ b/doc/fluid/api_cn/paddle_cn/less_than_cn.rst @@ -2,6 +2,6 @@ less_than ------------------------------- -:doc_source: paddle.fluid.layers.less_than +:doc_source: paddle.tensor.less_than diff --git a/doc/fluid/api_cn/paddle_cn/not_equal_cn.rst b/doc/fluid/api_cn/paddle_cn/not_equal_cn.rst index 987d96697..872637f9e 100644 --- a/doc/fluid/api_cn/paddle_cn/not_equal_cn.rst +++ b/doc/fluid/api_cn/paddle_cn/not_equal_cn.rst @@ -2,6 +2,6 @@ not_equal ------------------------------- -:doc_source: paddle.fluid.layers.not_equal +:doc_source: paddle.tensor.not_equal diff --git a/doc/fluid/api_cn/tensor_cn.rst b/doc/fluid/api_cn/tensor_cn.rst index d150b3001..b16ce668a 100644 --- a/doc/fluid/api_cn/tensor_cn.rst +++ b/doc/fluid/api_cn/tensor_cn.rst @@ -38,7 +38,6 @@ paddle.tensor tensor_cn/einsum_cn.rst tensor_cn/elementwise_add_cn.rst tensor_cn/elementwise_div_cn.rst - tensor_cn/elementwise_equal_cn.rst tensor_cn/elementwise_floordiv_cn.rst tensor_cn/elementwise_max_cn.rst tensor_cn/elementwise_min_cn.rst @@ -48,6 +47,7 @@ paddle.tensor tensor_cn/elementwise_sub_cn.rst tensor_cn/elementwise_sum_cn.rst tensor_cn/equal_cn.rst + tensor_cn/equal_all_cn.rst tensor_cn/erf_cn.rst tensor_cn/exp_cn.rst tensor_cn/expand_as_cn.rst diff --git a/doc/fluid/api_cn/tensor_cn/elementwise_equal_cn.rst b/doc/fluid/api_cn/tensor_cn/elementwise_equal_cn.rst deleted file mode 100644 index c7006ffda..000000000 --- a/doc/fluid/api_cn/tensor_cn/elementwise_equal_cn.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _cn_api_tensor_elementwise_equal: - -elementwise_equal -------------------------------- - -.. py:function:: paddle.elementwise_equal(x, y, name=None) - -:alias_main: paddle.elementwise_equal -:alias: paddle.elementwise_equal,paddle.tensor.elementwise_equal,paddle.tensor.logic.elementwise_equal -:update_api: paddle.fluid.layers.equal - - - -该OP返回 :math:`x==y` 逐元素比较x和y是否相等。 - -参数： - - **x** (Variable) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 - - **y** (Variable) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 - - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 - -返回：输出结果的Tensor，输出Tensor的shape和输入一致，Tensor数据类型为bool。 - -返回类型：变量（Variable） - -**代码示例**: - -.. code-block:: python - - import paddle - import paddle.fluid as fluid - import numpy as np - - label = fluid.layers.assign(np.array([3, 3], dtype="int32")) - limit = fluid.layers.assign(np.array([3, 2], dtype="int32")) - out1 = paddle.elementwise_equal(x=label, y=limit) #out1=[True, False] diff --git a/doc/fluid/api_cn/tensor_cn/equal_all_cn.rst b/doc/fluid/api_cn/tensor_cn/equal_all_cn.rst new file mode 100644 index 000000000..b12697760 --- /dev/null +++ b/doc/fluid/api_cn/tensor_cn/equal_all_cn.rst @@ -0,0 +1,40 @@ +.. _cn_api_tensor_equal_all: + +equal_all +------------------------------- + +.. py:function:: paddle.equal_all(x, y, name=None) + +:alias_main: paddle.equal_all +:alias: paddle.equal_all,paddle.tensor.equal_all,paddle.tensor.logic.equal_all + +该OP返回：返回的结果只有一个元素值，如果所有相同位置的元素相同返回True，否则返回False。 + +**注：该OP输出的结果不返回梯度。** + + +参数： + - **x** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 + - **y** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + +返回：输出结果为Tensor，Tensor数据类型为bool。 + +返回类型：变量（Tensor） + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle + import paddle.imperative as imperative + paddle.enable_imperative() + paddle.enable_imperative() + x = imperative.to_variable(np.array([1, 2, 3])) + y = imperative.to_variable(np.array([1, 2, 3])) + z = imperative.to_variable(np.array([1, 4, 3])) + result1 = paddle.equal_all(x, y) + print(result1.numpy()) # result1 = [True ] + result2 = paddle.equal_all(x, z) + print(result2.numpy()) # result2 = [False ] diff --git a/doc/fluid/api_cn/tensor_cn/equal_cn.rst b/doc/fluid/api_cn/tensor_cn/equal_cn.rst index d25ec0108..e8b1dff60 100644 --- a/doc/fluid/api_cn/tensor_cn/equal_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/equal_cn.rst @@ -2,54 +2,35 @@ equal ------------------------------- -.. py:function:: paddle.equal(x, y, axis=-1, name=None) +.. py:function:: paddle.equal(x, y, name=None) :alias_main: paddle.equal :alias: paddle.equal,paddle.tensor.equal,paddle.tensor.logic.equal +该OP返回 :math:`x==y` 逐元素比较x和y是否相等，相同位置的元素相同则返回True，否则返回False。使用重载算子 `==` 可以有相同的计算函数效果 - -该OP返回 :math:`x==y` 逐元素比较x和y是否相等，所有的元素都相同则返回True，否则返回False。 +**注：该OP输出的结果不返回梯度。** 参数： - - **x** (Variable) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 - - **y** (Variable) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 - - **axis** (int, 可选) - 如果输入的两个Tensor的维度不相同，并且如果y的维度是x的一部分, 那就可以通过broadcast的方式来进行op计算。axis是进行broadcast的开始的维度，具体broadcast的方式可以参考elementwise_add。 + - **x** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 + - **y** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 -返回：输出结果的Tensor，输出Tensor只有一个元素值，元素值是True或者False，Tensor数据类型为bool。 +返回：输出结果的Tensor，输出Tensor的shape和输入一致，Tensor数据类型为bool。 -返回类型：变量（Variable） +返回类型：变量（Tensor） **代码示例**: .. code-block:: python - import paddle.fluid as fluid - import paddle - import numpy as np - label = fluid.layers.assign(np.array([3, 4], dtype="int32")) - label_1 = fluid.layers.assign(np.array([1, 2], dtype="int32")) - limit = fluid.layers.assign(np.array([3, 4], dtype="int32")) - out1 = paddle.equal(x=label, y=limit) #out1=[True] - out2 = paddle.equal(x=label_1, y=limit) #out2=[False] - -.. code-block:: python + import numpy as np + import paddle + import paddle.imperative as imperative + paddle.enable_imperative() + x = imperative.to_variable(np.array([1, 2, 3])) + y = imperative.to_variable(np.array([1, 3, 2])) + result1 = paddle.equal(x, y) + print(result1.numpy()) # result1 = [True False False] - import paddle.fluid as fluid - import paddle - import numpy as np - def gen_data(): - return { - "x": np.ones((2, 3, 4, 5)).astype('float32'), - "y": np.zeros((3, 4)).astype('float32') - } - x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32') - y = fluid.data(name="y", shape=[3,4], dtype='float32') - out = paddle.equal(x, y, axis=1) - place = fluid.CPUPlace() - exe = fluid.Executor(place) - res = exe.run(feed=gen_data(), - fetch_list=[out]) - print(res[0]) #[False] diff --git a/doc/fluid/api_cn/tensor_cn/greater_equal_cn.rst b/doc/fluid/api_cn/tensor_cn/greater_equal_cn.rst index 21d267261..6eedd6c3b 100644 --- a/doc/fluid/api_cn/tensor_cn/greater_equal_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/greater_equal_cn.rst @@ -2,6 +2,36 @@ greater_equal ------------------------------- -:doc_source: paddle.fluid.layers.greater_equal +.. py:function:: paddle.greater_equal(x, y, name=None) + +:alias_main: paddle.greater_equal +:alias: paddle.greater_equal,paddle.tensor.greater_equal,paddle.tensor.logic.greater_equal + +该OP逐元素地返回 :math:`x >= y` 的逻辑值，相同位置前者输入大于等于后者输入则返回True，否则返回False。使用重载算子 `>=` 可以有相同的计算函数效果。 + +**注：该OP输出的结果不返回梯度。** + +参数： + - **x** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 + - **y** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + + +返回：输出结果的Tensor，输出Tensor的shape和输入一致，Tensor数据类型为bool。 + +返回类型：变量（Tensor） + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle + import paddle.imperative as imperative + paddle.enable_imperative() + x = imperative.to_variable(np.array([1, 2, 3])) + y = imperative.to_variable(np.array([1, 3, 2])) + result1 = paddle.greater_equal(x, y) + print(result1.numpy()) # result1 = [True False True] diff --git a/doc/fluid/api_cn/tensor_cn/greater_than_cn.rst b/doc/fluid/api_cn/tensor_cn/greater_than_cn.rst index 40ad68f70..33df3e31c 100644 --- a/doc/fluid/api_cn/tensor_cn/greater_than_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/greater_than_cn.rst @@ -2,6 +2,34 @@ greater_than ------------------------------- -:doc_source: paddle.fluid.layers.greater_than +.. py:function:: paddle.greater_than(x, y, name=None) +:alias_main: paddle.greater_than +:alias: paddle.greater_than,paddle.tensor.greater_than,paddle.tensor.logic.greater_than +该OP返回 :math:`x>y` 逐元素比较x和y是否相等，相同位置前者输入大于等于后者输入则返回True，否则返回False。使用重载算子 `>` 可以有相同的计算函数效果 + +**注：该OP输出的结果不返回梯度。** + +参数： + - **x** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 + - **y** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + + +返回：输出结果的Tensor，输出Tensor的shape和输入一致，Tensor数据类型为bool。 + +返回类型：变量（Tensor） + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle + import paddle.imperative as imperative + paddle.enable_imperative() + x = imperative.to_variable(np.array([1, 2, 3])) + y = imperative.to_variable(np.array([1, 3, 2])) + result1 = paddle.greater_than(x, y) + print(result1.numpy()) # result1 = [False False True] diff --git a/doc/fluid/api_cn/tensor_cn/less_equal_cn.rst b/doc/fluid/api_cn/tensor_cn/less_equal_cn.rst index f2b9381ca..63427b144 100644 --- a/doc/fluid/api_cn/tensor_cn/less_equal_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/less_equal_cn.rst @@ -2,6 +2,36 @@ less_equal ------------------------------- -:doc_source: paddle.fluid.layers.less_equal +.. py:function:: paddle.less_equal(x, y, name=None) + +:alias_main: paddle.less_equal +:alias: paddle.less_equal,paddle.tensor.less_equal,paddle.tensor.logic.less_equal + +该OP逐元素地返回 :math:`x <= y` 的逻辑值，相同位置前者输入小于等于后者输入则返回True，否则返回False。使用重载算子 `<=` 可以有相同的计算函数效果。 + +**注：该OP输出的结果不返回梯度。** + +参数： + - **x** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 + - **y** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + + +返回：输出结果的Tensor，输出Tensor的shape和输入一致，Tensor数据类型为bool。 + +返回类型：变量（Tensor） + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle + import paddle.imperative as imperative + paddle.enable_imperative() + x = imperative.to_variable(np.array([1, 2, 3])) + y = imperative.to_variable(np.array([1, 3, 2])) + result1 = paddle.less_equal(x, y) + print(result1.numpy()) # result1 = [True True False] diff --git a/doc/fluid/api_cn/tensor_cn/less_than_cn.rst b/doc/fluid/api_cn/tensor_cn/less_than_cn.rst index 8a89d50b1..e49b092cc 100644 --- a/doc/fluid/api_cn/tensor_cn/less_than_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/less_than_cn.rst @@ -2,6 +2,36 @@ less_than ------------------------------- -:doc_source: paddle.fluid.layers.less_than +.. py:function:: paddle.less_than(x, y, name=None) + +:alias_main: paddle.less_than +:alias: paddle.less_than,paddle.tensor.less_than,paddle.tensor.logic.less_than + +该OP逐元素地返回 :math:`x < y` 的逻辑值，相同位置前者输入小于后者输入则返回True，否则返回False。使用重载算子 `<` 可以有相同的计算函数效果。 + +**注：该OP输出的结果不返回梯度。** + +参数： + - **x** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 + - **y** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + + +返回：输出结果的Tensor，输出Tensor的shape和输入一致，Tensor数据类型为bool。 + +返回类型：变量（Tensor） + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle + import paddle.imperative as imperative + paddle.enable_imperative() + x = imperative.to_variable(np.array([1, 2, 3])) + y = imperative.to_variable(np.array([1, 3, 2])) + result1 = paddle.less_than(x, y) + print(result1.numpy()) # result1 = [False True False] diff --git a/doc/fluid/api_cn/tensor_cn/not_equal_cn.rst b/doc/fluid/api_cn/tensor_cn/not_equal_cn.rst index 5cd088f25..8a81f4f08 100644 --- a/doc/fluid/api_cn/tensor_cn/not_equal_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/not_equal_cn.rst @@ -1,7 +1,37 @@ -.. _cn_api_tensor_cn_not_equal: +.. _cn_api_tensor_not_equal: not_equal ------------------------------- -:doc_source: paddle.fluid.layers.not_equal +.. py:function:: paddle.not_equal(x, y, name=None) + +:alias_main: paddle.not_equal +:alias: paddle.not_equal,paddle.tensor.not_equal,paddle.tensor.logic.not_equal + +该OP返回 :math:`x!=y` 逐元素比较x和y是否相等，相同位置的元素不相同则返回True，否则返回False。使用重载算子 `!=` 可以有相同的计算函数效果 + +**注：该OP输出的结果不返回梯度。** + +参数： + - **x** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64，int32， int64。 + - **y** (Tensor) - 输入Tensor，支持的数据类型包括 float32， float64， int32， int64。 + - **name** （str，可选）- 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + + +返回：输出结果的Tensor，输出Tensor的shape和输入一致，Tensor数据类型为bool。 + +返回类型：变量（Tensor） + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle + import paddle.imperative as imperative + paddle.enable_imperative() + x = imperative.to_variable(np.array([1, 2, 3])) + y = imperative.to_variable(np.array([1, 3, 2])) + result1 = paddle.not_equal(x, y) + print(result1.numpy()) # result1 = [False True True] -- GitLab