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

flwr/client/mod/secure_aggregation/secaggplus_mod.py

@@ -22,15 +22,15 @@ from typing import Any, cast
 
 from flwr.client.typing import ClientAppCallable
 from flwr.common import (
-    ConfigsRecord,
+    ConfigRecord,
     Context,
     Message,
     Parameters,
-    RecordSet,
+    RecordDict,
     ndarray_to_bytes,
     parameters_to_ndarrays,
 )
-from flwr.common import recordset_compat as compat
+from flwr.common import recorddict_compat as compat
 from flwr.common.constant import MessageType
 from flwr.common.logger import log
 from flwr.common.secure_aggregation.crypto.shamir import create_shares
@@ -63,7 +63,7 @@ from flwr.common.secure_aggregation.secaggplus_utils import (
     share_keys_plaintext_concat,
     share_keys_plaintext_separate,
 )
-from flwr.common.typing import ConfigsRecordValues
+from flwr.common.typing import ConfigRecordValues
 
 
 @dataclass
@@ -97,7 +97,7 @@ class SecAggPlusState:
     ss2_dict: dict[int, bytes] = field(default_factory=dict)
     public_keys_dict: dict[int, tuple[bytes, bytes]] = field(default_factory=dict)
 
-    def __init__(self, **kwargs: ConfigsRecordValues) -> None:
+    def __init__(self, **kwargs: ConfigRecordValues) -> None:
         for k, v in kwargs.items():
             if k.endswith(":V"):
                 continue
@@ -115,7 +115,7 @@ class SecAggPlusState:
                     new_v = dict(zip(keys, values))
             self.__setattr__(k, new_v)
 
-    def to_dict(self) -> dict[str, ConfigsRecordValues]:
+    def to_dict(self) -> dict[str, ConfigRecordValues]:
         """Convert the state to a dictionary."""
         ret = vars(self)
         for k in list(ret.keys()):
