API improvement for paddle.svd_lowrank 易用性提升 #6562
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-6562.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
zhwesky2010
reviewed
Apr 1, 2024
| | niter | - | 表示子空间进行迭代的数量。Paddle 无此参数，暂无转写方式。 | | ||
| | M | - | 表示输入 Tensor 的平均 size。 Paddle 无此参数，暂无转写方式。 | | ||
| | - | full_matrics | 表示是否计算完整的 U 和 V 矩阵。 PyTorch 无此参数，Paddle 保持默认即可。 | | ||
| | q | q | 表示输入 Tensor 略高估计秩，PyTorch 为 6，Paddle 为 None，Paddle 需设置为与 PyTorch 一致。 | |
There was a problem hiding this comment.
看paddle代码里，如果q为None的话也是视作6来参与计算，因此这里是不是只有表面上不一致？底层其实是一致的
| @@ -20,6 +20,7 @@ pca_lowrank | |||
| - **x** (Tensor) - 输入的需要进行线性主成分分析的一个或一批方阵，类型为 Tensor。 ``x`` 的形状应为 ``[*, M, N]``，其中 ``*`` 为零或更大的批次维度，数据类型支持 float32， float64。 | |||
| - **q** (int，可选) - 对输入 :math:`X` 的秩稍微高估的预估值，默认值是 :math:`q=min(6,N,M)`。 | |||
| - **center** (bool，可选) - 是否对输入矩阵进行中心化操作，类型为 bool ，默认为 True。 | |||
| - **niter** (int) - 需要进行的子空间迭代次数。默认值为 2。 | |||
There was a problem hiding this comment.
torch.pca_lowrank的差异对比文档是不是也有问题？
There was a problem hiding this comment.
torch.pca_lowrank的差异对比文档里面写了niter，没有问题
| :::::::::::: | ||
|
|
||
| - **x** (Tensor) - 输入的需要进行奇异值分解的一个或一批方阵，类型为 Tensor。 ``x`` 的形状应为 ``[*, M, N]``，其中 ``*`` 为零或更大的批次维度，数据类型支持 float32， float64。 | ||
| - **q** (int，可选) - 对输入 :math:`X` 的秩稍微高估的预估值，默认值是 None，此时 ``q`` 将取 :math:`q=min(6,N,M)`。 |
|
@NKNaN code style检查的CI挂了 |
| :::::::::::: | ||
|
|
||
| - **x** (Tensor) - 输入的需要进行奇异值分解的一个或一批方阵，类型为 Tensor。 ``x`` 的形状应为 ``[*, M, N]``，其中 ``*`` 为零或更大的批次维度，数据类型支持 float32， float64。 | ||
| - **q** (int，可选) - 对输入 :math:`X` 的秩稍微高估的预估值，默认值为 6。 |
There was a problem hiding this comment.
建议和前面的 q=None 统一一下描述吧，尽量减少用户的理解成本，比如 默认值为 None，代表...
docs/guides/model_convert/convert_from_pytorch/api_difference/ops/torch.svd_lowrank.md
Outdated
Show resolved
Hide resolved
Co-authored-by: zachary sun <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
refer to: