未验证 提交 1d07d955 编写于 作者: W WuHaobo 提交者: GitHub

polish some docs (#2403)

* polish some docs

* polish some docs

* Update square_cn.rst

* polish some docs

* polish some docs

* polish round docs

* polish round docs

* Update square_cn.rst
上级 6e580889
.. _cn_api_nn_functional_sigmoid:
sigmoid
-------------------------------
.. py:function:: paddle.nn.functional.sigmoid(x, name=None)
sigmoid激活函数
.. math::
out = \frac{1}{1 + e^{-x}}
参数:
- **x** (Tensor) - 输入的 `Tensor` ,数据类型为:float32、float64。
- **name** (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。
返回:
- Tensor,对输入x进行sigmoid激活后的Tensor,形状、数据类型与输入x一致。
**代码示例**:
.. code-block:: python
import numpy as np
import paddle
import paddle.nn.functional as F
paddle.disable_static()
x_data = np.array([-0.4, -0.2, 0.1, 0.3])
x = paddle.to_tensor(x_data)
out = F.sigmoid(x)
print(out.numpy())
# [0.40131234 0.450166 0.52497919 0.57444252]
文件模式从 100755 更改为 100644
.. _cn_api_tensor_erf:
erf erf
------------------------------- -------------------------------
**版本升级,文档正在开发中**
.. py:function:: paddle.erf(x, name=None)
逐元素计算 Erf 激活函数。更多细节请参考 `Error function <https://en.wikipedia.org/wiki/Error_function>`_ 。
.. math::
out = \frac{2}{\sqrt{\pi}} \int_{0}^{x}e^{- \eta^{2}}d\eta
参数:
- **x** (Tensor) - 输入的 `Tensor` ,数据类型为: float16, float32, float64。
- **name** (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。
返回:
- Tensor,对输入x进行erf激活后的Tensor,形状、数据类型与输入 x 一致。
**代码示例**:
.. code-block:: python
import numpy as np
import paddle
paddle.disable_static()
x_data = np.array([-0.4, -0.2, 0.1, 0.3])
x = paddle.to_tensor(x_data)
out = paddle.erf(x)
print(out.numpy())
# [-0.42839236 -0.22270259 0.11246292 0.32862676]
...@@ -2,6 +2,30 @@ ...@@ -2,6 +2,30 @@
round round
------------------------------- -------------------------------
:doc_source: paddle.fluid.layers.round
.. py:function:: paddle.round(x, name=None)
该OP将输入中的数值四舍五入到最接近的整数数值。
参数:
- **x** (Tensor) - 输入的 `Tensor` ,数据类型为: float16, float32, float64。
- **name** (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。
返回:
- Tensor,对输入x四舍五入后的Tensor,形状、数据类型与输入x一致。
**代码示例**:
.. code-block:: python
import numpy as np
import paddle
paddle.disable_static()
x_data = np.array([-0.5, -0.2, 0.6, 1.5])
x = paddle.to_tensor(x_data)
out = paddle.round(x)
print(out.numpy())
# [-1. -0. 1. 2.]
...@@ -2,6 +2,39 @@ ...@@ -2,6 +2,39 @@
rsqrt rsqrt
------------------------------- -------------------------------
:doc_source: paddle.fluid.layers.rsqrt
.. py:function:: paddle.rsqrt(x, name=None)
该OP为rsqrt激活函数。
注:输入x应确保为非 **0** 值,否则程序会抛异常退出。
其运算公式如下:
.. math::
out = \frac{1}{\sqrt{x}}
参数:
- **x** (Tensor) - 输入的 `Tensor` ,数据类型为:float32、float64。
- **name** (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。
返回:
- Tensor,对输入x进行rsqrt激活后的Tensor,形状、数据类型与输入x一致。
**代码示例**:
.. code-block:: python
import numpy as np
import paddle
paddle.disable_static()
x_data = np.array([0.1, 0.2, 0.3, 0.4])
x = paddle.to_tensor(x_data)
out = paddle.rsqrt(x)
print(out.numpy())
# [3.16227766 2.23606798 1.82574186 1.58113883]
...@@ -3,11 +3,7 @@ ...@@ -3,11 +3,7 @@
sin sin
------------------------------- -------------------------------
.. py:function:: paddle.sin(x, name=None, out=None) .. py:function:: paddle.sin(x, name=None)
:alias_main: paddle.sin
:alias: paddle.sin,paddle.tensor.sin,paddle.tensor.math.sin
:update_api: paddle.fluid.layers.sin
...@@ -16,12 +12,13 @@ sin ...@@ -16,12 +12,13 @@ sin
.. math:: .. math::
out = sin(x) out = sin(x)
参数: 参数:
- **x** (Variable) - 支持任意维度的Tensor。数据类型为float32,float64或float16。 - **x** (Tensor) - 输入的 `Tensor` ,数据类型为: float16, float32, float64。
- **name** (str,可选) – 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。 - **name** (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。
- **out** (Variable, 可选) – 指定存储运算结果的Tensor。如果设置为None或者不设置,将创建新的Tensor存储运算结果,默认值为None。
返回:
- Tensor,对输入x计算sin值后的Tensor,形状、数据类型同输入x一致。
返回:返回类型为Variable(Tensor|LoDTensor), 数据类型同输入一致。
**代码示例**: **代码示例**:
...@@ -29,16 +26,9 @@ sin ...@@ -29,16 +26,9 @@ sin
import numpy as np import numpy as np
import paddle import paddle
import paddle.fluid as fluid paddle.disable_static()
x_data = np.array([-0.4, -0.2, 0.1, 0.3])
inputs = fluid.layers.data(name="x", shape = [3], dtype='float32') x = paddle.to_tensor(x_data)
output = paddle.sin(inputs) out = paddle.sin(x)
print(out.numpy())
exe = fluid.Executor(fluid.CPUPlace()) # [-0.38941834 -0.19866933 0.09983342 0.29552021]
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)]
...@@ -2,6 +2,34 @@ ...@@ -2,6 +2,34 @@
square square
------------------------------- -------------------------------
:doc_source: paddle.fluid.layers.square
.. py:function:: paddle.square(x,name=None)
该OP执行逐元素取平方运算。
.. math::
out = x^2
参数:
- **x** (Tensor) - 输入的 `Tensor` ,数据类型为:float32、float64。
- **name** (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。
返回:
- Tensor,对输入x取平方后的Tensor,形状、数据类型与输入x一致。
**代码示例**:
.. code-block:: python
import numpy as np
import paddle
paddle.disable_static()
x_data = np.array([-0.4, -0.2, 0.1, 0.3])
x = paddle.to_tensor(x_data)
out = paddle.square(x)
print(out.numpy())
# [0.16 0.04 0.01 0.09]
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册