X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=73d08ff87a55d5053a8263be3fbfd6377f1d858c;hb=78671207db483567021a935d0738ba85d8b16551;hp=fbb7a96039cb55dbca12ea20942878443544b3e8;hpb=125002d32a2c9ea88bdbc722a888d3788901fc27;p=dagnn.git

diff --git a/README.md b/README.md
index fbb7a96..73d08ff 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,8 @@
-
 # Introduction #
 
-This package implements a new module nn.DAG for the torch framework,
-which inherits from nn.Container and allows to combine modules in an
-arbitrary graph without cycle.
+This package implements a new module nn.DAG for the [torch framework](https://torch.ch),
+which inherits from [nn.Container](https://github.com/torch/nn/blob/master/Container.lua) and allows to combine modules in an
+arbitrary [Directed Acyclic Graph (DAG).](https://en.wikipedia.org/wiki/Directed_acyclic_graph)
 
 ## Example ##
 
@@ -67,7 +66,7 @@ table of inputs reflecting the structure of the nested table of
 modules given as argument to DAG:setInput (respectively DAG:setOutput)
 
 So for instance, in the example above, the model expects a tensor as
-input, since it is the input to the module a, and its output will is a
+input, since it is the input to the module a, and its output is a
 table composed of two tensors, corresponding to the outputs of d and e
 respectively.
 
@@ -80,17 +79,24 @@ Create a new empty DAG, which inherits from nn.Container.
 ### nn.DAG:connect([module1 [, module2 [, ...]]]) ###
 
 Add new nodes corresponding to the modules passed as arguments if they
-are not already existing. Add edges between every two nodes
-corresponding to a pair of successive modules in the arguments.
+have not been already added in a previous call. Add edges between
+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.
 
-Calling it 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 non-anonymous ones are those that have more than
+one successor / predecessor and the inputs / outputs.
 
 ### nn.DAG:setInput(i) ###
 
-Defines the content and structure of the input. The argument should be
+Define the content and structure of the input. The argument should be
 either a module, or a (nested) table of modules. The input to the DAG
-should be a (nested) table of inputs, with the corresponding structure.
+should be a (nested) table of inputs, with the corresponding
+structure.
 
 ### nn.DAG:setOutput(o) ###
 
@@ -98,7 +104,7 @@ Similar to DAG:setInput().
 
 ### nn.DAG:print() ###
 
-Prints the list of nodes.
+Print the list of nodes.
 
 ### nn.DAG:saveDot(filename) ###
 
@@ -109,6 +115,3 @@ a pdf file with
 ```
 dot graph.dot -T pdf -o graph.pdf
 ```
-
--- 
-*Francois Fleuret, Jan 13th, 2017*