Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.02 KB

api_design_template.md

File metadata and controls

49 lines (34 loc) · 2.02 KB

标题

标题如:paddle.io.dataset 设计文档

API名称 新增API名称
提交作者 李强、张明
提交时间 2022-03-01
版本号 此设计文档的版本号,如V1.0
依赖飞桨版本 如无特殊情况,都应基于develop版本开发
文件名 提交的markdown设计文档文件名称,如:20200301_api_design_for_dataset.md

一、概述

1、相关背景

填写此任务的开发背景,为什么想要开发这个API。如果有相关issue,请将issue链接填写至此。

2、功能目标

3、意义

集中阐述本次升级的作用和意义。

二、飞桨现状

对飞桨框架目前支持此功能的现状调研,如果不支持此功能,如是否可以有替代实现的API,是否有其他可绕过的方式,或者用其他API组合实现的方式;

三、业内方案调研

描述业内深度学习框架如何实现此功能,包括与此功能相关的现状、未来趋势;调研的范围包括不限于TensorFlow、PyTorch、NumPy等

四、对比分析

对第三部分调研的方案进行对比评价对比分析,论述各种方案的优劣势。

五、设计思路与实现方案

命名与参数设计

参考:飞桨API 设计及命名规范

底层OP设计

API实现方案

六、测试和验收的考量

参考:新增API 测试及验收规范

七、可行性分析和排期规划

时间和开发排期规划,主要milestone

八、影响面

需要进一步讨论的问题,开放性问题,有争议问题;对其他模块是否有影响

名词解释

附件及参考资料