flwr-nightly 1.7.0.dev20240124__tar.gz → 1.7.0.dev20240126__tar.gz

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.7.0.dev20240124
+Version: 1.7.0.dev20240126
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.dev
 License: Apache-2.0
@@ -184,6 +184,7 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [Advanced Flower with TensorFlow/Keras](https://github.com/adap/flower/tree/main/examples/advanced-tensorflow)
 - [Advanced Flower with PyTorch](https://github.com/adap/flower/tree/main/examples/advanced-pytorch)
 - Single-Machine Simulation of Federated Learning Systems ([PyTorch](https://github.com/adap/flower/tree/main/examples/simulation_pytorch)) ([Tensorflow](https://github.com/adap/flower/tree/main/examples/simulation_tensorflow))
+- [Flower through Docker Compose and with Grafana dashboard](https://github.com/adap/flower/tree/main/examples/flower-via-docker-compose)
 
 ## Community
 

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/README.md

@@ -135,6 +135,7 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [Advanced Flower with TensorFlow/Keras](https://github.com/adap/flower/tree/main/examples/advanced-tensorflow)
 - [Advanced Flower with PyTorch](https://github.com/adap/flower/tree/main/examples/advanced-pytorch)
 - Single-Machine Simulation of Federated Learning Systems ([PyTorch](https://github.com/adap/flower/tree/main/examples/simulation_pytorch)) ([Tensorflow](https://github.com/adap/flower/tree/main/examples/simulation_tensorflow))
+- [Flower through Docker Compose and with Grafana dashboard](https://github.com/adap/flower/tree/main/examples/flower-via-docker-compose)
 
 ## Community
 

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.7.0-dev20240124"
+version = "1.7.0-dev20240126"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.dev>"]
@@ -81,7 +81,7 @@ rest = ["requests", "starlette", "uvicorn"]
 [tool.poetry.group.dev.dependencies]
 types-dataclasses = "==0.6.6"
 types-protobuf = "==3.19.18"
-types-requests = "==2.31.0.10"
+types-requests = "==2.31.0.20240125"
 types-setuptools = "==69.0.0.20240115"
 clang-format = "==17.0.4"
 isort = "==5.13.2"

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/client/app.py

@@ -352,7 +352,7 @@ def _start_client_internal(
                     break
 
                 # Register state
-                node_state.register_runstate(run_id=task_ins.run_id)
+                node_state.register_context(run_id=task_ins.run_id)
 
                 # Load app
                 app: Flower = load_flower_callable_fn()
@@ -360,14 +360,14 @@ def _start_client_internal(
                 # Handle task message
                 fwd_msg: Fwd = Fwd(
                     task_ins=task_ins,
-                    state=node_state.retrieve_runstate(run_id=task_ins.run_id),
+                    context=node_state.retrieve_context(run_id=task_ins.run_id),
                 )
                 bwd_msg: Bwd = app(fwd=fwd_msg)
 
                 # Update node state
-                node_state.update_runstate(
-                    run_id=bwd_msg.task_res.run_id,
-                    run_state=bwd_msg.state,
+                node_state.update_context(
+                    run_id=fwd_msg.task_ins.run_id,
+                    context=bwd_msg.context,
                 )
 
                 # Send

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/client/client.py

@@ -19,7 +19,6 @@ from __future__ import annotations
 
 from abc import ABC
 
-from flwr.client.run_state import RunState
 from flwr.common import (
     Code,
     EvaluateIns,
@@ -33,12 +32,13 @@ from flwr.common import (
     Parameters,
     Status,
 )
+from flwr.common.context import Context
 
 
 class Client(ABC):
     """Abstract base class for Flower clients."""
 
-    state: RunState
+    context: Context
 
     def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
         """Return set of client's properties.
@@ -141,13 +141,13 @@ class Client(ABC):
             metrics={},
         )
 
-    def get_state(self) -> RunState:
-        """Get the run state from this client."""
-        return self.state
+    def get_context(self) -> Context:
+        """Get the run context from this client."""
+        return self.context
 
-    def set_state(self, state: RunState) -> None:
-        """Apply a run state to this client."""
-        self.state = state
+    def set_context(self, context: Context) -> None:
+        """Apply a run context to this client."""
+        self.context = context
 
     def to_client(self) -> Client:
         """Return client (itself)."""

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/client/flower.py

@@ -56,12 +56,12 @@ class Flower:
     ) -> None:
         # Create wrapper function for `handle`
         def ffn(fwd: Fwd) -> Bwd:  # pylint: disable=invalid-name
-            task_res, state_updated = handle(
+            task_res, context_updated = handle(
                 client_fn=client_fn,
-                state=fwd.state,
+                context=fwd.context,
                 task_ins=fwd.task_ins,
             )
-            return Bwd(task_res=task_res, state=state_updated)
+            return Bwd(task_res=task_res, context=context_updated)
 
         # Wrap middleware layers around the wrapped handle function
         self._call = make_ffn(ffn, layers if layers is not None else [])

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/client/message_handler/message_handler.py

@@ -28,10 +28,10 @@ from flwr.client.message_handler.task_handler import (
     get_server_message_from_task_ins,
     wrap_client_message_in_task_res,
 )
-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.common.context import Context
 from flwr.proto.task_pb2 import (  # pylint: disable=E0611
     SecureAggregation,
     Task,
@@ -88,16 +88,16 @@ def handle_control_message(task_ins: TaskIns) -> Tuple[Optional[TaskRes], int]:
 
 
 def handle(
-    client_fn: ClientFn, state: RunState, task_ins: TaskIns
-) -> Tuple[TaskRes, RunState]:
+    client_fn: ClientFn, context: Context, task_ins: TaskIns
+) -> Tuple[TaskRes, Context]:
     """Handle incoming TaskIns from the server.
 
     Parameters
     ----------
     client_fn : ClientFn
         A callable that instantiates a Client.
-    state : RunState
-        A dataclass storing the state for the run being executed by the client.
+    context : Context
+        A dataclass storing the context for the run being executed by the client.
     task_ins: TaskIns
         The task instruction coming from the server, to be processed by the client.
 
@@ -110,7 +110,7 @@ def handle(
     if server_msg is None:
         # Instantiate the client
         client = client_fn("-1")
-        client.set_state(state)
+        client.set_context(context)
         # Secure Aggregation
         if task_ins.task.HasField("sa") and isinstance(
             client, SecureAggregationHandler
@@ -127,24 +127,24 @@ def handle(
                     sa=SecureAggregation(named_values=serde.named_values_to_proto(res)),
                 ),
             )
-            return task_res, client.get_state()
+            return task_res, client.get_context()
         raise NotImplementedError()
-    client_msg, updated_state = handle_legacy_message(client_fn, state, server_msg)
+    client_msg, updated_context = handle_legacy_message(client_fn, context, server_msg)
     task_res = wrap_client_message_in_task_res(client_msg)
-    return task_res, updated_state
+    return task_res, updated_context
 
 
 def handle_legacy_message(
-    client_fn: ClientFn, state: RunState, server_msg: ServerMessage
-) -> Tuple[ClientMessage, RunState]:
+    client_fn: ClientFn, context: Context, server_msg: ServerMessage
+) -> Tuple[ClientMessage, Context]:
     """Handle incoming messages from the server.
 
     Parameters
     ----------
     client_fn : ClientFn
         A callable that instantiates a Client.
-    state : RunState
-        A dataclass storing the state for the run being executed by the client.
+    context : Context
+        A dataclass storing the context for the run being executed by the client.
     server_msg: ServerMessage
         The message coming from the server, to be processed by the client.
 
@@ -161,7 +161,7 @@ def handle_legacy_message(
 
     # Instantiate the client
     client = client_fn("-1")
-    client.set_state(state)
+    client.set_context(context)
     # Execute task
     message = None
     if field == "get_properties_ins":
@@ -173,7 +173,7 @@ def handle_legacy_message(
     if field == "evaluate_ins":
         message = _evaluate(client, server_msg.evaluate_ins)
     if message:
-        return message, client.get_state()
+        return message, client.get_context()
     raise UnknownServerMessage()
 
 

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/client/node_state.py

@@ -17,7 +17,8 @@
 
 from typing import Any, Dict
 
-from flwr.client.run_state import RunState
+from flwr.common.context import Context
+from flwr.common.recordset import RecordSet
 
 
 class NodeState:
@@ -25,24 +26,24 @@ class NodeState:
 
     def __init__(self) -> None:
         self._meta: Dict[str, Any] = {}  # holds metadata about the node
-        self.run_states: Dict[int, RunState] = {}
+        self.run_contexts: Dict[int, Context] = {}
 
-    def register_runstate(self, run_id: int) -> None:
-        """Register new run state for this node."""
-        if run_id not in self.run_states:
-            self.run_states[run_id] = RunState({})
+    def register_context(self, run_id: int) -> None:
+        """Register new run context for this node."""
+        if run_id not in self.run_contexts:
+            self.run_contexts[run_id] = Context(state=RecordSet())
 
-    def retrieve_runstate(self, run_id: int) -> RunState:
-        """Get run state given a run_id."""
-        if run_id in self.run_states:
-            return self.run_states[run_id]
+    def retrieve_context(self, run_id: int) -> Context:
+        """Get run context given a run_id."""
+        if run_id in self.run_contexts:
+            return self.run_contexts[run_id]
 
         raise RuntimeError(
-            f"RunState for run_id={run_id} doesn't exist."
-            " A run must be registered before it can be retrieved or updated "
+            f"Context for run_id={run_id} doesn't exist."
+            " A run context must be registered before it can be retrieved or updated "
             " by a client."
         )
 
-    def update_runstate(self, run_id: int, run_state: RunState) -> None:
-        """Update run state."""
-        self.run_states[run_id] = run_state
+    def update_context(self, run_id: int, context: Context) -> None:
+        """Update run context."""
+        self.run_contexts[run_id] = context

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/client/node_state_tests.py

@@ -16,17 +16,22 @@
 
 
 from flwr.client.node_state import NodeState
-from flwr.client.run_state import RunState
+from flwr.common.configsrecord import ConfigsRecord
+from flwr.common.context import Context
 from flwr.proto.task_pb2 import TaskIns  # pylint: disable=E0611
 
 
-def _run_dummy_task(state: RunState) -> RunState:
-    if "counter" in state.state:
-        state.state["counter"] += "1"
-    else:
-        state.state["counter"] = "1"
+def _run_dummy_task(context: Context) -> Context:
+    counter_value: str = "1"
+    if "counter" in context.state.configs.keys():
+        counter_value = context.get_configs("counter")["count"]  # type: ignore
+        counter_value += "1"
 
-    return state
+    context.state.set_configs(
+        name="counter", record=ConfigsRecord({"count": counter_value})
+    )
+
+    return context
 
 
 def test_multirun_in_node_state() -> None:
@@ -43,17 +48,17 @@ def test_multirun_in_node_state() -> None:
         run_id = task.run_id
 
         # Register
-        node_state.register_runstate(run_id=run_id)
+        node_state.register_context(run_id=run_id)
 
         # Get run state
-        state = node_state.retrieve_runstate(run_id=run_id)
+        context = node_state.retrieve_context(run_id=run_id)
 
         # Run "task"
-        updated_state = _run_dummy_task(state)
+        updated_state = _run_dummy_task(context)
 
         # Update run state
-        node_state.update_runstate(run_id=run_id, run_state=updated_state)
+        node_state.update_context(run_id=run_id, context=updated_state)
 
     # Verify values
-    for run_id, state in node_state.run_states.items():
-        assert state.state["counter"] == expected_values[run_id]
+    for run_id, context in node_state.run_contexts.items():
+        assert context.state.get_configs("counter")["count"] == expected_values[run_id]

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/client/numpy_client.py

@@ -19,7 +19,6 @@ from abc import ABC
 from typing import Callable, Dict, Tuple
 
 from flwr.client.client import Client
-from flwr.client.run_state import RunState
 from flwr.common import (
     Config,
     NDArrays,
@@ -27,6 +26,7 @@ from flwr.common import (
     ndarrays_to_parameters,
     parameters_to_ndarrays,
 )
+from flwr.common.context import Context
 from flwr.common.typing import (
     Code,
     EvaluateIns,
@@ -70,7 +70,7 @@ Example
 class NumPyClient(ABC):
     """Abstract base class for Flower clients using NumPy."""
 
-    state: RunState
+    context: Context
 
     def get_properties(self, config: Config) -> Dict[str, Scalar]:
         """Return a client's set of properties.
@@ -174,13 +174,13 @@ class NumPyClient(ABC):
         _ = (self, parameters, config)
         return 0.0, 0, {}
 
-    def get_state(self) -> RunState:
-        """Get the run state from this client."""
-        return self.state
+    def get_context(self) -> Context:
+        """Get the run context from this client."""
+        return self.context
 
-    def set_state(self, state: RunState) -> None:
-        """Apply a run state to this client."""
-        self.state = state
+    def set_context(self, context: Context) -> None:
+        """Apply a run context to this client."""
+        self.context = context
 
     def to_client(self) -> Client:
         """Convert to object to Client type and return it."""
@@ -278,21 +278,21 @@ def _evaluate(self: Client, ins: EvaluateIns) -> EvaluateRes:
     )
 
 
-def _get_state(self: Client) -> RunState:
-    """Return state of underlying NumPyClient."""
-    return self.numpy_client.get_state()  # type: ignore
+def _get_context(self: Client) -> Context:
+    """Return context of underlying NumPyClient."""
+    return self.numpy_client.get_context()  # type: ignore
 
 
-def _set_state(self: Client, state: RunState) -> None:
-    """Apply state to underlying NumPyClient."""
-    self.numpy_client.set_state(state)  # type: ignore
+def _set_context(self: Client, context: Context) -> None:
+    """Apply context to underlying NumPyClient."""
+    self.numpy_client.set_context(context)  # type: ignore
 
 
 def _wrap_numpy_client(client: NumPyClient) -> Client:
     member_dict: Dict[str, Callable] = {  # type: ignore
         "__init__": _constructor,
-        "get_state": _get_state,
-        "set_state": _set_state,
+        "get_context": _get_context,
+        "set_context": _set_context,
     }
 
     # Add wrapper type methods (if overridden)

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/client/typing.py

@@ -17,7 +17,7 @@
 from dataclasses import dataclass
 from typing import Callable
 
-from flwr.client.run_state import RunState
+from flwr.common.context import Context
 from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
 
 from .client import Client as Client
@@ -28,7 +28,7 @@ class Fwd:
     """."""
 
     task_ins: TaskIns
-    state: RunState
+    context: Context
 
 
 @dataclass
@@ -36,7 +36,7 @@ class Bwd:
     """."""
 
     task_res: TaskRes
-    state: RunState
+    context: Context
 
 
 FlowerCallable = Callable[[Fwd], Bwd]

flwr_nightly-1.7.0.dev20240124/src/py/flwr/client/run_state.py → flwr_nightly-1.7.0.dev20240126/src/py/flwr/common/context.py

@@ -1,4 +1,4 @@
-# Copyright 2023 Flower Labs GmbH. All Rights Reserved.
+# 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.
@@ -12,14 +12,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-"""Run state."""
+"""Context."""
+
 
 from dataclasses import dataclass
-from typing import Dict
+
+from .recordset import RecordSet
 
 
 @dataclass
-class RunState:
-    """State of a run executed by a client node."""
+class Context:
+    """State of your run.
+
+    Parameters
+    ----------
+    state : RecordSet
+        Holds records added by the entity in a given run 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)
+    """
 
-    state: Dict[str, str]
+    state: RecordSet

flwr_nightly-1.7.0.dev20240124/src/py/flwr/common/flowercontext.py → flwr_nightly-1.7.0.dev20240126/src/py/flwr/common/message.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-"""FlowerContext and Metadata."""
+"""Message."""
 
 
 from dataclasses import dataclass
@@ -48,30 +48,17 @@ class Metadata:
 
 
 @dataclass
-class FlowerContext:
+class Message:
     """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.
+    message : RecordSet
+        Holds records either sent by another entity (e.g. sent by the server-side
+        logic to a client, or vice-versa) or that will be sent to it.
     """
 
-    in_message: RecordSet
-    out_message: RecordSet
-    local: RecordSet
     metadata: Metadata
+    message: RecordSet

{flwr_nightly-1.7.0.dev20240124 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/common/recordset_compat.py

@@ -40,20 +40,22 @@ from .typing import (
 
 
 def parametersrecord_to_parameters(
-    record: ParametersRecord, keep_input: bool = False
+    record: ParametersRecord, keep_input: bool
 ) -> Parameters:
     """Convert ParameterRecord to legacy Parameters.
 
-    Warning: Because `Arrays` in `ParametersRecord` encode more information of the
+    Warnings
+    --------
+    Because `Arrays` in `ParametersRecord` encode more information of the
     array-like or tensor-like data (e.g their datatype, shape) than `Parameters` it
     might not be possible to reconstruct such data structures from `Parameters` objects
-    alone. Additional information or metadta must be provided from elsewhere.
+    alone. Additional information or metadata must be provided from elsewhere.
 
     Parameters
     ----------
     record : ParametersRecord
         The record to be conveted into Parameters.
-    keep_input : bool (default: False)
+    keep_input : bool
         A boolean indicating whether entries in the record should be deleted from the
         input dictionary immediately after adding them to the record.
     """
@@ -74,7 +76,7 @@ def parametersrecord_to_parameters(
 
 
 def parameters_to_parametersrecord(
-    parameters: Parameters, keep_input: bool = False
+    parameters: Parameters, keep_input: bool
 ) -> ParametersRecord:
     """Convert legacy Parameters into a single ParametersRecord.
 
@@ -86,7 +88,7 @@ def parameters_to_parametersrecord(
     ----------
     parameters : Parameters
         Parameters object to be represented as a ParametersRecord.
-    keep_input : bool (default: False)
+    keep_input : bool
         A boolean indicating whether parameters should be deleted from the input
         Parameters object (i.e. a list of serialized NumPy arrays) immediately after
         adding them to the record.
@@ -96,17 +98,17 @@ def parameters_to_parametersrecord(
     p_record = ParametersRecord()
 
     num_arrays = len(parameters.tensors)
+    ordered_dict = OrderedDict()
     for idx in range(num_arrays):
         if keep_input:
             tensor = parameters.tensors[idx]
         else:
             tensor = parameters.tensors.pop(0)
-        p_record.set_parameters(
-            OrderedDict(
-                {str(idx): Array(data=tensor, dtype="", stype=tensor_type, shape=[])}
-            )
+        ordered_dict[str(idx)] = Array(
+            data=tensor, dtype="", stype=tensor_type, shape=[]
         )
 
+    p_record.set_parameters(ordered_dict, keep_input=keep_input)
     return p_record
 
 
@@ -330,11 +332,15 @@ def getparametersins_to_recordset(getparameters_ins: GetParametersIns) -> Record
     return recordset
 
 
-def getparametersres_to_recordset(getparametersres: GetParametersRes) -> RecordSet:
+def getparametersres_to_recordset(
+    getparametersres: GetParametersRes, keep_input: bool
+) -> RecordSet:
     """Construct a RecordSet from a GetParametersRes object."""
     recordset = RecordSet()
     res_str = "getparametersres"
-    parameters_record = parameters_to_parametersrecord(getparametersres.parameters)
+    parameters_record = parameters_to_parametersrecord(
+        getparametersres.parameters, keep_input=keep_input
+    )
     recordset.set_parameters(f"{res_str}.parameters", parameters_record)
 
     # status
@@ -345,11 +351,13 @@ def getparametersres_to_recordset(getparametersres: GetParametersRes) -> RecordS
     return recordset
 
 
-def recordset_to_getparametersres(recordset: RecordSet) -> GetParametersRes:
+def recordset_to_getparametersres(
+    recordset: RecordSet, keep_input: bool
+) -> GetParametersRes:
     """Derive GetParametersRes from a RecordSet object."""
     res_str = "getparametersres"
     parameters = parametersrecord_to_parameters(
-        recordset.get_parameters(f"{res_str}.parameters")
+        recordset.get_parameters(f"{res_str}.parameters"), keep_input=keep_input
     )
 
     status = _extract_status_from_recordset(res_str, recordset)