Skip to content

Commit

Permalink
📝 add back note about graphviz
Browse files Browse the repository at this point in the history
  • Loading branch information
burgholzer committed Dec 22, 2023
1 parent 6e43054 commit aebd205
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/source/library/Visualization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ The recommended way to visualize search graphs of a mapping process is via a :cl
.. note::
:meth:`SearchVisualizer.visualize_search_graph` returns an IPython display object and therefore requires to be executed in a jupyter notebook or jupyter lab environment.

.. note::
Automatic layouting of architecture or search nodes requires `Graphviz <https://graphviz.org/>`_ to be installed (except for the layouting method :code:`walker`). If Graphviz is called without it being installed, it will ensue in an error such as:

:code:`FileNotFoundError: [Errno 2] "sfdp" not found in path.`

Consequently, the only way to use :meth:`SearchVisualizer.visualize_search_graph` without Graphviz is by passing explicit architecture node positions or hiding the architecture graph by passing :code:`show_layout=None`.

.. autoclass:: SearchVisualizer
:special-members: __init__
:members:

0 comments on commit aebd205

Please sign in to comment.