add net_design doc #2547

Superjomn · 2017-06-21T10:24:48Z

init

dzhwinter · 2017-06-21T11:14:22Z

doc/design/refactor_discuess/net_design.md

+# Overfiew
+
+整体设计上参考 caffe2的SimpleNet，即Net 是一组 operator 的集合，包含了operator相关的操作，比如Create, RunOps, Delete 等。
+


推荐design doc英文写，请参考目录下其他design doc，Interface 需要列出来，并简单描述一下
不应出现比如，设计文档是确定的方案，大家可以review和后续修改 : )

dzhwinter · 2017-06-21T11:37:58Z

doc/design/refactor_discuess/net_design.md

@@ -0,0 +1,14 @@
+# Overfiew
+
+整体设计上参考 caffe2的SimpleNet，即Net 是一组 operator 的集合，包含了operator相关的操作，比如Create, RunOps, Delete 等。


今天上午讨论的对外提供的接口包括：
AddOp
Run
这两个接口，
用户配置Net的接口为什么还需要Delete ？

dzhwinter · 2017-06-21T11:39:19Z

doc/design/refactor_discuess/net_design.md

+
+- Net 管理其拥有的operator
+- Net 本身不占用任何Variable资源
+- Net 的调用方式类似 Functor，即 `output = net(inputs, scope)` ，其中


请确认一下，这里是显式调用Net.Run吧？

wanghaoshuang · 2017-06-21T14:33:24Z

doc/design/refactor_discuess/net_design.md

+
+```c++
+// The minimum a network should be implemented.
+class BaseNetwork {


Named NetworkBase or Net is better ?

Net seems wired without a prefix like "SimpleNet" or "DAGNet" and I will name it "NetworkBase"

wangkuiyi · 2017-06-21T15:08:44Z

doc/design/refactor_discuess/net_design.md

@@ -0,0 +1,65 @@
+# Network Design


I'd suggest that we move this design doc into paddle/framework/net.md, so we could keep the code (implementation) together with the design.

wangkuiyi · 2017-06-21T15:16:18Z

doc/design/refactor_discuess/net_design.md

+// The minimum a network should be implemented.
+class BaseNetwork {
+public:
+  BaseNetwork(const NetDef& def, Scope *scope);


Following the purpose of decoupling Scope and Net, scope should be passed to Net::Run other than to Net::Net.

wangkuiyi · 2017-06-21T15:17:25Z

doc/design/refactor_discuess/net_design.md

+
+protected:
+  // the input variables feed into the network.
+  std::vector<Variable*> external_inputs_;


As there is not something named internal_inputs_, here we should just name it inputs_? And analogously, rename external_outputs_ into outputs_?

It seems that a net could read and/or write a variable, so we might have read-only and writable variables, other than input and output variables, associated with it?

I am not sure if we should distinguish them, or just have vars_.

I think inputs and outputs should be distinguished because both of them are important properties of a network(a directed graph).

As a "base network", we may inherit NetworkBase and implement a DAG in the future, and inputs and outputs will directly determine a sub-graph of a DAG.

wangkuiyi · 2017-06-21T15:21:01Z

doc/design/refactor_discuess/net_design.md

+
+protected:
+  // the input variables feed into the network.
+  std::vector<Variable*> external_inputs_;


Because a Scope is passed in to Run other than the constructor, we don't have a chance to get Variable* here. Instead, we should have:

std::vector<string> vars_;

wangkuiyi · 2017-06-21T15:21:39Z

doc/design/refactor_discuess/net_design.md

+  // the corresponding output variables the network will write.
+  std::vector<Variable*> external_outputs_;
+  // scope which contains all the global variables visiable to this network.
+  Scope *scope_;


If we have scope_, we are not decoupling Net from Workspace.

wangkuiyi · 2017-06-21T15:38:55Z

doc/design/refactor_discuess/net_design.md

+  // has a `name`
+  std::string name_;
+  // the operations are owned by `Network`.
+  std::vector<std::shared_ptr<Operator>> oprs_;


I think we should use unique_ptr here other than shared_ptr. The reason is in this comment.

wangkuiyi · 2017-06-21T15:39:19Z

doc/design/refactor_discuess/net_design.md

+  // has a `name`
+  std::string name_;
+  // the operations are owned by `Network`.
+  std::vector<std::shared_ptr<Operator>> oprs_;


The word "operator" usually shortened as "op", not "opr".

dzhwinter · 2017-06-21T16:14:16Z

doc/design/refactor_discuess/net_design.md

+# Network Design
+
+`Network` is the container and controller of a set of operators in a network, users can use `Network.addOp` to add operators into a network, 
+and use `Network.runOps` to run all the operators in the network.


To conform to list API in Net class, we should use Run instead of RunOps here

dzhwinter · 2017-06-21T16:24:11Z

doc/design/refactor_discuess/net_design.md

+protected:
+  // to make the network's structure more human-readable, each network will 
+  // has a `name`
+  std::string name_;


it is useless at present. we can remove it from the design doc and add when it is necessary.

add net_design doc

651f9a9

Superjomn requested review from wanghaoshuang and dzhwinter June 21, 2017 10:24

dzhwinter requested changes Jun 21, 2017

View reviewed changes

net design in en

d6f2abc

wanghaoshuang reviewed Jun 21, 2017

View reviewed changes

wangkuiyi reviewed Jun 21, 2017

View reviewed changes

dzhwinter requested changes Jun 21, 2017

View reviewed changes

Superjomn closed this Jun 22, 2017

Superjomn mentioned this pull request Jun 22, 2017

move net_design to framework #2553

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add net_design doc #2547

add net_design doc #2547

Superjomn commented Jun 21, 2017

dzhwinter Jun 21, 2017

dzhwinter Jun 21, 2017

dzhwinter Jun 21, 2017

wanghaoshuang Jun 21, 2017

Superjomn Jun 22, 2017

wangkuiyi Jun 21, 2017

Superjomn Jun 22, 2017

wangkuiyi Jun 21, 2017

Superjomn Jun 22, 2017

wangkuiyi Jun 21, 2017

wangkuiyi Jun 21, 2017

Superjomn Jun 22, 2017

wangkuiyi Jun 21, 2017

Superjomn Jun 22, 2017

Superjomn Jun 22, 2017

wangkuiyi Jun 21, 2017

Superjomn Jun 22, 2017

wangkuiyi Jun 21, 2017

Superjomn Jun 22, 2017

wangkuiyi Jun 21, 2017

Superjomn Jun 22, 2017

dzhwinter Jun 21, 2017

Superjomn Jun 22, 2017

dzhwinter Jun 21, 2017

Superjomn Jun 22, 2017

		# Overfiew

		整体设计上参考 caffe2的SimpleNet，即Net 是一组 operator 的集合，包含了operator相关的操作，比如Create, RunOps, Delete 等。

		@@ -0,0 +1,14 @@
		# Overfiew

		整体设计上参考 caffe2的SimpleNet，即Net 是一组 operator 的集合，包含了operator相关的操作，比如Create, RunOps, Delete 等。

add net_design doc #2547

add net_design doc #2547

Conversation

Superjomn commented Jun 21, 2017

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

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