X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=agtree2dot.git;a=blobdiff_plain;f=README.md;h=6b996b4d89c02af54af942f73671e7a88eb7a5d8;hp=7f7bf6f6a3b209627639a119744e9bdf3d59248d;hb=977a75b33305e91933ee4df441d0a249e46f2a31;hpb=851d5b775e36519594627738cc5a18f47368e1f5 diff --git a/README.md b/README.md index 7f7bf6f..6b996b4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # Introduction # -This package provides a function that generates a dot file from the -autograd graph. +This package provides a function that generates a +[dot file](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) +from a [pytorch](http://pytorch.org) autograd graph. # Usage # @@ -50,10 +51,11 @@ 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 ``` -to produce [mlp.pdf](https://fleuret.org/git-extract/agtree2dot/mlp.pdf). +to produce [mlp.pdf.](https://fleuret.org/git-extract/agtree2dot/mlp.pdf)