X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=agtree2dot.git;a=blobdiff_plain;f=README.md;h=6b996b4d89c02af54af942f73671e7a88eb7a5d8;hp=9b4017c9c3e1773fab8578d08b3cba5e4c4214c9;hb=977a75b33305e91933ee4df441d0a249e46f2a31;hpb=8a79b8841aea1fee0d1749a0650edfed196d5086 diff --git a/README.md b/README.md index 9b4017c..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 -auto-grad 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 # @@ -9,7 +10,7 @@ auto-grad graph. ### agtree2dot.save_dot(variable, variable_labels, result_file) ### -Saves into `result_file` a dot file corresponding to the auto-grad graph for `variable`, which can be either a single `Variable` or a set of `Variable`s. The dictionary `variable_labels` associates strings to some variables, which will be used in the resulting graph. +Saves into `result_file` a dot file corresponding to the autograd graph for `variable`, which can be either a single `Variable` or a set of `Variable`s. The dictionary `variable_labels` associates strings to some variables, which will be used in the resulting graph. ## Example ## @@ -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)