interactive graph vis

Author: Yuriy Peshkichev

CONTRIBUTING.md

@@ -74,6 +74,34 @@ poetry init
 - Include docstrings for functions and classes
 - Write unit tests for new features or bug fixes
 
+### Docstrings
+Use this Google style docstrings format:
+https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html
+Example from Dialog2graph:
+```python
+class ModelStorage(BaseModel):
+    """
+    ModelStorage is a class for managing the storage of model configurations and instances.
+    It provides functionality to load configurations from a YAML file, add new models to the storage,
+    and save the current storage state back to a YAML file.
+
+    Attributes:
+        storage (Dict[str, StoredData]): A dictionary that holds the stored model configurations
+            and their corresponding instances.
+    """
+
+    storage: Dict[str, StoredData] = Field(default_factory=dict)
+
+    def load(self, path: Path):
+        """
+        Load model configurations from a YAML file into the storage.
+
+        Args:
+            path (str): The file path to the YAML file containing model configurations.
+        """
+        ...
+```
+
 ## Pull Request Format
 
 - Name of your PR (keep it simple yet meaningful)

dialog2graph/pipelines/core/graph.py

@@ -7,6 +7,7 @@
 
 from datetime import datetime
 import networkx as nx
+import gravis as gv
 from pydantic import BaseModel
 from typing import Optional, Any
 import matplotlib.pyplot as plt
@@ -238,7 +239,7 @@ def visualise(self, *args, **kwargs):
         plt.axis("off")
         plt.show()
 
-    def visualise_short(self, name, *args, **kwargs):
+    def visualise_short(self, name="", *args, **kwargs):
         """Create a compact visualization of the graph.
 
         Args:
@@ -285,6 +286,37 @@ def visualise_short(self, name, *args, **kwargs):
         plt.axis("off")
         plt.show()
 
+    def visualise_interactive(self, *args, **kwargs) -> gv._internal.plotting.data_structures.Figure:
+        
+        """
+        Visualises the graph using interactive visualisation library "gravis".
+        Returns:
+          A figure object representing the interactive graph visualization.
+        """
+        graph = self.graph.copy()
+
+        node_labels = nx.get_node_attributes(graph, "utterances")
+        edge_labels = nx.get_edge_attributes(graph, "utterances")
+
+        for edge_id in graph.edges:
+            edge = graph.edges[edge_id]
+            edge['label'] = len(edge_labels[edge_id])
+            edge['hover'] = edge_labels[edge_id]
+        
+        for node_id in graph.nodes:
+            node = graph.nodes[node_id]
+            node['label'] = f"{node_id}:{len(node_labels[node_id])}"
+            node['hover'] = node_labels[node_id]
+        
+        return gv.vis(
+            graph, show_node_label=True, show_edge_label=True,
+            node_label_data_source='label',
+            edge_label_data_source='label', edge_label_size_factor=1.7,
+            layout_algorithm="hierarchicalRepulsion"
+            )
+
+
+
     def find_nodes_by_utterance(self, utterance: str) -> list[dict]:
         """Find nodes containing a specific utterance.