# 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 #
### 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 ##
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