From 58011566c145bf8d31b60d7a732e4260f2103ef5 Mon Sep 17 00:00:00 2001 From: Yiqun Liu Date: Mon, 11 May 2020 17:45:48 +0800 Subject: [PATCH] Add chinese documentation for inverse (new API for 2.0) (#2070) * Implement the chinese documentation of inverse. * Add the documentation of error type. * Remove the example of static graph. --- doc/fluid/api_cn/tensor_cn/inverse_cn.rst | 34 ++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/doc/fluid/api_cn/tensor_cn/inverse_cn.rst b/doc/fluid/api_cn/tensor_cn/inverse_cn.rst index ca3442242..c5e3f2fc2 100644 --- a/doc/fluid/api_cn/tensor_cn/inverse_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/inverse_cn.rst @@ -1,3 +1,35 @@ +.. _cn_api_tensor_inverse: + inverse ------------------------------- -**版本升级,文档正在开发中** + +.. py:function:: paddle.inverse(input, out=None, name=None) + +计算方阵的逆。方阵是行数和列数相等的矩阵。输入可以是一个方阵(2-D张量),或者是批次方阵(维数大于2时)。 + +**参数**: + - **input** (Variable) – 输入张量,最后两维的大小必须相等。如果输入张量的维数大于2,则高维部分代表2-D矩阵的批次(batch)。支持的数据类型:float32,float64。 + - **out** (Variable,可选) – 指定求和的结果Tensor,可以是程序中已经创建的任何Variable。默认值为None,此时将创建新的Variable来保存输出结果。 + - **name** (str,可选) – 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,默认值为None。 + +**返回**:数据类型同输入。 + +返回类型:Variable + +抛出异常: + - :code:`TypeError` ,input不是Variable类型,或者数据类型不是float32、float64时 + - :code:`ValueError` ,input的维数小于2时 + - :code:`TypeError` ,out不是Variable类型,或者数据类型和input不相同时 + +**代码示例**: + +.. code-block:: python + + import numpy as np + import paddle + + mat_np = np.array([[2, 0], [0, 2]]).astype("float32") + with paddle.imperative.guard(): + mat = paddle.imperative.to_variable(mat_np) + inv = paddle.inverse(mat) + print(inv.numpy()) # [[0.5, 0], [0, 0.5]] -- GitLab