【Hackathon No.18】 新增 heaviside API 设计文档 #57
Conversation
|
PR格式检查通过，你的PR将接受Paddle专家以及开源社区的review，请及时关注PR动态。 |
|
|
||
| # 五、设计思路与实现方案 | ||
|
|
||
| - 向前计算设计为`x == 0 ? y : static_cast<T>(x > 0) `； |
There was a problem hiding this comment.
由于该API的输入涉及较多与广播机制相关的内容，这里建议补充一下我们期望的API行为：例如x, y为标量/张量时，shape一致/不一致时等情况。
此外，这里有个小的语病，向前->前向
There was a problem hiding this comment.
我在后面补充说了这个API是逐元素计算的，那么广播时的行为就不言而喻了。
语病：修改完成。
|
|
||
| ## 命名与参数设计 | ||
|
|
||
| API设计为`heaviside(x, y, name=None)`，它支持广播，参数为 |
There was a problem hiding this comment.
-
API设计上给出调用全路径吧，如paddle.heaviside(x, y)这样；另外可以补充下Paddle.Tensor.heaviside这个调用路径。
-
这里参数的命名想再讨论下。从Pytorch的设计来看，使用了
input和values的命名。在Paddle中，输入用x是没问题的，但使用y会显得和x是对等关系（例如paddle.lerp, paddle.matmul等双输入的API）。 从这个函数的功能上来看（类似paddle.Tensor.fill_, paddle.full等API)，Pytorch的命名为values似乎更贴切。
There was a problem hiding this comment.
-
完成
-
我选择使用
x和y是因为我倾向于在这里把heaviside视为一个二元函数，这样就有理由为x和y都设计偏导数。另外，从功能上来看，我认为它和paddle.maximum更类似，都是逐元素计算的算子。
| API设计为`heaviside(x, y, name=None)`，它支持广播，参数为 | ||
|
|
||
| - x （Tensor）- 输入的Tensor。数据类型为 float32、 float64、int32或 int64； | ||
| - y （Tensor）- 输入的Tensor。数据类型为 float32、 float64 、int32或int64； |
There was a problem hiding this comment.
numpy是支持x，y以scalar形式输入的，从下面的用例看该设计上也是可以支持的。这里参数类型需要更正下。
There was a problem hiding this comment.
numpy确实支持标量输入，pytorch是不支持的。在飞桨中，其他逐元素计算的算子（比如paddle.maximum）均不支持标量输入。后文的用例设计确实是我原先写错了。
| - 与Numpy对比计算结果的一致性： | ||
| - x和y的形状一样时， | ||
| - x和y中有一个是标量时， | ||
| - 广播机制测试； |
There was a problem hiding this comment.
同前面关于预期行为的说明，测试用例能否细化下各种情况（标量/张量，shape一致/不一致等）。以及异常检查具体会包括哪些用例？
|
你的PR已合入community库，请进行后续代码开发，并将代码提交至Paddle仓库。 |
增加了paddle.heaviside设计文档。