Skip to content

Commit 9f78fa5

Browse files
authored
add rfc_template (#4854)
1 parent fa18d20 commit 9f78fa5

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# 标题
2+
3+
标题如:paddle.io.dataset 设计文档
4+
|API名称 | 新增API名称 |
5+
|---|---|
6+
|提交作者<input type="checkbox" class="rowselector hidden"> | 李强、张明 |
7+
|提交时间<input type="checkbox" class="rowselector hidden"> | 2022-03-01 |
8+
|版本号 | 此设计文档的版本号,如V1.0 |
9+
|依赖飞桨版本<input type="checkbox" class="rowselector hidden"> | 如无特殊情况,都应基于develop版本开发 |
10+
|文件名 | 提交的markdown设计文档文件名称,如:20200301_api_design_for_dataset.md<br> |
11+
12+
13+
# 一、概述
14+
## 1、相关背景
15+
填写此任务的开发背景,为什么想要开发这个API。如果有相关issue,请将issue链接填写至此。
16+
## 2、功能目标
17+
18+
## 3、意义
19+
集中阐述本次升级的作用和意义。
20+
21+
# 二、飞桨现状
22+
对飞桨框架目前支持此功能的现状调研,如果不支持此功能,如是否可以有替代实现的API,是否有其他可绕过的方式,或者用其他API组合实现的方式;
23+
24+
25+
# 三、业内方案调研
26+
描述业内深度学习框架如何实现此功能,包括与此功能相关的现状、未来趋势;调研的范围包括不限于TensorFlow、PyTorch、NumPy等
27+
28+
# 四、对比分析
29+
对第三部分调研的方案进行对比**评价****对比分析**,论述各种方案的优劣势。
30+
31+
# 五、设计思路与实现方案
32+
33+
## 命名与参数设计
34+
参考:[飞桨API 设计及命名规范](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/dev_guides/api_contributing_guides/api_design_guidelines_standard_cn.html)
35+
## 底层OP设计
36+
## API实现方案
37+
38+
# 六、测试和验收的考量
39+
参考:[新增API 测试及验收规范](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/dev_guides/api_contributing_guides/api_accpetance_criteria_cn.html)
40+
41+
# 七、可行性分析和排期规划
42+
时间和开发排期规划,主要milestone
43+
44+
# 八、影响面
45+
需要进一步讨论的问题,开放性问题,有争议问题;对其他模块是否有影响
46+
47+
# 名词解释
48+
49+
# 附件及参考资料

0 commit comments

Comments
 (0)