flwr-nightly 1.7.0.dev20240117__py3-none-any.whl → 1.7.0.dev20240119__py3-none-any.whl

flwr/client/app.py

@@ -35,7 +35,7 @@ from flwr.common.constant import (
     TRANSPORT_TYPES,
 )
 from flwr.common.logger import log, warn_experimental_feature
-from flwr.proto.task_pb2 import TaskIns, TaskRes
+from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 
 from .flower import load_flower_callable
 from .grpc_client.connection import grpc_connection

flwr/client/grpc_client/connection.py

@@ -25,10 +25,13 @@ from typing import Callable, Iterator, Optional, Tuple, Union
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
 from flwr.common.grpc import create_channel
 from flwr.common.logger import log
-from flwr.proto.node_pb2 import Node
-from flwr.proto.task_pb2 import Task, TaskIns, TaskRes
-from flwr.proto.transport_pb2 import ClientMessage, ServerMessage
-from flwr.proto.transport_pb2_grpc import FlowerServiceStub
+from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
+from flwr.proto.task_pb2 import Task, TaskIns, TaskRes  # pylint: disable=E0611
+from flwr.proto.transport_pb2 import (  # pylint: disable=E0611
+    ClientMessage,
+    ServerMessage,
+)
+from flwr.proto.transport_pb2_grpc import FlowerServiceStub  # pylint: disable=E0611
 
 # The following flags can be uncommented for debugging. Other possible values:
 # https://github.com/grpc/grpc/blob/master/doc/environment_variables.md

flwr/client/grpc_rere_client/connection.py

