映射文档 No.47 #5858
Merged
映射文档 No.47 #5858
Conversation
This file contains hidden or 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-5858.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
|
❌ The PR's message can't be empty. |
|
完善 #5691 中No.47的文档映射工作，修改了其中9个api映射文档格式。 |
Fancy-hjyp
reviewed
May 6, 2023
| @@ -0,0 +1,35 @@ | |||
| ## [仅 torch 参数更多]torch.linalg.cholesky | |||
There was a problem hiding this comment.
分类名改为 torch 参数更多 即可，下面的也改一下吧，和之前的命名保持统一
| paddle.linalg.cholesky(x,upper=False,name=None) | ||
| ``` | ||
|
|
||
| 其中 Paddle 相比 PyTorch 支持更多其他参数，具体如下： |
There was a problem hiding this comment.
应该是Pytorch 相比 Paddle 支持更多其他参数
| ### 参数映射 | ||
| |PyTorch|PaddlePaddle|备注| | ||
| | ------- | ------- | ------- | | ||
| |A|x|表示输入变量为多维 Tensor，它的维度应该为 [*, M, N]，其中*为零或更大的批次尺寸，并且最里面的两个维度上的矩阵都应为对称的正定矩阵，仅参数名不一致。| |
There was a problem hiding this comment.
可以在每个单元格内容前后敲几个空格，这样看着比较拥挤~
| | ------- | ------- | ------- | | ||
| |A|x|表示输入变量为多维 Tensor，它的维度应该为 [*, M, N]，其中*为零或更大的批次尺寸，并且最里面的两个维度上的矩阵都应为对称的正定矩阵，仅参数名不一致。| | ||
| |upper|upper|表示是否返回上三角矩阵或下三角矩阵。| | ||
| |out||表示输出的 Tensor ，Paddle 无此变量，需要进行转写。| |
There was a problem hiding this comment.
没有的参数用横线-替代，备注中将变量改为参数，保持和之前风格的统一
| @@ -0,0 +1,37 @@ | |||
| ## [仅 torch 参数更多]torch.addmm | |||
| paddle.tril(input,diagonal=0,name=None) | ||
| ``` | ||
|
|
||
| 其中 Paddle 相比 PyTorch 支持更多其他参数，具体如下： |
| | ------- | ------- | ------- | | ||
| |input|input|表示输入的 Tensor 。| | ||
| |diagonal|diagonal|表示指定的对角线，默认值是 0 ，表示主对角线。如果 diagonal > 0 ，表示主对角线之上的对角线；如果 diagonal < 0 ，表示主对角线之下的对角线。| | ||
| |out||表示输出的 Tensor ，Paddle 无此参数，需要进行转写。| |
| @@ -0,0 +1,38 @@ | |||
| ## [仅 torch 参数更多]torch.tril_indices | |||
| paddle.tril_indices(row,col,offset=0,dtype='int64') | ||
| ``` | ||
|
|
||
| 其中 Paddle 相比 PyTorch 支持更多其他参数，具体如下： |
| |offset|offset| 表示从指定二维平面中获取对角线的位置。如果 offset = 0 ，取主对角线；如果 offset > 0 ，取主对角线右上的对角线；如果 offset < 0 ，取主对角线左下的对角线。| | ||
| |dtype|dtype|表示输出张量的数据类型。| | ||
| |device||表示 Tensor 存放设备位置，Paddle 无此参数，需要进行转写。| | ||
| |layout||表示布局方式， Paddle 无此参数，一般对网络训练结果影响不大，可直接删除。| |
|
@Tomoko-hjf |
Fancy-hjyp
reviewed
May 8, 2023
|
|
||
| ### 转写示例 | ||
|
|
||
| #### out: 缩并运算的结果 |
| | ------- | ------- | ------- | | ||
| | input | input | 表示输入的 Tensor 。 | | ||
| | diagonal | diagonal | 指定的对角线，默认值为 0 ，表示主对角线。如果 diagonal > 0 ，表示主对角线之上的对角线；如果 diagonal < 0 ，表示主对角线之下的对角线。 | | ||
| | out | - | 表示输出的 Tensor ， Paddle 没有此字段，需要进行转写。 | |
|
|
||
| ```python | ||
| # Pytorch 写法 | ||
| >>> a = torch.triu_indices(row,col,offset,dtype,device=torch.device('cpu')) |
| | ------- | ------- | ------- | | ||
| | input | x | 表示输入的第一个 Tensor ，仅参数名不一致。 | | ||
| | mat2 | y | 表示输入的第二个 Tensor ，仅参数名不一致。 | | ||
| | out | - | 表示输出的 Tensor ， Paddle 无此字段，需要进行转写。 | |
|
|
|
剩余的一个API是已经存在了吗，如果是暂无对应功能，可以PR描述中说明 |
|
是的，剩下的API已经存在了 |
|
hi, @Archor001
|
lijialin03
pushed a commit
to lijialin03/Paddledocs
that referenced
this pull request
May 16, 2023
* 映射文档 No.47 * 映射文档 No.47：规范格式 * 映射文档 No.47: 规范格式 * 映射文档 No.47: 修改不规范格式 * 映射文档 No.47: 修改格式 * 映射文档 No.47: 修改不规范格式 * 映射文档 No.47: 修改格式 * 映射文档 No.47: 修改不规范格式 * 映射文档 No.47: 修改不规范格式 * 映射文档 No.47: 修改格式
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.
完成 #5691 中No.47的文档映射工作，新增了9个api映射文档到api_difference/ops目录下。（No.47中的API：torch.cholesky_solve已经存在）