flwr-nightly 1.17.0.dev20250320__py3-none-any.whl → 1.17.0.dev20250322__py3-none-any.whl

flwr/cli/run/run.py

@@ -35,15 +35,11 @@ from flwr.cli.constant import FEDERATION_CONFIG_HELP_MESSAGE
 from flwr.common.config import (
     flatten_dict,
     parse_config_args,
-    user_config_to_configsrecord,
+    user_config_to_configrecord,
 )
 from flwr.common.constant import CliOutputFormat
 from flwr.common.logger import print_json_error, redirect_output, restore_output
-from flwr.common.serde import (
-    configs_record_to_proto,
-    fab_to_proto,
-    user_config_to_proto,
-)
+from flwr.common.serde import config_record_to_proto, fab_to_proto, user_config_to_proto
 from flwr.common.typing import Fab
 from flwr.proto.exec_pb2 import StartRunRequest  # pylint: disable=E0611
 from flwr.proto.exec_pb2_grpc import ExecStub
@@ -171,14 +167,14 @@ def _run_with_exec_api(
 
     fab = Fab(fab_hash, content)
 
-    # Construct a `ConfigsRecord` out of a flattened `UserConfig`
+    # Construct a `ConfigRecord` out of a flattened `UserConfig`
     fed_conf = flatten_dict(federation_config.get("options", {}))
-    c_record = user_config_to_configsrecord(fed_conf)
+    c_record = user_config_to_configrecord(fed_conf)
 
     req = StartRunRequest(
         fab=fab_to_proto(fab),
         override_config=user_config_to_proto(parse_config_args(config_overrides)),
-        federation_options=configs_record_to_proto(c_record),
+        federation_options=config_record_to_proto(c_record),
     )
     with unauthenticated_exc_handler():
         res = stub.StartRun(req)

flwr/client/client_app.py

@@ -189,7 +189,7 @@ class ClientApp:
         >>> def train(message: Message, context: Context) -> Message:
         >>>     print("Executing default train function")
         >>>     # Create and return an echo reply message
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
 
         Registering a train function with a custom action name:
 
@@ -200,7 +200,7 @@ class ClientApp:
         >>> @app.train("custom_action")
         >>> def custom_action(message: Message, context: Context) -> Message:
         >>>     print("Executing train function for custom action")
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
 
         Registering a train function with a function-specific Flower Mod:
 
@@ -213,7 +213,7 @@ class ClientApp:
         >>> def train(message: Message, context: Context) -> Message:
         >>>     print("Executing train function with message size mod")
         >>>     # Create and return an echo reply message
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
         """
         return _get_decorator(self, MessageType.TRAIN, action, mods)
 
@@ -244,7 +244,7 @@ class ClientApp:
         >>> def evaluate(message: Message, context: Context) -> Message:
         >>>     print("Executing default evaluate function")
         >>>     # Create and return an echo reply message
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
 
         Registering an evaluate function with a custom action name:
 
@@ -255,7 +255,7 @@ class ClientApp:
         >>> @app.evaluate("custom_action")
         >>> def custom_action(message: Message, context: Context) -> Message:
         >>>     print("Executing evaluate function for custom action")
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
 
         Registering an evaluate function with a function-specific Flower Mod:
 
@@ -268,7 +268,7 @@ class ClientApp:
         >>> def evaluate(message: Message, context: Context) -> Message:
         >>>     print("Executing evaluate function with message size mod")
         >>>     # Create and return an echo reply message
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
         """
         return _get_decorator(self, MessageType.EVALUATE, action, mods)
 
@@ -299,7 +299,7 @@ class ClientApp:
         >>> def query(message: Message, context: Context) -> Message:
         >>>     print("Executing default query function")
         >>>     # Create and return an echo reply message
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
 
         Registering a query function with a custom action name:
 
@@ -310,7 +310,7 @@ class ClientApp:
         >>> @app.query("custom_action")
         >>> def custom_action(message: Message, context: Context) -> Message:
         >>>     print("Executing query function for custom action")
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
 
         Registering a query function with a function-specific Flower Mod:
 
@@ -323,7 +323,7 @@ class ClientApp:
         >>> def query(message: Message, context: Context) -> Message:
         >>>     print("Executing query function with message size mod")
         >>>     # Create and return an echo reply message
-        >>>     return message.create_reply(content=message.content)
+        >>>     return Message(message.content, reply_to=message)
         """
         return _get_decorator(self, MessageType.QUERY, action, mods)
 
@@ -454,8 +454,6 @@ def _registration_error(fn_name: str) -> ValueError:
         >>> def {fn_name}(message: Message, context: Context) -> Message:
         >>>    print("ClientApp {fn_name} running")
         >>>    # Create and return an echo reply message
-        >>>    return message.create_reply(
-        >>>        content=message.content()
-        >>>    )
+        >>>    return Message(message.content, reply_to=message)
         """,
     )

