From e84cc01402f7da01b7e00e9e1405286f0a0afe46 Mon Sep 17 00:00:00 2001 From: kinghuin Date: Tue, 21 Apr 2020 10:21:21 +0800 Subject: [PATCH] add paddle.sin, sqrt, tanh, atan cn doc,test=develop (#2008) * add paddle.sin, sqrt, tanh, atan cn doc to fluid docs --- doc/fluid/api_cn/tensor_cn/atan_cn.rst | 37 ++++++++++++++++++++++- doc/fluid/api_cn/tensor_cn/sin_cn.rst | 37 ++++++++++++++++++++++- doc/fluid/api_cn/tensor_cn/sqrt_cn.rst | 41 +++++++++++++++++++++++++- doc/fluid/api_cn/tensor_cn/tanh_cn.rst | 39 +++++++++++++++++++++++- 4 files changed, 150 insertions(+), 4 deletions(-) diff --git a/doc/fluid/api_cn/tensor_cn/atan_cn.rst b/doc/fluid/api_cn/tensor_cn/atan_cn.rst index 91f7c12c8..382f6b09b 100644 --- a/doc/fluid/api_cn/tensor_cn/atan_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/atan_cn.rst @@ -1,3 +1,38 @@ +.. _cn_api_tensor_atan: + atan ------------------------------- -**版本升级，文档正在开发中** + +.. py:function:: paddle.atan(x, name=None, out=None) + +arctanh 激活函数。 + +.. math:: + out = tanh^{-1}(x) + +参数: + - **x(Variable)** - atan的输入Tensor，数据类型为 float32 或 float64 + - **name** (str|None) – 具体用法请参见 :ref:`cn_api_guide_Name` ，一般无需设置，默认值为None。 + - **out** (Variable, 可选) – 指定存储运算结果的Tensor。如果设置为None或者不设置，将创建新的Tensor存储运算结果，默认值为None。 + +返回：返回类型为Variable(Tensor|LoDTensor)， 数据类型同输入一致。 + +**代码示例**： + +.. code-block:: python + + import numpy as np + import paddle + import paddle.fluid as fluid + + inputs = fluid.layers.data(name="x", shape = [3], dtype='float32') + output = paddle.atan(inputs) + + exe = fluid.Executor(fluid.CPUPlace()) + exe.run(fluid.default_startup_program()) + + img = np.array([-0.8183, 0.4912, -0.6444, 0.0371]).astype(np.float32) + + res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output]) + print(res) + #[array([-0.6858003, 0.45658287, -0.5724284, 0.03708299], dtype=float32)] diff --git a/doc/fluid/api_cn/tensor_cn/sin_cn.rst b/doc/fluid/api_cn/tensor_cn/sin_cn.rst index b3939bc45..7a94b3fbd 100644 --- a/doc/fluid/api_cn/tensor_cn/sin_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/sin_cn.rst @@ -1,3 +1,38 @@ +.. _cn_api_tensor_sin: + sin ------------------------------- -**版本升级，文档正在开发中** + +.. py:function:: paddle.sin(x, name=None, out=None) + +计算输入的正弦值。 + +.. math:: + out = sin(x) + +参数: + - **x** (Variable) - 支持任意维度的Tensor。数据类型为float32，float64或float16。 + - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + - **out** (Variable, 可选) – 指定存储运算结果的Tensor。如果设置为None或者不设置，将创建新的Tensor存储运算结果，默认值为None。 + +返回：返回类型为Variable(Tensor|LoDTensor)， 数据类型同输入一致。 + +**代码示例**： + +.. code-block:: python + + import numpy as np + import paddle + import paddle.fluid as fluid + + inputs = fluid.layers.data(name="x", shape = [3], dtype='float32') + output = paddle.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/tensor_cn/sqrt_cn.rst b/doc/fluid/api_cn/tensor_cn/sqrt_cn.rst index 0a4263872..b8a5a2b93 100644 --- a/doc/fluid/api_cn/tensor_cn/sqrt_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/sqrt_cn.rst @@ -1,3 +1,42 @@ +.. _cn_api_tensor_sqrt: + sqrt ------------------------------- -**版本升级，文档正在开发中** + +.. py:function:: paddle.sqrt(x, name=None, out=None) + +计算输入的算数平方根。 + +.. math:: + out=\sqrt x=x^{1/2} + +.. note:: + 请确保输入中的数值是非负数。 + +参数: + + - **x** (Variable) - 支持任意维度的Tensor。数据类型为float32，float64或float16。 + - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + - **out** (Variable, 可选) – 指定存储运算结果的Tensor。如果设置为None或者不设置，将创建新的Tensor存储运算结果，默认值为None。 + +返回：返回类型为Variable(Tensor|LoDTensor)， 数据类型同输入一致。 + +**代码示例**： + +.. code-block:: python + + import numpy as np + import paddle + import paddle.fluid as fluid + + inputs = fluid.layers.data(name="x", shape = [3], dtype='float32') + output = paddle.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)] diff --git a/doc/fluid/api_cn/tensor_cn/tanh_cn.rst b/doc/fluid/api_cn/tensor_cn/tanh_cn.rst index 2adbc224e..c36b1200a 100644 --- a/doc/fluid/api_cn/tensor_cn/tanh_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/tanh_cn.rst @@ -1,3 +1,40 @@ +.. _cn_api_tensor_tanh: + tanh ------------------------------- -**版本升级，文档正在开发中** + +.. py:function:: paddle.tanh(x, name=None, out=None) + +tanh 激活函数 + +.. math:: + out = \frac{e^{x} - e^{-x}}{e^{x} + e^{-x}} + + +参数: + + - **x** (Variable) - 支持任意维度的Tensor。数据类型为float32，float64或float16。 + - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为None。 + - **out** (Variable, 可选) – 指定存储运算结果的Tensor。如果设置为None或者不设置，将创建新的Tensor存储运算结果，默认值为None。 + +返回：返回类型为Variable(Tensor|LoDTensor)， 数据类型同输入一致。 + +**代码示例**： + +.. code-block:: python + + import numpy as np + import paddle + import paddle.fluid as fluid + + inputs = fluid.layers.data(name="x", shape = [3], dtype='float32') + output = paddle.tanh(inputs) + + exe = fluid.Executor(fluid.CPUPlace()) + exe.run(fluid.default_startup_program()) + + img = np.array([0, 0.5, 0.3]).astype(np.float32) + + res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output]) + print(res) + # [array([0., 0.46211717, 0.2913126], dtype=float32)] -- GitLab