@@ -144,13 +144,13 @@ def secaggplus_mod(
         return call_next(msg, ctxt)
 
     # Retrieve local state
-    if RECORD_KEY_STATE not in ctxt.state.configs_records:
-        ctxt.state.configs_records[RECORD_KEY_STATE] = ConfigsRecord({})
-    state_dict = ctxt.state.configs_records[RECORD_KEY_STATE]
+    if RECORD_KEY_STATE not in ctxt.state.config_records:
+        ctxt.state.config_records[RECORD_KEY_STATE] = ConfigRecord({})
+    state_dict = ctxt.state.config_records[RECORD_KEY_STATE]
     state = SecAggPlusState(**state_dict)
 
     # Retrieve incoming configs
-    configs = msg.content.configs_records[RECORD_KEY_CONFIGS]
+    configs = msg.content.config_records[RECORD_KEY_CONFIGS]
 
     # Check the validity of the next stage
     check_stage(state.current_stage, configs)
@@ -162,7 +162,7 @@ def secaggplus_mod(
     check_configs(state.current_stage, configs)
 
     # Execute
-    out_content = RecordSet()
+    out_content = RecordDict()
     if state.current_stage == Stage.SETUP:
         state.nid = msg.metadata.dst_node_id
         res = _setup(state, configs)
@@ -171,31 +171,31 @@ def secaggplus_mod(
     elif state.current_stage == Stage.COLLECT_MASKED_VECTORS:
         out_msg = call_next(msg, ctxt)
         out_content = out_msg.content
-        fitres = compat.recordset_to_fitres(out_content, keep_input=True)
+        fitres = compat.recorddict_to_fitres(out_content, keep_input=True)
         res = _collect_masked_vectors(
             state, configs, fitres.num_examples, fitres.parameters
         )
-        for p_record in out_content.parameters_records.values():
-            p_record.clear()
+        for arr_record in out_content.array_records.values():
+            arr_record.clear()
     elif state.current_stage == Stage.UNMASK:
         res = _unmask(state, configs)
     else:
         raise ValueError(f"Unknown SecAgg/SecAgg+ stage: {state.current_stage}")
 
     # Save state
-    ctxt.state.configs_records[RECORD_KEY_STATE] = ConfigsRecord(state.to_dict())
+    ctxt.state.config_records[RECORD_KEY_STATE] = ConfigRecord(state.to_dict())
 
     # Return message
-    out_content.configs_records[RECORD_KEY_CONFIGS] = ConfigsRecord(res, False)
-    return msg.create_reply(out_content)
+    out_content.config_records[RECORD_KEY_CONFIGS] = ConfigRecord(res, False)
+    return Message(out_content, reply_to=msg)
 
 
-def check_stage(current_stage: str, configs: ConfigsRecord) -> None:
+def check_stage(current_stage: str, configs: ConfigRecord) -> None:
     """Check the validity of the next stage."""
     # Check the existence of Config.STAGE
     if Key.STAGE not in configs:
         raise KeyError(
-            f"The required key '{Key.STAGE}' is missing from the ConfigsRecord."
+            f"The required key '{Key.STAGE}' is missing from the ConfigRecord."
         )
 
     # Check the value type of the Config.STAGE
@@ -223,7 +223,7 @@ def check_stage(current_stage: str, configs: ConfigsRecord) -> None:
 
 
 # pylint: disable-next=too-many-branches
-def check_configs(stage: str, configs: ConfigsRecord) -> None:
+def check_configs(stage: str, configs: ConfigRecord) -> None:
     """Check the validity of the configs."""
     # Check configs for the setup stage
     if stage == Stage.SETUP:
@@ -239,7 +239,7 @@ def check_configs(stage: str, configs: ConfigsRecord) -> None:
             if key not in configs:
                 raise KeyError(
                     f"Stage {Stage.SETUP}: the required key '{key}' is "
-                    "missing from the ConfigsRecord."
+                    "missing from the ConfigRecord."
                 )
             # Bool is a subclass of int in Python,
             # so `isinstance(v, int)` will return True even if v is a boolean.
@@ -272,7 +272,7 @@ def check_configs(stage: str, configs: ConfigsRecord) -> None:
                 raise KeyError(
                     f"Stage {Stage.COLLECT_MASKED_VECTORS}: "
                     f"the required key '{key}' is "
-                    "missing from the ConfigsRecord."
+                    "missing from the ConfigRecord."
                 )
             if not isinstance(configs[key], list) or any(
                 elm
@@ -295,7 +295,7 @@ def check_configs(stage: str, configs: ConfigsRecord) -> None:
                 raise KeyError(
                     f"Stage {Stage.UNMASK}: "
                     f"the required key '{key}' is "
-                    "missing from the ConfigsRecord."
+                    "missing from the ConfigRecord."
                 )
             if not isinstance(configs[key], list) or any(
                 elm
@@ -313,8 +313,8 @@ def check_configs(stage: str, configs: ConfigsRecord) -> None:
 
 
 def _setup(
-    state: SecAggPlusState, configs: ConfigsRecord
-) -> dict[str, ConfigsRecordValues]:
+    state: SecAggPlusState, configs: ConfigRecord
+) -> dict[str, ConfigRecordValues]:
     # Assigning parameter values to object fields
     sec_agg_param_dict = configs
     state.sample_num = cast(int, sec_agg_param_dict[Key.SAMPLE_NUMBER])
@@ -349,8 +349,8 @@ def _setup(
 
 # pylint: disable-next=too-many-locals
 def _share_keys(
-    state: SecAggPlusState, configs: ConfigsRecord
-) -> dict[str, ConfigsRecordValues]:
+    state: SecAggPlusState, configs: ConfigRecord
+) -> dict[str, ConfigRecordValues]:
     named_bytes_tuples = cast(dict[str, tuple[bytes, bytes]], configs)
     key_dict = {int(sid): (pk1, pk2) for sid, (pk1, pk2) in named_bytes_tuples.items()}
     log(DEBUG, "Node %d: starting stage 1...", state.nid)
@@ -412,10 +412,10 @@ def _share_keys(
 # pylint: disable-next=too-many-locals
 def _collect_masked_vectors(
     state: SecAggPlusState,
-    configs: ConfigsRecord,
+    configs: ConfigRecord,
     num_examples: int,
     updated_parameters: Parameters,
-) -> dict[str, ConfigsRecordValues]:
+) -> dict[str, ConfigRecordValues]:
     log(DEBUG, "Node %d: starting stage 2...", state.nid)
     available_clients: list[int] = []
     ciphertexts = cast(list[bytes], configs[Key.CIPHERTEXT_LIST])
@@ -498,8 +498,8 @@ def _collect_masked_vectors(
 
 
 def _unmask(
-    state: SecAggPlusState, configs: ConfigsRecord
-) -> dict[str, ConfigsRecordValues]:
+    state: SecAggPlusState, configs: ConfigRecord
+) -> dict[str, ConfigRecordValues]:
     log(DEBUG, "Node %d: starting stage 3...", state.nid)
 
     active_nids = cast(list[int], configs[Key.ACTIVE_NODE_ID_LIST])

flwr/client/run_info_store.py

@@ -19,7 +19,7 @@ from dataclasses import dataclass
 from pathlib import Path
 from typing import Optional
 
-from flwr.common import Context, RecordSet
+from flwr.common import Context, RecordDict
 from flwr.common.config import (
     get_fused_config,
     get_fused_config_from_dir,
@@ -86,7 +86,7 @@ class DeprecatedRunInfoStore:
                     run_id=run_id,
                     node_id=self.node_id,
                     node_config=self.node_config,
-                    state=RecordSet(),
+                    state=RecordDict(),
                     run_config=initial_run_config.copy(),
                 ),
             )

flwr/common/__init__.py

@@ -31,9 +31,13 @@ from .parameter import ndarray_to_bytes as ndarray_to_bytes
 from .parameter import ndarrays_to_parameters as ndarrays_to_parameters
 from .parameter import parameters_to_ndarrays as parameters_to_ndarrays
 from .record import Array as Array
+from .record import ArrayRecord as ArrayRecord
+from .record import ConfigRecord as ConfigRecord
 from .record import ConfigsRecord as ConfigsRecord
+from .record import MetricRecord as MetricRecord
 from .record import MetricsRecord as MetricsRecord
 from .record import ParametersRecord as ParametersRecord
+from .record import RecordDict as RecordDict
 from .record import RecordSet as RecordSet
 from .record import array_from_numpy as array_from_numpy
 from .telemetry import EventType as EventType
@@ -41,7 +45,7 @@ from .telemetry import event as event
 from .typing import ClientMessage as ClientMessage
 from .typing import Code as Code
 from .typing import Config as Config
-from .typing import ConfigsRecordValues as ConfigsRecordValues
+from .typing import ConfigRecordValues as ConfigRecordValues
 from .typing import DisconnectRes as DisconnectRes
 from .typing import EvaluateIns as EvaluateIns
 from .typing import EvaluateRes as EvaluateRes
@@ -51,9 +55,9 @@ from .typing import GetParametersIns as GetParametersIns
 from .typing import GetParametersRes as GetParametersRes
 from .typing import GetPropertiesIns as GetPropertiesIns
 from .typing import GetPropertiesRes as GetPropertiesRes
+from .typing import MetricRecordValues as MetricRecordValues
 from .typing import Metrics as Metrics
 from .typing import MetricsAggregationFn as MetricsAggregationFn
-from .typing import MetricsRecordValues as MetricsRecordValues
 from .typing import NDArray as NDArray
 from .typing import NDArrays as NDArrays
 from .typing import Parameters as Parameters
@@ -65,11 +69,13 @@ from .typing import Status as Status
 
 __all__ = [
     "Array",
+    "ArrayRecord",
     "ClientMessage",
     "Code",
     "Config",
+    "ConfigRecord",
+    "ConfigRecordValues",
     "ConfigsRecord",
-    "ConfigsRecordValues",
     "Context",
     "DEFAULT_TTL",
     "DisconnectRes",
@@ -88,16 +94,18 @@ __all__ = [
     "MessageType",
     "MessageTypeLegacy",
     "Metadata",
+    "MetricRecord",
+    "MetricRecordValues",
     "Metrics",
     "MetricsAggregationFn",
     "MetricsRecord",
-    "MetricsRecordValues",
     "NDArray",
     "NDArrays",
     "Parameters",
     "ParametersRecord",
     "Properties",
     "ReconnectIns",
+    "RecordDict",
     "RecordSet",
     "Scalar",
     "ServerMessage",

flwr/common/config.py

@@ -34,7 +34,7 @@ from flwr.common.constant import (
 )
 from flwr.common.typing import Run, UserConfig, UserConfigValue
 
-from . import ConfigsRecord, object_ref
+from . import ConfigRecord, object_ref
 
 T_dict = TypeVar("T_dict", bound=dict[str, Any])  # pylint: disable=invalid-name
 
@@ -260,9 +260,9 @@ def get_metadata_from_config(config: dict[str, Any]) -> tuple[str, str]:
     )
 
 
-def user_config_to_configsrecord(config: UserConfig) -> ConfigsRecord:
-    """Construct a `ConfigsRecord` out of a `UserConfig`."""
-    c_record = ConfigsRecord()
+def user_config_to_configrecord(config: UserConfig) -> ConfigRecord:
+    """Construct a `ConfigRecord` out of a `UserConfig`."""
+    c_record = ConfigRecord()
     for k, v in config.items():
         c_record[k] = v
 

flwr/common/constant.py

@@ -121,7 +121,7 @@ TIMESTAMP_HEADER = "flwr-timestamp"
 TIMESTAMP_TOLERANCE = 10  # General tolerance for timestamp verification
 SYSTEM_TIME_TOLERANCE = 5  # Allowance for system time drift
 
-# Constants for ParametersRecord
+# Constants for ArrayRecord
 GC_THRESHOLD = 200_000_000  # 200 MB
 
 

flwr/common/context.py

@@ -17,7 +17,7 @@
 
 from dataclasses import dataclass
 
-from .record import RecordSet
+from .record import RecordDict
 from .typing import UserConfig
 
 
@@ -34,7 +34,7 @@ class Context:
     node_config : UserConfig
         A config (key/value mapping) unique to the node and independent of the
         `run_config`. This config persists across all runs this node participates in.
-    state : RecordSet
+    state : RecordDict
         Holds records added by the entity in a given `run_id` 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
@@ -50,7 +50,7 @@ class Context:
     run_id: int
     node_id: int
     node_config: UserConfig
-    state: RecordSet
+    state: RecordDict
     run_config: UserConfig
 
     def __init__(  # pylint: disable=too-many-arguments, too-many-positional-arguments
@@ -58,7 +58,7 @@ class Context:
         run_id: int,
         node_id: int,
         node_config: UserConfig,
-        state: RecordSet,
+        state: RecordDict,
         run_config: UserConfig,
     ) -> None:
         self.run_id = run_id