【PaddlePaddle Hackathon 4 No.17】为 Paddle 新增 cummax / cummin API #401
There are no files selected for viewing
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # paddle.[Tensor.]cummin 设计文档 | ||
|
|
||
| | API名称 | paddle.[Tensor.]cummin | | ||
| | ------------------------------------------------------------ | ----------------------------------- | | ||
|
|
@@ -12,7 +12,7 @@ | |
|
|
||
| ## 1、相关背景 | ||
|
|
||
| cummin函数的功能为求累积最小值（cumulative min）。对于输入向量/矩阵，第i个位置的计算方式为： | ||
| $$ | ||
| y_i = \min(x_1, x_2, x_3, \cdots , x_i) | ||
| $$ | ||
|
|
@@ -21,7 +21,7 @@ PyTorch、NumPy 和 Pandas 提供了相似算子。 | |
|
|
||
| ## 2、功能目标 | ||
|
|
||
| cummin API 是一个按轴寻找累计最大值和最大值所在位置的 API。此任务的目标是在 Paddle 框架中，新增 cummin API，调用路径为：`paddle.cummin`和 `paddle.Tensor.cummin`。 | ||
| ## 3、意义 | ||
|
|
||
| 完善矩阵运算的基本功能，增强统计运算完善度。 | ||
|
|
@@ -265,20 +265,21 @@ PyTorch 还提供了基于 CUDA 的算子实现。 | |
|
|
||
| ## 命名与参数设计 | ||
|
|
||
| API设计为`paddle.cummin(x, axis, name)`以及`paddle.Tensor.cummin(axis, name)`。 | ||
|
|
||
|
|
||
| paddle.cummin | ||
| ---------------------- | ||
| 参数 | ||
| ::::::::: | ||
| - x (Tensor) - 累积最小值的输入，需要进行累积最小值操作的 Tensor。 | ||
| - axis (int, 可选) - 指明需要统计的维度。-1代表最后一维。默认：None，将输入展开为一维变量再进行累积最小值计算。 | ||
| - dtype (str，可选) - 指定输出索引的数据类型，可以为int32和int64，默认：int64。 | ||
| - name (str，可选) - 具体用法请参见 [Name](https://www.paddlepaddle.org.cn/documentation/docs/zh/api_guides/low_level/program.html#api-guide-name)，一般无需设置，默认值为 None。 | ||
| 返回 | ||
|
There was a problem hiding this comment. 返回索引的api，需要对索引的dtype进行限制，增加一个索引输出的dtype参数吧 |
||
| ::::::::: | ||
| - Out (tuple) - 返回累积最小值结果和对应的索引信息。累积最小值结果的数据类型和输入`x`一致。 | ||
|
|
||
| paddle.Tensor.cummin指向paddle.cummin，两者是相同的API | ||
|
|
||
|
There was a problem hiding this comment. 写明返回值；以写中文文档形式写这里的命名以及参数设计 There was a problem hiding this comment. 且返回值中有标的api，需要提供dtype参数,限制返回的下标数据类型(int32, int64),默认为int64 具体参考 https://www.paddlepaddle.org.cn/documentation/docs/zh/dev_guides/api_contributing_guides/api_design_guidelines_standard_cn.html API命名与设计规范 |
||
| ## 底层OP设计 | ||
|
|
||
|
|
||
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.
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.
这里不对
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.
不应该是寻找最大值