flwr-nightly 1.12.0.dev20241006__tar.gz → 1.12.0.dev20241007__tar.gz

{flwr_nightly-1.12.0.dev20241006 → flwr_nightly-1.12.0.dev20241007}/PKG-INFO

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

{flwr_nightly-1.12.0.dev20241006 → flwr_nightly-1.12.0.dev20241007}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.12.0.dev20241006"
+version = "1.12.0.dev20241007"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]
@@ -43,12 +43,8 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Typing :: Typed",
 ]
-packages = [
-    { include = "flwr", from = "src/py" },
-]
-exclude = [
-    "src/py/**/*_test.py",
-]
+packages = [{ include = "flwr", from = "src/py" }]
+exclude = ["src/py/**/*_test.py"]
 
 [tool.poetry.scripts]
 # `flwr` CLI
@@ -62,7 +58,7 @@ flower-superlink = "flwr.server.app:run_superlink"
 flower-supernode = "flwr.client.supernode.app:run_supernode"
 flower-server-app = "flwr.server.run_serverapp:run_server_app"
 flwr-clientapp = "flwr.client.clientapp:flwr_clientapp"
-flower-client-app = "flwr.client.supernode:run_client_app"  # Deprecated
+flower-client-app = "flwr.client.supernode:run_client_app" # Deprecated
 
 [tool.poetry.dependencies]
 python = "^3.9"
@@ -96,6 +92,7 @@ types-setuptools = "==69.0.0.20240125"
 clang-format = "==17.0.6"
 isort = "==5.13.2"
 black = { version = "==24.2.0", extras = ["jupyter"] }
+taplo = "==0.9.3"
 docformatter = "==1.7.5"
 mypy = "==1.8.0"
 pylint = "==3.0.3"
@@ -160,10 +157,7 @@ disable = "duplicate-code,too-few-public-methods,useless-import-alias"
 [tool.pytest.ini_options]
 minversion = "6.2"
 addopts = "-qq"
-testpaths = [
-    "src/py/flwr",
-    "src/py/flwr_tool",
-]
+testpaths = ["src/py/flwr", "src/py/flwr_tool"]
 filterwarnings = "ignore::DeprecationWarning"
 
 [tool.pytest-watcher]
@@ -176,17 +170,12 @@ patterns = ["*.py"]
 ignore_patterns = []
 
 [tool.mypy]
-plugins = [
-    "numpy.typing.mypy_plugin",
-]
+plugins = ["numpy.typing.mypy_plugin"]
 ignore_missing_imports = true
 strict = true
 
 [[tool.mypy.overrides]]
-module = [
-    "importlib.metadata.*",
-    "importlib_metadata.*",
-]
+module = ["importlib.metadata.*", "importlib_metadata.*"]
 follow_imports = "skip"
 follow_imports_for_stubs = true
 disallow_untyped_calls = false

{flwr_nightly-1.12.0.dev20241006 → flwr_nightly-1.12.0.dev20241007}/src/py/flwr/common/constant.py

@@ -78,6 +78,9 @@ GRPC_ADAPTER_METADATA_SHOULD_EXIT_KEY = "should-exit"
 GRPC_ADAPTER_METADATA_MESSAGE_MODULE_KEY = "grpc-message-module"
 GRPC_ADAPTER_METADATA_MESSAGE_QUALNAME_KEY = "grpc-message-qualname"
 
+# Message TTL
+MESSAGE_TTL_TOLERANCE = 1e-1
+
 
 class MessageType:
     """Message type."""

{flwr_nightly-1.12.0.dev20241006 → flwr_nightly-1.12.0.dev20241007}/src/py/flwr/common/message.py

@@ -17,9 +17,11 @@
 from __future__ import annotations
 
 import time
-import warnings
+from logging import WARNING
 from typing import Optional, cast
 
+from .constant import MESSAGE_TTL_TOLERANCE
+from .logger import log
 from .record import RecordSet
 
 DEFAULT_TTL = 3600
@@ -289,13 +291,6 @@ class Message:
 
             ttl = msg.meta.ttl - (reply.meta.created_at - msg.meta.created_at)
         """
-        if ttl:
-            warnings.warn(
-                "A custom TTL was set, but note that the SuperLink does not enforce "
-                "the TTL yet. The SuperLink will start enforcing the TTL in a future "
-                "version of Flower.",
-                stacklevel=2,
-            )
         # If no TTL passed, use default for message creation (will update after
         # message creation)
         ttl_ = DEFAULT_TTL if ttl is None else ttl
@@ -309,6 +304,8 @@ class Message:
             )
             message.metadata.ttl = ttl
 
+        self._limit_task_res_ttl(message)
+
         return message
 
     def create_reply(self, content: RecordSet, ttl: float | None = None) -> Message:
@@ -334,13 +331,6 @@ class Message:
         Message
             A new `Message` instance representing the reply.
         """
