X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=3df18f5a24e81ae09837bf704479818ae288844e;hb=f13855d442ddf0fc5dbecbd25622eadb67685ffb;hp=fbb7a96039cb55dbca12ea20942878443544b3e8;hpb=125002d32a2c9ea88bdbc722a888d3788901fc27;p=dagnn.git diff --git a/README.md b/README.md index fbb7a96..3df18f5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # 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 ## @@ -80,11 +80,11 @@ 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 it with n > 2 arguments is strictly equivalent to calling it -n-1 times on the pairs of successive arguments. +Calling this function with n > 2 arguments is strictly equivalent to +calling it n-1 times on the pairs of successive arguments. ### nn.DAG:setInput(i) ###