flwr-nightly 1.17.0.dev20250319__py3-none-any.whl → 1.17.0.dev20250321__py3-none-any.whl

flwr/server/workflow/secure_aggregation/secaggplus_workflow.py

@@ -20,15 +20,15 @@ from dataclasses import dataclass, field
 from logging import DEBUG, ERROR, INFO, WARN
 from typing import Optional, Union, cast
 
-import flwr.common.recordset_compat as compat
+import flwr.common.recorddict_compat as compat
 from flwr.common import (
-    ConfigsRecord,
+    ConfigRecord,
     Context,
     FitRes,
     Message,
     MessageType,
     NDArrays,
-    RecordSet,
+    RecordDict,
     bytes_to_ndarray,
     log,
     ndarrays_to_parameters,
@@ -66,7 +66,7 @@ class WorkflowState:  # pylint: disable=R0902
     """The state of the SecAgg+ protocol."""
 
     nid_to_proxies: dict[int, ClientProxy] = field(default_factory=dict)
-    nid_to_fitins: dict[int, RecordSet] = field(default_factory=dict)
+    nid_to_fitins: dict[int, RecordDict] = field(default_factory=dict)
     sampled_node_ids: set[int] = field(default_factory=set)
     active_node_ids: set[int] = field(default_factory=set)
     num_shares: int = 0
@@ -283,10 +283,10 @@ class SecAggPlusWorkflow:
     ) -> bool:
         """Execute the 'setup' stage."""
         # Obtain fit instructions
-        cfg = context.state.configs_records[MAIN_CONFIGS_RECORD]
+        cfg = context.state.config_records[MAIN_CONFIGS_RECORD]
         current_round = cast(int, cfg[WorkflowKey.CURRENT_ROUND])
