"op name" #3452

dzhwinter · 2017-08-14T03:50:24Z

这个PR中只包含了OpProtoMaker应该如何书写，OpProtoMaker中的Input/Output/Attr都会被写入OpProto。在客户端语言创建Op，使用Op的时候会依赖于参数命名规则。在review OpPorting的实践过程中遇到一些问题，更新到该文档中，形成统一的Op参数命名规范。
fix op porting name wiki
#3976
#3899

reyoung · 2017-08-14T05:56:37Z

paddle/operators/name_convention.md

+
+Variable name is uppercase. e.g. `X`, `Y`
+
+Tensor name is lowercase. e.g. `tensor`


Operator's inputs/outputs are Variable not Tensor.
So what's the meaning of Tensor name?

I mean the variable is a Tensor. fix it.

I think we need distinguish input/output's ProtoName and DescName.

if matrix and Out conflict?

jacquesqiao · 2017-08-25T04:27:34Z

paddle/operators/name_convention.md

+
+### Input/Output names
+
+* Variable name is prefer uppercase. e.g. `X`, `Y`. But when the variable is tensor, its name should lowercase. e.g. `matrix`, to discriminate with otherone.


if the name has multiple letters, such as all, what should we name it All or ALL?

We follow the CamelCase but the first character is uppercase. Such as All, Matrix.

JiayiFeng · 2017-08-25T04:33:10Z

paddle/operators/name_convention.md

+
+* Variable name is prefer uppercase. e.g. `X`, `Y`. But when the variable is tensor, its name should lowercase. e.g. `matrix`, to discriminate with otherone.
+
+* element wise operator, math operator or similar op, please obey common name convention. if the operator only have one output, use `Out`.


I think we shall distinguish between input/outputs' ProtoName and DescName.

lcy-seso · 2017-09-08T08:44:19Z

我建议我们应该尽快完成并 merge 这个PR。

现在 Op 的命名不仅仅是可读性的问题，也会影响到运行，特别是影响了一些组合 Op 的编写，如果命名不统一，组合 Op 的编写会出现 if-else 分枝来处理特殊命名。

从我们代码目前的设计上看，对命名是敏感的，设计发生变化对现阶段来说是合理的，但，在开发中出现了一些和命名相关的问题，希望能够尽努力有一个标准。是否可以保证 PR merge 之后，大家可以共同维护修改。

从版本库中仅有的例子看，会出现编译通过，但运行时创建 OP 与注册 OP 命名不统一引起的运行时 core dump。以及各种因为忽视命名引发的运行时错误，并且目前的错误信息非常晦涩。

哪些命名必须强制固定；
哪些命名应该遵循可读性原则；

这个边界在哪里，对写 OP 的同学应该有一个相对清晰的标准。

dzhwinter

Done.

dzhwinter · 2017-09-12T17:54:03Z

paddle/operators/name_convention.md

+
+### Input/Output names
+
+* Variable name is prefer uppercase. e.g. `X`, `Y`. But when the variable is tensor, its name should lowercase. e.g. `matrix`, to discriminate with otherone.


We follow the CamelCase but the first character is uppercase. Such as All, Matrix.

wangkuiyi · 2017-09-12T20:33:46Z

paddle/operators/name_convention.md

+  -  names follow the `CamelCase` but the first character is uppercase. e.g. `X`, `Y`, `Matrix`, `LastAxisInMatrix`. Input/Output much more like Variables, we prefer to meaningful English words.
+  - If an operator's Input/Output are not meaningful words, input name starts from `X`. e.g. `X`, `Y`, and output name starts from `Out`. e.g. `Out`.
+
+* Attribute.


有的地方用 * 有的用 - 。太随便了。

Sorry for the format error. I will try my best to write the better document in the future.
fixed.

wangkuiyi · 2017-09-12T20:33:56Z

paddle/operators/name_convention.md

@@ -0,0 +1,27 @@
+## Operator Name Convention


Operator's Parameter Name?

wangkuiyi · 2017-09-12T20:34:09Z

paddle/operators/name_convention.md

+
+To make the operator document itself more clear, we recommend operator names obey the listing conventions.
+
+### OpMaker names


OpMaker or OpProtoMaker ?

OpProtoMaker. Done.

wangkuiyi · 2017-09-12T20:34:29Z

paddle/operators/name_convention.md

+
+### OpMaker names
+
+When defining an operator in Paddle, a corresponding `OpMaker` need to be defined. All the `Input`/`Output` and `attrs` will write into the `OpProto` , and will be used in client language to create operator. 


这里需要一个连接来解释什么是OpMaker？

是的，需要一个文档。暂时Paddle中还没有，添加了TODO.

wangkuiyi · 2017-09-12T20:35:28Z

paddle/operators/name_convention.md

