X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=6418a4029420fe3ae652952b637ef6e43787051a;hb=6a412f5164d3b4085f657114b797006eb7e56a74;hp=206a132afaca80f294f62fca4b14461c21591a0e;hpb=3c69b13db0310729c934ebfa9c98a676e19d4eb8;p=dagnn.git diff --git a/README.md b/README.md index 206a132..6418a40 100644 --- a/README.md +++ b/README.md @@ -65,33 +65,36 @@ input, since it is the input to the module a, and its output will is a table composed of two tensors, corresponding to the outputs of d and e respectively. -#Usage# +##Usage## -##nn.DAG()## +###nn.DAG()### Create a new empty DAG, which inherits from nn.Container. -##nn.DAG:connect([module1 [, module2 [, ...]]])## +###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. -##nn.DAG:setInput(i)## +Calling it with n > 2 arguments is strictly equivalent to calling it +n-1 times on the pairs of successive arguments. + +###nn.DAG:setInput(i)### Defines the content and structure of the input. The argument should be either a module, or a (nested) table of module. The input to the DAG should be a (nested) table of inputs with the corresponding structure. -##nn.DAG:setOutput(o)## +###nn.DAG:setOutput(o)### Similar to DAG:setInput(). -##nn.DAG:print()## +###nn.DAG:print()### Prints the list of nodes. -##nn.DAG:saveDot(filename)## +###nn.DAG:saveDot(filename)### Save a dot file to be used by the Graphviz set of tools for graph visualization. This dot file can than be used for instance to produce @@ -101,16 +104,5 @@ a pdf file with dot graph.dot -T pdf -o graph.pdf ``` -##nn.DAG:updateOutput(input)## - -See the torch documentation. - -##nn.DAG:updateGradInput(input, gradOutput)## - -See the torch documentation. - -##nn.DAG:accGradParameters(input, gradOutput, scale)## - -See the torch documentation. - +-- *Francois Fleuret, Jan 13th, 2017*