flwr-nightly 1.10.0.dev20240617__tar.gz → 1.10.0.dev20240618__tar.gz

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.10.0.dev20240617
+Version: 1.10.0.dev20240618
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.10.0.dev20240617"
+version = "1.10.0.dev20240618"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]

flwr_nightly-1.10.0.dev20240618/src/py/flwr/client/grpc_adapter_client/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Client-side part of the GrpcAdapter transport layer."""

flwr_nightly-1.10.0.dev20240618/src/py/flwr/client/grpc_adapter_client/connection.py

@@ -0,0 +1,94 @@
+# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Contextmanager for a GrpcAdapter channel to the Flower server."""
+
+
+from contextlib import contextmanager
+from logging import ERROR
+from typing import Callable, Iterator, Optional, Tuple, Union
+
+from cryptography.hazmat.primitives.asymmetric import ec
+
+from flwr.client.grpc_rere_client.connection import grpc_request_response
+from flwr.client.grpc_rere_client.grpc_adapter import GrpcAdapter
+from flwr.common import GRPC_MAX_MESSAGE_LENGTH
+from flwr.common.logger import log
+from flwr.common.message import Message
+from flwr.common.retry_invoker import RetryInvoker
+
+
+@contextmanager
+def grpc_adapter(  # pylint: disable=R0913
+    server_address: str,
+    insecure: bool,
+    retry_invoker: RetryInvoker,
+    max_message_length: int = GRPC_MAX_MESSAGE_LENGTH,  # pylint: disable=W0613
+    root_certificates: Optional[Union[bytes, str]] = None,
+    authentication_keys: Optional[  # pylint: disable=unused-argument
+        Tuple[ec.EllipticCurvePrivateKey, ec.EllipticCurvePublicKey]
+    ] = None,
+) -> Iterator[
+    Tuple[
+        Callable[[], Optional[Message]],
+        Callable[[Message], None],
+        Optional[Callable[[], None]],
+        Optional[Callable[[], None]],
+        Optional[Callable[[int], Tuple[str, str]]],
+    ]
+]:
+    """Primitives for request/response-based interaction with a server via GrpcAdapter.
+
+    Parameters
+    ----------
+    server_address : str
+        The IPv6 address of the server with `http://` or `https://`.
+        If the Flower server runs on the same machine
+        on port 8080, then `server_address` would be `"http://[::]:8080"`.
+    insecure : bool
+        Starts an insecure gRPC connection when True. Enables HTTPS connection
+        when False, using system certificates if `root_certificates` is None.
+    retry_invoker: RetryInvoker
+        `RetryInvoker` object that will try to reconnect the client to the server
+        after gRPC errors. If None, the client will only try to
+        reconnect once after a failure.
+    max_message_length : int
+        Ignored, only present to preserve API-compatibility.
+    root_certificates : Optional[Union[bytes, str]] (default: None)
+        Path of the root certificate. If provided, a secure
+        connection using the certificates will be established to an SSL-enabled
+        Flower server. Bytes won't work for the REST API.
+    authentication_keys : Optional[Tuple[PrivateKey, PublicKey]] (default: None)
+        Client authentication is not supported for this transport type.
+
+    Returns
+    -------
+    receive : Callable
+    send : Callable
+    create_node : Optional[Callable]
+    delete_node : Optional[Callable]
+    get_run : Optional[Callable]
+    """
+    if authentication_keys is not None:
+        log(ERROR, "Client authentication is not supported for this transport type.")
+    with grpc_request_response(
+        server_address=server_address,
+        insecure=insecure,
+        retry_invoker=retry_invoker,
+        max_message_length=max_message_length,
+        root_certificates=root_certificates,
+        authentication_keys=None,  # Authentication is not supported
+        adapter_cls=GrpcAdapter,
+    ) as conn:
+        yield conn

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/client/grpc_client/connection.py

@@ -17,7 +17,7 @@
 
 import uuid
 from contextlib import contextmanager
-from logging import DEBUG
+from logging import DEBUG, ERROR
 from pathlib import Path
 from queue import Queue
 from typing import Callable, Iterator, Optional, Tuple, Union, cast
