X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=dagnn.git;a=blobdiff_plain;f=README.md;h=fa77a7e785ccdb23880cacdea55e5d609f294399;hp=662b8a885b43a5342e7dd917f16535cc025cb3e8;hb=HEAD;hpb=84b07c45eb8a2785a81cad7bcf6fadbac0d63f8f diff --git a/README.md b/README.md index 662b8a8..fa77a7e 100644 --- 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 @@ -105,11 +110,12 @@ Print the list of nodes. 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 -a pdf file with +a pdf file such as [this one](https://fleuret.org/git-extract/dagnn/graph.pdf) 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()