From df08209af93aeb390319519bde73a47cde637363 Mon Sep 17 00:00:00 2001 From: zhaoyuchen2018 <45989343+zhaoyuchen2018@users.noreply.github.com> Date: Wed, 4 Dec 2019 10:28:54 +0800 Subject: [PATCH] [cherry-pick] Add descending parameter for argsort doc. (#1621) (#1632) * Add descending parameter for argsort doc. * Refine doc * Refine format --- doc/fluid/api_cn/layers_cn/argsort_cn.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/fluid/api_cn/layers_cn/argsort_cn.rst b/doc/fluid/api_cn/layers_cn/argsort_cn.rst index 1ca8c0d70..cc3510975 100644 --- a/doc/fluid/api_cn/layers_cn/argsort_cn.rst +++ b/doc/fluid/api_cn/layers_cn/argsort_cn.rst @@ -3,14 +3,15 @@ argsort ------------------------------- -.. py:function:: paddle.fluid.layers.argsort(input,axis=-1,name=None) +.. py:function:: paddle.fluid.layers.argsort(input,axis=-1,descending=False,name=None) -对输入变量沿给定轴进行 **升序** 排列,输出排序好的数据和相应的索引,其维度和输入相同。**暂不支持降序排列**。 +对输入变量沿给定轴进行排序,输出排序好的数据和相应的索引,其维度和输入相同。**默认升序排列,如果需要降序排列设置** ``descending=True`` 。 参数: - **input** (Variable) - 输入的多维 ``Tensor`` ,支持的数据类型:float32、float64。 - **axis** (int,可选) - 指定对输入Tensor进行运算的轴, ``axis`` 的有效范围是[-R, R),R是输入 ``x`` 的Rank, ``axis`` 为负时与 ``axis`` +R 等价。默认值为0。 + - **descending** (bool,可选) - 指定算法排序的方向。如果设置为True,算法按照降序排序。如果设置为False或者不设置,按照升序排序。默认值为False。 - **name** (str,可选) – 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。 返回:一组已排序的输出(与 ``input`` 维度相同、数据类型相同)和索引(数据类型为int64)。 -- GitLab