Skip to content

Added: Examples in docstring on displaying pydot with IPython #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kayjan merged 1 commit into from
Dec 8, 2023
Merged

Added: Examples in docstring on displaying pydot with IPython #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions bigtree/dag/export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,12 @@ def dag_to_dot(
>>> e = DAGNode("e", step=3, parents=[d])
>>> dag_graph = dag_to_dot(a)

Display image directly without saving (requires IPython)

>>> from IPython.display import Image, display
>>> plt = Image(dag_graph.create_png())
>>> display(plt)

Export to image, dot file, etc.

>>> dag_graph.write_png("tree_dag.png")
Expand Down
6 changes: 6 additions & 0 deletions bigtree/tree/export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -640,6 +640,12 @@ def tree_to_dot(
>>> e = Node("e", age=35, parent=b)
>>> graph = tree_to_dot(root)

Display image directly without saving (requires IPython)

>>> from IPython.display import Image, display
>>> plt = Image(graph.create_png())
>>> display(plt)

Export to image, dot file, etc.

>>> graph.write_png("tree.png")
Expand Down