Skip to content
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

Merged
merged 6 commits into from
May 16, 2024

Conversation

Chen-Lun-Hao
Copy link
Contributor

@Chen-Lun-Hao Chen-Lun-Hao commented Apr 3, 2024

Copy link

paddle-bot bot commented Apr 3, 2024

感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-6587.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明,请参考:飞桨文档预览工具

Copy link
Collaborator

@sunzhongkai588 sunzhongkai588 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

除文档优化内容外,另外需要注意在 linalg.Overview 里加上该 API 的描述

Comment on lines 8 to 9
计算一个普通矩阵与 Householder 矩阵的乘积。计算维度为(m, n)的矩阵 C(由 :attr:`other` 给出)和一个矩阵 Q 的乘积,
其中 Q 由 Householder 反射系数 (:attr:`x`, :attr:`tau`) 表示。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这句话优化一下吧,计算...。计算... 一开始看有点懵,不知道是计算哪个,我理解后面的文字是对前面的补充?那么文字上就优化一下


- **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。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **other ** (Tensor) - 输入一个或一批方阵,类型为 Tensor。 ``other`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。
- **other** (Tensor) - 输入一个或一批方阵,类型为 Tensor。 ``other`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。

参数
::::::::::::

- **x** (Tensor) - 输入一个或一批方阵,类型为 Tensor。 ``x`` 的形状应为 ``[*, MN, K]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

方阵 会带来误解,方阵是指行数和列数相等的矩阵。想表示 matrix 就统一用 矩阵,下面也是一样

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

方阵 会带来误解,方阵是指行数和列数相等的矩阵。想表示 matrix 就统一用 矩阵,下面也是一样

已经修改好了

Copy link
Collaborator

@sunzhongkai588 sunzhongkai588 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@luotao1 luotao1 changed the title 【Hackathon 6th No.4】Add ormqr docs API to Paddle 【Hackathon 6th No.4】Add ormqr docs API to Paddle -part May 16, 2024
@luotao1 luotao1 merged commit b1c4116 into PaddlePaddle:develop May 16, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor PaddlePaddle Hackathon 飞桨黑客松活动issue与PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants