OCD cosmetics.
authorFrancois Fleuret <francois@fleuret.org>
Fri, 13 Jan 2017 22:59:17 +0000 (23:59 +0100)
committerFrancois Fleuret <francois@fleuret.org>
Fri, 13 Jan 2017 22:59:17 +0000 (23:59 +0100)
README.md

index 1d6f5bd..7d51566 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
 
-#Introduction#
+# Introduction #
 
 This package implements a new module nn.DAG which inherits from
 nn.Container and allows to combine modules in an arbitrary graph
 without cycle.
 
-##Example##
+## Example ##
 
 A typical use would be:
 
@@ -48,9 +48,9 @@ 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#
+# Usage #
 
-##Input and output##
+## Input and output ##
 
 The DAG can deal with modules which take as input and produce as
 output tensors and nested tables of tensors.
@@ -70,13 +70,13 @@ 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.
 
-##Functions##
+## Functions ##
 
-###nn.DAG()###
+### nn.DAG() ###
 
 Create a new empty DAG, which inherits from nn.Container.
 
-###nn.DAG:connect([module1 [, module2 [, ...]]])###
+### 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
@@ -85,21 +85,21 @@ corresponding to a pair of 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.
 
-###nn.DAG:setInput(i)###
+### nn.DAG:setInput(i) ###
 
 Defines 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.
 
-###nn.DAG:setOutput(o)###
+### nn.DAG:setOutput(o) ###
 
 Similar to DAG:setInput().
 
-###nn.DAG:print()###
+### nn.DAG:print() ###
 
 Prints the list of nodes.
 
-###nn.DAG:saveDot(filename)###
+### nn.DAG:saveDot(filename) ###
 
 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