flwr-nightly 1.7.0.dev20240124__py3-none-any.whl → 1.7.0.dev20240126__py3-none-any.whl

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/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/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/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/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/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/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/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/{client/run_state.py → 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/common/{flowercontext.py → 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/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)

flwr/common/serde.py

@@ -17,7 +17,7 @@
 
 from typing import Any, Dict, List, MutableMapping, OrderedDict, Type, TypeVar, cast
 
-from google.protobuf.message import Message
+from google.protobuf.message import Message as GrpcMessage
 
 # pylint: disable=E0611
 from flwr.proto.recordset_pb2 import Array as ProtoArray
@@ -30,7 +30,7 @@ from flwr.proto.recordset_pb2 import MetricsRecordValue as ProtoMetricsRecordVal
 from flwr.proto.recordset_pb2 import ParametersRecord as ProtoParametersRecord
 from flwr.proto.recordset_pb2 import RecordSet as ProtoRecordSet
 from flwr.proto.recordset_pb2 import Sint64List, StringList
-from flwr.proto.task_pb2 import Value
+from flwr.proto.task_pb2 import Task, TaskIns, TaskRes, Value
 from flwr.proto.transport_pb2 import (
     ClientMessage,
     Code,
@@ -44,6 +44,7 @@ from flwr.proto.transport_pb2 import (
 # pylint: enable=E0611
 from . import typing
 from .configsrecord import ConfigsRecord
+from .message import Message, Metadata
 from .metricsrecord import MetricsRecord
 from .parametersrecord import Array, ParametersRecord
 from .recordset import RecordSet
@@ -600,12 +601,15 @@ T = TypeVar("T")
 def _record_value_to_proto(
     value: Any, allowed_types: List[type], proto_class: Type[T]
 ) -> T:
-    """Serialize `*RecordValue` to ProtoBuf."""
+    """Serialize `*RecordValue` to ProtoBuf.
+
+    Note: `bool` MUST be put in the front of allowd_types if it exists.
+    """
     arg = {}
     for t in allowed_types:
         # Single element
         # Note: `isinstance(False, int) == True`.
-        if type(value) == t:  # pylint: disable=C0123
+        if isinstance(value, t):
             arg[_type_to_field[t]] = value
             return proto_class(**arg)
         # List
@@ -620,7 +624,7 @@ def _record_value_to_proto(
     )
 
 
-def _record_value_from_proto(value_proto: Message) -> Any:
+def _record_value_from_proto(value_proto: GrpcMessage) -> Any:
     """Deserialize `*RecordValue` from ProtoBuf."""
     value_field = cast(str, value_proto.WhichOneof("value"))
     if value_field.endswith("list"):
@@ -633,7 +637,14 @@ def _record_value_from_proto(value_proto: Message) -> Any:
 def _record_value_dict_to_proto(
     value_dict: Dict[str, Any], allowed_types: List[type], value_proto_class: Type[T]
 ) -> Dict[str, T]:
-    """Serialize the record value dict to ProtoBuf."""
+    """Serialize the record value dict to ProtoBuf.
+
+    Note: `bool` MUST be put in the front of allowd_types if it exists.
+    """
+    # Move bool to the front
+    if bool in allowed_types and allowed_types[0] != bool:
+        allowed_types.remove(bool)
+        allowed_types.insert(0, bool)
 
     def proto(_v: Any) -> T:
         return _record_value_to_proto(_v, allowed_types, value_proto_class)
@@ -707,7 +718,7 @@ def configs_record_to_proto(record: ConfigsRecord) -> ProtoConfigsRecord:
     """Serialize ConfigsRecord to ProtoBuf."""
     return ProtoConfigsRecord(
         data=_record_value_dict_to_proto(
-            record.data, [int, float, bool, str, bytes], ProtoConfigsRecordValue
+            record.data, [bool, int, float, str, bytes], ProtoConfigsRecordValue
         )
     )
 
@@ -751,3 +762,64 @@ def recordset_from_proto(recordset_proto: ProtoRecordSet) -> RecordSet:
             k: configs_record_from_proto(v) for k, v in recordset_proto.configs.items()
         },
     )
+
+
+# === Message ===
+
+
+def message_to_taskins(message: Message) -> TaskIns:
+    """Create a TaskIns from the Message."""
+    return TaskIns(
+        task=Task(
+            ttl=message.metadata.ttl,
+            task_type=message.metadata.task_type,
+            recordset=recordset_to_proto(message.message),
+        ),
+    )
+
+
+def message_from_taskins(taskins: TaskIns) -> Message:
+    """Create a Message from the TaskIns."""
+    # Retrieve the Metadata
+    metadata = Metadata(
+        run_id=taskins.run_id,
+        task_id=taskins.task_id,
+        group_id=taskins.group_id,
+        ttl=taskins.task.ttl,
+        task_type=taskins.task.task_type,
+    )
+
+    # Return the Message
+    return Message(
+        metadata=metadata,
+        message=recordset_from_proto(taskins.task.recordset),
+    )
+
+
+def message_to_taskres(message: Message) -> TaskRes:
+    """Create a TaskRes from the Message."""
+    return TaskRes(
+        task=Task(
+            ttl=message.metadata.ttl,
+            task_type=message.metadata.task_type,
+            recordset=recordset_to_proto(message.message),
+        ),
+    )
+
+
+def message_from_taskres(taskres: TaskRes) -> Message:
+    """Create a Message from the TaskIns."""
+    # Retrieve the MetaData
+    metadata = Metadata(
+        run_id=taskres.run_id,
+        task_id=taskres.task_id,
+        group_id=taskres.group_id,
+        ttl=taskres.task.ttl,
+        task_type=taskres.task.task_type,
+    )
+
+    # Return the Message
+    return Message(
+        metadata=metadata,
+        message=recordset_from_proto(taskres.task.recordset),
+    )

flwr/simulation/ray_transport/ray_actor.py

@@ -27,7 +27,7 @@ from ray.util.actor_pool import ActorPool
 
 from flwr import common
 from flwr.client import Client, ClientFn
-from flwr.client.run_state import RunState
+from flwr.common.context import Context
 from flwr.common.logger import log
 from flwr.simulation.ray_transport.utils import check_clientfn_returns_client
 
@@ -61,8 +61,8 @@ class VirtualClientEngineActor(ABC):
         client_fn: ClientFn,
         job_fn: JobFn,
         cid: str,
-        state: RunState,
-    ) -> Tuple[str, ClientRes, RunState]:
+        context: Context,
+    ) -> Tuple[str, ClientRes, Context]:
         """Run a client run."""
         # Execute tasks and return result
         # return also cid which is needed to ensure results
