-
Notifications
You must be signed in to change notification settings - Fork 673
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
【Hackathon 6th No.4】Add ormqr docs API to Paddle -part #6587
Conversation
感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-6587.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
除文档优化内容外,另外需要注意在 linalg.Overview 里加上该 API 的描述
docs/api/paddle/linalg/ormqr_cn.rst
Outdated
计算一个普通矩阵与 Householder 矩阵的乘积。计算维度为(m, n)的矩阵 C(由 :attr:`other` 给出)和一个矩阵 Q 的乘积, | ||
其中 Q 由 Householder 反射系数 (:attr:`x`, :attr:`tau`) 表示。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这句话优化一下吧,计算...。计算...
一开始看有点懵,不知道是计算哪个,我理解后面的文字是对前面的补充?那么文字上就优化一下
docs/api/paddle/linalg/ormqr_cn.rst
Outdated
|
||
- **x** (Tensor) - 输入一个或一批方阵,类型为 Tensor。 ``x`` 的形状应为 ``[*, MN, K]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。 | ||
- **tau** (Tensor) - 输入一个或一批 Householder 反射系数,类型为 Tensor。 ``tau`` 的形状应为 ``[*, min(MN, K)]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。 | ||
- **other ** (Tensor) - 输入一个或一批方阵,类型为 Tensor。 ``other`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **other ** (Tensor) - 输入一个或一批方阵,类型为 Tensor。 ``other`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。 | |
- **other** (Tensor) - 输入一个或一批方阵,类型为 Tensor。 ``other`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。 |
docs/api/paddle/linalg/ormqr_cn.rst
Outdated
参数 | ||
:::::::::::: | ||
|
||
- **x** (Tensor) - 输入一个或一批方阵,类型为 Tensor。 ``x`` 的形状应为 ``[*, MN, K]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
方阵
会带来误解,方阵是指行数和列数相等的矩阵。想表示 matrix 就统一用 矩阵
,下面也是一样
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
方阵
会带来误解,方阵是指行数和列数相等的矩阵。想表示 matrix 就统一用矩阵
,下面也是一样
已经修改好了
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
pr:PaddlePaddle/Paddle#63227
rfc:PaddlePaddle/community#855