From 15064bb7c2958b2e4d3cd2733faf4368e1fdbfb2 Mon Sep 17 00:00:00 2001
From: Zhaolong Xing <nhzlx.dragon@gmail.com>
Date: Thu, 26 Sep 2019 14:36:50 +0800
Subject: [PATCH] fix round, sin, sqrt api eng doc (#1209)

test=develop
---
 doc/fluid/api_cn/layers_cn/round_cn.rst | 33 +++++++++++++++++++------
 doc/fluid/api_cn/layers_cn/sin_cn.rst   | 28 ++++++++++++---------
 doc/fluid/api_cn/layers_cn/sqrt_cn.rst  | 29 ++++++++++++++--------
 3 files changed, 61 insertions(+), 29 deletions(-)

diff --git a/doc/fluid/api_cn/layers_cn/round_cn.rst b/doc/fluid/api_cn/layers_cn/round_cn.rst
index 7d3af7195..3d7392a1c 100644
--- a/doc/fluid/api_cn/layers_cn/round_cn.rst
+++ b/doc/fluid/api_cn/layers_cn/round_cn.rst
@@ -5,27 +5,44 @@ round
 
 .. py:function:: paddle.fluid.layers.round(x, name=None)
 
-Round取整激活函数。
 
+该OP将输入中的数值四舍五入到最接近的整数数值。
 
-.. math::
-     out = [x]
+.. code-block:: python
+
+  输入：
+    x.shape = [4]
+    x.data = [1.2, -0.9, 3.4, 0.9]
 
+  输出：
+    out.shape = [4]
+    Out.data = [1., -1., 3., 1.]
 
 参数:
 
-    - **x** - round算子的输入
-    - **use_cudnn** (BOOLEAN) – （bool，默认为false）是否仅用于cudnn核，需要安装cudnn
+    - **x** (Variable) - 支持任意维度的Tensor。数据类型为float32，float64或float16。
+    - **name** (str，可选) – 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` , 默认值为None。
 
-返回：        Round算子的输出。
+返回：返回类型为Variable(Tensor|LoDTensor)， 数据类型同输入一致。
 
 **代码示例**：
 
 .. code-block:: python
 
+        import numpy as np
         import paddle.fluid as fluid
-        data = fluid.layers.data(name="input", shape=[32, 784])
-        result = fluid.layers.round(data)
+
+        inputs = fluid.layers.data(name="x", shape = [3], dtype='float32')
+        output = fluid.layers.round(inputs)
+
+        exe = fluid.Executor(fluid.CPUPlace())
+        exe.run(fluid.default_startup_program())
+
+        img = np.array([1.2, -0.9, 3.4, 0.9]).astype(np.float32)
+
+        res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output])
+        print(res)
+        # [array([ 1., -1.,  3.,  1.], dtype=float32)]
 
 
 
diff --git a/doc/fluid/api_cn/layers_cn/sin_cn.rst b/doc/fluid/api_cn/layers_cn/sin_cn.rst
index 81898e423..3efb6b6bf 100644
--- a/doc/fluid/api_cn/layers_cn/sin_cn.rst
+++ b/doc/fluid/api_cn/layers_cn/sin_cn.rst
@@ -5,26 +5,32 @@ sin
 
 .. py:function:: paddle.fluid.layers.sin(x, name=None)
 
-正弦sine激活函数。
-
-.. math::
-     out = sin(x)
-
+计算输入的正弦值。
 
 参数:
-    - **x** - sin算子的输入
-    - **use_cudnn** (BOOLEAN) – （bool，默认为false）是否仅用于cudnn核，需要安装cudnn
+    - **x** (Variable) - 支持任意维度的Tensor。数据类型为float32，float64或float16。
+    - **name** (str，可选) – 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` , 默认值为None。
 
-
-返回：        Sin算子的输出。
+返回：返回类型为Variable(Tensor|LoDTensor)， 数据类型同输入一致。
 
 **代码示例**：
 
 .. code-block:: python
 
+        import numpy as np
         import paddle.fluid as fluid
-        data = fluid.layers.data(name="input", shape=[32, 784])
-        result = fluid.layers.sin(data)
+
+        inputs = fluid.layers.data(name="x", shape = [3], dtype='float32')
+        output = fluid.layers.sin(inputs)
+
+        exe = fluid.Executor(fluid.CPUPlace())
+        exe.run(fluid.default_startup_program())
+
+        img = np.array([0, 45, 90]).astype(np.float32)
+
+        res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output])
+        print(res)
+        # [array([0.        , 0.8509035 , 0.89399666], dtype=float32)]
 
 
 
diff --git a/doc/fluid/api_cn/layers_cn/sqrt_cn.rst b/doc/fluid/api_cn/layers_cn/sqrt_cn.rst
index 5a8608a31..73d8be8c3 100644
--- a/doc/fluid/api_cn/layers_cn/sqrt_cn.rst
+++ b/doc/fluid/api_cn/layers_cn/sqrt_cn.rst
@@ -5,28 +5,37 @@ sqrt
 
 .. py:function:: paddle.fluid.layers.sqrt(x, name=None)
 
-算数平方根激活函数。
+计算输入的算数平方根。
 
-请确保输入是非负数。有些训练当中，会出现输入为接近零的负值，此时应加上一个小值epsilon（1e-12）将其变为正数从而正确运算并进行后续的操作。
+.. math:: out=\sqrt x=x^{1/2}
 
-
-.. math::
-    out = \sqrt{x}
+<font color="#FF0000">**注意：请确保输入中的数值是非负数。**</font>
 
 参数:
 
-    - **x** - Sqrt算子的输入
-    - **use_cudnn** (BOOLEAN) – （bool，默认为false）是否仅用于cudnn核，需要安装cudnn
+    - **x** (Variable) - 支持任意维度的Tensor。数据类型为float32，float64或float16。
+    - **name** (str，可选) – 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` , 默认值为None。
 
-返回：       Sqrt算子的输出。
+返回：返回类型为Variable(Tensor|LoDTensor)， 数据类型同输入一致。
 
 **代码示例**：
 
 .. code-block:: python
 
+        import numpy as np
         import paddle.fluid as fluid
-        data = fluid.layers.data(name="input", shape=[32, 784])
-        result = fluid.layers.sqrt(data)
+
+        inputs = fluid.layers.data(name="x", shape = [3], dtype='float32')
+        output = fluid.layers.sqrt(inputs)
+
+        exe = fluid.Executor(fluid.CPUPlace())
+        exe.run(fluid.default_startup_program())
+
+        img = np.array([0, 9, 36]).astype(np.float32)
+
+        res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output])
+        print(res)
+        # [array([0., 3., 6.], dtype=float32)] 
 
 
 
-- 
GitLab