@@ -70,12 +70,12 @@ class VirtualClientEngineActor(ABC):
         try:
             # Instantiate client (check 'Client' type is returned)
             client = check_clientfn_returns_client(client_fn(cid))
-            # Inject state
-            client.set_state(state)
+            # Inject context
+            client.set_context(context)
             # Run client job
             job_results = job_fn(client)
-            # Retrieve state (potentially updated)
-            updated_state = client.get_state()
+            # Retrieve context (potentially updated)
+            updated_context = client.get_context()
         except Exception as ex:
             client_trace = traceback.format_exc()
             message = (
@@ -89,7 +89,7 @@ class VirtualClientEngineActor(ABC):
             )
             raise ClientException(str(message)) from ex
 
-        return cid, job_results, updated_state
+        return cid, job_results, updated_context
 
 
 @ray.remote
@@ -237,16 +237,16 @@ class VirtualClientEngineActorPool(ActorPool):
             self._idle_actors.extend(new_actors)
             self.num_actors += num_actors
 
-    def submit(self, fn: Any, value: Tuple[ClientFn, JobFn, str, RunState]) -> None:
+    def submit(self, fn: Any, value: Tuple[ClientFn, JobFn, str, Context]) -> None:
         """Take idle actor and assign it a client run.
 
         Submit a job to an actor by first removing it from the list of idle actors, then
         check if this actor was flagged to be removed from the pool
         """
-        client_fn, job_fn, cid, state = value
+        client_fn, job_fn, cid, context = value
         actor = self._idle_actors.pop()
         if self._check_and_remove_actor_from_pool(actor):
-            future = fn(actor, client_fn, job_fn, cid, state)
+            future = fn(actor, client_fn, job_fn, cid, context)
             future_key = tuple(future) if isinstance(future, List) else future
             self._future_to_actor[future_key] = (self._next_task_index, actor, cid)
             self._next_task_index += 1