-        parameters = compat.parametersrecord_to_parameters(
-            context.state.parameters_records[MAIN_PARAMS_RECORD],
+        parameters = compat.arrayrecord_to_parameters(
+            context.state.array_records[MAIN_PARAMS_RECORD],
             keep_input=True,
         )
         proxy_fitins_lst = context.strategy.configure_fit(
@@ -303,7 +303,7 @@ class SecAggPlusWorkflow:
         )
 
         state.nid_to_fitins = {
-            proxy.node_id: compat.fitins_to_recordset(fitins, True)
+            proxy.node_id: compat.fitins_to_recorddict(fitins, True)
             for proxy, fitins in proxy_fitins_lst
         }
         state.nid_to_proxies = {proxy.node_id: proxy for proxy, _ in proxy_fitins_lst}
@@ -366,14 +366,14 @@ class SecAggPlusWorkflow:
         state.sampled_node_ids = state.active_node_ids
 
         # Send setup configuration to clients
-        cfgs_record = ConfigsRecord(sa_params_dict)  # type: ignore
-        content = RecordSet({RECORD_KEY_CONFIGS: cfgs_record})
+        cfg_record = ConfigRecord(sa_params_dict)  # type: ignore
+        content = RecordDict({RECORD_KEY_CONFIGS: cfg_record})
 
         def make(nid: int) -> Message:
-            return grid.create_message(
+            return Message(
                 content=content,
-                message_type=MessageType.TRAIN,
                 dst_node_id=nid,
+                message_type=MessageType.TRAIN,
                 group_id=str(cfg[WorkflowKey.CURRENT_ROUND]),
             )
 
@@ -398,7 +398,7 @@ class SecAggPlusWorkflow:
             if msg.has_error():
                 state.failures.append(Exception(msg.error))
                 continue
-            key_dict = msg.content.configs_records[RECORD_KEY_CONFIGS]
+            key_dict = msg.content.config_records[RECORD_KEY_CONFIGS]
             node_id = msg.metadata.src_node_id
             pk1, pk2 = key_dict[Key.PUBLIC_KEY_1], key_dict[Key.PUBLIC_KEY_2]
             state.nid_to_publickeys[node_id] = [cast(bytes, pk1), cast(bytes, pk2)]
@@ -409,19 +409,19 @@ class SecAggPlusWorkflow:
         self, grid: Grid, context: LegacyContext, state: WorkflowState
     ) -> bool:
         """Execute the 'share keys' stage."""
-        cfg = context.state.configs_records[MAIN_CONFIGS_RECORD]
+        cfg = context.state.config_records[MAIN_CONFIGS_RECORD]
 
         def make(nid: int) -> Message:
             neighbours = state.nid_to_neighbours[nid] & state.active_node_ids
-            cfgs_record = ConfigsRecord(
+            cfg_record = ConfigRecord(
                 {str(nid): state.nid_to_publickeys[nid] for nid in neighbours}
             )
-            cfgs_record[Key.STAGE] = Stage.SHARE_KEYS
-            content = RecordSet({RECORD_KEY_CONFIGS: cfgs_record})
-            return grid.create_message(
+            cfg_record[Key.STAGE] = Stage.SHARE_KEYS
+            content = RecordDict({RECORD_KEY_CONFIGS: cfg_record})
+            return Message(
                 content=content,
-                message_type=MessageType.TRAIN,
                 dst_node_id=nid,
+                message_type=MessageType.TRAIN,
                 group_id=str(cfg[WorkflowKey.CURRENT_ROUND]),
             )
 
@@ -458,7 +458,7 @@ class SecAggPlusWorkflow:
                 state.failures.append(Exception(msg.error))
                 continue
             node_id = msg.metadata.src_node_id
-            res_dict = msg.content.configs_records[RECORD_KEY_CONFIGS]
+            res_dict = msg.content.config_records[RECORD_KEY_CONFIGS]
             dst_lst = cast(list[int], res_dict[Key.DESTINATION_LIST])
             ctxt_lst = cast(list[bytes], res_dict[Key.CIPHERTEXT_LIST])
             srcs += [node_id] * len(dst_lst)
@@ -479,22 +479,22 @@ class SecAggPlusWorkflow:
         self, grid: Grid, context: LegacyContext, state: WorkflowState
     ) -> bool:
         """Execute the 'collect masked vectors' stage."""
-        cfg = context.state.configs_records[MAIN_CONFIGS_RECORD]
+        cfg = context.state.config_records[MAIN_CONFIGS_RECORD]
 
         # Send secret key shares to clients (plus FitIns) and collect masked vectors
         def make(nid: int) -> Message:
-            cfgs_dict = {
+            cfg_dict = {
                 Key.STAGE: Stage.COLLECT_MASKED_VECTORS,
                 Key.CIPHERTEXT_LIST: state.forward_ciphertexts[nid],
                 Key.SOURCE_LIST: state.forward_srcs[nid],
             }
-            cfgs_record = ConfigsRecord(cfgs_dict)  # type: ignore
+            cfg_record = ConfigRecord(cfg_dict)  # type: ignore
             content = state.nid_to_fitins[nid]
-            content.configs_records[RECORD_KEY_CONFIGS] = cfgs_record
-            return grid.create_message(
+            content.config_records[RECORD_KEY_CONFIGS] = cfg_record
+            return Message(
                 content=content,
-                message_type=MessageType.TRAIN,
                 dst_node_id=nid,
+                message_type=MessageType.TRAIN,
                 group_id=str(cfg[WorkflowKey.CURRENT_ROUND]),
             )
 
@@ -524,7 +524,7 @@ class SecAggPlusWorkflow:
             if msg.has_error():
                 state.failures.append(Exception(msg.error))
                 continue
-            res_dict = msg.content.configs_records[RECORD_KEY_CONFIGS]
+            res_dict = msg.content.config_records[RECORD_KEY_CONFIGS]
             bytes_list = cast(list[bytes], res_dict[Key.MASKED_PARAMETERS])
             client_masked_vec = [bytes_to_ndarray(b) for b in bytes_list]
             if masked_vector is None:
@@ -540,7 +540,7 @@ class SecAggPlusWorkflow:
             if msg.has_error():
                 state.failures.append(Exception(msg.error))
                 continue
-            fitres = compat.recordset_to_fitres(msg.content, True)
+            fitres = compat.recorddict_to_fitres(msg.content, True)
             proxy = state.nid_to_proxies[msg.metadata.src_node_id]
             state.legacy_results.append((proxy, fitres))
 
@@ -550,7 +550,7 @@ class SecAggPlusWorkflow:
         self, grid: Grid, context: LegacyContext, state: WorkflowState
     ) -> bool:
         """Execute the 'unmask' stage."""
-        cfg = context.state.configs_records[MAIN_CONFIGS_RECORD]
+        cfg = context.state.config_records[MAIN_CONFIGS_RECORD]
         current_round = cast(int, cfg[WorkflowKey.CURRENT_ROUND])
 
         # Construct active node IDs and dead node IDs
@@ -560,17 +560,17 @@ class SecAggPlusWorkflow:
         # Send secure IDs of active and dead clients and collect key shares from clients
         def make(nid: int) -> Message:
             neighbours = state.nid_to_neighbours[nid]
-            cfgs_dict = {
+            cfg_dict = {
                 Key.STAGE: Stage.UNMASK,
                 Key.ACTIVE_NODE_ID_LIST: list(neighbours & active_nids),
                 Key.DEAD_NODE_ID_LIST: list(neighbours & dead_nids),
             }
-            cfgs_record = ConfigsRecord(cfgs_dict)  # type: ignore
-            content = RecordSet({RECORD_KEY_CONFIGS: cfgs_record})
-            return grid.create_message(
+            cfg_record = ConfigRecord(cfg_dict)  # type: ignore
+            content = RecordDict({RECORD_KEY_CONFIGS: cfg_record})
+            return Message(
                 content=content,
-                message_type=MessageType.TRAIN,
                 dst_node_id=nid,
+                message_type=MessageType.TRAIN,
                 group_id=str(current_round),
             )
 
@@ -599,7 +599,7 @@ class SecAggPlusWorkflow:
             if msg.has_error():
                 state.failures.append(Exception(msg.error))
                 continue
-            res_dict = msg.content.configs_records[RECORD_KEY_CONFIGS]
+            res_dict = msg.content.config_records[RECORD_KEY_CONFIGS]
             nids = cast(list[int], res_dict[Key.NODE_ID_LIST])
             shares = cast(list[bytes], res_dict[Key.SHARE_LIST])
             for owner_nid, share in zip(nids, shares):
@@ -676,10 +676,8 @@ class SecAggPlusWorkflow:
 
         # Update the parameters and write history
         if parameters_aggregated:
-            paramsrecord = compat.parameters_to_parametersrecord(
-                parameters_aggregated, True
-            )
-            context.state.parameters_records[MAIN_PARAMS_RECORD] = paramsrecord
+            arr_record = compat.parameters_to_arrayrecord(parameters_aggregated, True)
+            context.state.array_records[MAIN_PARAMS_RECORD] = arr_record
             context.history.add_metrics_distributed_fit(
                 server_round=current_round, metrics=metrics_aggregated
             )

flwr/simulation/app.py

@@ -47,7 +47,7 @@ from flwr.common.logger import (
     stop_log_uploader,
 )
 from flwr.common.serde import (
-    configs_record_from_proto,
+    config_record_from_proto,
     context_from_proto,
     context_to_proto,
     fab_from_proto,
@@ -184,7 +184,7 @@ def run_simulation_process(  # pylint: disable=R0914, disable=W0212, disable=R09
             fed_opt_res: GetFederationOptionsResponse = conn._stub.GetFederationOptions(
                 GetFederationOptionsRequest(run_id=run.run_id)
             )
-            federation_options = configs_record_from_proto(
+            federation_options = config_record_from_proto(
                 fed_opt_res.federation_options
             )
 

flwr/simulation/ray_transport/ray_actor.py

@@ -105,8 +105,10 @@ def pool_size_from_resources(client_resources: dict[str, Union[int, float]]) ->
         if not node_resources:
             continue
 
-        num_cpus = node_resources["CPU"]
-        num_gpus = node_resources.get("GPU", 0)  # There might not be GPU
+        # Fallback to zero when resource quantity is not configured on the ray node
+        # e.g.: node without GPU; head node set up not to run tasks (zero resources)
+        num_cpus = node_resources.get("CPU", 0)
+        num_gpus = node_resources.get("GPU", 0)
         num_actors = int(num_cpus / client_resources["num_cpus"])
 
         # If a GPU is present and client resources do require one

flwr/simulation/ray_transport/ray_client_proxy.py

@@ -23,7 +23,7 @@ from flwr import common
 from flwr.client import ClientFnExt
 from flwr.client.client_app import ClientApp
 from flwr.client.run_info_store import DeprecatedRunInfoStore
-from flwr.common import DEFAULT_TTL, Message, Metadata, RecordSet
+from flwr.common import DEFAULT_TTL, Message, Metadata, RecordDict, now
 from flwr.common.constant import (
     NUM_PARTITIONS_KEY,
     PARTITION_ID_KEY,
@@ -31,15 +31,16 @@ from flwr.common.constant import (
     MessageTypeLegacy,
 )
 from flwr.common.logger import log
-from flwr.common.recordset_compat import (
-    evaluateins_to_recordset,
-    fitins_to_recordset,
-    getparametersins_to_recordset,
-    getpropertiesins_to_recordset,
-    recordset_to_evaluateres,
-    recordset_to_fitres,
-    recordset_to_getparametersres,
-    recordset_to_getpropertiesres,
+from flwr.common.message import make_message
+from flwr.common.recorddict_compat import (
+    evaluateins_to_recorddict,
+    fitins_to_recorddict,
+    getparametersins_to_recorddict,
+    getpropertiesins_to_recorddict,
+    recorddict_to_evaluateres,
+    recorddict_to_fitres,
+    recorddict_to_getparametersres,
+    recorddict_to_getpropertiesres,
 )
 from flwr.server.client_proxy import ClientProxy
 from flwr.simulation.ray_transport.ray_actor import VirtualClientEngineActorPool
@@ -109,23 +110,24 @@ class RayActorClientProxy(ClientProxy):
 
         return out_mssg
 
-    def _wrap_recordset_in_message(
+    def _wrap_recorddict_in_message(
         self,
-        recordset: RecordSet,
+        recorddict: RecordDict,
         message_type: str,
         timeout: Optional[float],
         group_id: Optional[int],
     ) -> Message:
-        """Wrap a RecordSet inside a Message."""
-        return Message(
-            content=recordset,
+        """Wrap a RecordDict inside a Message."""
+        return make_message(
+            content=recorddict,
             metadata=Metadata(
                 run_id=0,
                 message_id="",
                 group_id=str(group_id) if group_id is not None else "",
                 src_node_id=0,
                 dst_node_id=self.node_id,
-                reply_to_message="",
+                reply_to_message_id="",
+                created_at=now().timestamp(),
                 ttl=timeout if timeout else DEFAULT_TTL,
                 message_type=message_type,
             ),
@@ -138,9 +140,9 @@ class RayActorClientProxy(ClientProxy):
         group_id: Optional[int],
     ) -> common.GetPropertiesRes:
         """Return client's properties."""
-        recordset = getpropertiesins_to_recordset(ins)
-        message = self._wrap_recordset_in_message(
-            recordset,
+        recorddict = getpropertiesins_to_recorddict(ins)
+        message = self._wrap_recorddict_in_message(
+            recorddict,
             message_type=MessageTypeLegacy.GET_PROPERTIES,
             timeout=timeout,
             group_id=group_id,
@@ -148,7 +150,7 @@ class RayActorClientProxy(ClientProxy):
 
         message_out = self._submit_job(message, timeout)
 
-        return recordset_to_getpropertiesres(message_out.content)
+        return recorddict_to_getpropertiesres(message_out.content)
 
     def get_parameters(
         self,
@@ -157,9 +159,9 @@ class RayActorClientProxy(ClientProxy):
         group_id: Optional[int],
     ) -> common.GetParametersRes:
         """Return the current local model parameters."""
-        recordset = getparametersins_to_recordset(ins)
-        message = self._wrap_recordset_in_message(
-            recordset,
+        recorddict = getparametersins_to_recorddict(ins)
+        message = self._wrap_recorddict_in_message(
+            recorddict,
             message_type=MessageTypeLegacy.GET_PARAMETERS,
             timeout=timeout,
             group_id=group_id,
@@ -167,17 +169,17 @@ class RayActorClientProxy(ClientProxy):
 
         message_out = self._submit_job(message, timeout)
 
-        return recordset_to_getparametersres(message_out.content, keep_input=False)
+        return recorddict_to_getparametersres(message_out.content, keep_input=False)
 
     def fit(
         self, ins: common.FitIns, timeout: Optional[float], group_id: Optional[int]
     ) -> common.FitRes:
         """Train model parameters on the locally held dataset."""
-        recordset = fitins_to_recordset(
+        recorddict = fitins_to_recorddict(
             ins, keep_input=True
         )  # This must stay TRUE since ins are in-memory
-        message = self._wrap_recordset_in_message(
-            recordset,
+        message = self._wrap_recorddict_in_message(
+            recorddict,
             message_type=MessageType.TRAIN,
             timeout=timeout,
             group_id=group_id,
@@ -185,17 +187,17 @@ class RayActorClientProxy(ClientProxy):
 
         message_out = self._submit_job(message, timeout)
 
-        return recordset_to_fitres(message_out.content, keep_input=False)
+        return recorddict_to_fitres(message_out.content, keep_input=False)
 
     def evaluate(
         self, ins: common.EvaluateIns, timeout: Optional[float], group_id: Optional[int]
     ) -> common.EvaluateRes:
         """Evaluate model parameters on the locally held dataset."""
-        recordset = evaluateins_to_recordset(
+        recorddict = evaluateins_to_recorddict(
             ins, keep_input=True
         )  # This must stay TRUE since ins are in-memory
-        message = self._wrap_recordset_in_message(
-            recordset,
+        message = self._wrap_recorddict_in_message(
+            recorddict,
             message_type=MessageType.EVALUATE,
             timeout=timeout,
             group_id=group_id,
@@ -203,7 +205,7 @@ class RayActorClientProxy(ClientProxy):
 
         message_out = self._submit_job(message, timeout)
 
-        return recordset_to_evaluateres(message_out.content)
+        return recorddict_to_evaluateres(message_out.content)
 
     def reconnect(
         self,

flwr/simulation/run_simulation.py

@@ -30,7 +30,7 @@ from typing import Any, Optional
 from flwr.cli.config_utils import load_and_validate
 from flwr.cli.utils import get_sha256_hash
 from flwr.client import ClientApp
-from flwr.common import Context, EventType, RecordSet, event, log, now
+from flwr.common import Context, EventType, RecordDict, event, log, now
 from flwr.common.config import get_fused_config_from_dir, parse_config_args
 from flwr.common.constant import RUN_ID_NUM_BYTES, Status
 from flwr.common.logger import (
@@ -180,7 +180,7 @@ def run_simulation(
         for values parsed to initialisation of backend, `client_resources`
         to define the resources for clients, and `actor` to define the actor
         parameters. Values supported in <value> are those included by
-        `flwr.common.typing.ConfigsRecordValues`.
+        `flwr.common.typing.ConfigRecordValues`.
 
     enable_tf_gpu_growth : bool (default: False)
         A boolean to indicate whether to enable GPU growth on the main thread. This is
@@ -260,7 +260,7 @@ def run_serverapp_th(
                 run_id=run_id,
                 node_id=0,
                 node_config={},
-                state=RecordSet(),
+                state=RecordDict(),
                 run_config=_server_app_run_config,
             )
 
@@ -333,7 +333,7 @@ def _main_loop(
         run_id=run.run_id,
         node_id=0,
         node_config=UserConfig(),
-        state=RecordSet(),
+        state=RecordDict(),
         run_config=UserConfig(),
     )
     try:
@@ -546,7 +546,7 @@ def _parse_args_run_simulation() -> argparse.ArgumentParser:
         default="{}",
         help='A JSON formatted stream, e.g \'{"<keyA>":<value>, "<keyB>":<value>}\' to '
         "configure a backend. Values supported in <value> are those included by "
-        "`flwr.common.typing.ConfigsRecordValues`. ",
+        "`flwr.common.typing.ConfigRecordValues`. ",
     )
     parser.add_argument(
         "--enable-tf-gpu-growth",

flwr/superexec/deployment.py

@@ -23,7 +23,7 @@ from typing import Optional
 from typing_extensions import override
 
 from flwr.cli.config_utils import get_fab_metadata
-from flwr.common import ConfigsRecord, Context, RecordSet
+from flwr.common import ConfigRecord, Context, RecordDict
 from flwr.common.constant import (
     SERVERAPPIO_API_DEFAULT_CLIENT_ADDRESS,
     Status,
@@ -141,7 +141,7 @@ class DeploymentEngine(Executor):
         fab_id, fab_version = get_fab_metadata(fab.content)
 
         run_id = self.linkstate.create_run(
-            fab_id, fab_version, fab_hash, override_config, ConfigsRecord()
+            fab_id, fab_version, fab_hash, override_config, ConfigRecord()
         )
         return run_id
 
@@ -149,7 +149,7 @@ class DeploymentEngine(Executor):
         """Register a Context for a Run."""
         # Create an empty context for the Run
         context = Context(
-            run_id=run_id, node_id=0, node_config={}, state=RecordSet(), run_config={}
+            run_id=run_id, node_id=0, node_config={}, state=RecordDict(), run_config={}
         )
 
         # Register the context at the LinkState
@@ -160,7 +160,7 @@ class DeploymentEngine(Executor):
         self,
         fab_file: bytes,
         override_config: UserConfig,
-        federation_options: ConfigsRecord,
+        federation_options: ConfigRecord,
     ) -> Optional[int]:
         """Start run using the Flower Deployment Engine."""
         run_id = None

flwr/superexec/exec_servicer.py

@@ -28,7 +28,7 @@ from flwr.common.auth_plugin import ExecAuthPlugin
 from flwr.common.constant import LOG_STREAM_INTERVAL, Status, SubStatus
 from flwr.common.logger import log
 from flwr.common.serde import (
-    configs_record_from_proto,
+    config_record_from_proto,
     run_to_proto,
     user_config_from_proto,
 )
@@ -79,7 +79,7 @@ class ExecServicer(exec_pb2_grpc.ExecServicer):
         run_id = self.executor.start_run(
             request.fab.content,
             user_config_from_proto(request.override_config),
-            configs_record_from_proto(request.federation_options),
+            config_record_from_proto(request.federation_options),
         )
 
         if run_id is None:

flwr/superexec/executor.py

@@ -20,7 +20,7 @@ from dataclasses import dataclass, field
 from subprocess import Popen
 from typing import Optional
 
-from flwr.common import ConfigsRecord
+from flwr.common import ConfigRecord
 from flwr.common.typing import UserConfig
 from flwr.server.superlink.ffs.ffs_factory import FfsFactory
 from flwr.server.superlink.linkstate import LinkStateFactory
@@ -73,7 +73,7 @@ class Executor(ABC):
         self,
         fab_file: bytes,
         override_config: UserConfig,
-        federation_options: ConfigsRecord,
+        federation_options: ConfigRecord,
     ) -> Optional[int]:
         """Start a run using the given Flower FAB ID and version.
 
@@ -86,7 +86,7 @@ class Executor(ABC):
             The Flower App Bundle file bytes.
         override_config: UserConfig
             The config overrides dict sent by the user (using `flwr run`).
-        federation_options: ConfigsRecord
+        federation_options: ConfigRecord
             The federation options sent by the user (using `flwr run`).
 
         Returns

flwr/superexec/simulation.py

@@ -22,7 +22,7 @@ from typing import Optional
 from typing_extensions import override
 
 from flwr.cli.config_utils import get_fab_metadata
-from flwr.common import ConfigsRecord, Context, RecordSet
+from flwr.common import ConfigRecord, Context, RecordDict
 from flwr.common.logger import log
 from flwr.common.typing import Fab, UserConfig
 from flwr.server.superlink.ffs import Ffs
@@ -76,7 +76,7 @@ class SimulationEngine(Executor):
         self,
         fab_file: bytes,
         override_config: UserConfig,
-        federation_options: ConfigsRecord,
+        federation_options: ConfigRecord,
     ) -> Optional[int]:
         """Start run using the Flower Simulation Engine."""
         try:
@@ -104,7 +104,7 @@ class SimulationEngine(Executor):
                 run_id=run_id,
                 node_id=0,
                 node_config={},
-                state=RecordSet(),
+                state=RecordDict(),
                 run_config={},
             )
 

{flwr_nightly-1.17.0.dev20250319.dist-info → flwr_nightly-1.17.0.dev20250321.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.17.0.dev20250319
+Version: 1.17.0.dev20250321
 Summary: Flower: A Friendly Federated AI Framework
 Home-page: https://flower.ai
 License: Apache-2.0