Skip to content

Commit b1c4116

Browse files
authored
【Hackathon 6th No.4】Add ormqr docs API to Paddle -part (#6587)
* ormqr docs * update ormqr * update * update * update * update
1 parent 70a2ccf commit b1c4116

File tree

3 files changed

+40
-0
lines changed

3 files changed

+40
-0
lines changed

docs/api/paddle/Tensor_cn.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3233,3 +3233,15 @@ signbit(x, name=None)
32333233
返回类型:Tensor
32343234

32353235
请参考 :ref:`cn_api_paddle_signbit`
3236+
3237+
ormqr(x, tau, other, left=True, transpose=False)
3238+
:::::::::
3239+
3240+
计算维度为(m, n)的矩阵 C(由 :attr:`other` 给出)和一个矩阵 Q 的乘积,
3241+
其中 Q 由 Householder 反射系数 (:attr:`x`, :attr:`tau`) 表示。
3242+
3243+
返回:乘积 Tensor。
3244+
3245+
返回类型:Tensor
3246+
3247+
请参考 :ref:`cn_api_paddle_linalg_ormqr`

docs/api/paddle/linalg/Overview_cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ paddle.linalg 目录下包含飞桨框架支持的线性代数相关 API。具
6565
" :ref:`paddle.linalg.lu <cn_api_paddle_linalg_lu>` ", "计算矩阵的 LU 分解"
6666
" :ref:`paddle.linalg.lu_unpack <cn_api_paddle_linalg_lu_unpack>` ", "对矩阵的 LU 分解结果进行展开得到各单独矩阵"
6767
" :ref:`paddle.linalg.householder_product <cn_api_paddle_linalg_householder_product>` ", "计算 Householder 矩阵乘积的前 n 列(输入矩阵为 `[*,m,n]` )"
68+
" :ref:`paddle.linalg.ormqr <cn_api_paddle_linalg_ormqr>` ", "计算一个普通矩阵与 Householder 矩阵的乘积"
6869

6970
.. _about_solvers:
7071

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _cn_api_paddle_linalg_ormqr:
2+
3+
ormqr
4+
-------------------------------
5+
6+
.. py:function:: paddle.linalg.ormqr(x, tau, other, left=True, transpose=False)
7+
8+
计算维度为(m, n)的矩阵 C(由 :attr:`other` 给出)和一个矩阵 Q 的乘积,
9+
其中 Q 由 Householder 反射系数 (:attr:`x`, :attr:`tau`) 表示。
10+
11+
参数
12+
::::::::::::
13+
14+
- **x** (Tensor) - 输入一个或一批矩阵,类型为 Tensor。 ``x`` 的形状应为 ``[*, MN, K]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。
15+
- **tau** (Tensor) - 输入一个或一批 Householder 反射系数,类型为 Tensor。 ``tau`` 的形状应为 ``[*, min(MN, K)]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。
16+
- **other** (Tensor) - 输入一个或一批矩阵,类型为 Tensor。 ``other`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。
17+
- **left** (bool, 可选) - 决定了矩阵乘积运算的顺序。如果 left 为 ``True`` ,计算顺序为 op(Q) * other ,否则,计算顺序为 other * op(Q)。默认值: ``True`` 。
18+
- **transpose** (bool, 可选) - 如果为 ``True`` ,对矩阵 Q 进行共轭转置变换,否则,不对矩阵 Q 进行共轭转置变换。默认值: ``False`` 。
19+
返回
20+
::::::::::::
21+
22+
``Tensor``,维度和数据类型都与 :attr:`other` 一致。
23+
24+
代码示例
25+
::::::::::
26+
27+
COPY-FROM: paddle.linalg.ormqr

0 commit comments

Comments
 (0)