-        if ttl:
-            warnings.warn(
-                "A custom TTL was set, but note that the SuperLink does not enforce "
-                "the TTL yet. The SuperLink will start enforcing the TTL in a future "
-                "version of Flower.",
-                stacklevel=2,
-            )
         # If no TTL passed, use default for message creation (will update after
         # message creation)
         ttl_ = DEFAULT_TTL if ttl is None else ttl
@@ -357,6 +347,8 @@ class Message:
             )
             message.metadata.ttl = ttl
 
+        self._limit_task_res_ttl(message)
+
         return message
 
     def __repr__(self) -> str:
@@ -370,6 +362,31 @@ class Message:
         )
         return f"{self.__class__.__qualname__}({view})"
 
+    def _limit_task_res_ttl(self, message: Message) -> None:
+        """Limit the TaskRes TTL to not exceed the expiration time of the TaskIns it
+        replies to.
+
+        Parameters
+        ----------
+        message : Message
+            The message to which the TaskRes is replying.
+        """
+        # Calculate the maximum allowed TTL
+        max_allowed_ttl = (
+            self.metadata.created_at + self.metadata.ttl - message.metadata.created_at
+        )
+
+        if message.metadata.ttl - max_allowed_ttl > MESSAGE_TTL_TOLERANCE:
+            log(
+                WARNING,
+                "The reply TTL of %.2f seconds exceeded the "
+                "allowed maximum of %.2f seconds. "
+                "The TTL has been updated to the allowed maximum.",
+                message.metadata.ttl,
+                max_allowed_ttl,
+            )
+            message.metadata.ttl = max_allowed_ttl
+
 
 def _create_reply_metadata(msg: Message, ttl: float) -> Metadata:
     """Construct metadata for a reply message."""

{flwr_nightly-1.12.0.dev20241006 → flwr_nightly-1.12.0.dev20241007}/src/py/flwr/server/strategy/aggregate.py

@@ -15,8 +15,8 @@
 """Aggregation functions for strategy implementations."""
 # mypy: disallow_untyped_calls=False
 
-from functools import reduce
-from typing import Any, Callable
+from functools import partial, reduce
+from typing import Any, Callable, Union
 
 import numpy as np
 
@@ -52,17 +52,31 @@ def aggregate_inplace(results: list[tuple[ClientProxy, FitRes]]) -> NDArrays:
         fit_res.num_examples / num_examples_total for _, fit_res in results
     ]
 
+    def _try_inplace(
+        x: NDArray, y: Union[NDArray, float], np_binary_op: np.ufunc
+    ) -> NDArray:
+        return (  # type: ignore[no-any-return]
+            np_binary_op(x, y, out=x)
+            if np.can_cast(y, x.dtype, casting="same_kind")
+            else np_binary_op(x, np.array(y, x.dtype), out=x)
+        )
+
     # Let's do in-place aggregation
     # Get first result, then add up each other
     params = [
-        scaling_factors[0] * x for x in parameters_to_ndarrays(results[0][1].parameters)
+        _try_inplace(x, scaling_factors[0], np_binary_op=np.multiply)
+        for x in parameters_to_ndarrays(results[0][1].parameters)
     ]
-    for i, (_, fit_res) in enumerate(results[1:]):
+
+    for i, (_, fit_res) in enumerate(results[1:], start=1):
         res = (
-            scaling_factors[i + 1] * x
+            _try_inplace(x, scaling_factors[i], np_binary_op=np.multiply)
             for x in parameters_to_ndarrays(fit_res.parameters)
         )
-        params = [reduce(np.add, layer_updates) for layer_updates in zip(params, res)]
+        params = [
+            reduce(partial(_try_inplace, np_binary_op=np.add), layer_updates)
+            for layer_updates in zip(params, res)
+        ]
 
     return params
 
@@ -128,7 +142,7 @@ def aggregate_bulyan(
 
     Parameters
     ----------
-    results: List[Tuple[NDArrays, int]]
+    results: list[tuple[NDArrays, int]]
         Weights and number of samples for each of the client.
     num_malicious: int
         The maximum number of malicious clients.
@@ -332,7 +346,7 @@ def _aggregate_n_closest_weights(
     ----------
     reference_weights: NDArrays
         The weights from which the distances will be computed
-    results: List[Tuple[NDArrays, int]]
+    results: list[tuple[NDArrays, int]]
         The weights from models
     beta_closest: int
         The number of the closest distance weights that will be averaged

{flwr_nightly-1.12.0.dev20241006 → flwr_nightly-1.12.0.dev20241007}/src/py/flwr/server/superlink/state/in_memory_state.py

@@ -17,12 +17,16 @@
 
 import threading
 import time
-from logging import ERROR
+from logging import ERROR, WARNING
 from typing import Optional
 from uuid import UUID, uuid4
 
 from flwr.common import log, now
-from flwr.common.constant import NODE_ID_NUM_BYTES, RUN_ID_NUM_BYTES
+from flwr.common.constant import (
+    MESSAGE_TTL_TOLERANCE,
+    NODE_ID_NUM_BYTES,
+    RUN_ID_NUM_BYTES,
+)
 from flwr.common.typing import Run, UserConfig
 from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 from flwr.server.superlink.state.state import State
@@ -83,6 +87,7 @@ class InMemoryState(State):  # pylint: disable=R0902,R0904
 
         # Find TaskIns for node_id that were not delivered yet
         task_ins_list: list[TaskIns] = []
+        current_time = time.time()
         with self.lock:
             for _, task_ins in self.task_ins_store.items():
                 # pylint: disable=too-many-boolean-expressions
@@ -91,11 +96,13 @@ class InMemoryState(State):  # pylint: disable=R0902,R0904
                     and task_ins.task.consumer.anonymous is False
                     and task_ins.task.consumer.node_id == node_id
                     and task_ins.task.delivered_at == ""
+                    and task_ins.task.created_at + task_ins.task.ttl > current_time
                 ) or (
                     node_id is None  # Anonymous
                     and task_ins.task.consumer.anonymous is True
                     and task_ins.task.consumer.node_id == 0
                     and task_ins.task.delivered_at == ""
+                    and task_ins.task.created_at + task_ins.task.ttl > current_time
                 ):
                     task_ins_list.append(task_ins)
                 if limit and len(task_ins_list) == limit:
@@ -134,6 +141,27 @@ class InMemoryState(State):  # pylint: disable=R0902,R0904
                 )
                 return None
 