@@ -255,7 +255,7 @@ class VirtualClientEngineActorPool(ActorPool):
             self._cid_to_future[cid]["future"] = future_key
 
     def submit_client_job(
-        self, actor_fn: Any, job: Tuple[ClientFn, JobFn, str, RunState]
+        self, actor_fn: Any, job: Tuple[ClientFn, JobFn, str, Context]
     ) -> None:
         """Submit a job while tracking client ids."""
         _, _, cid, _ = job
@@ -295,17 +295,17 @@ class VirtualClientEngineActorPool(ActorPool):
 
         return self._cid_to_future[cid]["ready"]  # type: ignore
 
-    def _fetch_future_result(self, cid: str) -> Tuple[ClientRes, RunState]:
-        """Fetch result and updated state for a VirtualClient from Object Store.
+    def _fetch_future_result(self, cid: str) -> Tuple[ClientRes, Context]:
+        """Fetch result and updated context for a VirtualClient from Object Store.
 
         The job submitted by the ClientProxy interfacing with client with cid=cid is
         ready. Here we fetch it from the object store and return.
         """
         try:
             future: ObjectRef[Any] = self._cid_to_future[cid]["future"]  # type: ignore
-            res_cid, res, updated_state = ray.get(
+            res_cid, res, updated_context = ray.get(
                 future
-            )  # type: (str, ClientRes, RunState)
+            )  # type: (str, ClientRes, Context)
         except ray.exceptions.RayActorError as ex:
             log(ERROR, ex)
             if hasattr(ex, "actor_id"):
@@ -322,7 +322,7 @@ class VirtualClientEngineActorPool(ActorPool):
         # Reset mapping
         self._reset_cid_to_future_dict(cid)
 
-        return res, updated_state
+        return res, updated_context
 
     def _flag_actor_for_removal(self, actor_id_hex: str) -> None:
         """Flag actor that should be removed from pool."""
@@ -409,7 +409,7 @@ class VirtualClientEngineActorPool(ActorPool):
 
     def get_client_result(
         self, cid: str, timeout: Optional[float]
-    ) -> Tuple[ClientRes, RunState]:
+    ) -> Tuple[ClientRes, Context]:
         """Get result from VirtualClient with specific cid."""
         # Loop until all jobs submitted to the pool are completed. Break early
         # if the result for the ClientProxy calling this method is ready
@@ -421,5 +421,5 @@ class VirtualClientEngineActorPool(ActorPool):
                 break
 
         # Fetch result belonging to the VirtualClient calling this method
-        # Return both result from tasks and (potentially) updated run state
+        # Return both result from tasks and (potentially) updated run context
         return self._fetch_future_result(cid)

flwr/simulation/ray_transport/ray_client_proxy.py

@@ -138,20 +138,20 @@ class RayActorClientProxy(ClientProxy):
         run_id = 0
 
         # Register state
-        self.proxy_state.register_runstate(run_id=run_id)
+        self.proxy_state.register_context(run_id=run_id)
 
         # Retrieve state
-        state = self.proxy_state.retrieve_runstate(run_id=run_id)
+        state = self.proxy_state.retrieve_context(run_id=run_id)
 
         try:
             self.actor_pool.submit_client_job(
                 lambda a, c_fn, j_fn, cid, state: a.run.remote(c_fn, j_fn, cid, state),
                 (self.client_fn, job_fn, self.cid, state),
             )
-            res, updated_state = self.actor_pool.get_client_result(self.cid, timeout)
+            res, updated_context = self.actor_pool.get_client_result(self.cid, timeout)
 
             # Update state
-            self.proxy_state.update_runstate(run_id=run_id, run_state=updated_state)
+            self.proxy_state.update_context(run_id=run_id, context=updated_context)
 
         except Exception as ex:
             if self.actor_pool.num_actors == 0:

{flwr_nightly-1.7.0.dev20240124.dist-info → flwr_nightly-1.7.0.dev20240126.dist-info}/METADATA

@@ -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.dist-info → flwr_nightly-1.7.0.dev20240126.dist-info}/RECORD

@@ -1,42 +1,42 @@
 flwr/__init__.py,sha256=6zbcS7z2q-VUdmpFppLH6BacsE-ZFmfq6OvtKNOyYE0,981
 flwr/client/__init__.py,sha256=2T4enmlE4PsoKiGTvXwBKSlhOjZ7MXRy5oCGNf0UH9Y,1111
-flwr/client/app.py,sha256=AkJXshBH0zKLqkm3dQQ4KYFrwNmLdjzLNZvgzfKiCOc,19243
-flwr/client/client.py,sha256=LmGguS2YV_BmTG-P3NXvxeljbuJ2d1OkFYRY5pQz-bQ,8198
+flwr/client/app.py,sha256=B0pa8BZ5oLYRs1Fs7KhqYOxM3Sy6w9LmUt-hQfjTlBA,19242
+flwr/client/client.py,sha256=ATcsqAMS9zpMBJ9ZUbBeB7BEPWX_VWISONy0p6Wxl5g,8210
 flwr/client/dpfedavg_numpy_client.py,sha256=0XryFdCMM_RLiNLCr6evLp-6R7ZjeMmRUROIgzRmtmc,7215
-flwr/client/flower.py,sha256=PPYROFVnu7NEe7sR8XFVbkfvfwecIuQc5-VllPz0LlQ,4049
+flwr/client/flower.py,sha256=Xh3v7NgAliaLEjwMC6hhq_E0YxaVbHqwEd0HqwWe2lo,4059
 flwr/client/grpc_client/__init__.py,sha256=LsnbqXiJhgQcB0XzAlUQgPx011Uf7Y7yabIC1HxivJ8,735
 flwr/client/grpc_client/connection.py,sha256=WJazRjWZuSLnE4jsGtJ86g9THewbAfspQ-XtmfGR8uQ,5115
 flwr/client/grpc_rere_client/__init__.py,sha256=avn6W_vHEM_yZEB1S7hCZgnTbXb6ZujqRP_vAzyXu-0,752
 flwr/client/grpc_rere_client/connection.py,sha256=NtYxwJCucI9RYieU9rVMi5wzrnvLNxhSWYmi5IiWAtc,6660
 flwr/client/message_handler/__init__.py,sha256=abHvBRJJiiaAMNgeILQbMOa6h8WqMK2BcnvxwQZFpic,719
-flwr/client/message_handler/message_handler.py,sha256=zf6n2itYm7pjapTzEy3tvda3e1YTotIXNxRGX_hlLOg,8393
+flwr/client/message_handler/message_handler.py,sha256=vhVhFdohM3q6xz5bqcDLSTyR9viFUAkbBKHCTiB4qyQ,8414
 flwr/client/message_handler/task_handler.py,sha256=36g-gP7oH_VDpsjW2P9LH4uzlDkygY8S9FyGxjbSw34,5823
 flwr/client/middleware/__init__.py,sha256=Eo3JvAV5XqmyRySNqeiw93YNETmmP5ixEOMeBA6ah4w,769
 flwr/client/middleware/utils.py,sha256=QUghso_SWsKTUPfKwrtBwPyyJoEI9AV9hRY2acu1TYE,1168
-flwr/client/node_state.py,sha256=3NUHqNokmFAN7Rv0rWIWnoaBKyYH9K3Ir0exGC_nx4M,1749
-flwr/client/node_state_tests.py,sha256=SX1kiXQmDP11eJTkaj1BFoKQpP_6XFaMQukT3_sOT6c,1939
-flwr/client/numpy_client.py,sha256=c9OMP2c61dr_oNy88osWwQjsOyimzJXeldlN34UAo2c,10276
+flwr/client/node_state.py,sha256=0hk1RZuFZ3_S7Y8Q0BCP60NljxnT9vqPmIflvCCGxnQ,1819
+flwr/client/node_state_tests.py,sha256=H3sO526boAlDS491fO5xvZhl5XNDzzl-I8DiaVmnsXM,2195
+flwr/client/numpy_client.py,sha256=42e8_gZU5gwzpvVXQr6LEWEGfpWYTcQ0MY0F0owNlAc,10310
 flwr/client/rest_client/__init__.py,sha256=ThwOnkMdzxo_UuyTI47Q7y9oSpuTgNT2OuFvJCfuDiw,735
 flwr/client/rest_client/connection.py,sha256=j8BpGRM4mGJrkw7Yncpwk-BJ6KOw0C3PS3tqLfsUUes,11762
-flwr/client/run_state.py,sha256=d4UmHLt9zMd0sTgnVdRsLgr1QEx0l5PtJ0dPv2NSVVw,867
 flwr/client/secure_aggregation/__init__.py,sha256=XCDycteBTivym0zwkwqXhFMCAoDoHBZQg5GxdMnFCfA,888
 flwr/client/secure_aggregation/handler.py,sha256=oRyGCerz92aED7UydYwJ7OFVxUwHqedG3PshHrdZq-Y,1522
 flwr/client/secure_aggregation/secaggplus_handler.py,sha256=2jKtRhoJaVRmMJgJ2v8VRUCw2ko7uhTL2_h8CZVFwZA,18928
-flwr/client/typing.py,sha256=75vC6dpzv99PLRztPzaGPik2OifFZbgxvHVDMIA_C30,1219
+flwr/client/typing.py,sha256=F6E2sDRrUirWdGQlfBR4YOaAJ-TYn7XiLuQMG6bMXrI,1218
 flwr/common/__init__.py,sha256=qttep0POwoigzB5pcraZa4YMt9jsCSfeibcrTQMUjIc,2884
 flwr/common/address.py,sha256=iTAN9jtmIGMrWFnx9XZQl45ZEtQJVZZLYPRBSNVARGI,1882
 flwr/common/configsrecord.py,sha256=i41syiXeG4CyWr4ujOCxTDBZKiClNnNgR4xbufxThh0,4799
 flwr/common/constant.py,sha256=J-BpHv6OFmrA37SeS4En8Nsy7yJdoNJWHCtbdnjIxSc,1120
+flwr/common/context.py,sha256=OP4mTxsCdU2LS63TegdLHaEDpxULZ4AQ4ybZl7jEdDU,1329
 flwr/common/date.py,sha256=UWhBZj49yX9LD4BmatS_ZFZu_-kweGh0KQJ1djyWWH4,891
 flwr/common/dp.py,sha256=hF45cPElXxcQsh4AoquAyaTrNi0xCrIcKx7xOcV_1XU,1782
-flwr/common/flowercontext.py,sha256=pC8Vjw9ToNX4i8oMuvSSJrZEccJhPN9i60b1apQnQWE,2562
 flwr/common/grpc.py,sha256=qVLB0d6bCuaBRW5YB0vEZXsR7Bo3R2lh4ONiCocqwRI,2270
 flwr/common/logger.py,sha256=qX_gqEyrmGOH0x_r8uQ1Vskz4fGvEij9asdo4DUOPY8,4135
+flwr/common/message.py,sha256=GQuhFmvJIrCG6h4L-jQMsn6KYh-nmNqNNo5qVe7ye5w,1847
 flwr/common/metricsrecord.py,sha256=n9789VVdjEPX0o7Je_1wRuzs7LkLh5d37QRyN0iVmRY,4783
 flwr/common/parameter.py,sha256=-bFAUayToYDF50FZGrBC1hQYJCQDtB2bbr3ZuVLMtdE,2095
 flwr/common/parametersrecord.py,sha256=v5RmvJI1Y5iJhgIhdatZj7FItRRuaEmTKkCGDRFPQDU,4413
 flwr/common/recordset.py,sha256=OeRcBMGqx9vutWRz1xkujBPHlVpU58R1EcFRHEQrePo,2351
-flwr/common/recordset_compat.py,sha256=6j9NWzb_DJ4RApPnsHtKQnB2jKs-ToUjkSVeTxt3XBI,13611
+flwr/common/recordset_compat.py,sha256=4tbpHIPZM9V-DuVFuTdLbdb8N7-rMT0nT0uj22gaS7g,13730
 flwr/common/retry_invoker.py,sha256=H_hKqKaEI8vZPywWmoAtJYkcUnKhlYc4kV63zRY0kWA,10856
 flwr/common/secure_aggregation/__init__.py,sha256=29nHIUO2L8-KhNHQ2KmIgRo_4CPkq4LgLCUN0on5FgI,731
 flwr/common/secure_aggregation/crypto/__init__.py,sha256=dz7pVx2aPrHxr_AwgO5mIiTzu4PcvUxRq9NLBbFcsf8,738
@@ -46,7 +46,7 @@ flwr/common/secure_aggregation/ndarrays_arithmetic.py,sha256=KAHCEHGSTJ6mCgnC8dT
 flwr/common/secure_aggregation/quantization.py,sha256=appui7GGrkRPsupF59TkapeV4Na_CyPi73JtJ1pimdI,2310
 flwr/common/secure_aggregation/secaggplus_constants.py,sha256=m5UDo7IgRkMS3yixhzz7DhhAv6VAQMCghglMygSPU_k,1606
 flwr/common/secure_aggregation/secaggplus_utils.py,sha256=PleDyDu7jHNAfbRoEaoQiOjxG6iMl9yA8rNKYTfnyFw,3155
-flwr/common/serde.py,sha256=WGTBE1uj0iUYLMWFAV-798qJq8ThA9TZf6WvNLQAHXc,24844
+flwr/common/serde.py,sha256=mI4K91XJ2lnxbdLSK93djkdrQmc_iZENvH_yKKSHo-E,26794
 flwr/common/telemetry.py,sha256=se_-pHgEWcmN09ChSpTeek72l1UJHf7GbwXBB1KXBjQ,7683
 flwr/common/typing.py,sha256=3Wu6Ol1Ja6Gb0WdlcXVEn1EHYJbc4oRRJA81vEegxBo,4382
 flwr/common/version.py,sha256=A0MKvyKPrV8wLg0YCAODTqM71v26NEH36c6JYtfgg0o,667
@@ -138,11 +138,11 @@ flwr/server/utils/validator.py,sha256=b_3ahGkSPn4M3TPYaNiY5DyJmnkQHJsyarccPgrhFo
 flwr/simulation/__init__.py,sha256=E2eD5FlTmZZ80u21FmWCkacrM7O4mrEHD8iXqeCaBUQ,1278
 flwr/simulation/app.py,sha256=pbkldpm3Uc9_0M2R5-8Ako26g9WxNhZW4fLJY-4YtJY,13879
 flwr/simulation/ray_transport/__init__.py,sha256=FsaAnzC4cw4DqoouBCix6496k29jACkfeIam55BvW9g,734
-flwr/simulation/ray_transport/ray_actor.py,sha256=S_E-7Bk0ONWx12b0ObP3CtzJSEL3yPxpFVcYfkDx6Es,17044
-flwr/simulation/ray_transport/ray_client_proxy.py,sha256=RziUVY9PmuI8fJEbra-Vk9oWwRxALDZOeF1fAW-a9wg,9430
+flwr/simulation/ray_transport/ray_actor.py,sha256=G_g50ISt3Knf0zuX1wmw39gsDXSoMI5f3rmYZWGrUh4,17062
+flwr/simulation/ray_transport/ray_client_proxy.py,sha256=UxQEzWmklp3WO2V7LH5vNyAgYL7KYFFZQa1HTUSgEqY,9429
 flwr/simulation/ray_transport/utils.py,sha256=e0mkFOgOXSJHSQdiipoggF-DLBXaJZVytx9auQ35fCg,3368
-flwr_nightly-1.7.0.dev20240124.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-flwr_nightly-1.7.0.dev20240124.dist-info/METADATA,sha256=-jpfLXNP3X7t1PWjDCwR4Fl-5TKxBkNYSpH6iyLptHU,13440
-flwr_nightly-1.7.0.dev20240124.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-flwr_nightly-1.7.0.dev20240124.dist-info/entry_points.txt,sha256=1uLlD5tIunkzALMfMWnqjdE_D5hRUX_I1iMmOMv6tZI,181
-flwr_nightly-1.7.0.dev20240124.dist-info/RECORD,,
+flwr_nightly-1.7.0.dev20240126.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+flwr_nightly-1.7.0.dev20240126.dist-info/METADATA,sha256=kigwmhoqGNgCqt0T-xOjxzJDhDvu4ycW1vttbQpB5lk,13578
+flwr_nightly-1.7.0.dev20240126.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+flwr_nightly-1.7.0.dev20240126.dist-info/entry_points.txt,sha256=1uLlD5tIunkzALMfMWnqjdE_D5hRUX_I1iMmOMv6tZI,181
+flwr_nightly-1.7.0.dev20240126.dist-info/RECORD,,