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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.7.0.dev20240125
+Version: 1.7.0.dev20240126
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.dev
 License: Apache-2.0

{flwr_nightly-1.7.0.dev20240125 → 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-dev20240125"
+version = "1.7.0-dev20240126"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.dev>"]

{flwr_nightly-1.7.0.dev20240125 → 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.dev20240125 → 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.dev20240125 → 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.dev20240125 → 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.dev20240125 → 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.dev20240125 → 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.dev20240125 → 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.dev20240125 → 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.dev20240125 → flwr_nightly-1.7.0.dev20240126}/src/py/flwr/common/serde.py

@@ -601,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
@@ -634,7 +637,14 @@ def _record_value_from_proto(value_proto: GrpcMessage) -> 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)
@@ -708,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
         )
     )
 

{flwr_nightly-1.7.0.dev20240125 → flwr_nightly-1.7.0.dev20240126}/src/py/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_nightly-1.7.0.dev20240125 → flwr_nightly-1.7.0.dev20240126}/src/py/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.dev20240125/src/py/flwr/client/run_state.py

@@ -1,25 +0,0 @@
-# Copyright 2023 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.
-# ==============================================================================
-"""Run state."""
-
-from dataclasses import dataclass
-from typing import Dict
-
-
-@dataclass
-class RunState:
-    """State of a run executed by a client node."""
-
-    state: Dict[str, str]