+            # Fail if the TaskRes TTL exceeds the
+            # expiration time of the TaskIns it replies to.
+            # Condition: TaskIns.created_at + TaskIns.ttl ≥
+            #            TaskRes.created_at + TaskRes.ttl
+            # A small tolerance is introduced to account
+            # for floating-point precision issues.
+            max_allowed_ttl = (
+                task_ins.task.created_at + task_ins.task.ttl - task_res.task.created_at
+            )
+            if task_res.task.ttl and (
+                task_res.task.ttl - max_allowed_ttl > MESSAGE_TTL_TOLERANCE
+            ):
+                log(
+                    WARNING,
+                    "Received TaskRes with TTL %.2f "
+                    "exceeding the allowed maximum TTL %.2f.",
+                    task_res.task.ttl,
+                    max_allowed_ttl,
+                )
+                return None
+
         # Validate run_id
         if task_res.run_id not in self.run_ids:
             log(ERROR, "`run_id` is invalid")

{flwr_nightly-1.12.0.dev20241006 → flwr_nightly-1.12.0.dev20241007}/src/py/flwr/server/superlink/state/sqlite_state.py

@@ -20,12 +20,16 @@ import re
 import sqlite3
 import time
 from collections.abc import Sequence
-from logging import DEBUG, ERROR
+from logging import DEBUG, ERROR, WARNING
 from typing import Any, Optional, Union, cast
 from uuid import UUID, uuid4
 
 from flwr.common import log, now
-from flwr.common.constant import NODE_ID_NUM_BYTES, RUN_ID_NUM_BYTES
+from flwr.common.constant import (
+    MESSAGE_TTL_TOLERANCE,
+    NODE_ID_NUM_BYTES,
+    RUN_ID_NUM_BYTES,
+)
 from flwr.common.typing import Run, UserConfig
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.recordset_pb2 import RecordSet  # pylint: disable=E0611
@@ -295,6 +299,7 @@ class SqliteState(State):  # pylint: disable=R0904
                 WHERE consumer_anonymous == 1
                 AND   consumer_node_id == 0
                 AND   delivered_at = ""
+                AND   (created_at + ttl) > CAST(strftime('%s', 'now') AS REAL)
             """
         else:
             # Convert the uint64 value to sint64 for SQLite
@@ -307,6 +312,7 @@ class SqliteState(State):  # pylint: disable=R0904
                 WHERE consumer_anonymous == 0
                 AND   consumer_node_id == :node_id
                 AND   delivered_at = ""
+                AND   (created_at + ttl) > CAST(strftime('%s', 'now') AS REAL)
             """
 
         if limit is not None:
@@ -383,6 +389,27 @@ class SqliteState(State):  # pylint: disable=R0904
             )
             return None
 
+        # Fail if the TaskRes TTL exceeds the
+        # expiration time of the TaskIns it replies to.
+        # Condition: TaskIns.created_at + TaskIns.ttl ≥
+        #            TaskRes.created_at + TaskRes.ttl
+        # A small tolerance is introduced to account
+        # for floating-point precision issues.
+        max_allowed_ttl = (
+            task_ins["created_at"] + task_ins["ttl"] - task_res.task.created_at
+        )
+        if task_res.task.ttl and (
+            task_res.task.ttl - max_allowed_ttl > MESSAGE_TTL_TOLERANCE
+        ):
+            log(
+                WARNING,
+                "Received TaskRes with TTL %.2f "
+                "exceeding the allowed maximum TTL %.2f.",
+                task_res.task.ttl,
+                max_allowed_ttl,
+            )
+            return None
+
         # Store TaskRes
         task_res.task_id = str(task_id)
         data = (task_res_to_dict(task_res),)