X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=dagnn.git;a=blobdiff_plain;f=README.md;h=fa77a7e785ccdb23880cacdea55e5d609f294399;hp=73d08ff87a55d5053a8263be3fbfd6377f1d858c;hb=HEAD;hpb=f3a748c4119c4f374b30d0010198732bb80b43a6 diff --git a/README.md b/README.md index 73d08ff..fa77a7e 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ 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 @@ -87,9 +87,9 @@ 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 non-anonymous ones are those that have more than -one successor / predecessor and the inputs / outputs. +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) ### @@ -110,8 +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 ``` + +### nn.DAG:setLabel(module, name) ### + +Add a label to the given module, that will be used for DAG:print() and DAG:saveDot()