X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=1d6f5bd811b5706b39890c13fe4d5404dc7768c1;hb=07a8c54a66b01f342e4d03ca2cf99710d56806d0;hp=436aa63d1c585c267e8ee40756f23588a01765b0;hpb=5a149d40e14c1931103514b41c56a4139f06973a;p=dagnn.git diff --git a/README.md b/README.md index 436aa63..1d6f5bd 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,18 @@ Note that DAG:connect allows to add a bunch of edges at once. This is particularly useful to add anonymous modules which have a single predecessor and successor. +#Usage# + ##Input and output## -If a node has a single predecessor, its output is taken as-is. If it -has multiple predecessors, all the outputs are collected into a table, -and the table is used as input. The indexes of the outputs in that -table reflects the order in which the predecessors appeared in the -DAG:connect() commands. +The DAG can deal with modules which take as input and produce as +output tensors and nested tables of tensors. + +If a node has a single predecessor, the output of the latter is taken +as-is as the input of the former. If it has multiple predecessors, all +the outputs are collected into a table, and the table is used as +input. The indexes of the outputs in that table reflects the order in +which the edges where created in the DAG:connect() commands. The input to the DAG (respectively the produced output) is a nested table of inputs reflecting the structure of the nested table of @@ -65,7 +70,7 @@ 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## +##Functions## ###nn.DAG()### @@ -83,8 +88,8 @@ 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. +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. ###nn.DAG:setOutput(o)### @@ -104,17 +109,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*