X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=662b8a885b43a5342e7dd917f16535cc025cb3e8;hb=e73c3494970d12154aff7587fcb43cf600f03e30;hp=869a1d97c09df81fd886168e78159bc56b7f8bdf;hpb=91d22819226af01ec2eee6aed49007e058dc6e50;p=dagnn.git diff --git a/README.md b/README.md index 869a1d9..662b8a8 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 ## @@ -67,7 +67,7 @@ table of inputs reflecting the structure of the nested table of modules given as argument to DAG:setInput (respectively DAG:setOutput) So for instance, in the example above, the model expects a tensor as -input, since it is the input to the module a, and its output will is a +input, since it is the input to the module a, and its output is a table composed of two tensors, corresponding to the outputs of d and e respectively. @@ -88,9 +88,10 @@ 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 +Define the content and structure of the input. The argument should be 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. +should be a (nested) table of inputs, with the corresponding +structure. ### nn.DAG:setOutput(o) ### @@ -98,7 +99,7 @@ Similar to DAG:setInput(). ### nn.DAG:print() ### -Prints the list of nodes. +Print the list of nodes. ### nn.DAG:saveDot(filename) ###