Merge pull request #173 from neo4j/gds/rel-properties

gds/rel properties

Author: FlorentinD

changelog.md

@@ -7,6 +7,7 @@
 ## New features
 
 * Allow visualization based only on relationship DataFrames, without specifying node DataFrames in `from_dfs`
+* Add relationship properties to `VisualizationGraph` when constructing via `from_gds`.
 
 ## Bug fixes
 

examples/gds-example.ipynb

@@ -22,6 +22,20 @@ def _node_dfs(
 
 
 def _rel_df(gds: GraphDataScience, G: Graph) -> pd.DataFrame:
+    relationship_properties = G.relationship_properties()
+
+    if len(relationship_properties) > 0:
+        if isinstance(relationship_properties, pd.Series):
+            relationship_properties_per_type = relationship_properties.tolist()
+            property_set: set[str] = set()
+            for props in relationship_properties_per_type:
+                if props:
+                    property_set.update(props)
+
+        return gds.graph.relationshipProperties.stream(
+            G, relationship_properties=list(property_set), separate_property_columns=True
+        )
+
     return gds.graph.relationships.stream(G)
 
 
@@ -89,10 +103,10 @@ def from_gds(
             df.rename(columns={"labels": "__labels"}, inplace=True)
         df["labels"] = lbl
 
-    node_lbls_df = pd.concat([df[["id", "labels"]] for df in node_dfs.values()], ignore_index=True, axis=0)
-    node_lbls_df = node_lbls_df.groupby("id").agg({"labels": list})
+    node_labels_df = pd.concat([df[["id", "labels"]] for df in node_dfs.values()], ignore_index=True, axis=0)
+    node_labels_df = node_labels_df.groupby("id").agg({"labels": list})
 
-    node_df = node_props_df.merge(node_lbls_df, on="id")
+    node_df = node_props_df.merge(node_labels_df, on="id")
 
     rel_df = _rel_df(gds, G)
     rel_df.rename(columns={"sourceNodeId": "source", "targetNodeId": "target"}, inplace=True)

python-wrapper/src/neo4j_viz/gds.py

@@ -24,6 +24,8 @@ def test_from_gds_integration(gds: Any) -> None:
         {
             "sourceNodeId": [0, 1, 2],
             "targetNodeId": [1, 2, 0],
+            "cost": [1.0, 2.0, 3.0],
+            "weight": [0.5, 1.5, 2.5],
             "relationshipType": ["REL", "REL2", "REL"],
         }
     )
@@ -46,12 +48,16 @@ def test_from_gds_integration(gds: Any) -> None:
 
         assert len(VG.relationships) == 3
         vg_rels = sorted(
-            [(e.source, e.target, e.properties["relationshipType"]) for e in VG.relationships], key=lambda x: x[0]
+            [
+                (e.source, e.target, e.properties["relationshipType"], e.properties["cost"], e.properties["weight"])
+                for e in VG.relationships
+            ],
+            key=lambda x: x[0],
         )
         assert vg_rels == [
-            (0, 1, "REL"),
-            (1, 2, "REL2"),
-            (2, 0, "REL"),
+            (0, 1, "REL", 1.0, 0.5),
+            (1, 2, "REL2", 2.0, 1.0),
+            (2, 0, "REL", 3.0, 1.5),
         ]