flwr/client/grpc_client/connection.py

@@ -28,7 +28,7 @@ from cryptography.hazmat.primitives.asymmetric import ec
 from flwr.common import (
     DEFAULT_TTL,
     GRPC_MAX_MESSAGE_LENGTH,
-    ConfigsRecord,
+    ConfigRecord,
     Message,
     Metadata,
     RecordDict,
@@ -166,7 +166,7 @@ def grpc_connection(  # pylint: disable=R0913,R0915,too-many-positional-argument
             message_type = MessageType.EVALUATE
         elif field == "reconnect_ins":
             recorddict = RecordDict()
-            recorddict.configs_records["config"] = ConfigsRecord(
+            recorddict.config_records["config"] = ConfigRecord(
                 {"seconds": proto.reconnect_ins.seconds}
             )
             message_type = "reconnect"
@@ -216,7 +216,7 @@ def grpc_connection(  # pylint: disable=R0913,R0915,too-many-positional-argument
             msg_proto = ClientMessage(evaluate_res=serde.evaluate_res_to_proto(evalres))
         elif message_type == "reconnect":
             reason = cast(
-                Reason.ValueType, recorddict.configs_records["config"]["reason"]
+                Reason.ValueType, recorddict.config_records["config"]["reason"]
             )
             msg_proto = ClientMessage(
                 disconnect_res=ClientMessage.DisconnectRes(reason=reason)

flwr/client/message_handler/message_handler.py

@@ -26,7 +26,7 @@ from flwr.client.client import (
 )
 from flwr.client.numpy_client import NumPyClient
 from flwr.client.typing import ClientFnExt
-from flwr.common import ConfigsRecord, Context, Message, Metadata, RecordDict, log
+from flwr.common import ConfigRecord, Context, Message, Metadata, RecordDict, log
 from flwr.common.constant import MessageType, MessageTypeLegacy
 from flwr.common.recorddict_compat import (
     evaluateres_to_recorddict,
@@ -72,7 +72,7 @@ def handle_control_message(message: Message) -> tuple[Optional[Message], int]:
     if message.metadata.message_type == "reconnect":
         # Retrieve ReconnectIns from RecordDict
         recorddict = message.content
-        seconds = cast(int, recorddict.configs_records["config"]["seconds"])
+        seconds = cast(int, recorddict.config_records["config"]["seconds"])
         # Construct ReconnectIns and call _reconnect
         disconnect_msg, sleep_duration = _reconnect(
             ServerMessage.ReconnectIns(seconds=seconds)
@@ -80,7 +80,7 @@ def handle_control_message(message: Message) -> tuple[Optional[Message], int]:
         # Store DisconnectRes in RecordDict
         reason = cast(int, disconnect_msg.disconnect_res.reason)
         recorddict = RecordDict()
-        recorddict.configs_records["config"] = ConfigsRecord({"reason": reason})
+        recorddict.config_records["config"] = ConfigRecord({"reason": reason})
         out_message = Message(recorddict, reply_to=message)
         # Return Message and sleep duration
         return out_message, sleep_duration

flwr/client/mod/__init__.py

@@ -16,7 +16,7 @@
 
 
 from .centraldp_mods import adaptiveclipping_mod, fixedclipping_mod
-from .comms_mods import message_size_mod, parameters_size_mod
+from .comms_mods import arrays_size_mod, message_size_mod
 from .localdp_mod import LocalDpMod
 from .secure_aggregation import secagg_mod, secaggplus_mod
 from .utils import make_ffn
@@ -24,10 +24,10 @@ from .utils import make_ffn
 __all__ = [
     "LocalDpMod",
     "adaptiveclipping_mod",
+    "arrays_size_mod",
     "fixedclipping_mod",
     "make_ffn",
     "message_size_mod",
-    "parameters_size_mod",
     "secagg_mod",
     "secaggplus_mod",
 ]

flwr/client/mod/comms_mods.py

@@ -34,47 +34,41 @@ def message_size_mod(
     """
     message_size_in_bytes = 0
 
-    for p_record in msg.content.parameters_records.values():
-        message_size_in_bytes += p_record.count_bytes()
-
-    for c_record in msg.content.configs_records.values():
-        message_size_in_bytes += c_record.count_bytes()
-
-    for m_record in msg.content.metrics_records.values():
-        message_size_in_bytes += m_record.count_bytes()
+    for record in msg.content.values():
+        message_size_in_bytes += record.count_bytes()
 
     log(INFO, "Message size: %i bytes", message_size_in_bytes)
 
     return call_next(msg, ctxt)
 
 
-def parameters_size_mod(
+def arrays_size_mod(
     msg: Message, ctxt: Context, call_next: ClientAppCallable
 ) -> Message:
-    """Parameters size mod.
+    """Arrays size mod.
 
-    This mod logs the number of parameters transmitted in the message as well as their
-    size in bytes.
+    This mod logs the number of array elements transmitted in ``ArrayRecord``s of
+    the message as well as their sizes in bytes.
     """
     model_size_stats = {}
-    parameters_size_in_bytes = 0
-    for record_name, p_record in msg.content.parameters_records.items():
-        p_record_bytes = p_record.count_bytes()
-        parameters_size_in_bytes += p_record_bytes
-        parameter_count = 0
-        for array in p_record.values():
-            parameter_count += (
+    arrays_size_in_bytes = 0
+    for record_name, arr_record in msg.content.array_records.items():
+        arr_record_bytes = arr_record.count_bytes()
+        arrays_size_in_bytes += arr_record_bytes
+        element_count = 0
+        for array in arr_record.values():
+            element_count += (
                 int(np.prod(array.shape)) if array.shape else array.numpy().size
             )
 
         model_size_stats[f"{record_name}"] = {
-            "parameters": parameter_count,
-            "bytes": p_record_bytes,
+            "elements": element_count,
+            "bytes": arr_record_bytes,
         }
 
     if model_size_stats:
         log(INFO, model_size_stats)
 
-    log(INFO, "Total parameters transmitted: %i bytes", parameters_size_in_bytes)
+    log(INFO, "Total array elements transmitted: %i bytes", arrays_size_in_bytes)
 
     return call_next(msg, ctxt)

flwr/client/mod/secure_aggregation/secaggplus_mod.py

@@ -22,7 +22,7 @@ from typing import Any, cast
 
 from flwr.client.typing import ClientAppCallable
 from flwr.common import (
-    ConfigsRecord,
+    ConfigRecord,
     Context,
     Message,
     Parameters,
@@ -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)
@@ -175,27 +175,27 @@ def secaggplus_mod(
         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)
+    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/common/__init__.py

@@ -31,7 +31,10 @@ 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
@@ -42,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
@@ -52,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
@@ -66,11 +69,13 @@ from .typing import Status as Status
 
 __all__ = [
     "Array",
+    "ArrayRecord",
     "ClientMessage",
     "Code",
     "Config",
+    "ConfigRecord",
+    "ConfigRecordValues",
     "ConfigsRecord",
-    "ConfigsRecordValues",
     "Context",
     "DEFAULT_TTL",
     "DisconnectRes",
@@ -89,10 +94,11 @@ __all__ = [
     "MessageType",
     "MessageTypeLegacy",
     "Metadata",
+    "MetricRecord",
+    "MetricRecordValues",
     "Metrics",
     "MetricsAggregationFn",
     "MetricsRecord",
-    "MetricsRecordValues",
     "NDArray",
     "NDArrays",
     "Parameters",

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/record/__init__.py

@@ -15,15 +15,18 @@
 """Record APIs."""
 
 
-from .configsrecord import ConfigsRecord
+from .arrayrecord import Array, ArrayRecord, ParametersRecord
+from .configrecord import ConfigRecord, ConfigsRecord
 from .conversion_utils import array_from_numpy
-from .metricsrecord import MetricsRecord
-from .parametersrecord import Array, ParametersRecord
+from .metricrecord import MetricRecord, MetricsRecord
 from .recorddict import RecordDict, RecordSet
 
 __all__ = [
     "Array",
+    "ArrayRecord",
+    "ConfigRecord",
     "ConfigsRecord",
+    "MetricRecord",
     "MetricsRecord",
     "ParametersRecord",
     "RecordDict",