@@ -101,6 +101,8 @@ def grpc_connection(  # pylint: disable=R0913, R0915
         The PEM-encoded root certificates as a byte string or a path string.
         If provided, a secure connection using the certificates will be
         established to an SSL-enabled Flower server.
+    authentication_keys : Optional[Tuple[PrivateKey, PublicKey]] (default: None)
+        Client authentication is not supported for this transport type.
 
     Returns
     -------
@@ -123,6 +125,8 @@ def grpc_connection(  # pylint: disable=R0913, R0915
     """
     if isinstance(root_certificates, str):
         root_certificates = Path(root_certificates).read_bytes()
+    if authentication_keys is not None:
+        log(ERROR, "Client authentication is not supported for this transport type.")
 
     channel = create_channel(
         server_address=server_address,

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/client/grpc_rere_client/connection.py

@@ -55,6 +55,7 @@ from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=
 from flwr.proto.task_pb2 import TaskIns  # pylint: disable=E0611
 
 from .client_interceptor import AuthenticateClientInterceptor
+from .grpc_adapter import GrpcAdapter
 
 
 def on_channel_state_change(channel_connectivity: str) -> None:
@@ -72,7 +73,7 @@ def grpc_request_response(  # pylint: disable=R0913, R0914, R0915
     authentication_keys: Optional[
         Tuple[ec.EllipticCurvePrivateKey, ec.EllipticCurvePublicKey]
     ] = None,
-    adapter_cls: Optional[Type[FleetStub]] = None,
+    adapter_cls: Optional[Union[Type[FleetStub], Type[GrpcAdapter]]] = None,
 ) -> Iterator[
     Tuple[
         Callable[[], Optional[Message]],
@@ -106,6 +107,11 @@ def grpc_request_response(  # pylint: disable=R0913, R0914, R0915
         Path of the root certificate. If provided, a secure
         connection using the certificates will be established to an SSL-enabled
         Flower server. Bytes won't work for the REST API.
+    authentication_keys : Optional[Tuple[PrivateKey, PublicKey]] (default: None)
+        Tuple containing the elliptic curve private key and public key for
+        authentication from the cryptography library.
+        Source: https://cryptography.io/en/latest/hazmat/primitives/asymmetric/ec/
+        Used to establish an authenticated connection with the server.
 
     Returns
     -------
@@ -113,6 +119,7 @@ def grpc_request_response(  # pylint: disable=R0913, R0914, R0915
     send : Callable
     create_node : Optional[Callable]
     delete_node : Optional[Callable]
+    get_run : Optional[Callable]
     """
     if isinstance(root_certificates, str):
         root_certificates = Path(root_certificates).read_bytes()

flwr_nightly-1.10.0.dev20240618/src/py/flwr/client/grpc_rere_client/grpc_adapter.py

@@ -0,0 +1,133 @@
+# Copyright 2024 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""GrpcAdapter implementation."""
+
+
+import sys
+from logging import DEBUG
+from typing import Any, Type, TypeVar, cast
+
+import grpc
+from google.protobuf.message import Message as GrpcMessage
+
+from flwr.common import log
+from flwr.common.constant import (
+    GRPC_ADAPTER_METADATA_FLOWER_VERSION_KEY,
+    GRPC_ADAPTER_METADATA_SHOULD_EXIT_KEY,
+)
+from flwr.common.version import package_version
+from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
+    CreateNodeRequest,
+    CreateNodeResponse,
+    DeleteNodeRequest,
+    DeleteNodeResponse,
+    PingRequest,
+    PingResponse,
+    PullTaskInsRequest,
+    PullTaskInsResponse,
+    PushTaskResRequest,
+    PushTaskResResponse,
+)
+from flwr.proto.grpcadapter_pb2 import MessageContainer  # pylint: disable=E0611
+from flwr.proto.grpcadapter_pb2_grpc import GrpcAdapterStub
+from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
+
+T = TypeVar("T", bound=GrpcMessage)
+
+
+class GrpcAdapter:
+    """Adapter class to send and receive gRPC messages via the ``GrpcAdapterStub``.
+
+    This class utilizes the ``GrpcAdapterStub`` to send and receive gRPC messages
+    which are defined and used by the Fleet API, as defined in ``fleet.proto``.
+    """
+
+    def __init__(self, channel: grpc.Channel) -> None:
+        self.stub = GrpcAdapterStub(channel)
+
+    def _send_and_receive(
+        self, request: GrpcMessage, response_type: Type[T], **kwargs: Any
+    ) -> T:
+        # Serialize request
+        container_req = MessageContainer(
+            metadata={GRPC_ADAPTER_METADATA_FLOWER_VERSION_KEY: package_version},
+            grpc_message_name=request.__class__.__qualname__,
+            grpc_message_content=request.SerializeToString(),
+        )
+
+        # Send via the stub
+        container_res = cast(
+            MessageContainer, self.stub.SendReceive(container_req, **kwargs)
+        )
+
+        # Handle control message
+        should_exit = (
+            container_res.metadata.get(GRPC_ADAPTER_METADATA_SHOULD_EXIT_KEY, "false")
+            == "true"
+        )
+        if should_exit:
+            log(
+                DEBUG,
+                'Received shutdown signal: exit flag is set to ``"true"``. Exiting...',
+            )
+            sys.exit(0)
+
+        # Check the grpc_message_name of the response
+        if container_res.grpc_message_name != response_type.__qualname__:
+            raise ValueError(
+                f"Invalid grpc_message_name. Expected {response_type.__qualname__}"
+                f", but got {container_res.grpc_message_name}."
+            )
+
+        # Deserialize response
+        response = response_type()
+        response.ParseFromString(container_res.grpc_message_content)
+        return response
+
+    def CreateNode(  # pylint: disable=C0103
+        self, request: CreateNodeRequest, **kwargs: Any
+    ) -> CreateNodeResponse:
+        """."""
+        return self._send_and_receive(request, CreateNodeResponse, **kwargs)
+
+    def DeleteNode(  # pylint: disable=C0103
+        self, request: DeleteNodeRequest, **kwargs: Any
+    ) -> DeleteNodeResponse:
+        """."""
+        return self._send_and_receive(request, DeleteNodeResponse, **kwargs)
+
+    def Ping(  # pylint: disable=C0103
+        self, request: PingRequest, **kwargs: Any
+    ) -> PingResponse:
+        """."""
+        return self._send_and_receive(request, PingResponse, **kwargs)
+
+    def PullTaskIns(  # pylint: disable=C0103
+        self, request: PullTaskInsRequest, **kwargs: Any
+    ) -> PullTaskInsResponse:
+        """."""
+        return self._send_and_receive(request, PullTaskInsResponse, **kwargs)
+
+    def PushTaskRes(  # pylint: disable=C0103
+        self, request: PushTaskResRequest, **kwargs: Any
+    ) -> PushTaskResResponse:
+        """."""
+        return self._send_and_receive(request, PushTaskResResponse, **kwargs)
+
+    def GetRun(  # pylint: disable=C0103
+        self, request: GetRunRequest, **kwargs: Any
+    ) -> GetRunResponse:
+        """."""
+        return self._send_and_receive(request, GetRunResponse, **kwargs)

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/client/rest_client/connection.py

@@ -117,10 +117,16 @@ def http_request_response(  # pylint: disable=,R0913, R0914, R0915
         Path of the root certificate. If provided, a secure
         connection using the certificates will be established to an SSL-enabled
         Flower server. Bytes won't work for the REST API.
+    authentication_keys : Optional[Tuple[PrivateKey, PublicKey]] (default: None)
+        Client authentication is not supported for this transport type.
 
     Returns
     -------
-    receive, send : Callable, Callable
+    receive : Callable
+    send : Callable
+    create_node : Optional[Callable]
+    delete_node : Optional[Callable]
+    get_run : Optional[Callable]
     """
     log(
         WARN,
@@ -145,6 +151,8 @@ def http_request_response(  # pylint: disable=,R0913, R0914, R0915
             "For the REST API, the root certificates "
             "must be provided as a string path to the client.",
         )
+    if authentication_keys is not None:
+        log(ERROR, "Client authentication is not supported for this transport type.")
 
     # Shared variables for inner functions
     metadata: Optional[Metadata] = None

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/common/constant.py

@@ -51,6 +51,10 @@ FAB_CONFIG_FILE = "pyproject.toml"
 FLWR_HOME = "FLWR_HOME"
 
 
+GRPC_ADAPTER_METADATA_FLOWER_VERSION_KEY = "flower-version"
+GRPC_ADAPTER_METADATA_SHOULD_EXIT_KEY = "should-exit"
+
+
 class MessageType:
     """Message type."""
 

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/common/typing.py

@@ -185,3 +185,12 @@ class ClientMessage:
     get_parameters_res: Optional[GetParametersRes] = None
     fit_res: Optional[FitRes] = None
     evaluate_res: Optional[EvaluateRes] = None
+
+
+@dataclass
+class Run:
+    """Run details."""
+
+    run_id: int
+    fab_id: str
+    fab_version: str

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/server/superlink/fleet/message_handler/message_handler.py

@@ -112,6 +112,6 @@ def get_run(
     request: GetRunRequest, state: State  # pylint: disable=W0613
 ) -> GetRunResponse:
     """Get run information."""
-    run_id, fab_id, fab_version = state.get_run(request.run_id)
-    run = Run(run_id=run_id, fab_id=fab_id, fab_version=fab_version)
-    return GetRunResponse(run=run)
+    run = state.get_run(request.run_id)
+    run_proto = None if run is None else Run(**vars(run))
+    return GetRunResponse(run=run_proto)

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/server/superlink/state/in_memory_state.py

@@ -23,6 +23,7 @@ from typing import Dict, List, Optional, Set, Tuple
 from uuid import UUID, uuid4
 
 from flwr.common import log, now
+from flwr.common.typing import Run
 from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 from flwr.server.superlink.state.state import State
 from flwr.server.utils import validate_task_ins_or_res
@@ -40,7 +41,7 @@ class InMemoryState(State):  # pylint: disable=R0902,R0904
         self.public_key_to_node_id: Dict[bytes, int] = {}
 
         # Map run_id to (fab_id, fab_version)
-        self.run_ids: Dict[int, Tuple[str, str]] = {}
+        self.run_ids: Dict[int, Run] = {}
         self.task_ins_store: Dict[UUID, TaskIns] = {}
         self.task_res_store: Dict[UUID, TaskRes] = {}
 
@@ -281,7 +282,9 @@ class InMemoryState(State):  # pylint: disable=R0902,R0904
             run_id: int = int.from_bytes(os.urandom(8), "little", signed=True)
 
             if run_id not in self.run_ids:
-                self.run_ids[run_id] = (fab_id, fab_version)
+                self.run_ids[run_id] = Run(
+                    run_id=run_id, fab_id=fab_id, fab_version=fab_version
+                )
                 return run_id
         log(ERROR, "Unexpected run creation failure.")
         return 0
@@ -319,13 +322,13 @@ class InMemoryState(State):  # pylint: disable=R0902,R0904
         """Retrieve all currently stored `client_public_keys` as a set."""
         return self.client_public_keys
 
-    def get_run(self, run_id: int) -> Tuple[int, str, str]:
+    def get_run(self, run_id: int) -> Optional[Run]:
         """Retrieve information about the run with the specified `run_id`."""
         with self.lock:
             if run_id not in self.run_ids:
                 log(ERROR, "`run_id` is invalid")
-                return 0, "", ""
-            return run_id, *self.run_ids[run_id]
+                return None
+            return self.run_ids[run_id]
 
     def acknowledge_ping(self, node_id: int, ping_interval: float) -> bool:
         """Acknowledge a ping received from a node, serving as a heartbeat."""

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/server/superlink/state/sqlite_state.py

@@ -24,6 +24,7 @@ from typing import Any, Dict, List, Optional, Sequence, Set, Tuple, Union, cast
 from uuid import UUID, uuid4
 
 from flwr.common import log, now
+from flwr.common.typing import Run
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.recordset_pb2 import RecordSet  # pylint: disable=E0611
 from flwr.proto.task_pb2 import Task, TaskIns, TaskRes  # pylint: disable=E0611
@@ -680,15 +681,17 @@ class SqliteState(State):  # pylint: disable=R0904
         result: Set[bytes] = {row["public_key"] for row in rows}
         return result
 
-    def get_run(self, run_id: int) -> Tuple[int, str, str]:
+    def get_run(self, run_id: int) -> Optional[Run]:
         """Retrieve information about the run with the specified `run_id`."""
         query = "SELECT * FROM run WHERE run_id = ?;"
         try:
             row = self.query(query, (run_id,))[0]
-            return run_id, row["fab_id"], row["fab_version"]
+            return Run(
+                run_id=run_id, fab_id=row["fab_id"], fab_version=row["fab_version"]
+            )
         except sqlite3.IntegrityError:
             log(ERROR, "`run_id` does not exist.")
-            return 0, "", ""
+            return None
 
     def acknowledge_ping(self, node_id: int, ping_interval: float) -> bool:
         """Acknowledge a ping received from a node, serving as a heartbeat."""

{flwr_nightly-1.10.0.dev20240617 → flwr_nightly-1.10.0.dev20240618}/src/py/flwr/server/superlink/state/state.py

@@ -16,9 +16,10 @@
 
 
 import abc
-from typing import List, Optional, Set, Tuple
+from typing import List, Optional, Set
 from uuid import UUID
 
+from flwr.common.typing import Run
 from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 
 
@@ -160,7 +161,7 @@ class State(abc.ABC):  # pylint: disable=R0904
         """Create a new run for the specified `fab_id` and `fab_version`."""
 
     @abc.abstractmethod
-    def get_run(self, run_id: int) -> Tuple[int, str, str]:
+    def get_run(self, run_id: int) -> Optional[Run]:
         """Retrieve information about the run with the specified `run_id`.
 
         Parameters
@@ -170,8 +171,8 @@ class State(abc.ABC):  # pylint: disable=R0904
 
         Returns
         -------
-        Tuple[int, str, str]
-            A tuple containing three elements:
+        Optional[Run]
+            A dataclass instance containing three elements if `run_id` is valid:
             - `run_id`: The identifier of the run, same as the specified `run_id`.
             - `fab_id`: The identifier of the FAB used in the specified run.
             - `fab_version`: The version of the FAB used in the specified run.