Updated with DAG:setLabel()

[dagnn.git] / README.md

diff --git a/README.md b/README.md
index 662b8a8..c641e03 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,3 @@
-
 # Introduction #
 
 This package implements a new module nn.DAG for the [torch framework](https://torch.ch),
@@ -77,15 +76,21 @@ respectively.
 
 Create a new empty DAG, which inherits from nn.Container.
 
-### nn.DAG:connect([module1 [, module2 [, ...]]]) ###
+### nn.DAG:connect(module1, module2 [, module3, [...]]) ###
 
 Add new nodes corresponding to the modules passed as arguments if they
 have not been already added in a previous call. Add edges between
-every two nodes associated to two successive modules in the arguments.
+every two nodes associated to two successive modules in the
+arguments.
 
 Calling this function with n > 2 arguments is strictly equivalent to
 calling it n-1 times on the pairs of successive arguments.
 
+Accepting more than two arguments allows in particular to add
+anonymous modules, which are not associated to variables. In principle
+the only ones that have to be non-anonymous are those that have more
+than one successor / predecessor and/or are inputs / outputs.
+
 ### nn.DAG:setInput(i) ###
 
 Define the content and structure of the input. The argument should be
@@ -111,5 +116,6 @@ a pdf file with
 dot graph.dot -T pdf -o graph.pdf
 ```
 
--- 
-*Francois Fleuret, Jan 13th, 2017*
+### nn.DAG:setLabel(module, name) ###
+
+Add a label to the given module, that will be used for DAG:print() and DAG:saveDot()