+When defining an operator in Paddle, a corresponding `OpMaker` need to be defined. All the `Input`/`Output` and `attrs` will write into the `OpProto` , and will be used in client language to create operator. 
+
+- Input/Output.
+  -  names follow the `CamelCase` but the first character is uppercase. e.g. `X`, `Y`, `Matrix`, `LastAxisInMatrix`. Input/Output much more like Variables, we prefer to meaningful English words.


names => Names

wangkuiyi · 2017-09-12T20:36:24Z

paddle/operators/name_convention.md

+When defining an operator in Paddle, a corresponding `OpMaker` need to be defined. All the `Input`/`Output` and `attrs` will write into the `OpProto` , and will be used in client language to create operator. 
+
+- Input/Output.
+  -  names follow the `CamelCase` but the first character is uppercase. e.g. `X`, `Y`, `Matrix`, `LastAxisInMatrix`. Input/Output much more like Variables, we prefer to meaningful English words.


CamelCase 的第一个字母就是大写的吧。第一个字母小写的叫camelCase。

wangkuiyi · 2017-09-12T20:36:49Z

paddle/operators/name_convention.md

+When defining an operator in Paddle, a corresponding `OpMaker` need to be defined. All the `Input`/`Output` and `attrs` will write into the `OpProto` , and will be used in client language to create operator. 
+
+- Input/Output.
+  -  names follow the `CamelCase` but the first character is uppercase. e.g. `X`, `Y`, `Matrix`, `LastAxisInMatrix`. Input/Output much more like Variables, we prefer to meaningful English words.


一对 和 是表示 code 的，不是用来表示着重号的。

"op name"

b63e1c6

reyoung reviewed Aug 14, 2017

View reviewed changes

"polish words"

e9eee6f

jacquesqiao reviewed Aug 25, 2017

View reviewed changes

JiayiFeng reviewed Aug 25, 2017

View reviewed changes

lcy-seso mentioned this pull request Sep 8, 2017

OpRegistry::CreateOp调用，输入/输出名字写错，报错信息难以理解 #3899

Closed

dzhwinter added 3 commits September 11, 2017 11:01

"fix name"

21d4974

add more rules

5c4dfde

Merge remote-tracking branch 'origin/develop' into op_name

e9ac7df

dzhwinter commented Sep 12, 2017

View reviewed changes

wangkuiyi reviewed Sep 12, 2017

View reviewed changes

dzhwinter added 3 commits September 12, 2017 15:47

"add Op name example and fix format error"

d00e8a5

"fix typo"

594dece

"remove used words"

15fccfe

wangkuiyi approved these changes Sep 13, 2017

View reviewed changes

wangkuiyi merged commit 57d8afe into PaddlePaddle:develop Sep 13, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

"op name" #3452

"op name" #3452

dzhwinter commented Aug 14, 2017 •

edited

reyoung Aug 14, 2017

dzhwinter Aug 15, 2017

JiayiFeng Aug 23, 2017

jacquesqiao Aug 25, 2017

jacquesqiao Aug 25, 2017

dzhwinter Sep 12, 2017

JiayiFeng Aug 25, 2017

dzhwinter Sep 12, 2017

lcy-seso commented Sep 8, 2017 •

edited

dzhwinter left a comment

dzhwinter Sep 12, 2017

wangkuiyi Sep 12, 2017

dzhwinter Sep 12, 2017

wangkuiyi Sep 12, 2017

dzhwinter Sep 12, 2017

wangkuiyi Sep 12, 2017

dzhwinter Sep 12, 2017

wangkuiyi Sep 12, 2017

dzhwinter Sep 12, 2017

wangkuiyi Sep 12, 2017

dzhwinter Sep 12, 2017

wangkuiyi Sep 12, 2017

dzhwinter Sep 12, 2017

wangkuiyi Sep 12, 2017

dzhwinter Sep 12, 2017


		Variable name is uppercase. e.g. `X`, `Y`

		Tensor name is lowercase. e.g. `tensor`


		### Input/Output names

		* Variable name is prefer uppercase. e.g. `X`, `Y`. But when the variable is tensor, its name should lowercase. e.g. `matrix`, to discriminate with otherone.


		* Variable name is prefer uppercase. e.g. `X`, `Y`. But when the variable is tensor, its name should lowercase. e.g. `matrix`, to discriminate with otherone.

		* element wise operator, math operator or similar op, please obey common name convention. if the operator only have one output, use `Out`.


		To make the operator document itself more clear, we recommend operator names obey the listing conventions.

		### OpMaker names


		### OpMaker names

		When defining an operator in Paddle, a corresponding `OpMaker` need to be defined. All the `Input`/`Output` and `attrs` will write into the `OpProto` , and will be used in client language to create operator.

"op name" #3452

"op name" #3452

Conversation

dzhwinter commented Aug 14, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lcy-seso commented Sep 8, 2017 • edited

dzhwinter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dzhwinter commented Aug 14, 2017 •

edited

lcy-seso commented Sep 8, 2017 •

edited