From ea408129ae8e4f9075316a4f0f556fa9de287f3f Mon Sep 17 00:00:00 2001 From: WuHaobo <14162525+WuHaobo@users.noreply.github.com> Date: Fri, 14 Aug 2020 11:30:48 +0800 Subject: [PATCH] Update `log` `log1p` docs (#2337) * remove the out args * update log docs * update log1p docs --- doc/fluid/api_cn/tensor_cn/log1p_cn.rst | 35 ++++++++++------------ doc/fluid/api_cn/tensor_cn/log_cn.rst | 39 ++++++++++++++++++++++++- 2 files changed, 53 insertions(+), 21 deletions(-) diff --git a/doc/fluid/api_cn/tensor_cn/log1p_cn.rst b/doc/fluid/api_cn/tensor_cn/log1p_cn.rst index dab3f158a..ff96c6080 100644 --- a/doc/fluid/api_cn/tensor_cn/log1p_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/log1p_cn.rst @@ -3,7 +3,7 @@ log1p ------------------------------- -.. py:function:: paddle.tensor.log1p(x, out=None, name=None) +.. py:function:: paddle.log1p(x, name=None) :alias_main: paddle.log1p :alias: paddle.log1p,paddle.tensor.log1p,paddle.tensor.math.log1p @@ -18,32 +18,27 @@ log1p 参数: - - **x** (Variable) – 该OP的输入为LodTensor/Tensor。数据类型为float32,float64。 - - **out** (Variable, 可选) - 指定算子输出结果的LoDTensor/Tensor,可以是程序中已经创建的任何Variable。默认值为None,此时将创建新的Variable来保存输出结果。 + - **x** (Tensor) – 指定输入为一个多维的Tensor。数据类型为float32,float64。 - **name** (str,可选) – 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,默认值为None。 返回:Log1p算子自然对数输出 -返回类型: Variable - 该OP的输出为LodTensor/Tensor,数据类型为输入一致。 +返回类型: Tensor - 该OP的输出为一个多维的Tensor,数据类型为输入一致。 **代码示例** .. code-block:: python - import paddle - import paddle.fluid as fluid - import numpy as np - - x = fluid.data(name="x", shape=[2,1], dtype="float32") - res = paddle.log1p(x) # paddle.log1p等价于 paddle.tensor.log1p - - # 举例选择CPU计算环境 - exe = fluid.Executor(fluid.CPUPlace()) - - # 执行静态图,输出结果 - x_i = np.array([[0], [1]]).astype(np.float32) - res_val, = exe.run(fluid.default_main_program(), feed={'x':x_i}, fetch_list=[res]) - print(res_val) # [[0.], [0.6931472]] - - + import paddle + import numpy as np + + paddle.enable_imperative() + x = np.array([[1, 2], [3, 4]]).astype('float32') + x1 = paddle.imperative.to_variable(x) + + out1 = paddle.log1p(x1) + print(out1.numpy()) + # [[0.6931472 1.0986123] + # [1.3862944 1.609438 ]] + diff --git a/doc/fluid/api_cn/tensor_cn/log_cn.rst b/doc/fluid/api_cn/tensor_cn/log_cn.rst index 960019d43..5cfc4f494 100644 --- a/doc/fluid/api_cn/tensor_cn/log_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/log_cn.rst @@ -2,6 +2,43 @@ log ------------------------------- -:doc_source: paddle.fluid.layers.log +.. py:function:: paddle.log(x, name=None) +:alias_main: paddle.log +:alias: paddle.log,paddle.tensor.log,paddle.tensor.math.log +:old_api: paddle.fluid.layers.log + + + + +Log激活函数(计算自然对数) + +.. math:: + \\Out=ln(x)\\ + + +参数: + - **x** (Tensor) – 指定输入为一个多维的Tensor。数据类型为float32,float64。 + - **name** (str,可选) – 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,默认值为None。 + +返回:Log算子自然对数输出 + +返回类型: Tensor - 该OP的输出为一个多维的Tensor,数据类型为输入一致。 + + +**代码示例** + +.. code-block:: python + + import paddle + import numpy as np + + paddle.enable_imperative() + x = np.array([[1, 2], [3, 4]]).astype('float32') + x1 = paddle.imperative.to_variable(x) + + out1 = paddle.log(x1) + print(out1.numpy()) + # [[0. 0.6931472] + # [1.0986123 1.3862944]] -- GitLab