-
Notifications
You must be signed in to change notification settings - Fork 5.6k
重构代码 文档规范
qingqing01 edited this page Aug 28, 2017
·
7 revisions
- C++ 代码参考 https://google.github.io/styleguide/cppguide.html 。
- 单元测试覆盖完整。
- 先写Design Doc,再写实现。实现写完要同步Design Doc。
欢迎大家实现中纠正和补充
- Op命名需要规范:Paddle原先Layer的命名不规范着,移植过程可以更正
- ProtoMaker定义命名规范
- 输入输出命名尽可能更有含义:首字母大写
- 属性命名也尽可能更有含义:首字母小写
- 如果没有含义,而且只有一个输出,可以用
Out
命名: 例如cosine
Op: inputs :X
, attrs:axis
, outputs :Out
- Op实现需要尽可能标准,例如:
- Conv实现与cuDNN标准一致,与其他开源框架尽可能一致
- Conv、Pool的Padding模式与cuDNN、其他框架标准标保持一致
- 公共函数函数提炼成functor.
- 我们使用简单句,每句话有主谓宾。尽量不要使用从句。尽量不要使用术语。
- 环环相扣(上下句之间有逻辑关系),滴水不漏(逻辑关系不跳跃)。