graphdatascience 1.10__tar.gz → 1.11__tar.gz

{graphdatascience-1.10/graphdatascience.egg-info → graphdatascience-1.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: graphdatascience
-Version: 1.10
+Version: 1.11
 Summary: A Python client for the Neo4j Graph Data Science (GDS) library
 Home-page: https://neo4j.com/product/graph-data-science/
 Author: Neo4j
@@ -29,9 +29,10 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: multimethod<2.0,>=1.0
-Requires-Dist: neo4j<6.0,>=4.4.2
+Requires-Dist: neo4j<6.0,>=4.4.12
+Requires-Dist: numpy<2.0
 Requires-Dist: pandas<3.0,>=1.0
-Requires-Dist: pyarrow<16.0,>=11.0
+Requires-Dist: pyarrow<17.0,>=14.0.1
 Requires-Dist: textdistance<5.0,>=4.0
 Requires-Dist: tqdm<5.0,>=4.0
 Requires-Dist: typing-extensions<5.0,>=4.0
@@ -141,8 +142,6 @@ The manual is versioned to cover all GDS Python Client versions, so make sure to
 Operations known to not yet work with `graphdatascience`:
 
 * [Numeric utility functions](https://neo4j.com/docs/graph-data-science/current/management-ops/utility-functions/#utility-functions-numeric) (will never be supported)
-* [Cypher on GDS](https://neo4j.com/docs/graph-data-science/current/management-ops/create-cypher-db/) (might be supported in the future)
-* [Projecting graphs using Cypher Aggregation](https://neo4j.com/docs/graph-data-science/current/management-ops/projections/graph-project-cypher-aggregation/) (might be supported in the future)
 
 
 ## License

{graphdatascience-1.10 → graphdatascience-1.11}/README.md

@@ -98,8 +98,6 @@ The manual is versioned to cover all GDS Python Client versions, so make sure to
 Operations known to not yet work with `graphdatascience`:
 
 * [Numeric utility functions](https://neo4j.com/docs/graph-data-science/current/management-ops/utility-functions/#utility-functions-numeric) (will never be supported)
-* [Cypher on GDS](https://neo4j.com/docs/graph-data-science/current/management-ops/create-cypher-db/) (might be supported in the future)
-* [Projecting graphs using Cypher Aggregation](https://neo4j.com/docs/graph-data-science/current/management-ops/projections/graph-project-cypher-aggregation/) (might be supported in the future)
 
 
 ## License

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/call_builder.py

@@ -1,6 +1,6 @@
 from .algo.algo_endpoints import AlgoEndpoints
 from .error.uncallable_namespace import UncallableNamespace
-from .utils.util_endpoints import IndirectUtilAlphaEndpoints
+from .utils.direct_util_endpoints import IndirectUtilAlphaEndpoints
 
 
 class IndirectCallBuilder(AlgoEndpoints, UncallableNamespace):

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/endpoints.py

@@ -23,7 +23,7 @@ from .system.system_endpoints import (
     SystemBetaEndpoints,
 )
 from .topological_lp.topological_lp_endpoints import TopologicalLPAlphaEndpoints
-from .utils.util_endpoints import DirectUtilEndpoints
+from .utils.direct_util_endpoints import DirectUtilEndpoints
 
 """
 This class should inherit endpoint classes that only contain endpoints that can be called directly from
@@ -44,7 +44,7 @@ class DirectEndpoints(
 
 
 """
-This class should inherit endpoint classes that only expose calls of the `gds.beta` namespace.
+This class should inherit endpoint classes that only expose calls of the `gds.alpha` namespace.
 Example of such endpoints: "gds.alpha.listProgress".
 """
 
@@ -65,6 +65,21 @@ class AlphaEndpoints(
         return IndirectAlphaCallBuilder(self._query_runner, f"{self._namespace}.{attr}", self._server_version)
 
 
+class AlphaRemoteEndpoints(
+    GraphAlphaEndpoints,
+    PipelineAlphaEndpoints,
+    ModelAlphaEndpoints,
+    SingleModeAlphaAlgoEndpoints,
+    SystemAlphaEndpoints,
+    AlphaConfigEndpoints,
+):
+    def __init__(self, query_runner: QueryRunner, namespace: str, server_version: ServerVersion):
+        super().__init__(query_runner, namespace, server_version)
+
+    def __getattr__(self, attr: str) -> IndirectAlphaCallBuilder:
+        return IndirectAlphaCallBuilder(self._query_runner, f"{self._namespace}.{attr}", self._server_version)
+
+
 """
 This class should inherit endpoint classes that only expose calls of the `gds.beta` namespace.
 Example of such endpoints:  "gds.beta.listProgress".

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/graph/base_graph_proc_runner.py

@@ -15,12 +15,12 @@ from ..error.uncallable_namespace import UncallableNamespace
 from ..server_version.compatible_with import compatible_with
 from ..server_version.server_version import ServerVersion
 from .graph_entity_ops_runner import (
-    GraphElementPropertyRunner,
     GraphLabelRunner,
     GraphNodePropertiesRunner,
     GraphNodePropertyRunner,
     GraphPropertyRunner,
     GraphRelationshipPropertiesRunner,
+    GraphRelationshipPropertyRunner,
     GraphRelationshipRunner,
     GraphRelationshipsRunner,
 )
@@ -390,9 +390,9 @@ class BaseGraphProcRunner(UncallableNamespace, IllegalAttrChecker):
         return GraphNodePropertiesRunner(self._query_runner, self._namespace, self._server_version)
 
     @property
-    def relationshipProperty(self) -> GraphElementPropertyRunner:
+    def relationshipProperty(self) -> GraphRelationshipPropertyRunner:
         self._namespace += ".relationshipProperty"
-        return GraphElementPropertyRunner(self._query_runner, self._namespace, self._server_version)
+        return GraphRelationshipPropertyRunner(self._query_runner, self._namespace, self._server_version)
 
     @property
     def relationshipProperties(self) -> GraphRelationshipPropertiesRunner:
@@ -517,8 +517,7 @@ class BaseGraphProcRunner(UncallableNamespace, IllegalAttrChecker):
         ).squeeze()
 
     @multimethod
-    def removeNodeProperties(self) -> None:
-        ...
+    def removeNodeProperties(self) -> None: ...
 
     @removeNodeProperties.register
     @graph_type_check

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/graph/graph_cypher_runner.py

@@ -1,6 +1,10 @@
+from __future__ import annotations
+
 import re
 from itertools import chain, zip_longest
-from typing import Any, Optional
+from typing import Any, Dict, Optional
+
+from pandas import Series
 
 from ..caller_base import CallerBase
 from ..query_runner.query_runner import QueryRunner
@@ -41,7 +45,10 @@ class GraphCypherRunner(CallerBase):
 
         GraphCypherRunner._verify_query_ends_with_return_clause(self._namespace, query)
 
-        result = self._query_runner.run_cypher(query, params, database, False).squeeze()
+        result: Optional[Dict[str, Any]] = self._query_runner.run_cypher(query, params, database, False).squeeze()
+
+        if not result:
+            raise ValueError("Projected graph cannot be empty.")
 
         try:
             graph_name = str(result["graphName"])
@@ -50,7 +57,7 @@ class GraphCypherRunner(CallerBase):
                 f"Invalid query, the query must end with the `RETURN {self._namespace}(...)` call: {query}"
             )
 
-        return GraphCreateResult(Graph(graph_name, self._query_runner, self._server_version), result)
+        return GraphCreateResult(Graph(graph_name, self._query_runner, self._server_version), Series(data=result))
 
     __separators = re.compile(r"[,(.]")
 

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/graph/graph_entity_ops_runner.py

@@ -70,13 +70,6 @@ class GraphEntityOpsBaseRunner(UncallableNamespace, IllegalAttrChecker):
         )
 
 
-class GraphElementPropertyRunner(GraphEntityOpsBaseRunner):
-    @compatible_with("stream", min_inclusive=ServerVersion(2, 2, 0))
-    def stream(self, G: Graph, node_properties: str, node_labels: Strings = ["*"], **config: Any) -> DataFrame:
-        self._namespace += ".stream"
-        return self._handle_properties(G, node_properties, node_labels, config)
-
-
 class GraphNodePropertyRunner(GraphEntityOpsBaseRunner):
     @compatible_with("stream", min_inclusive=ServerVersion(2, 2, 0))
     @filter_id_func_deprecation_warning()
@@ -177,7 +170,7 @@ class GraphNodePropertiesRunner(GraphEntityOpsBaseRunner):
         return reduce(add_property, db_node_properties, query_prefix)
 
     @compatible_with("write", min_inclusive=ServerVersion(2, 2, 0))
-    def write(self, G: Graph, node_properties: List[str], node_labels: Strings = ["*"], **config: Any) -> "Series[Any]":
+    def write(self, G: Graph, node_properties: Strings, node_labels: Strings = ["*"], **config: Any) -> "Series[Any]":
         self._namespace += ".write"
         return self._handle_properties(G, node_properties, node_labels, config).squeeze()  # type: ignore
 
@@ -197,6 +190,16 @@ class GraphNodePropertiesRunner(GraphEntityOpsBaseRunner):
         ).squeeze()
 
 
+class GraphRelationshipPropertyRunner(GraphEntityOpsBaseRunner):
+    @compatible_with("stream", min_inclusive=ServerVersion(2, 2, 0))
+    def stream(
+        self, G: Graph, relationship_property: str, relationship_types: Strings = ["*"], **config: Any
+    ) -> DataFrame:
+        self._namespace += ".stream"
+        relationship_types = [relationship_types] if isinstance(relationship_types, str) else relationship_types
+        return self._handle_properties(G, relationship_property, relationship_types, config)
+
+
 class GraphRelationshipPropertiesRunner(GraphEntityOpsBaseRunner):
     @compatible_with("stream", min_inclusive=ServerVersion(2, 2, 0))
     def stream(
@@ -209,6 +212,8 @@ class GraphRelationshipPropertiesRunner(GraphEntityOpsBaseRunner):
     ) -> DataFrame:
         self._namespace += ".stream"
 
+        relationship_types = [relationship_types] if isinstance(relationship_types, str) else relationship_types
+
         result = self._handle_properties(G, relationship_properties, relationship_types, config)
 
         # new format was requested, but the query was run via Cypher

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/graph/graph_remote_proc_runner.py

@@ -5,5 +5,4 @@ from graphdatascience.graph.graph_remote_project_runner import GraphProjectRemot
 class GraphRemoteProcRunner(BaseGraphProcRunner):
     @property
     def project(self) -> GraphProjectRemoteRunner:
-        self._namespace += ".project.remoteDb"
         return GraphProjectRemoteRunner(self._query_runner, self._namespace, self._server_version)

graphdatascience-1.11/graphdatascience/graph/graph_remote_project_runner.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from typing import List, Optional
+
+from ..error.illegal_attr_checker import IllegalAttrChecker
+from ..query_runner.aura_db_query_runner import AuraDbQueryRunner
+from ..server_version.compatible_with import compatible_with
+from .graph_object import Graph
+from graphdatascience.call_parameters import CallParameters
+from graphdatascience.graph.graph_create_result import GraphCreateResult
+from graphdatascience.server_version.server_version import ServerVersion
+
+
+class GraphProjectRemoteRunner(IllegalAttrChecker):
+    @compatible_with("project", min_inclusive=ServerVersion(2, 7, 0))
+    def __call__(
+        self,
+        graph_name: str,
+        query: str,
+        concurrency: int = 4,
+        undirected_relationship_types: Optional[List[str]] = None,
+        inverse_indexed_relationship_types: Optional[List[str]] = None,
+        batch_size: Optional[int] = None,
+    ) -> GraphCreateResult:
+        if inverse_indexed_relationship_types is None:
+            inverse_indexed_relationship_types = []
+        if undirected_relationship_types is None:
+            undirected_relationship_types = []
+
+        arrow_configuration = {}
+        if batch_size is not None:
+            arrow_configuration["batchSize"] = batch_size
+
+        params = CallParameters(
+            graph_name=graph_name,
+            query=query,
+            concurrency=concurrency,
+            undirected_relationship_types=undirected_relationship_types,
+            inverse_indexed_relationship_types=inverse_indexed_relationship_types,
+            arrow_configuration=arrow_configuration,
+        )
+
+        result = self._query_runner.call_procedure(
+            endpoint=AuraDbQueryRunner.GDS_REMOTE_PROJECTION_PROC_NAME,
+            params=params,
+        ).squeeze()
+        return GraphCreateResult(Graph(graph_name, self._query_runner, self._server_version), result)

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/graph_data_science.py

@@ -13,6 +13,7 @@ from .query_runner.neo4j_query_runner import Neo4jQueryRunner
 from .query_runner.query_runner import QueryRunner
 from .server_version.server_version import ServerVersion
 from graphdatascience.graph.graph_proc_runner import GraphProcRunner
+from graphdatascience.utils.util_proc_runner import UtilProcRunner
 
 
 class GraphDataScience(DirectEndpoints, UncallableNamespace):
@@ -44,20 +45,20 @@ class GraphDataScience(DirectEndpoints, UncallableNamespace):
             A username, password pair for database authentication.
         aura_ds : bool, default False
             A flag that indicates that that the client is used to connect
-            to a Neo4j Aura instance.
+            to a Neo4j AuraDS instance.
         database: Optional[str], default None
             The Neo4j database to query against.
         arrow : Union[str, bool], default True
-            Arrow connection information. Either a flag that indicates whether the client should use Apache Arrow
-            for data streaming if it is available on the server. True means discover the connection URI from the server.
-            A connection URI (str) can also be provided.
+            Arrow connection information. This is either a bool or a string.
+            If it is a string, it will be interpreted as a connection URL to a GDS Arrow Server.
+            If it is a bool,
+                True will make the client discover the connection URI to the GDS Arrow server via the Neo4j endpoint,
+                while False will make the client use Bolt for all operations.
         arrow_disable_server_verification : bool, default True
-            A flag that indicates that, if the flight client is connecting with
-            TLS, that it skips server verification. If this is enabled, all
-            other TLS settings are overridden.
+            A flag that overrides other TLS settings and disables server verification for TLS connections.
         arrow_tls_root_certs : Optional[bytes], default None
-            PEM-encoded certificates that are used for the connecting to the
-            Arrow Flight server.
+            PEM-encoded certificates that are used for the connection to the
+            GDS Arrow Flight server.
         bookmarks : Optional[Any], default None
             The Neo4j bookmarks to require a certain state before the next query gets executed.
         """
@@ -81,12 +82,16 @@ class GraphDataScience(DirectEndpoints, UncallableNamespace):
                 None if arrow is True else arrow,
             )
 
-        super().__init__(self._query_runner, "gds", self._server_version)
+        super().__init__(self._query_runner, namespace="gds", server_version=self._server_version)
 
     @property
     def graph(self) -> GraphProcRunner:
         return GraphProcRunner(self._query_runner, f"{self._namespace}.graph", self._server_version)
 
+    @property
+    def util(self) -> UtilProcRunner:
+        return UtilProcRunner(self._query_runner, f"{self._namespace}.util", self._server_version)
+
     @property
     def alpha(self) -> AlphaEndpoints:
         return AlphaEndpoints(self._query_runner, "gds.alpha", self._server_version)

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/model/link_prediction_model.py

@@ -41,5 +41,5 @@ class LPModel(PipelineModel):
             A list of LinkFeatures of the pipeline.
 
         """
-        steps: List[Dict[str, Any]] = self._list_info()["modelInfo"][0]["pipeline"]["featureSteps"]
+        steps: List[Dict[str, Any]] = self._list_info()["modelInfo"]["pipeline"]["featureSteps"]
         return [LinkFeature(s["name"], s["config"]) for s in steps]

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/model/model.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
 from typing import Any, Dict
 
@@ -21,34 +23,32 @@ class Model(ABC):
     def _endpoint_prefix(self) -> str:
         pass
 
-    def _list_info(self) -> DataFrame:
+    def _list_info(self) -> Series[Any]:
+        params = CallParameters(name=self.name())
+
+        result: Series[Any]
         if self._server_version < ServerVersion(2, 5, 0):
-            query = "CALL gds.beta.model.list($name)"
+            result = self._query_runner.call_procedure(
+                "gds.beta.model.list", params=params, custom_error=False
+            ).squeeze()
         else:
-            query = """
-                    CALL gds.model.list($name)
-                    YIELD
-                      modelName, modelType, modelInfo,
-                      creationTime, trainConfig, graphSchema,
-                      loaded, stored, published
-                    RETURN
-                      modelName, modelType,
-                      modelInfo {.*, modelName: modelName, modelType: modelType} AS modelInfo,
-                      creationTime, trainConfig, graphSchema,
-                      loaded, stored, published, published AS shared
-                    """
-
-        params = {"name": self.name()}
-
-        # FIXME use call procedure + do post processing on the client side
-        info = self._query_runner.run_cypher(query, params, custom_error=False)
-
-        if len(info) == 0:
+            result = self._query_runner.call_procedure("gds.model.list", params=params, custom_error=False).squeeze()
+
+            if not result.empty:
+                #  2.5 compat format
+                result["modelInfo"] = {
+                    **result["modelInfo"],
+                    "modelName": result["modelName"],
+                    "modelType": result["modelType"],
+                }
+                result["shared"] = result["published"]
+
+        if result.empty:
             raise ValueError(f"There is no '{self.name()}' in the model catalog")
 
-        return info
+        return result
 
-    def _estimate_predict(self, predict_mode: str, graph_name: str, config: Dict[str, Any]) -> "Series[Any]":
+    def _estimate_predict(self, predict_mode: str, graph_name: str, config: Dict[str, Any]) -> Series[Any]:
         endpoint = f"{self._endpoint_prefix()}{predict_mode}.estimate"
         config["modelName"] = self.name()
         params = CallParameters(graph_name=graph_name, config=config)
@@ -76,9 +76,9 @@ class Model(ABC):
             The type of the model.
 
         """
-        return self._list_info()["modelInfo"][0]["modelType"]  # type: ignore
+        return self._list_info()["modelInfo"]["modelType"]  # type: ignore
 
-    def train_config(self) -> "Series[Any]":
+    def train_config(self) -> Series[Any]:
         """
         Get the train config of the model.
 
@@ -86,10 +86,10 @@ class Model(ABC):
             The train config of the model.
 
         """
-        train_config: "Series[Any]" = Series(self._list_info()["trainConfig"][0])
+        train_config: Series[Any] = Series(self._list_info()["trainConfig"])
         return train_config
 
-    def graph_schema(self) -> "Series[Any]":
+    def graph_schema(self) -> Series[Any]:
         """
         Get the graph schema of the model.
 
@@ -97,7 +97,7 @@ class Model(ABC):
             The graph schema of the model.
 
         """
-        graph_schema: "Series[Any]" = Series(self._list_info()["graphSchema"][0])
+        graph_schema: Series[Any] = Series(self._list_info()["graphSchema"])
         return graph_schema
 
     def loaded(self) -> bool:
@@ -108,7 +108,7 @@ class Model(ABC):
             True if the model is loaded in memory, False otherwise.
 
         """
-        return self._list_info()["loaded"].squeeze()  # type: ignore
+        return self._list_info()["loaded"]  # type: ignore
 
     def stored(self) -> bool:
         """
@@ -118,7 +118,7 @@ class Model(ABC):
             True if the model is stored on disk, False otherwise.
 
         """
-        return self._list_info()["stored"].squeeze()  # type: ignore
+        return self._list_info()["stored"]  # type: ignore
 
     def creation_time(self) -> Any:  # neo4j.time.DateTime not exported
         """
@@ -128,7 +128,7 @@ class Model(ABC):
             The creation time of the model.
 
         """
-        return self._list_info()["creationTime"].squeeze()
+        return self._list_info()["creationTime"]
 
     def shared(self) -> bool:
         """
@@ -138,7 +138,7 @@ class Model(ABC):
             True if the model is shared, False otherwise.
 
         """
-        return self._list_info()["shared"].squeeze()  # type: ignore
+        return self._list_info()["shared"]  # type: ignore
 
     @compatible_with("published", min_inclusive=ServerVersion(2, 5, 0))
     def published(self) -> bool:
@@ -149,9 +149,9 @@ class Model(ABC):
             True if the model is published, False otherwise.
 
         """
-        return self._list_info()["published"].squeeze()  # type: ignore
+        return self._list_info()["published"]  # type: ignore
 
-    def model_info(self) -> "Series[Any]":
+    def model_info(self) -> Dict[str, Any]:
         """
         Get the model info of the model.
 
@@ -159,7 +159,7 @@ class Model(ABC):
             The model info of the model.
 
         """
-        return Series(self._list_info()["modelInfo"].squeeze())
+        return Series(self._list_info()["modelInfo"])  # type: ignore
 
     def exists(self) -> bool:
         """
@@ -179,7 +179,7 @@ class Model(ABC):
             endpoint=endpoint, params=params, yields=yields, custom_error=False
         ).squeeze()
 
-    def drop(self, failIfMissing: bool = False) -> "Series[Any]":
+    def drop(self, failIfMissing: bool = False) -> Series[Any]:
         """
         Drop the model.
 
@@ -190,27 +190,29 @@ class Model(ABC):
             The result of the drop operation.
 
         """
+        params = CallParameters(model_name=self._name, fail_if_missing=failIfMissing)
         if self._server_version < ServerVersion(2, 5, 0):
-            query = "CALL gds.beta.model.drop($model_name, $fail_if_missing)"
+            return self._query_runner.call_procedure(  # type: ignore
+                "gds.beta.model.drop", params=params, custom_error=False
+            ).squeeze()
         else:
-            query = """
-                    CALL gds.model.drop($model_name, $fail_if_missing)
-                    YIELD
-                      modelName, modelType, modelInfo,
-                      creationTime, trainConfig, graphSchema,
-                      loaded, stored, published
-                    RETURN
-                      modelName, modelType,
-                      modelInfo {.*, modelName: modelName, modelType: modelType} AS modelInfo,
-                      creationTime, trainConfig, graphSchema,
-                      loaded, stored, published, published AS shared
-                    """
-
-        params = {"model_name": self._name, "fail_if_missing": failIfMissing}
-        # FIXME use call procedure + do post processing on the client side
-        return self._query_runner.run_cypher(query, params, custom_error=False).squeeze()  # type: ignore
-
-    def metrics(self) -> "Series[Any]":
+            result: Series[Any] = self._query_runner.call_procedure(
+                "gds.model.drop", params=params, custom_error=False
+            ).squeeze()
+
+            if result.empty:
+                return result
+
+            #  modelInfo {.*, modelName: modelName, modelType: modelType} AS modelInfo
+            result["modelInfo"] = {
+                **result["modelInfo"],
+                "modelName": result["modelName"],
+                "modelType": result["modelType"],
+            }
+            result["shared"] = result["published"]
+            return result
+
+    def metrics(self) -> Series[Any]:
         """
         Get the metrics of the model.
 
@@ -218,8 +220,8 @@ class Model(ABC):
             The metrics of the model.
 
         """
-        model_info = self._list_info()["modelInfo"][0]
-        metrics: "Series[Any]" = Series(model_info["metrics"])
+        model_info = self._list_info()["modelInfo"]
+        metrics: Series[Any] = Series(model_info["metrics"])
         return metrics
 
     @graph_type_check
@@ -242,7 +244,7 @@ class Model(ABC):
         return self._query_runner.call_procedure(endpoint=endpoint, params=params, logging=True)
 
     @graph_type_check
-    def predict_stream_estimate(self, G: Graph, **config: Any) -> "Series[Any]":
+    def predict_stream_estimate(self, G: Graph, **config: Any) -> Series[Any]:
         """
         Estimate the prediction on the given graph using the model and stream the results as DataFrame
 
@@ -257,7 +259,7 @@ class Model(ABC):
         return self._estimate_predict("stream", G.name(), config)
 
     @graph_type_check
-    def predict_mutate(self, G: Graph, **config: Any) -> "Series[Any]":
+    def predict_mutate(self, G: Graph, **config: Any) -> Series[Any]:
         """
         Predict on the given graph using the model and mutate the graph with the results.
 
@@ -278,7 +280,7 @@ class Model(ABC):
         ).squeeze()
 
     @graph_type_check
-    def predict_mutate_estimate(self, G: Graph, **config: Any) -> "Series[Any]":
+    def predict_mutate_estimate(self, G: Graph, **config: Any) -> Series[Any]:
         """
         Estimate the memory needed to predict on the given graph using the model.
 

{graphdatascience-1.10 → graphdatascience-1.11}/graphdatascience/model/model_proc_runner.py

@@ -1,4 +1,6 @@
-from typing import Any, Dict, List, Optional, Tuple
+from __future__ import annotations
+
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 from pandas import DataFrame, Series
 
@@ -49,23 +51,29 @@ class TransECreator(UncallableNamespace, IllegalAttrChecker):
 class ModelProcRunner(ModelResolver):
     @client_only_endpoint("gds.model")
     def get(self, model_name: str) -> Model:
+        params = CallParameters(model_name=model_name)
         if self._server_version < ServerVersion(2, 5, 0):
-            query = "CALL gds.beta.model.list($model_name) YIELD modelInfo RETURN modelInfo.modelType AS modelType"
+            endpoint = "gds.beta.model.list"
+            yields = ["modelInfo"]
+            result_25: Series[Any] = self._query_runner.call_procedure(
+                endpoint=endpoint, params=params, yields=yields, custom_error=False
+            ).squeeze()
+            model_type = str(result_25["modelInfo"]["modelType"]) if not result_25.empty else None
         else:
-            query = "CALL gds.model.list($model_name) YIELD modelType"
-
-        params = {"model_name": model_name}
-        # FIXME use call procedure + do post processing on the client side
-        result = self._query_runner.run_cypher(query, params, custom_error=False)
-
-        if len(result) == 0:
+            endpoint = "gds.model.list"
+            yields = ["modelType"]
+            result: Union[str, Series[Any]] = self._query_runner.call_procedure(
+                endpoint=endpoint, params=params, yields=yields, custom_error=False
+            ).squeeze()
+            model_type = result if isinstance(result, str) else None
+
+        if model_type is None:
             raise ValueError(f"No loaded model named '{model_name}' exists")
 
-        model_type = str(result["modelType"].squeeze())
         return self._resolve_model(model_type, model_name)
 
     @compatible_with("store", min_inclusive=ServerVersion(2, 5, 0))
-    def store(self, model: Model, failIfUnsupportedType: bool = True) -> "Series[Any]":
+    def store(self, model: Model, failIfUnsupportedType: bool = True) -> Series[Any]:
         self._namespace += ".store"
         params = CallParameters(model_name=model.name(), fail_flag=failIfUnsupportedType)
 
@@ -88,7 +96,7 @@ class ModelProcRunner(ModelResolver):
         return self._resolve_model(model_type, model_name)
 
     @compatible_with("load", min_inclusive=ServerVersion(2, 5, 0))
-    def load(self, model_name: str) -> Tuple[Model, "Series[Any]"]:
+    def load(self, model_name: str) -> Tuple[Model, Series[Any]]:
         self._namespace += ".load"
 
         params = CallParameters(model_name=model_name)
@@ -101,7 +109,7 @@ class ModelProcRunner(ModelResolver):
         return proc_runner.get(result["modelName"]), result
 
     @compatible_with("delete", min_inclusive=ServerVersion(2, 5, 0))
-    def delete(self, model: Model) -> "Series[Any]":
+    def delete(self, model: Model) -> Series[Any]:
         self._namespace += ".delete"
         params = CallParameters(model_name=model.name())
         return self._query_runner.call_procedure(endpoint=self._namespace, params=params).squeeze()  # type: ignore
@@ -117,7 +125,7 @@ class ModelProcRunner(ModelResolver):
         return self._query_runner.call_procedure(endpoint=self._namespace, params=params)
 
     @compatible_with("exists", min_inclusive=ServerVersion(2, 5, 0))
-    def exists(self, model_name: str) -> "Series[Any]":
+    def exists(self, model_name: str) -> Series[Any]:
         self._namespace += ".exists"
 
         return self._query_runner.call_procedure(  # type: ignore
@@ -125,7 +133,7 @@ class ModelProcRunner(ModelResolver):
         ).squeeze()
 
     @compatible_with("drop", min_inclusive=ServerVersion(2, 5, 0))
-    def drop(self, model: Model) -> "Series[Any]":
+    def drop(self, model: Model) -> Series[Any]:
         self._namespace += ".drop"
 
         return self._query_runner.call_procedure(  # type: ignore