X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=agtree2dot.git;a=blobdiff_plain;f=README.md;fp=README.md;h=007efc66d5af856bbe42cf8fafb161451967588a;hp=7f7bf6f6a3b209627639a119744e9bdf3d59248d;hb=a8b63a996712e71a274a9ef11fbe9dd262bd6ecd;hpb=851d5b775e36519594627738cc5a18f47368e1f5 diff --git a/README.md b/README.md index 7f7bf6f..007efc6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Introduction # -This package provides a function that generates a dot file from the +This package provides a function that generates a [dot file](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) from the autograd graph. # Usage # @@ -50,7 +50,8 @@ agtree2dot.save_dot(loss, open('./mlp.dot', 'w')) ``` -which would generate a file mlp.dot, which can then be translated to pdf with +which would generate a file mlp.dot, which can then be translated to +pdf using the [Graphviz tools](http://www.graphviz.org/) ``` dot mlp.dot -Lg -T pdf -o mlp.pdf