graphdatascience 1.18__tar.gz → 1.19__tar.gz

{graphdatascience-1.18/src/graphdatascience.egg-info → graphdatascience-1.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graphdatascience
-Version: 1.18
+Version: 1.19
 Summary: A Python client for the Neo4j Graph Data Science (GDS) library
 Author-email: Neo4j <team-gds@neo4j.org>
 License-Expression: Apache-2.0

{graphdatascience-1.18 → graphdatascience-1.19}/pyproject.toml

@@ -62,41 +62,40 @@ dev = [
     { include-group = "docs-ci" },
 ]
 
-
 dev-base = [
-    "ruff == 0.11.7",
-    "mypy == 1.13.0",
-    "nbconvert == 7.16.4",
+    "ruff == 0.14.11",
+    "mypy == 1.19.1",
     "pandas-stubs == 2.2.3.241009",
-    "tox == 4.30.2",
+    "tox == 4.34.1",
     "types-setuptools == 75.8.0.20250110",
     "enum-tools[sphinx] == 0.12.0",
     "autodoc_pydantic",
     "types-requests",
     "types-tqdm",
     "types-python-dateutil",
-    "python-dotenv==1.1.0",
+    "python-dotenv==1.2.1",
     "types-colorama",
 ]
 test = [
-    "pytest == 8.3.3",
-    "requests_mock == 1.11.0",
+    "pytest == 9.0.2",
+    "requests_mock == 1.12.1",
     "pytest_mock == 3.15.1",
-    "testcontainers >= 4.0, < 4.13.0",
+    "testcontainers == 4.14.0",
     "python-dateutil >= 2.9",
 ]
+
 docs-ci = [
     "sphinx == 7.3.7",
     "enum-tools[sphinx] == 0.12.0",
     "autodoc_pydantic",
 ]
 notebook-base = [
-    "nbconvert==7.16.4",
+    "nbconvert==7.16.6",
     "nbformat==5.10.4",
-    "nbclient==0.10.2",
-    "ipykernel==6.29.5",
+    "nbclient==0.10.4",
+    "ipykernel==7.1.0",
 ]
-notebook-aura-ci = [{ include-group = "notebook-base" }, "python-dotenv==1.1.0"]
+notebook-aura-ci = [{ include-group = "notebook-base" }, "python-dotenv==1.2.1"]
 notebook-ci = [
     { include-group = "notebook-base" },
     "scipy == 1.14.0",

graphdatascience-1.19/src/graphdatascience/arrow_client/arrow_client_options_util.py

@@ -0,0 +1,13 @@
+from typing import Any
+
+TLS_ROOT_CERTS_OPTION = "tls_root_certs"
+
+
+def disable_server_verification(arrow_client_options: dict[str, Any]) -> dict[str, Any]:
+    arrow_client_options["disable_server_verification"] = True
+    return arrow_client_options
+
+
+def set_tls_root_certs(arrow_client_options: dict[str, Any], tls_root_certs: bytes | str) -> dict[str, Any]:
+    arrow_client_options[TLS_ROOT_CERTS_OPTION] = tls_root_certs
+    return arrow_client_options

{graphdatascience-1.18 → graphdatascience-1.19}/src/graphdatascience/arrow_client/authenticated_flight_client.py

@@ -26,6 +26,7 @@ from graphdatascience.arrow_client.arrow_info import ArrowInfo
 from graphdatascience.retry_utils.retry_config import ExponentialWaitConfig, RetryConfigV2, StopConfig
 
 from ..version import __version__
+from .arrow_client_options_util import TLS_ROOT_CERTS_OPTION, set_tls_root_certs
 from .middleware.auth_middleware import AuthFactory, AuthMiddleware
 from .middleware.user_agent_middleware import UserAgentFactory
 
@@ -220,8 +221,8 @@ class AuthenticatedArrowClient:
 
         # We need to specify the system root certificates on Windows
         if platform.system() == "Windows":
-            if not client_options["tls_root_certs"]:
-                client_options["tls_root_certs"] = certifi.contents()
+            if TLS_ROOT_CERTS_OPTION not in client_options:
+                set_tls_root_certs(client_options, certifi.contents())
 
         if self._auth:
             user_agent = f"neo4j-graphdatascience-v{__version__} pyarrow-v{arrow_version}"

{graphdatascience-1.18 → graphdatascience-1.19}/src/graphdatascience/arrow_client/v1/gds_arrow_client.py

@@ -2,13 +2,11 @@ from __future__ import annotations
 
 import json
 import logging
-import re
 from types import TracebackType
 from typing import Any, Callable, Iterable, Type
 
 import pandas
 import pyarrow
-from neo4j.exceptions import ClientError
 from pyarrow import Array, ChunkedArray, DictionaryArray, RecordBatch, Table, chunked_array, flight
 from pyarrow.types import is_dictionary
 from pydantic import BaseModel
@@ -17,6 +15,7 @@ from graphdatascience.arrow_client.arrow_endpoint_version import ArrowEndpointVe
 from graphdatascience.arrow_client.authenticated_flight_client import AuthenticatedArrowClient, ConnectionInfo
 from graphdatascience.arrow_client.v1.data_mapper_utils import deserialize_single
 
+from ...procedure_surface.arrow.error_handler import handle_flight_error
 from ...semantic_version.semantic_version import SemanticVersion
 
 
@@ -515,7 +514,7 @@ class GdsArrowClient:
                     ack_stream.read()
                     progress_callback(partition.num_rows)
         except Exception as e:
-            GdsArrowClient.handle_flight_error(e)
+            handle_flight_error(e)
 
     def _get_data(
         self,
@@ -560,7 +559,7 @@ class GdsArrowClient:
         try:
             arrow_table = get.read_all()
         except Exception as e:
-            GdsArrowClient.handle_flight_error(e)
+            handle_flight_error(e)
         arrow_table = self._sanitize_arrow_table(arrow_table)
         if SemanticVersion.from_string(pandas.__version__) >= SemanticVersion(2, 0, 0):
             return arrow_table.to_pandas(types_mapper=pandas.ArrowDtype)  # type: ignore
@@ -615,26 +614,6 @@ class GdsArrowClient:
         else:
             return array
 
-    @staticmethod
-    def handle_flight_error(e: Exception) -> None:
-        if isinstance(e, flight.FlightServerError | flight.FlightInternalError | ClientError):
-            original_message = e.args[0] if len(e.args) > 0 else e.message
-            improved_message = original_message.replace(
-                "Flight RPC failed with message: org.apache.arrow.flight.FlightRuntimeException: ", ""
-            )
-            improved_message = improved_message.replace(
-                "Flight returned internal error, with message: org.apache.arrow.flight.FlightRuntimeException: ", ""
-            )
-            improved_message = improved_message.replace(
-                "Failed to invoke procedure `gds.arrow.project`: Caused by: org.apache.arrow.flight.FlightRuntimeException: ",
-                "",
-            )
-            improved_message = re.sub(r"(\. )?gRPC client debug context: .+$", "", improved_message)
-
-            raise flight.FlightServerError(improved_message)
-        else:
-            raise e
-
 
 class NodeLoadDoneResult(BaseModel):
     name: str

{graphdatascience-1.18 → graphdatascience-1.19}/src/graphdatascience/arrow_client/v2/api_types.py

@@ -34,13 +34,13 @@ class JobStatus(ArrowBaseModel):
         return None
 
     def aborted(self) -> bool:
-        return self.status == "Aborted"
+        return self.status.lower() == "aborted"
 
     def succeeded(self) -> bool:
-        return self.status == "Done"
+        return self.status.lower() == "done"
 
     def running(self) -> bool:
-        return self.status == "Running"
+        return self.status.lower() == "running"
 
 
 class MutateResult(ArrowBaseModel):

{graphdatascience-1.18 → graphdatascience-1.19}/src/graphdatascience/arrow_client/v2/gds_arrow_client.py

@@ -93,7 +93,7 @@ class GdsArrowClient:
         job_id: str | None = None,
     ) -> str:
         """
-        Start a new export process to stream the nodes with the specified label and filter from the graph.
+        Start a new export process to stream the nodes that match the filter from the graph.
 
         Parameters
         ----------

{graphdatascience-1.18 → graphdatascience-1.19}/src/graphdatascience/arrow_client/v2/job_client.py

@@ -3,13 +3,14 @@ from typing import Any
 
 from pandas import ArrowDtype, DataFrame
 from pyarrow._flight import Ticket
-from tenacity import Retrying, retry_if_result, wait_exponential
+from tenacity import Retrying, retry_if_result
 
 from graphdatascience.arrow_client.authenticated_flight_client import AuthenticatedArrowClient
 from graphdatascience.arrow_client.v2.api_types import JobIdConfig, JobStatus
 from graphdatascience.arrow_client.v2.data_mapper_utils import deserialize_single
 from graphdatascience.query_runner.progress.progress_bar import TqdmProgressBar
 from graphdatascience.query_runner.termination_flag import TerminationFlag
+from graphdatascience.retry_utils.retry_utils import job_wait_strategy
 
 JOB_STATUS_ENDPOINT = "v2/jobs.status"
 RESULTS_SUMMARY_ENDPOINT = "v2/results.summary"
@@ -50,12 +51,9 @@ class JobClient:
         if termination_flag is None:
             termination_flag = TerminationFlag.create()
 
-        for attempt in Retrying(
-            retry=retry_if_result(lambda _: True), wait=wait_exponential(min=0.1, max=5), reraise=True
-        ):
+        for attempt in Retrying(retry=retry_if_result(lambda _: True), wait=job_wait_strategy(), reraise=True):
             with attempt:
                 termination_flag.assert_running()
-
                 job_status = self.get_job_status(client, job_id)
 
                 if check_expected_status(job_status) or job_status.aborted():

{graphdatascience-1.18 → graphdatascience-1.19}/src/graphdatascience/graph_data_science.py

@@ -13,6 +13,7 @@ from graphdatascience.query_runner.arrow_authentication import UsernamePasswordA
 from graphdatascience.query_runner.query_mode import QueryMode
 from graphdatascience.topological_lp.topological_lp_runner import TopologicalLPRunner
 
+from .arrow_client.arrow_client_options_util import disable_server_verification, set_tls_root_certs
 from .call_builder import IndirectCallBuilder
 from .endpoints import AlphaEndpoints, BetaEndpoints, DirectEndpoints
 from .error.uncallable_namespace import UncallableNamespace
@@ -121,9 +122,9 @@ class GraphDataScience(DirectEndpoints, UncallableNamespace):
             if arrow_client_options is None:
                 arrow_client_options = {}
             if arrow_disable_server_verification:
-                arrow_client_options["disable_server_verification"] = True
+                disable_server_verification(arrow_client_options)
             if arrow_tls_root_certs is not None:
-                arrow_client_options["tls_root_certs"] = arrow_tls_root_certs
+                set_tls_root_certs(arrow_client_options, arrow_tls_root_certs)
             self._query_runner = ArrowQueryRunner.create(
                 self._query_runner,
                 arrow_info=arrow_info,

{graphdatascience-1.18 → graphdatascience-1.19}/src/graphdatascience/plugin_v2_endpoints.py

@@ -3,6 +3,7 @@ from graphdatascience.procedure_surface.api.catalog.scale_properties_endpoints i
 from graphdatascience.procedure_surface.api.centrality.articlerank_endpoints import ArticleRankEndpoints
 from graphdatascience.procedure_surface.api.centrality.articulationpoints_endpoints import ArticulationPointsEndpoints
 from graphdatascience.procedure_surface.api.centrality.betweenness_endpoints import BetweennessEndpoints
+from graphdatascience.procedure_surface.api.centrality.bridges_endpoints import BridgesEndpoints
 from graphdatascience.procedure_surface.api.centrality.celf_endpoints import CelfEndpoints
 from graphdatascience.procedure_surface.api.centrality.closeness_endpoints import ClosenessEndpoints
 from graphdatascience.procedure_surface.api.centrality.closeness_harmonic_endpoints import ClosenessHarmonicEndpoints
@@ -22,6 +23,7 @@ from graphdatascience.procedure_surface.api.community.local_clustering_coefficie
 )
 from graphdatascience.procedure_surface.api.community.louvain_endpoints import LouvainEndpoints
 from graphdatascience.procedure_surface.api.community.maxkcut_endpoints import MaxKCutEndpoints
+from graphdatascience.procedure_surface.api.community.modularity_endpoints import ModularityEndpoints
 from graphdatascience.procedure_surface.api.community.modularity_optimization_endpoints import (
     ModularityOptimizationEndpoints,
 )
@@ -30,11 +32,13 @@ from graphdatascience.procedure_surface.api.community.sllpa_endpoints import Sll
 from graphdatascience.procedure_surface.api.community.triangle_count_endpoints import TriangleCountEndpoints
 from graphdatascience.procedure_surface.api.community.wcc_endpoints import WccEndpoints
 from graphdatascience.procedure_surface.api.config_endpoints import ConfigEndpoints
+from graphdatascience.procedure_surface.api.model.model_catalog_endpoints import ModelCatalogEndpoints
 from graphdatascience.procedure_surface.api.node_embedding.fastrp_endpoints import FastRPEndpoints
 from graphdatascience.procedure_surface.api.node_embedding.graphsage_endpoints import GraphSageEndpoints
 from graphdatascience.procedure_surface.api.node_embedding.hashgnn_endpoints import HashGNNEndpoints
 from graphdatascience.procedure_surface.api.node_embedding.node2vec_endpoints import Node2VecEndpoints
 from graphdatascience.procedure_surface.api.pathfinding.all_shortest_path_endpoints import AllShortestPathEndpoints
+from graphdatascience.procedure_surface.api.pathfinding.bfs_endpoints import BFSEndpoints
 from graphdatascience.procedure_surface.api.pathfinding.dag_endpoints import DagEndpoints
 from graphdatascience.procedure_surface.api.pathfinding.k_spanning_tree_endpoints import KSpanningTreeEndpoints
 from graphdatascience.procedure_surface.api.pathfinding.max_flow_endpoints import MaxFlowEndpoints
@@ -57,6 +61,7 @@ from graphdatascience.procedure_surface.cypher.centrality.articulationpoints_cyp
     ArticulationPointsCypherEndpoints,
 )
 from graphdatascience.procedure_surface.cypher.centrality.betweenness_cypher_endpoints import BetweennessCypherEndpoints
+from graphdatascience.procedure_surface.cypher.centrality.bridges_cypher_endpoints import BridgesCypherEndpoints
 from graphdatascience.procedure_surface.cypher.centrality.celf_cypher_endpoints import CelfCypherEndpoints
 from graphdatascience.procedure_surface.cypher.centrality.closeness_cypher_endpoints import ClosenessCypherEndpoints
 from graphdatascience.procedure_surface.cypher.centrality.closeness_harmonic_cypher_endpoints import (
@@ -82,6 +87,7 @@ from graphdatascience.procedure_surface.cypher.community.local_clustering_coeffi
 )
 from graphdatascience.procedure_surface.cypher.community.louvain_cypher_endpoints import LouvainCypherEndpoints
 from graphdatascience.procedure_surface.cypher.community.maxkcut_cypher_endpoints import MaxKCutCypherEndpoints
+from graphdatascience.procedure_surface.cypher.community.modularity_cypher_endpoints import ModularityCypherEndpoints
 from graphdatascience.procedure_surface.cypher.community.modularity_optimization_cypher_endpoints import (
     ModularityOptimizationCypherEndpoints,
 )
@@ -92,6 +98,9 @@ from graphdatascience.procedure_surface.cypher.community.triangle_count_cypher_e
 )
 from graphdatascience.procedure_surface.cypher.community.wcc_cypher_endpoints import WccCypherEndpoints
 from graphdatascience.procedure_surface.cypher.config_cypher_endpoints import ConfigCypherEndpoints
+from graphdatascience.procedure_surface.cypher.model.model_catalog_cypher_endpoints import (
+    ModelCatalogCypherEndpoints,
+)
 from graphdatascience.procedure_surface.cypher.node_embedding.fastrp_cypher_endpoints import FastRPCypherEndpoints
 from graphdatascience.procedure_surface.cypher.node_embedding.graphsage_predict_cypher_endpoints import (
     GraphSagePredictCypherEndpoints,
@@ -104,6 +113,7 @@ from graphdatascience.procedure_surface.cypher.node_embedding.node2vec_cypher_en
 from graphdatascience.procedure_surface.cypher.pathfinding.all_shortest_path_cypher_endpoints import (
     AllShortestPathCypherEndpoints,
 )
+from graphdatascience.procedure_surface.cypher.pathfinding.bfs_cypher_endpoints import BFSCypherEndpoints
 from graphdatascience.procedure_surface.cypher.pathfinding.dag_cypher_endpoints import DagCypherEndpoints
 from graphdatascience.procedure_surface.cypher.pathfinding.k_spanning_tree_cypher_endpoints import (
     KSpanningTreeCypherEndpoints,
@@ -147,6 +157,13 @@ class PluginV2Endpoints:
         """
         return CatalogCypherEndpoints(self._db_client, self._arrow_client)
 
+    @property
+    def model(self) -> ModelCatalogEndpoints:
+        """
+        Return model-related endpoints for model management.
+        """
+        return ModelCatalogCypherEndpoints(self._db_client)
+
     @property
     def config(self) -> ConfigEndpoints:
         """
@@ -177,6 +194,13 @@ class PluginV2Endpoints:
         """
         return ArticleRankCypherEndpoints(self._db_client)
 
+    @property
+    def bfs(self) -> BFSEndpoints:
+        """
+        Return endpoints for the Breadth First Search (BFS) algorithm.
+        """
+        return BFSCypherEndpoints(self._db_client)
+
     @property
     def articulation_points(self) -> ArticulationPointsEndpoints:
         """
@@ -191,6 +215,13 @@ class PluginV2Endpoints:
         """
         return BetweennessCypherEndpoints(self._db_client)
 
+    @property
+    def bridges(self) -> BridgesEndpoints:
+        """
+        Return endpoints for the bridges algorithm.
+        """
+        return BridgesCypherEndpoints(self._db_client)
+
     @property
     def bellman_ford(self) -> SingleSourceBellmanFordEndpoints:
         """
@@ -362,6 +393,13 @@ class PluginV2Endpoints:
         """
         return MaxKCutCypherEndpoints(self._db_client)
 
+    @property
+    def modularity(self) -> ModularityEndpoints:
+        """
+        Return endpoints for the modularity algorithm.
+        """
+        return ModularityCypherEndpoints(self._db_client)
+
     @property
     def modularity_optimization(self) -> ModularityOptimizationEndpoints:
         """

{graphdatascience-1.18 → graphdatascience-1.19}/src/graphdatascience/procedure_surface/api/catalog/catalog_endpoints.py

@@ -16,6 +16,22 @@ from graphdatascience.procedure_surface.api.catalog.relationships_endpoints impo
 
 
 class CatalogEndpoints(ABC):
+    @abstractmethod
+    def get(self, graph_name: str) -> GraphV2:
+        """Retrieve a handle to a graph from the graph catalog.
+
+        Parameters
+        ----------
+        graph_name
+            The name of the graph.
+
+        Returns
+        -------
+        GraphV2
+            A handle to the graph.
+        """
+        pass
+
     @abstractmethod
     def construct(
         self,

graphdatascience-1.19/src/graphdatascience/procedure_surface/api/centrality/bridges_endpoints.py

@@ -0,0 +1,82 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+from pandas import DataFrame
+
+from graphdatascience.procedure_surface.api.catalog.graph_api import GraphV2
+from graphdatascience.procedure_surface.api.default_values import ALL_LABELS, ALL_TYPES
+from graphdatascience.procedure_surface.api.estimation_result import EstimationResult
+
+
+class BridgesEndpoints(ABC):
+    @abstractmethod
+    def stream(
+        self,
+        G: GraphV2,
+        relationship_types: list[str] = ALL_TYPES,
+        node_labels: list[str] = ALL_LABELS,
+        sudo: bool = False,
+        log_progress: bool = True,
+        username: str | None = None,
+        concurrency: int | None = None,
+        job_id: str | None = None,
+    ) -> DataFrame:
+        """
+        Executes the Bridges algorithm and returns a stream of results.
+
+        Parameters
+        ----------
+        G
+           Graph object to use
+        relationship_types
+            Filter the graph using the given relationship types. Relationships with any of the given types will be included.
+        node_labels
+            Filter the graph using the given node labels. Nodes with any of the given labels will be included.
+        sudo
+            Disable the memory guard.
+        log_progress
+            Display progress logging.
+        username
+            As an administrator, impersonate a different user for accessing their graphs.
+        concurrency
+            Number of concurrent threads to use.
+        job_id
+            Identifier for the computation.
+
+        Returns
+        -------
+        DataFrame
+            DataFrame with 'from', 'to' and 'remainingSizes' columns. The remainingSizes column contains the sizes of the remaining connected components after removing the bridge relationship.
+        """
+        pass
+
+    @abstractmethod
+    def estimate(
+        self,
+        G: GraphV2 | dict[str, Any],
+        relationship_types: list[str] = ALL_TYPES,
+        node_labels: list[str] = ALL_LABELS,
+        concurrency: int | None = None,
+    ) -> EstimationResult:
+        """
+        Estimate the memory consumption of an algorithm run.
+
+        Parameters
+        ----------
+        G
+           Graph object to use or a dictionary representing the graph dimensions.
+        relationship_types
+            Filter the graph using the given relationship types. Relationships with any of the given types will be included.
+        node_labels
+            Filter the graph using the given node labels. Nodes with any of the given labels will be included.
+        concurrency
+            Number of concurrent threads to use.
+
+        Returns
+        -------
+        EstimationResult
+            Memory estimation details
+        """
+        pass

graphdatascience-1.19/src/graphdatascience/procedure_surface/api/community/modularity_endpoints.py

@@ -0,0 +1,160 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any
+
+from pandas import DataFrame
+
+from graphdatascience.procedure_surface.api.base_result import BaseResult
+from graphdatascience.procedure_surface.api.catalog.graph_api import GraphV2
+from graphdatascience.procedure_surface.api.default_values import ALL_LABELS, ALL_TYPES
+from graphdatascience.procedure_surface.api.estimation_result import EstimationResult
+
+
+class ModularityEndpoints(ABC):
+    @abstractmethod
+    def stats(
+        self,
+        G: GraphV2,
+        community_property: str,
+        *,
+        concurrency: int | None = None,
+        job_id: str | None = None,
+        log_progress: bool = True,
+        node_labels: list[str] = ALL_LABELS,
+        relationship_types: list[str] = ALL_TYPES,
+        relationship_weight_property: str | None = None,
+        sudo: bool = False,
+        username: str | None = None,
+    ) -> ModularityStatsResult:
+        """
+        Executes the Modularity algorithm and returns statistics.
+
+        Parameters
+        ----------
+        G
+            Graph object to use
+        community_property
+            Name of the node property containing community assignments.
+        concurrency
+            Number of concurrent threads to use.
+        job_id
+            Identifier for the computation.
+        log_progress
+            Display progress logging.
+        node_labels
+            Filter the graph using the given node labels. Nodes with any of the given labels will be included.
+        relationship_types
+            Filter the graph using the given relationship types. Relationships with any of the given types will be included.
+        relationship_weight_property
+            Name of the property to be used as weights.
+        sudo
+            Disable the memory guard.
+        username
+            As an administrator, impersonate a different user for accessing their graphs.
+
+        Returns
+        -------
+        ModularityStatsResult
+            Algorithm statistics including communityCount, modularity, nodeCount, and relationshipCount
+        """
+        pass
+
+    @abstractmethod
+    def stream(
+        self,
+        G: GraphV2,
+        community_property: str,
+        *,
+        concurrency: int | None = None,
+        job_id: str | None = None,
+        log_progress: bool = True,
+        node_labels: list[str] = ALL_LABELS,
+        relationship_types: list[str] = ALL_TYPES,
+        relationship_weight_property: str | None = None,
+        sudo: bool = False,
+        username: str | None = None,
+    ) -> DataFrame:
+        """
+        Executes the Modularity algorithm and returns a stream of results.
+
+        Parameters
+        ----------
+        G
+            Graph object to use
+        community_property
+            Name of the node property containing community assignments.
+        concurrency
+            Number of concurrent threads to use.
+        job_id
+            Identifier for the computation.
+        log_progress
+            Display progress logging.
+        node_labels
+            Filter the graph using the given node labels. Nodes with any of the given labels will be included.
+        relationship_types
+            Filter the graph using the given relationship types. Relationships with any of the given types will be included.
+        relationship_weight_property
+            Name of the property to be used as weights.
+        sudo
+            Disable the memory guard.
+        username
+            As an administrator, impersonate a different user for accessing their graphs.
+
+        Returns
+        -------
+        DataFrame
+            DataFrame with the algorithm results containing 'communityId' and 'modularity' columns
+        """
+        pass
+
+    @abstractmethod
+    def estimate(
+        self,
+        G: GraphV2 | dict[str, Any],
+        community_property: str,
+        *,
+        concurrency: int | None = None,
+        node_labels: list[str] = ALL_LABELS,
+        relationship_types: list[str] = ALL_TYPES,
+        relationship_weight_property: str | None = None,
+    ) -> EstimationResult:
+        """
+        Estimate the memory consumption of the modularity algorithm.
+
+        Parameters
+        ----------
+        G
+            Graph object to use or a dictionary representing the graph dimensions.
+        community_property
+            Name of the node property containing community assignments.
+        concurrency
+            Number of concurrent threads to use.
+        node_labels
+            Filter the graph using the given node labels. Nodes with any of the given labels will be included.
+        relationship_types
+            Filter the graph using the given relationship types. Relationships with any of the given types will be included.
+        relationship_weight_property
+            Name of the property to be used as weights.
+
+        Returns
+        -------
+        EstimationResult
+            An object containing the result of the estimation
+        """
+        pass
+
+
+class ModularityStatsResult(BaseResult):
+    """
+    Result object for the modularity stats algorithm.
+    """
+
+    community_count: int
+    modularity: float
+    node_count: int
+    relationship_count: int
+    pre_processing_millis: int
+    compute_millis: int
+    post_processing_millis: int
+    configuration: dict[str, Any]

graphdatascience-1.19/src/graphdatascience/procedure_surface/api/model/__init__.py

@@ -0,0 +1,15 @@
+from .model_catalog_endpoints import (
+    ModelCatalogEndpoints,
+    ModelDeleteResult,
+    ModelExistsResult,
+    ModelLoadResult,
+    ModelStoreResult,
+)
+
+__all__ = [
+    "ModelCatalogEndpoints",
+    "ModelDeleteResult",
+    "ModelExistsResult",
+    "ModelLoadResult",
+    "ModelStoreResult",
+]