[Hackathon No.5] add tril_indices op docs #4599
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
|
✅ This PR's description meets the template requirements! |
|
Thanks for your contribution! |
|
|
Ligoml
reviewed
Apr 27, 2022
docs/api/paddle/tril_indices_cn.rst
Outdated
| .. py:function:: paddle.tril_indices(rows, cols, offset=0, dtype=3) | ||
|
|
||
|
|
||
| 这个op返回行数和列数已知的二维矩阵中下三角形矩阵元素的行列坐标，其中下三角矩阵为原始矩阵某一对角线左下部分元素的子矩阵 |
There was a problem hiding this comment.
- 去掉「这个op」的描述，python层面暴露出来的接口已经算api了~
- 句尾要加句号
docs/api/paddle/tril_indices_cn.rst
Outdated
| - 如果 offset < 0，则取主对角线左下的对角线。 | ||
| :math:`\{(i, i)\}` for :math:`i \in [0, \min\{d_{1}, d_{2}\} - 1]` 其中 | ||
| :math:`d_{1}, d_{2}` 是矩阵行列数. | ||
| - **dtype** (int，可选)- 指定输出张量的数据类型，默认值为int64。 |
There was a problem hiding this comment.
- 预览格式乱掉了，需要调整一下markdown格式
- 注意标点符号的正确使用
There was a problem hiding this comment.
这个应该是冒号导致的，我在c178247里修改之后，预览文档那边还显示冒号，不知道是不是没有同步
|
|
||
|
|
||
| 代码示例 | ||
| ::::::::: |
Ligoml
reviewed
Apr 28, 2022
docs/api/paddle/tril_indices_cn.rst
Outdated
| .. py:function:: paddle.tril_indices(rows, cols, offset=0, dtype='int64') | ||
|
|
||
|
|
||
| 此API返回行数和列数已知的二维矩阵中下三角形矩阵元素的行列坐标，其中下三角矩阵为原始矩阵某一对角线左下部分元素的子矩阵。 |
docs/api/paddle/tril_indices_cn.rst
Outdated
| - 如果 offset < 0，则取主对角线左下的对角线。 | ||
| :math:`\{(i, i)\}` for :math:`i \in [0, \min\{d_{1}, d_{2}\} - 1]` 其中 | ||
| :math:`d_{1}, d_{2}` 是矩阵行列数. | ||
| - **dtype** (int，可选)- 指定输出张量的数据类型，默认值为int64。 |
Ligoml
reviewed
Apr 28, 2022
docs/api/paddle/tril_indices_cn.rst
Outdated
|
|
||
| 返回 | ||
| ::::::::: | ||
| Tensor,二维矩阵的下三角矩阵行坐标和列坐标。数据类型和参数dtype一致。 |
|
需要在 docs/api/paddle/Overview 页面中，添加该API的索引 |
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.
PADDLEPADDLE_PR=41639
PaddlePaddle/Paddle#41639