X-Git-Url: https://fleuret.org/cgi-bin/gitweb/gitweb.cgi?a=blobdiff_plain;f=README.md;h=007efc66d5af856bbe42cf8fafb161451967588a;hb=a8b63a996712e71a274a9ef11fbe9dd262bd6ecd;hp=4c219b713b8e2f3199a66ead5e6dd46082153076;hpb=63f04303f0320d25d36e6a4f9f535e62cdb139e1;p=agtree2dot.git diff --git a/README.md b/README.md index 4c219b7..007efc6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 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 the +autograd graph. # Usage # @@ -9,7 +9,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 ## @@ -46,11 +46,12 @@ criterion = nn.MSELoss() loss = criterion(output, target) agtree2dot.save_dot(loss, - { input: 'input', loss: 'loss' }, + { input: 'input', target: 'target', loss: '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