diff --git a/doc/fluid/api_cn/tensor_cn/addmm_cn.rst b/doc/fluid/api_cn/tensor_cn/addmm_cn.rst index 7c4b599daa4006bd58eccebd9b826f470a54755d..10a43b40a82600b832bb18015fe2acbab3885862 100644 --- a/doc/fluid/api_cn/tensor_cn/addmm_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/addmm_cn.rst @@ -14,12 +14,12 @@ addmm out = alpha * x * y + beta * input 参数: - - **input** (Variable) : 输入Tensor input,数据类型支持float32, float64。 - - **x** (Variable) : 输入Tensor x,数据类型支持float32, float64。 - - **y** (Variable) : 输入Tensor y,数据类型支持float32, float64。 - - **alpha** (float,可选) : 乘以x*y的标量,数据类型支持float32, float64,默认值为1.0。 - - **beta** (float,可选) : 乘以input的标量,数据类型支持float32, float64,默认值为1.0。 - - **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。 + - **input** (Variable):输入Tensor input,数据类型支持float32, float64。 + - **x** (Variable):输入Tensor x,数据类型支持float32, float64。 + - **y** (Variable):输入Tensor y,数据类型支持float32, float64。 + - **alpha** (float,可选):乘以x*y的标量,数据类型支持float32, float64,默认值为1.0。 + - **beta** (float,可选):乘以input的标量,数据类型支持float32, float64,默认值为1.0。 + - **name** (str,可选):具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。 返回:计算得到的Tensor。Tensor数据类型与输入input数据类型一致。 diff --git a/doc/fluid/api_cn/tensor_cn/tril_cn.rst b/doc/fluid/api_cn/tensor_cn/tril_cn.rst index 2d39c115a4d6e353da3a103295a81d9e241d6ed3..d013f25dd63ecf5ccb0f00f4b0fe28c8411e3b26 100644 --- a/doc/fluid/api_cn/tensor_cn/tril_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/tril_cn.rst @@ -1,3 +1,58 @@ +.. _cn_api_tensor_tril: + tril ------------------------------- -**版本升级,文档正在开发中** + +.. py:function:: paddle.tensor.tril(input, diagonal=0, name=None) + +返回输入矩阵 `input` 的下三角部分,其余部分被设为0。 +矩形的下三角部分被定义为对角线上和下方的元素。 + +参数: + - **input** (Variable) : 输入Tensor input,数据类型支持 `float32`, `float64`, `int32`, `int64` 。 + - **diagonal** (int,可选) : 指定的对角线,默认值为0。如果diagonal = 0,表示主对角线; 如果diagonal是正数,表示主对角线之上的对角线; 如果diagonal是负数,表示主对角线之下的对角线。 + - **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。 + +返回:计算得到的Tensor。Tensor数据类型与输入 `input` 数据类型一致。 + +返回类型:Variable + + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle.tensor as tensor + import paddle.fluid as fluid + + data = np.arange(1, 13, dtype="int64").reshape(3,-1) + # array([[ 1, 2, 3, 4], + # [ 5, 6, 7, 8], + # [ 9, 10, 11, 12]]) + x = fluid.data(shape=(-1, 4), dtype='int64', name='x') + exe = fluid.Executor(fluid.CPUPlace()) + + # example 1, default diagonal + tril = tensor.tril(x) + tril_out, = exe.run(fluid.default_main_program(), feed={"x": data}, + fetch_list=[tril], return_numpy=True) + # array([[ 1, 0, 0, 0], + # [ 5, 6, 0, 0], + # [ 9, 10, 11, 0]]) + + # example 2, positive diagonal value + tril = tensor.tril(x, diagonal=2) + tril_out, = exe.run(fluid.default_main_program(), feed={"x": data}, + fetch_list=[tril], return_numpy=True) + # array([[ 1, 2, 3, 0], + # [ 5, 6, 7, 8], + # [ 9, 10, 11, 12]]) + + # example 3, negative diagonal value + tril = tensor.tril(x, diagonal=-1) + tril_out, = exe.run(fluid.default_main_program(), feed={"x": data}, + fetch_list=[tril], return_numpy=True) + # array([[ 0, 0, 0, 0], + # [ 5, 0, 0, 0], + # [ 9, 10, 0, 0]]) diff --git a/doc/fluid/api_cn/tensor_cn/triu_cn.rst b/doc/fluid/api_cn/tensor_cn/triu_cn.rst index a93c76b4dd164cb8e951138d11f0df8e02b5fce0..21e6cdc6fb08bd7e5347706f8bb8f7a9681399f8 100644 --- a/doc/fluid/api_cn/tensor_cn/triu_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/triu_cn.rst @@ -1,3 +1,59 @@ +.. _cn_api_tensor_triu: + triu ------------------------------- -**版本升级,文档正在开发中** + +.. py:function:: paddle.tensor.triu(input, diagonal=0, name=None) + +返回输入矩阵 `input` 的上三角部分,其余部分被设为0。 +矩形的上三角部分被定义为对角线上和上方的元素。 + +参数: + - **input** (Variable) : 输入Tensor input,数据类型支持 `float32`, `float64`, `int32`, `int64` 。 + - **diagonal** (int,可选) : 指定的对角线,默认值为0。如果diagonal = 0,表示主对角线; 如果diagonal是正数,表示主对角线之上的对角线; 如果diagonal是负数,表示主对角线之下的对角线。 + - **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。 + +返回:计算得到的Tensor。Tensor数据类型与输入 `input` 数据类型一致。 + +返回类型:Variable + + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle.fluid as fluid + import paddle.tensor as tensor + + data = np.arange(1, 13, dtype="int64").reshape(3,-1) + # array([[ 1, 2, 3, 4], + # [ 5, 6, 7, 8], + # [ 9, 10, 11, 12]]) + x = fluid.data(shape=(-1, 4), dtype='int64', name='x') + exe = fluid.Executor(fluid.CPUPlace()) + + # example 1, default diagonal + triu = tensor.triu(x) + triu_out, = exe.run(fluid.default_main_program(), feed={"x": data}, + fetch_list=[triu], return_numpy=True) + # array([[ 1, 2, 3, 4], + # [ 0, 6, 7, 8], + # [ 0, 0, 11, 12]]) + + # example 2, positive diagonal value + triu = tensor.triu(x, diagonal=2) + triu_out, = exe.run(fluid.default_main_program(), feed={"x": data}, + fetch_list=[triu], return_numpy=True) + # array([[0, 0, 3, 4], + # [0, 0, 0, 8], + # [0, 0, 0, 0]]) + + # example 3, negative diagonal value + triu = tensor.triu(x, diagonal=-1) + triu_out, = exe.run(fluid.default_main_program(), feed={"x": data}, + fetch_list=[triu], return_numpy=True) + # array([[ 1, 2, 3, 4], + # [ 5, 6, 7, 8], + # [ 0, 10, 11, 12]]) +