Merge pull request #47 from ksunden/introspection

Introspection graph visualization with improved node placement

Author: ksunden

.github/workflows/docs.yml

@@ -5,7 +5,7 @@ on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: "Set up Python 3.10"

data_prototype/conversion_edge.py

@@ -372,7 +372,20 @@ def edges(self):
         return SequenceEdge.from_edges("eval", out_edges, output)
 
     def visualize(self, input: dict[str, Desc] | None = None):
-        import networkx as nx
+        if input is None:
+            from .introspection import draw_graph
+
+            draw_graph(self)
+            return
+
+        try:
+            import networkx as nx
+        except ImportError:
+            from .introspection import draw_graph
+
+            draw_graph(self)
+            return
+
         import matplotlib.pyplot as plt
 
         from pprint import pformat
@@ -382,38 +395,26 @@ def node_format(x):
 
         G = nx.DiGraph()
 
-        if input is not None:
-            for _, edges in self._subgraphs:
-                q: list[dict[str, Desc]] = [input]
-                explored: set[tuple[tuple[str, str], ...]] = set()
-                explored.add(
-                    tuple(sorted(((k, v.coordinates) for k, v in q[0].items())))
-                )
-                G.add_node(node_format(q[0]))
-                while q:
-                    n = q.pop()
-                    for e in edges:
-                        if Desc.compatible(n, e.input):
-                            w = n | e.output
-                            if node_format(w) not in G:
-                                G.add_node(node_format(w))
-                                explored.add(
-                                    tuple(
-                                        sorted(
-                                            ((k, v.coordinates) for k, v in w.items())
-                                        )
-                                    )
+        for _, edges in self._subgraphs:
+            q: list[dict[str, Desc]] = [input]
+            explored: set[tuple[tuple[str, str], ...]] = set()
+            explored.add(tuple(sorted(((k, v.coordinates) for k, v in q[0].items()))))
+            G.add_node(node_format(q[0]))
+            while q:
+                n = q.pop()
+                for e in edges:
+                    if Desc.compatible(n, e.input):
+                        w = n | e.output
+                        if node_format(w) not in G:
+                            G.add_node(node_format(w))
+                            explored.add(
+                                tuple(
+                                    sorted(((k, v.coordinates) for k, v in w.items()))
                                 )
-                                q.append(w)
-                            if node_format(w) != node_format(n):
-                                G.add_edge(node_format(n), node_format(w), name=e.name)
-        else:
-            # don't bother separating subgraphs,as the end result is exactly the same here
-            for edge in self._edges:
-                G.add_edge(
-                    node_format(edge.input), node_format(edge.output), name=edge.name
-                )
-
+                            )
+                            q.append(w)
+                        if node_format(w) != node_format(n):
+                            G.add_edge(node_format(n), node_format(w), name=e.name)
         try:
             pos = nx.shell_layout(G)
         except Exception:

data_prototype/introspection.py

@@ -0,0 +1,161 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+import graphlib
+from pprint import pformat
+
+import matplotlib.pyplot as plt
+
+from .conversion_edge import Edge, Graph
+from .description import Desc
+
+
+@dataclass
+class VisNode:
+    keys: list[str]
+    coordinates: list[str]
+    parents: list[VisNode] = field(default_factory=list)
+    children: list[VisNode] = field(default_factory=list)
+    x: int = 0
+    y: int = 0
+
+    def __eq__(self, other):
+        return self.keys == other.keys and self.coordinates == other.coordinates
+
+    def format(self):
+        return pformat({k: v for k, v in zip(self.keys, self.coordinates)}, width=20)
+
+
+@dataclass
+class VisEdge:
+    name: str
+    parent: VisNode
+    child: VisNode
+
+
+def _position_subgraph(
+    subgraph: tuple(set[str], list[Edge]),
+) -> tuple[list[VisNode], list[VisEdge]]:
+    # Build graph
+    nodes: list[VisNode] = []
+    edges: list[VisEdge] = []
+
+    q: list[dict[str, Desc]] = [e.input for e in subgraph[1]]
+    explored: set[tuple[tuple[str, str], ...]] = set()
+    explored.add(tuple(sorted(((k, v.coordinates) for k, v in q[0].items()))))
+
+    for e in subgraph[1]:
+        nodes.append(
+            VisNode(list(e.input.keys()), [x.coordinates for x in e.input.values()])
+        )
+
+    while q:
+        n = q.pop()
+        vn = VisNode(list(n.keys()), [x.coordinates for x in n.values()])
+        for nn in nodes:
+            if vn == nn:
+                vn = nn
+
+        for e in subgraph[1]:
+            # Shortcut default edges appearing all over the place
+            if e.input == {} and vn.keys != []:
+                continue
+            if Desc.compatible(n, e.input):
+                w = e.output
+                vw = VisNode(list(w.keys()), [x.coordinates for x in w.values()])
+                for nn in nodes:
+                    if vw == nn:
+                        vw = nn
+
+                if vw not in nodes:
+                    nodes.append(vw)
+                    explored.add(
+                        tuple(sorted(((k, v.coordinates) for k, v in w.items())))
+                    )
+                    q.append(w)
+                if vw != vn:
+                    edges.append(VisEdge(e.name, vn, vw))
+                    vw.parents.append(vn)
+                    vn.children.append(vw)
+
+    # adapt graph for total ording
+    def hash_node(n):
+        return (tuple(n.keys), tuple(n.coordinates))
+
+    to_graph = {hash_node(n): set() for n in nodes}
+    for e in edges:
+        to_graph[hash_node(e.child)] |= {hash_node(e.parent)}
+
+    # evaluate total ordering
+    topological_sorter = graphlib.TopologicalSorter(to_graph)
+
+    # position horizontally by 1+ highest parent, vertically by 1+ highest sibling
+    def get_node(n):
+        for node in nodes:
+            if n[0] == tuple(node.keys) and n[1] == tuple(node.coordinates):
+                return node
+
+    static_order = list(topological_sorter.static_order())
+
+    for n in static_order:
+        node = get_node(n)
+        if node.parents != []:
+            node.y = max(p.y for p in node.parents) + 1
+    x_pos = {}
+    for n in static_order:
+        node = get_node(n)
+        if node.y in x_pos:
+            node.x = x_pos[node.y]
+            x_pos[node.y] += 1.25
+        else:
+            x_pos[node.y] = 1.25
+
+    return nodes, edges
+
+
+def draw_graph(graph: Graph, ax=None, *, adjust_axes=None):
+    if ax is None:
+        fig, ax = plt.subplots()
+        if adjust_axes is None:
+            adjust_axes = True
+
+    inverted = adjust_axes or ax.yaxis.get_inverted()
+
+    origin_y = 0
+    xmax = 0
+
+    for sg in graph._subgraphs:
+        nodes, edges = _position_subgraph(sg)
+        annotations = {}
+        # Draw nodes
+        for node in nodes:
+            annotations[node.format()] = ax.annotate(
+                node.format(),
+                (node.x, node.y + origin_y),
+                ha="center",
+                va="center",
+                bbox={"boxstyle": "round", "facecolor": "none"},
+            )
+
+        # Draw edges
+        for edge in edges:
+            arr = ax.annotate(
+                "",
+                (0.5, 1.05 if inverted else -0.05),
+                (0.5, -0.05 if inverted else 1.05),
+                xycoords=annotations[edge.child.format()],
+                textcoords=annotations[edge.parent.format()],
+                arrowprops={"arrowstyle": "->"},
+                annotation_clip=True,
+            )
+            ax.annotate(edge.name, (0.5, 0.5), xytext=(0.5, 0.5), textcoords=arr)
+
+        origin_y += max(node.y for node in nodes) + 1
+        xmax = max(xmax, max(node.x for node in nodes))
+
+    if adjust_axes:
+        ax.set_ylim(origin_y, -1)
+        ax.set_xlim(-1, xmax + 1)
+        ax.spines[:].set_visible(False)
+        ax.set_xticks([])
+        ax.set_yticks([])