@@ -29,15 +29,15 @@ from flwr.client.message_handler.task_handler import (
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
 from flwr.common.grpc import create_channel
 from flwr.common.logger import log, warn_experimental_feature
-from flwr.proto.fleet_pb2 import (
+from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeRequest,
     DeleteNodeRequest,
     PullTaskInsRequest,
     PushTaskResRequest,
 )
-from flwr.proto.fleet_pb2_grpc import FleetStub
-from flwr.proto.node_pb2 import Node
-from flwr.proto.task_pb2 import TaskIns, TaskRes
+from flwr.proto.fleet_pb2_grpc import FleetStub  # pylint: disable=E0611
+from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
+from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 
 KEY_NODE = "node"
 KEY_TASK_INS = "current_task_ins"

flwr/client/message_handler/message_handler.py

@@ -32,8 +32,17 @@ from flwr.client.run_state import RunState
 from flwr.client.secure_aggregation import SecureAggregationHandler
 from flwr.client.typing import ClientFn
 from flwr.common import serde
-from flwr.proto.task_pb2 import SecureAggregation, Task, TaskIns, TaskRes
-from flwr.proto.transport_pb2 import ClientMessage, Reason, ServerMessage
+from flwr.proto.task_pb2 import (  # pylint: disable=E0611
+    SecureAggregation,
+    Task,
+    TaskIns,
+    TaskRes,
+)
+from flwr.proto.transport_pb2 import (  # pylint: disable=E0611
+    ClientMessage,
+    Reason,
+    ServerMessage,
+)
 
 
 class UnexpectedServerMessage(Exception):

flwr/client/message_handler/task_handler.py

@@ -17,10 +17,13 @@
 
 from typing import Optional
 
-from flwr.proto.fleet_pb2 import PullTaskInsResponse
-from flwr.proto.node_pb2 import Node
-from flwr.proto.task_pb2 import Task, TaskIns, TaskRes
-from flwr.proto.transport_pb2 import ClientMessage, ServerMessage
+from flwr.proto.fleet_pb2 import PullTaskInsResponse  # pylint: disable=E0611
+from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
+from flwr.proto.task_pb2 import Task, TaskIns, TaskRes  # pylint: disable=E0611
+from flwr.proto.transport_pb2 import (  # pylint: disable=E0611
+    ClientMessage,
+    ServerMessage,
+)
 
 
 def validate_task_ins(task_ins: TaskIns, discard_reconnect_ins: bool) -> bool:

flwr/client/node_state_tests.py

@@ -17,7 +17,7 @@
 
 from flwr.client.node_state import NodeState
 from flwr.client.run_state import RunState
-from flwr.proto.task_pb2 import TaskIns
+from flwr.proto.task_pb2 import TaskIns  # pylint: disable=E0611
 
 
 def _run_dummy_task(state: RunState) -> RunState:

flwr/client/rest_client/connection.py

@@ -29,7 +29,7 @@ from flwr.client.message_handler.task_handler import (
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
 from flwr.common.constant import MISSING_EXTRA_REST
 from flwr.common.logger import log
-from flwr.proto.fleet_pb2 import (
+from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeRequest,
     CreateNodeResponse,
     DeleteNodeRequest,
@@ -38,8 +38,8 @@ from flwr.proto.fleet_pb2 import (
     PushTaskResRequest,
     PushTaskResResponse,
 )
-from flwr.proto.node_pb2 import Node
-from flwr.proto.task_pb2 import TaskIns, TaskRes
+from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
+from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 
 try:
     import requests

flwr/client/typing.py

@@ -18,7 +18,7 @@ from dataclasses import dataclass
 from typing import Callable
 
 from flwr.client.run_state import RunState
-from flwr.proto.task_pb2 import TaskIns, TaskRes
+from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 
 from .client import Client as Client
 

flwr/common/configsrecord.py

@@ -0,0 +1,107 @@
+# 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.
+# ==============================================================================
+"""ConfigsRecord."""
+
+
+from dataclasses import dataclass, field
+from typing import Dict, Optional, get_args
+
+from .typing import ConfigsRecordValues, ConfigsScalar
+
+
+@dataclass
+class ConfigsRecord:
+    """Configs record."""
+
+    data: Dict[str, ConfigsRecordValues] = field(default_factory=dict)
+
+    def __init__(
+        self,
+        configs_dict: Optional[Dict[str, ConfigsRecordValues]] = None,
+        keep_input: bool = True,
+    ):
+        """Construct a ConfigsRecord object.
+
+        Parameters
+        ----------
+        configs_dict : Optional[Dict[str, ConfigsRecordValues]]
+            A dictionary that stores basic types (i.e. `str`, `int`, `float`, `bytes` as
+            defined in `ConfigsScalar`) and lists of such types (see
+            `ConfigsScalarList`).
+        keep_input : bool (default: True)
+            A boolean indicating whether config passed should be deleted from the input
+            dictionary immediately after adding them to the record. When set
+            to True, the data is duplicated in memory. If memory is a concern, set
+            it to False.
+        """
+        self.data = {}
+        if configs_dict:
+            self.set_configs(configs_dict, keep_input=keep_input)
+
+    def set_configs(
+        self, configs_dict: Dict[str, ConfigsRecordValues], keep_input: bool = True
+    ) -> None:
+        """Add configs to the record.
+
+        Parameters
+        ----------
+        configs_dict : Dict[str, ConfigsRecordValues]
+            A dictionary that stores basic types (i.e. `str`,`int`, `float`, `bytes` as
+            defined in `ConfigsRecordValues`) and list of such types (see
+            `ConfigsScalarList`).
+        keep_input : bool (default: True)
+            A boolean indicating whether config passed should be deleted from the input
+            dictionary immediately after adding them to the record. When set
+            to True, the data is duplicated in memory. If memory is a concern, set
+            it to False.
+        """
+        if any(not isinstance(k, str) for k in configs_dict.keys()):
+            raise TypeError(f"Not all keys are of valid type. Expected {str}")
+
+        def is_valid(value: ConfigsScalar) -> None:
+            """Check if value is of expected type."""
+            if not isinstance(value, get_args(ConfigsScalar)):
+                raise TypeError(
+                    "Not all values are of valid type."
+                    f" Expected {ConfigsRecordValues} but you passed {type(value)}."
+                )
+
+        # Check types of values
+        # Split between those values that are list and those that aren't
+        # then process in the same way
+        for value in configs_dict.values():
+            if isinstance(value, list):
+                # If your lists are large (e.g. 1M+ elements) this will be slow
+                # 1s to check 10M element list on a M2 Pro
+                # In such settings, you'd be better of treating such config as
+                # an array and pass it to a ParametersRecord.
+                for list_value in value:
+                    is_valid(list_value)
+            else:
+                is_valid(value)
+
+        # Add configs to record
+        if keep_input:
+            # Copy
+            self.data = configs_dict.copy()
+        else:
+            # Add entries to dataclass without duplicating memory
+            for key in list(configs_dict.keys()):
+                self.data[key] = configs_dict[key]
+                del configs_dict[key]
+
+    def __getitem__(self, key: str) -> ConfigsRecordValues:
+        """Retrieve an element stored in record."""
+        return self.data[key]

flwr/common/flowercontext.py

@@ -0,0 +1,77 @@
+# 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.
+# ==============================================================================
+"""FlowerContext and Metadata."""
+
+
+from dataclasses import dataclass
+
+from .recordset import RecordSet
+
+
+@dataclass
+class Metadata:
+    """A dataclass holding metadata associated with the current task.
+
+    Parameters
+    ----------
+    run_id : int
+        An identifier for the current run.
+    task_id : str
+        An identifier for the current task.
+    group_id : str
+        An identifier for grouping tasks. In some settings
+        this is used as the FL round.
+    ttl : str
+        Time-to-live for this task.
+    task_type : str
+        A string that encodes the action to be executed on
+        the receiving end.
+    """
+
+    run_id: int
+    task_id: str
+    group_id: str
+    ttl: str
+    task_type: str
+
+
+@dataclass
+class FlowerContext:
+    """State of your application from the viewpoint of the entity using it.
+
+    Parameters
+    ----------
+    in_message : RecordSet
+        Holds records sent by another entity (e.g. sent by the server-side
+        logic to a client, or vice-versa)
+    out_message : RecordSet
+        Holds records added by the current entity. This `RecordSet` will
+        be sent out (e.g. back to the server-side for aggregation of
+        parameter, or to the client to perform a certain task)
+    local : RecordSet
+        Holds record added by the current entity and that will stay local.
+        This means that the data it holds will never leave the system it's running from.
+        This can be used as an intermediate storage or scratchpad when
+        executing middleware layers. It can also be used as a memory to access
+        at different points during the lifecycle of this entity (e.g. across
+        multiple rounds)
+    metadata : Metadata
+        A dataclass including information about the task to be executed.
+    """
+
+    in_message: RecordSet
+    out_message: RecordSet
+    local: RecordSet
+    metadata: Metadata

flwr/common/logger.py

@@ -111,3 +111,17 @@ def warn_experimental_feature(name: str) -> None:
         """,
         name,
     )
+
+
+def warn_deprecated_feature(name: str) -> None:
+    """Warn the user when they use a deprecated feature."""
+    log(
+        WARN,
+        """
+        DEPRECATED FEATURE: %s
+
+        This is a deprecated feature. It will be removed
+        entirely in future versions of Flower.
+        """,
+        name,
+    )

flwr/common/metricsrecord.py

@@ -0,0 +1,107 @@
+# 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.
+# ==============================================================================
+"""MetricsRecord."""
+
+
+from dataclasses import dataclass, field
+from typing import Dict, Optional, get_args
+
+from .typing import MetricsRecordValues, MetricsScalar
+
+
+@dataclass
+class MetricsRecord:
+    """Metrics record."""
+
+    data: Dict[str, MetricsRecordValues] = field(default_factory=dict)
+
+    def __init__(
+        self,
+        metrics_dict: Optional[Dict[str, MetricsRecordValues]] = None,
+        keep_input: bool = True,
+    ):
+        """Construct a MetricsRecord object.
+
+        Parameters
+        ----------
+        metrics_dict : Optional[Dict[str, MetricsRecordValues]]
+            A dictionary that stores basic types (i.e. `int`, `float` as defined
+            in `MetricsScalar`) and list of such types (see `MetricsScalarList`).
+        keep_input : bool (default: True)
+            A boolean indicating whether metrics should be deleted from the input
+            dictionary immediately after adding them to the record. When set
+            to True, the data is duplicated in memory. If memory is a concern, set
+            it to False.
+        """
+        self.data = {}
+        if metrics_dict:
+            self.set_metrics(metrics_dict, keep_input=keep_input)
+
+    def set_metrics(
+        self, metrics_dict: Dict[str, MetricsRecordValues], keep_input: bool = True
+    ) -> None:
+        """Add metrics to the record.
+
+        Parameters
+        ----------
+        metrics_dict : Dict[str, MetricsRecordValues]
+            A dictionary that stores basic types (i.e. `int`, `float` as defined
+            in `MetricsScalar`) and list of such types (see `MetricsScalarList`).
+        keep_input : bool (default: True)
+            A boolean indicating whether metrics should be deleted from the input
+            dictionary immediately after adding them to the record. When set
+            to True, the data is duplicated in memory. If memory is a concern, set
+            it to False.
+        """
+        if any(not isinstance(k, str) for k in metrics_dict.keys()):
+            raise TypeError(f"Not all keys are of valid type. Expected {str}.")
+
+        def is_valid(value: MetricsScalar) -> None:
+            """Check if value is of expected type."""
+            if not isinstance(value, get_args(MetricsScalar)) or isinstance(
+                value, bool
+            ):
+                raise TypeError(
+                    "Not all values are of valid type."
+                    f" Expected {MetricsRecordValues} but you passed {type(value)}."
+                )
+
+        # Check types of values
+        # Split between those values that are list and those that aren't
+        # then process in the same way
+        for value in metrics_dict.values():
+            if isinstance(value, list):
+                # If your lists are large (e.g. 1M+ elements) this will be slow
+                # 1s to check 10M element list on a M2 Pro
+                # In such settings, you'd be better of treating such metric as
+                # an array and pass it to a ParametersRecord.
+                for list_value in value:
+                    is_valid(list_value)
+            else:
+                is_valid(value)
+
+        # Add metrics to record
+        if keep_input:
+            # Copy
+            self.data = metrics_dict.copy()
+        else:
+            # Add entries to dataclass without duplicating memory
+            for key in list(metrics_dict.keys()):
+                self.data[key] = metrics_dict[key]
+                del metrics_dict[key]
+
+    def __getitem__(self, key: str) -> MetricsRecordValues:
+        """Retrieve an element stored in record."""
+        return self.data[key]

flwr/common/parametersrecord.py

@@ -59,7 +59,6 @@ class ParametersRecord:
     PyTorch's state_dict, but holding serialised tensors instead.
     """
 
-    keep_input: bool
     data: OrderedDict[str, Array] = field(default_factory=OrderedDict[str, Array])
 
     def __init__(
@@ -82,25 +81,29 @@ class ParametersRecord:
             parameters after adding it to the record, set this flag to True. When set
             to True, the data is duplicated in memory.
         """
-        self.keep_input = keep_input
         self.data = OrderedDict()
         if array_dict:
-            self.set_parameters(array_dict)
+            self.set_parameters(array_dict, keep_input=keep_input)
 
-    def set_parameters(self, array_dict: OrderedDict[str, Array]) -> None:
+    def set_parameters(
+        self, array_dict: OrderedDict[str, Array], keep_input: bool = False
+    ) -> None:
         """Add parameters to record.
 
         Parameters
         ----------
         array_dict : OrderedDict[str, Array]
             A dictionary that stores serialized array-like or tensor-like objects.
+        keep_input : bool (default: False)
+            A boolean indicating whether parameters should be deleted from the input
+            dictionary immediately after adding them to the record.
         """
         if any(not isinstance(k, str) for k in array_dict.keys()):
             raise TypeError(f"Not all keys are of valid type. Expected {str}")
         if any(not isinstance(v, Array) for v in array_dict.values()):
             raise TypeError(f"Not all values are of valid type. Expected {Array}")
 
-        if self.keep_input:
+        if keep_input:
             # Copy
             self.data = OrderedDict(array_dict)
         else:
@@ -108,3 +111,7 @@ class ParametersRecord:
             for key in list(array_dict.keys()):
                 self.data[key] = array_dict[key]
                 del array_dict[key]
+
+    def __getitem__(self, key: str) -> Array:
+        """Retrieve an element stored in record."""
+        return self.data[key]

flwr/common/recordset.py

@@ -14,22 +14,15 @@
 # ==============================================================================
 """RecordSet."""
 
+
 from dataclasses import dataclass, field
 from typing import Dict
 
+from .configsrecord import ConfigsRecord
+from .metricsrecord import MetricsRecord
 from .parametersrecord import ParametersRecord
 
 
-@dataclass
-class MetricsRecord:
-    """Metrics record."""
-
-
-@dataclass
-class ConfigsRecord:
-    """Configs record."""
-
-
 @dataclass
 class RecordSet:
     """Definition of RecordSet."""

flwr/common/serde.py

@@ -17,8 +17,8 @@
 
 from typing import Any, Dict, List, MutableMapping, cast
 
-from flwr.proto.task_pb2 import Value
-from flwr.proto.transport_pb2 import (
+from flwr.proto.task_pb2 import Value  # pylint: disable=E0611
+from flwr.proto.transport_pb2 import (  # pylint: disable=E0611
     ClientMessage,
     Code,
     Parameters,

flwr/common/typing.py

@@ -45,6 +45,15 @@ Value = Union[
     List[str],
 ]
 
+# Value types for common.MetricsRecord
+MetricsScalar = Union[int, float]
+MetricsScalarList = Union[List[int], List[float]]
+MetricsRecordValues = Union[MetricsScalar, MetricsScalarList]
+# Value types for common.ConfigsRecord
+ConfigsScalar = Union[MetricsScalar, str, bytes, bool]
+ConfigsScalarList = Union[MetricsScalarList, List[str], List[bytes], List[bool]]
+ConfigsRecordValues = Union[ConfigsScalar, ConfigsScalarList]
+
 Metrics = Dict[str, Scalar]
 MetricsAggregationFn = Callable[[List[Tuple[int, Metrics]]], Metrics]
 

flwr/driver/app.py

@@ -25,7 +25,7 @@ from typing import Dict, Optional, Union
 from flwr.common import EventType, event
 from flwr.common.address import parse_address
 from flwr.common.logger import log
-from flwr.proto import driver_pb2
+from flwr.proto import driver_pb2  # pylint: disable=E0611
 from flwr.server.app import ServerConfig, init_defaults, run_fl
 from flwr.server.client_manager import ClientManager
 from flwr.server.history import History
@@ -171,7 +171,9 @@ def update_client_manager(
     `client_manager.unregister()`.
     """
     # Request for run_id
-    run_id = driver.create_run(driver_pb2.CreateRunRequest()).run_id
+    run_id = driver.create_run(
+        driver_pb2.CreateRunRequest()  # pylint: disable=E1101
+    ).run_id
 
     # Loop until the driver is disconnected
     registered_nodes: Dict[int, DriverClientProxy] = {}
@@ -181,7 +183,7 @@ def update_client_manager(
             if driver.stub is None:
                 break
             get_nodes_res = driver.get_nodes(
-                req=driver_pb2.GetNodesRequest(run_id=run_id)
+                req=driver_pb2.GetNodesRequest(run_id=run_id)  # pylint: disable=E1101
             )
         all_node_ids = {node.node_id for node in get_nodes_res.nodes}
         dead_nodes = set(registered_nodes).difference(all_node_ids)

flwr/driver/driver.py

@@ -18,14 +18,14 @@
 from typing import Iterable, List, Optional, Tuple
 
 from flwr.driver.grpc_driver import DEFAULT_SERVER_ADDRESS_DRIVER, GrpcDriver
-from flwr.proto.driver_pb2 import (
+from flwr.proto.driver_pb2 import (  # pylint: disable=E0611
     CreateRunRequest,
     GetNodesRequest,
     PullTaskResRequest,
     PushTaskInsRequest,
 )
-from flwr.proto.node_pb2 import Node
-from flwr.proto.task_pb2 import TaskIns, TaskRes
+from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
+from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 
 
 class Driver: