Merge pull request #378 from orazve/rwr-no-alpha

Remove alpha tier from RWR algorithm endpoint

Author: orazve

doc/sphinx/source/algorithms.rst

@@ -97,6 +97,10 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Constructs a random subgraph based on common-neighbour-aware random walks.
 
+.. py:function:: gds.graph.sample.cnarw.estimate(G: Graph, **config: Any) -> "Series[Any]"
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. py:function:: gds.alpha.hits.mutate(G: Graph, **config: Any) -> "Series[Any]"
 
     Hyperlink-Induced Topic Search (HITS) is a link analysis algorithm that rates nodes.

graphdatascience/graph/graph_alpha_proc_runner.py

@@ -11,14 +11,14 @@
 from .graph_alpha_project_runner import GraphAlphaProjectRunner
 from .graph_entity_ops_runner import GraphLabelRunner, GraphPropertyRunner
 from .graph_object import Graph
-from .graph_sample_runner import GraphSampleRunner
+from .graph_sample_runner import GraphAlphaSampleRunner
 
 
 class GraphAlphaProcRunner(UncallableNamespace, IllegalAttrChecker):
     @property
-    def sample(self) -> GraphSampleRunner:
+    def sample(self) -> GraphAlphaSampleRunner:
         self._namespace += ".sample"
-        return GraphSampleRunner(self._query_runner, self._namespace, self._server_version)
+        return GraphAlphaSampleRunner(self._query_runner, self._namespace, self._server_version)
 
     @property
     def graphProperty(self) -> GraphPropertyRunner:

graphdatascience/graph/graph_sample_runner.py

@@ -2,19 +2,37 @@
 
 from pandas import Series
 
+from ..error.deprecation_warning import deprecation_warning
 from ..error.illegal_attr_checker import IllegalAttrChecker
 from ..server_version.compatible_with import compatible_with
 from ..server_version.server_version import ServerVersion
 from .graph_object import Graph
 from .graph_type_check import from_graph_type_check
 
 
-class GraphSampleRunner(IllegalAttrChecker):
+class GraphAlphaSampleRunner(IllegalAttrChecker):
     @compatible_with("construct", min_inclusive=ServerVersion(2, 2, 0))
+    @deprecation_warning("gds.graph.sample.rwr", ServerVersion(2, 4, 0))
     @from_graph_type_check
     def rwr(self, graph_name: str, from_G: Graph, **config: Any) -> Tuple[Graph, "Series[Any]"]:
-        self._namespace += ".rwr"
+        runner = RWRRunner(self._query_runner, self._namespace + ".rwr", self._server_version)
+        return runner(graph_name, from_G, **config)
+
+
+class GraphSampleRunner(IllegalAttrChecker):
+    @property
+    def rwr(self) -> "RWRRunner":
+        return RWRRunner(self._query_runner, self._namespace + ".rwr", self._server_version)
+
+    @property
+    def cnarw(self) -> "CNARWRunner":
+        return CNARWRunner(self._query_runner, self._namespace + ".cnarw", self._server_version)
 
+
+class RWRRunner(IllegalAttrChecker):
+    @compatible_with("construct", min_inclusive=ServerVersion(2, 2, 0))
+    @from_graph_type_check
+    def __call__(self, graph_name: str, from_G: Graph, **config: Any) -> Tuple[Graph, "Series[Any]"]:
         query = f"CALL {self._namespace}($graph_name, $from_graph_name, $config)"
         params = {
             "graph_name": graph_name,
@@ -26,10 +44,6 @@ def rwr(self, graph_name: str, from_G: Graph, **config: Any) -> Tuple[Graph, "Se
 
         return Graph(graph_name, self._query_runner, self._server_version), result
 
-    @property
-    def cnarw(self) -> "CNARWRunner":
-        return CNARWRunner(self._query_runner, self._namespace + ".cnarw", self._server_version)
-
 
 class CNARWRunner(IllegalAttrChecker):
     @compatible_with("construct", min_inclusive=ServerVersion(2, 4, 0))

graphdatascience/tests/integration/test_graph_ops.py

@@ -90,7 +90,7 @@ def test_project_subgraph(runner: QueryRunner, gds: GraphDataScience) -> None:
 def test_sample_rwr(runner: QueryRunner, gds: GraphDataScience) -> None:
     from_G, _ = gds.graph.project(GRAPH_NAME, {"Node": {"properties": "x"}}, "*")
 
-    rwr_G, result = gds.alpha.graph.sample.rwr("s", from_G, samplingRatio=0.6, concurrency=1, randomSeed=42)
+    rwr_G, result = gds.graph.sample.rwr("s", from_G, samplingRatio=0.6, concurrency=1, randomSeed=42)
 
     assert rwr_G.name() == "s"
     assert result["graphName"] == "s"

graphdatascience/tests/unit/resources/example_server_endpoints.py

@@ -272,6 +272,9 @@
     "gds.graph.relationshipProperty.stream",
     "gds.graph.relationships.drop",
     "gds.graph.removeNodeProperties",
+    "gds.graph.sample.rwr",
+    "gds.graph.sample.cnarw",
+    "gds.graph.sample.cnarw.estimate",
     "gds.graph.streamNodeProperties",
     "gds.graph.streamNodeProperty",
     "gds.graph.streamRelationshipProperties",

graphdatascience/tests/unit/test_graph_ops.py

@@ -602,7 +602,7 @@ def test_graph_generate(runner: CollectingQueryRunner, gds: GraphDataScience) ->
     }
 
 
-def test_graph_sample_rwr(runner: CollectingQueryRunner, gds: GraphDataScience) -> None:
+def test_alpha_graph_sample_rwr(runner: CollectingQueryRunner, gds: GraphDataScience) -> None:
     from_G, _ = gds.graph.project("g", "*", "*")
     gds.alpha.graph.sample.rwr("s", from_G, samplingRatio=0.9, concurrency=7)
 
@@ -614,6 +614,18 @@ def test_graph_sample_rwr(runner: CollectingQueryRunner, gds: GraphDataScience)
     }
 
 
+def test_graph_sample_rwr(runner: CollectingQueryRunner, gds: GraphDataScience) -> None:
+    from_G, _ = gds.graph.project("g", "*", "*")
+    gds.graph.sample.rwr("s", from_G, samplingRatio=0.9, concurrency=7)
+
+    assert runner.last_query() == "CALL gds.graph.sample.rwr($graph_name, $from_graph_name, $config)"
+    assert runner.last_params() == {
+        "graph_name": "s",
+        "from_graph_name": "g",
+        "config": {"samplingRatio": 0.9, "concurrency": 7},
+    }
+
+
 def test_graph_sample_cnarw(runner: CollectingQueryRunner, gds: GraphDataScience) -> None:
     from_G, _ = gds.graph.project("g", "*", "*")
     gds.graph.sample.cnarw("s", from_G, samplingRatio=0.9, concurrency=7)