aboutsummaryrefslogtreecommitdiff
path: root/doc/nerv_nn.md
diff options
context:
space:
mode:
authorcloudygoose <[email protected]>2015-06-12 12:27:36 +0800
committercloudygoose <[email protected]>2015-06-12 12:27:36 +0800
commit83dbefa3435b72911ee643f9f99205247d140279 (patch)
tree819edfc2f32080eb398bbb736a61e27db093b317 /doc/nerv_nn.md
parentc3db7ffba45b7e4d0a1d76281e187b3f88129db9 (diff)
doc change
Diffstat (limited to 'doc/nerv_nn.md')
-rw-r--r--doc/nerv_nn.md37
1 files changed, 35 insertions, 2 deletions
diff --git a/doc/nerv_nn.md b/doc/nerv_nn.md
index 54c7165..0f274c4 100644
--- a/doc/nerv_nn.md
+++ b/doc/nerv_nn.md
@@ -12,7 +12,24 @@ it contains __nerv.LayerRepo__, __nerv.ParamRepo__, and __nerv.DAGLayer__(inheri
* `table layers` Contains the mapping of layer ID to layer object.
objects.
* __nerv.DAGLayer__ inherits __nerv.Layer__.
-
+ * `table layers` Mapping from a layer ID to its "ref". A ref is of the structure below:
+ ```
+ nerv.Layer layer --its layer
+ nerv.Matrix inputs
+ nerv.Matrix outputs
+ nerv.Matrix err_inputs
+ nerv.Matrix err_outputs
+ table next_layers
+ int input_len -- #dim_in
+ int output_len -- #dim_out
+ int in_deg
+ bool visited -- used in topology sort
+ ```
+ * `inputs`
+ * `outputs`
+ * `parsed_conn`
+ * `queue`
+
##Methods##
###__nerv.ParamRepo__###
* __void ParamRepo:\_\_init(table param_files)__
@@ -29,4 +46,20 @@ llist : {layer1, layer2, ...}
layer : layerid = {param_config, layer_config}
param_config : {param1 = paramID1, param2 = paramID2}
```
-__LayerRepo__ will merge `param_config` into `layer_config` and construct a layer by calling `layer_type(layerid, global_conf, layer_config)`. \ No newline at end of file
+__LayerRepo__ will merge `param_config` into `layer_config` and construct a layer by calling `layer_type(layerid, global_conf, layer_config)`.
+
+* __[nerv.Layer] LayerRepo.get_layer([LayerRepo] self, [string] lid)__
+`self`, __nerv.LayerRepo__, ...
+Returns the layer with ID `lid`.
+
+###__nerv.DAGLayer__###
+* __DAGLayer:\_\_init(id, global_conf, layer_conf, [a, b, ...])__
+ Returns:
+ __string__, dfdfdfddf
+ __asasa__, asasasasa
+ Parameters:
+ `id`: __string__, the ID of the layer.
+ `global_conf`:__table__,the global config.
+
+ sasasa
+ \ No newline at end of file