flwr 1.16.0__py3-none-any.whl → 1.17.0__py3-none-any.whl

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

@@ -61,6 +61,7 @@ PING_CALL_TIMEOUT = 5
 PING_BASE_MULTIPLIER = 0.8
 PING_RANDOM_RANGE = (-0.1, 0.1)
 PING_MAX_INTERVAL = 1e300
+PING_PATIENCE = 2
 
 # IDs
 RUN_ID_NUM_BYTES = 8
@@ -120,6 +121,9 @@ TIMESTAMP_HEADER = "flwr-timestamp"
 TIMESTAMP_TOLERANCE = 10  # General tolerance for timestamp verification
 SYSTEM_TIME_TOLERANCE = 5  # Allowance for system time drift
 
+# Constants for ArrayRecord
+GC_THRESHOLD = 200_000_000  # 200 MB
+
 
 class MessageType:
     """Message type."""
@@ -127,6 +131,7 @@ class MessageType:
     TRAIN = "train"
     EVALUATE = "evaluate"
     QUERY = "query"
+    SYSTEM = "system"
 
     def __new__(cls) -> MessageType:
         """Prevent instantiation."""
@@ -162,6 +167,7 @@ class ErrorCode:
     CLIENT_APP_RAISED_EXCEPTION = 2
     MESSAGE_UNAVAILABLE = 3
     REPLY_MESSAGE_UNAVAILABLE = 4
+    NODE_UNAVAILABLE = 5
 
     def __new__(cls) -> ErrorCode:
         """Prevent instantiation."""
@@ -217,14 +223,8 @@ class AuthType:
 class EventLogWriterType:
     """Event log writer types."""
 
-    FALSE = "false"
     STDOUT = "stdout"
 
     def __new__(cls) -> EventLogWriterType:
         """Prevent instantiation."""
         raise TypeError(f"{cls.__name__} cannot be instantiated.")
-
-    @classmethod
-    def choices(cls) -> list[str]:
-        """Return a list of available log writer choices."""
-        return [cls.FALSE, cls.STDOUT]

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

flwr/common/event_log_plugin/event_log_plugin.py

@@ -36,7 +36,7 @@ class EventLogWriterPlugin(ABC):
         self,
         request: GrpcMessage,
         context: grpc.ServicerContext,
-        user_info: UserInfo,
+        user_info: Optional[UserInfo],
         method_name: str,
     ) -> LogEntry:
         """Compose pre-event log entry from the provided request and context."""
@@ -46,9 +46,9 @@ class EventLogWriterPlugin(ABC):
         self,
         request: GrpcMessage,
         context: grpc.ServicerContext,
-        user_info: UserInfo,
+        user_info: Optional[UserInfo],
         method_name: str,
-        response: Optional[Union[GrpcMessage, Exception]],
+        response: Optional[Union[GrpcMessage, BaseException]],
     ) -> LogEntry:
         """Compose post-event log entry from the provided response and context."""
 

flwr/common/logger.py

@@ -250,9 +250,9 @@ def warn_deprecated_feature_with_example(
     log(
         WARN,
         """FEATURE UPDATE: %s
-        ------------------------------------------------------------
+            ------------------------------------------------------------
         %s
-        ------------------------------------------------------------
+            ------------------------------------------------------------
         """,
         example_message,
         code_example,