From 7b408b9c4c0a6cfa0ecce4865300c31dd05ec041 Mon Sep 17 00:00:00 2001 From: liuwei1031 <46661762+liuwei1031@users.noreply.github.com> Date: Fri, 17 Apr 2020 14:04:37 +0800 Subject: [PATCH] add cn doc for dot and logsumexp (#1997) * add cn doc for dot and logsumexp --- doc/fluid/api_cn/tensor_cn/dot_cn.rst | 36 +++++++++++++++- doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst | 48 ++++++++++++++++++++- 2 files changed, 82 insertions(+), 2 deletions(-) diff --git a/doc/fluid/api_cn/tensor_cn/dot_cn.rst b/doc/fluid/api_cn/tensor_cn/dot_cn.rst index fa68663f6..37c5e3a21 100644 --- a/doc/fluid/api_cn/tensor_cn/dot_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/dot_cn.rst @@ -1,3 +1,37 @@ +.. _cn_api_paddle_tensor_linalg_dot: + dot ------------------------------- -**版本升级,文档正在开发中** + +.. py:function:: paddle.tensor.linalg.dot(x, y, name=None) + +该OP计算向量的内积 + +.. note:: + 仅支持1维Tensor(向量). + +参数: + - **x** (Variable)- 1维 ``Tensor`` 或 ``LoDTensor`` 。数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64``。 + - **y** (Variable)- 1维 ``Tensor`` 或 ``LoDTensor`` 。数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或 ``int64``。 + - **name** (str,可选)- 输出的名字。默认值为None。该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` 。 + + +返回: ``Tensor`` 或 ``LoDTensor`` ,数据类型与 ``x`` 相同。 + +返回类型: Variable。 + +**代码示例** + +.. code-block:: python + + import paddle + import paddle.fluid as fluid + import numpy as np + + with fluid.dygraph.guard(): + x = fluid.dygraph.to_variable(np.random.uniform(0.1, 1, [10]).astype(np.float32)) + y = fluid.dygraph.to_variable(np.random.uniform(1, 3, [10]).astype(np.float32)) + z = paddle.dot(x, y) + print(z.numpy()) + + diff --git a/doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst b/doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst index b100c5346..2ee70212e 100644 --- a/doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst @@ -1,3 +1,49 @@ +.. _cn_api_paddle_tensor_math_logsumexp: + logsumexp ------------------------------- -**版本升级,文档正在开发中** + +.. py:function:: paddle.tensor.math.logsumexp(x, dim=None, keepdim=False, out=None, name=None) + +该OP对输入Tensor的元素以e为底做指数运算,然后根据指定维度做求和之后取自然对数 + +.. math:: + logsumexp(x) = \log\sum exp(x) + +参数: + - **x** (Variable)- 输入变量为多维Tensor或LoDTensor,支持数据类型为float32,float64 + - **dim** (list | int ,可选)- 求和运算的维度。如果为None,则计算所有元素的和并返回包含单个元素的Tensor变量,否则必须在 :math:`[−rank(input),rank(input)]` 范围内。如果 :math:`dim [i] <0` ,则维度将变为 :math:`rank+dim[i]` ,默认值为None。 + - **keep_dim** (bool)- 是否在输出Tensor中保留减小的维度。如 keep_dim 为true,否则结果张量的维度将比输入张量小,默认值为False。 + - **out** (Variable , 可选)- 显示指定的输出变量 + - **name** (str , 可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。 + +返回: Tensor,数据类型和输入数据类型一致。 + +返回类型:Variable + +**代码示例1** + +.. code-block:: python + + import paddle + import paddle.fluid as fluid + import numpy as np + + with fluid.dygraph.guard(): + np_x = np.random.uniform(0.1, 1, [10]).astype(np.float32) + x = fluid.dygraph.to_variable(np_x) + print(paddle.logsumexp(x).numpy()) + +**代码示例2** + +.. code-block:: python + + import paddle + import paddle.fluid as fluid + import numpy as np + + with fluid.dygraph.guard(): + np_x = np.random.uniform(0.1, 1, [2, 3, 4]).astype(np.float32) + x = fluid.dygraph.to_variable(np_x) + print(paddle.logsumexp(x, dim=1).numpy()) + print(paddle.logsumexp(x, dim=[0, 2]).numpy()) -- GitLab