flwr-nightly 1.13.0.dev20241021__py3-none-any.whl → 1.13.0.dev20241111__py3-none-any.whl

flwr/common/object_ref.py

@@ -55,8 +55,8 @@ def validate(
         specified attribute within it.
     project_dir : Optional[Union[str, Path]] (default: None)
         The directory containing the module. If None, the current working directory
-        is used. If `check_module` is True, the `project_dir` will be inserted into
-        the system path, and the previously inserted `project_dir` will be removed.
+        is used. If `check_module` is True, the `project_dir` will be temporarily
+        inserted into the system path and then removed after the validation is complete.
 
     Returns
     -------
@@ -66,8 +66,8 @@ def validate(
 
     Note
     ----
-    This function will modify `sys.path` by inserting the provided `project_dir`
-    and removing the previously inserted `project_dir`.
+    This function will temporarily modify `sys.path` by inserting the provided
+    `project_dir`, which will be removed after the validation is complete.
     """
     module_str, _, attributes_str = module_attribute_str.partition(":")
     if not module_str:
@@ -82,11 +82,19 @@ def validate(
         )
 
     if check_module:
+        if project_dir is None:
+            project_dir = Path.cwd()
+        project_dir = Path(project_dir).absolute()
         # Set the system path
-        _set_sys_path(project_dir)
+        sys.path.insert(0, str(project_dir))
 
         # Load module
         module = find_spec(module_str)
+
+        # Unset the system path
+        sys.path.remove(str(project_dir))
+
+        # Check if the module and the attribute exist
         if module and module.origin:
             if not _find_attribute_in_module(module.origin, attributes_str):
                 return (
@@ -133,8 +141,10 @@ def load_app(  # pylint: disable= too-many-branches
 
     Note
     ----
-    This function will modify `sys.path` by inserting the provided `project_dir`
-    and removing the previously inserted `project_dir`.
+    - This function will unload all modules in the previously provided `project_dir`,
+      if it is invoked again.
+    - This function will modify `sys.path` by inserting the provided `project_dir`
+      and removing the previously inserted `project_dir`.
     """
     valid, error_msg = validate(module_attribute_str, check_module=False)
     if not valid and error_msg:
@@ -143,8 +153,19 @@ def load_app(  # pylint: disable= too-many-branches
     module_str, _, attributes_str = module_attribute_str.partition(":")
 
     try:
+        # Initialize project path
+        if project_dir is None:
+            project_dir = Path.cwd()
+        project_dir = Path(project_dir).absolute()
+
+        # Unload modules if the project directory has changed
+        if _current_sys_path and _current_sys_path != str(project_dir):
+            _unload_modules(Path(_current_sys_path))
+
+        # Set the system path
         _set_sys_path(project_dir)
 
+        # Import the module
         if module_str not in sys.modules:
             module = importlib.import_module(module_str)
         # Hack: `tabnet` does not work with `importlib.reload`
@@ -160,15 +181,7 @@ def load_app(  # pylint: disable= too-many-branches
             module = sys.modules[module_str]
         else:
             module = sys.modules[module_str]
-
-            if project_dir is None:
-                project_dir = Path.cwd()
-
-            # Reload cached modules in the project directory
-            for m in list(sys.modules.values()):
-                path: Optional[str] = getattr(m, "__file__", None)
-                if path is not None and path.startswith(str(project_dir)):
-                    importlib.reload(m)
+            _reload_modules(project_dir)
 
     except ModuleNotFoundError as err:
         raise error_type(
@@ -189,6 +202,24 @@ def load_app(  # pylint: disable= too-many-branches
     return attribute
 
 
+def _unload_modules(project_dir: Path) -> None:
+    """Unload modules from the project directory."""
+    dir_str = str(project_dir.absolute())
+    for name, m in list(sys.modules.items()):
+        path: Optional[str] = getattr(m, "__file__", None)
+        if path is not None and path.startswith(dir_str):
+            del sys.modules[name]
+
+
+def _reload_modules(project_dir: Path) -> None:
+    """Reload modules from the project directory."""
+    dir_str = str(project_dir.absolute())
+    for m in list(sys.modules.values()):
+        path: Optional[str] = getattr(m, "__file__", None)
+        if path is not None and path.startswith(dir_str):
+            importlib.reload(m)
+
+
 def _set_sys_path(directory: Optional[Union[str, Path]]) -> None:
     """Set the system path."""
     if directory is None:

flwr/common/serde.py

@@ -40,6 +40,7 @@ from flwr.proto.recordset_pb2 import ParametersRecord as ProtoParametersRecord
 from flwr.proto.recordset_pb2 import RecordSet as ProtoRecordSet
 from flwr.proto.recordset_pb2 import SintList, StringList, UintList
 from flwr.proto.run_pb2 import Run as ProtoRun
+from flwr.proto.run_pb2 import RunStatus as ProtoRunStatus
 from flwr.proto.task_pb2 import Task, TaskIns, TaskRes
 from flwr.proto.transport_pb2 import (
     ClientMessage,
@@ -839,6 +840,7 @@ def message_from_proto(message_proto: ProtoMessage) -> Message:
 def context_to_proto(context: Context) -> ProtoContext:
     """Serialize `Context` to ProtoBuf."""
     proto = ProtoContext(
+        run_id=context.run_id,
         node_id=context.node_id,
         node_config=user_config_to_proto(context.node_config),
         state=recordset_to_proto(context.state),
@@ -850,6 +852,7 @@ def context_to_proto(context: Context) -> ProtoContext:
 def context_from_proto(context_proto: ProtoContext) -> Context:
     """Deserialize `Context` from ProtoBuf."""
     context = Context(
+        run_id=context_proto.run_id,
         node_id=context_proto.node_id,
         node_config=user_config_from_proto(context_proto.node_config),
         state=recordset_from_proto(context_proto.state),
@@ -910,3 +913,24 @@ def clientappstatus_from_proto(
     if msg.code == ClientAppOutputCode.UNKNOWN_ERROR:
         code = typing.ClientAppOutputCode.UNKNOWN_ERROR
     return typing.ClientAppOutputStatus(code=code, message=msg.message)
+
+
+# === Run status ===
+
+
+def run_status_to_proto(run_status: typing.RunStatus) -> ProtoRunStatus:
+    """Serialize `RunStatus` to ProtoBuf."""
+    return ProtoRunStatus(
+        status=run_status.status,
+        sub_status=run_status.sub_status,
+        details=run_status.details,
+    )
+
+
+def run_status_from_proto(run_status_proto: ProtoRunStatus) -> typing.RunStatus:
+    """Deserialize `RunStatus` from ProtoBuf."""
+    return typing.RunStatus(
+        status=run_status_proto.status,
+        sub_status=run_status_proto.sub_status,
+        details=run_status_proto.details,
+    )

flwr/common/telemetry.py

@@ -150,12 +150,6 @@ class EventType(str, Enum):
 
     # Not yet implemented
 
-    # --- SuperExec --------------------------------------------------------------------
-
-    # SuperExec
-    RUN_SUPEREXEC_ENTER = auto()
-    RUN_SUPEREXEC_LEAVE = auto()
-
     # --- Simulation Engine ------------------------------------------------------------
 
     # CLI: flower-simulation

flwr/common/typing.py

@@ -24,7 +24,7 @@ import numpy.typing as npt
 
 NDArray = npt.NDArray[Any]
 NDArrayInt = npt.NDArray[np.int_]
-NDArrayFloat = npt.NDArray[np.float_]
+NDArrayFloat = npt.NDArray[np.float64]
 NDArrays = list[NDArray]
 
 # The following union type contains Python types corresponding to ProtoBuf types that
@@ -218,6 +218,15 @@ class Run:
     override_config: UserConfig
 
 
+@dataclass
+class RunStatus:
+    """Run status information."""
+
+    status: str
+    sub_status: str
+    details: str
+
+
 @dataclass
 class Fab:
     """Fab file representation."""

flwr/proto/exec_pb2.py

@@ -14,9 +14,10 @@ _sym_db = _symbol_database.Default()
 
 from flwr.proto import fab_pb2 as flwr_dot_proto_dot_fab__pb2
 from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
+from flwr.proto import recordset_pb2 as flwr_dot_proto_dot_recordset__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/exec.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xdf\x02\n\x0fStartRunRequest\x12\x1c\n\x03\x66\x61\x62\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Fab\x12H\n\x0foverride_config\x18\x02 \x03(\x0b\x32/.flwr.proto.StartRunRequest.OverrideConfigEntry\x12L\n\x11\x66\x65\x64\x65ration_config\x18\x03 \x03(\x0b\x32\x31.flwr.proto.StartRunRequest.FederationConfigEntry\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\x1aK\n\x15\x46\x65\x64\x65rationConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"\"\n\x10StartRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"#\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"(\n\x12StreamLogsResponse\x12\x12\n\nlog_output\x18\x01 \x01(\t2\xa0\x01\n\x04\x45xec\x12G\n\x08StartRun\x12\x1b.flwr.proto.StartRunRequest\x1a\x1c.flwr.proto.StartRunResponse\"\x00\x12O\n\nStreamLogs\x12\x1d.flwr.proto.StreamLogsRequest\x1a\x1e.flwr.proto.StreamLogsResponse\"\x00\x30\x01\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/exec.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x1a\x66lwr/proto/transport.proto\x1a\x1a\x66lwr/proto/recordset.proto\"\xfb\x01\n\x0fStartRunRequest\x12\x1c\n\x03\x66\x61\x62\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Fab\x12H\n\x0foverride_config\x18\x02 \x03(\x0b\x32/.flwr.proto.StartRunRequest.OverrideConfigEntry\x12\x35\n\x12\x66\x65\x64\x65ration_options\x18\x03 \x01(\x0b\x32\x19.flwr.proto.ConfigsRecord\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"\"\n\x10StartRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"<\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x17\n\x0f\x61\x66ter_timestamp\x18\x02 \x01(\x01\"B\n\x12StreamLogsResponse\x12\x12\n\nlog_output\x18\x01 \x01(\t\x12\x18\n\x10latest_timestamp\x18\x02 \x01(\x01\x32\xa0\x01\n\x04\x45xec\x12G\n\x08StartRun\x12\x1b.flwr.proto.StartRunRequest\x1a\x1c.flwr.proto.StartRunResponse\"\x00\x12O\n\nStreamLogs\x12\x1d.flwr.proto.StreamLogsRequest\x1a\x1e.flwr.proto.StreamLogsResponse\"\x00\x30\x01\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -25,20 +26,16 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   DESCRIPTOR._options = None
   _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._options = None
   _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_options = b'8\001'
-  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._options = None
-  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_options = b'8\001'
-  _globals['_STARTRUNREQUEST']._serialized_start=88
-  _globals['_STARTRUNREQUEST']._serialized_end=439
-  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=289
-  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=362
-  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_start=364
-  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_end=439
-  _globals['_STARTRUNRESPONSE']._serialized_start=441
-  _globals['_STARTRUNRESPONSE']._serialized_end=475
-  _globals['_STREAMLOGSREQUEST']._serialized_start=477
-  _globals['_STREAMLOGSREQUEST']._serialized_end=512
-  _globals['_STREAMLOGSRESPONSE']._serialized_start=514
-  _globals['_STREAMLOGSRESPONSE']._serialized_end=554
-  _globals['_EXEC']._serialized_start=557
-  _globals['_EXEC']._serialized_end=717
+  _globals['_STARTRUNREQUEST']._serialized_start=116
+  _globals['_STARTRUNREQUEST']._serialized_end=367
+  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=294
+  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=367
+  _globals['_STARTRUNRESPONSE']._serialized_start=369
+  _globals['_STARTRUNRESPONSE']._serialized_end=403
+  _globals['_STREAMLOGSREQUEST']._serialized_start=405
+  _globals['_STREAMLOGSREQUEST']._serialized_end=465
+  _globals['_STREAMLOGSRESPONSE']._serialized_start=467
+  _globals['_STREAMLOGSRESPONSE']._serialized_end=533
+  _globals['_EXEC']._serialized_start=536
+  _globals['_EXEC']._serialized_end=696
 # @@protoc_insertion_point(module_scope)

flwr/proto/exec_pb2.pyi

@@ -4,6 +4,7 @@ isort:skip_file
 """
 import builtins
 import flwr.proto.fab_pb2
+import flwr.proto.recordset_pb2
 import flwr.proto.transport_pb2
 import google.protobuf.descriptor
 import google.protobuf.internal.containers
@@ -30,38 +31,23 @@ class StartRunRequest(google.protobuf.message.Message):
         def HasField(self, field_name: typing_extensions.Literal["value",b"value"]) -> builtins.bool: ...
         def ClearField(self, field_name: typing_extensions.Literal["key",b"key","value",b"value"]) -> None: ...
 
-    class FederationConfigEntry(google.protobuf.message.Message):
-        DESCRIPTOR: google.protobuf.descriptor.Descriptor
-        KEY_FIELD_NUMBER: builtins.int
-        VALUE_FIELD_NUMBER: builtins.int
-        key: typing.Text
-        @property
-        def value(self) -> flwr.proto.transport_pb2.Scalar: ...
-        def __init__(self,
-            *,
-            key: typing.Text = ...,
-            value: typing.Optional[flwr.proto.transport_pb2.Scalar] = ...,
-            ) -> None: ...
-        def HasField(self, field_name: typing_extensions.Literal["value",b"value"]) -> builtins.bool: ...
-        def ClearField(self, field_name: typing_extensions.Literal["key",b"key","value",b"value"]) -> None: ...
-
     FAB_FIELD_NUMBER: builtins.int
     OVERRIDE_CONFIG_FIELD_NUMBER: builtins.int
-    FEDERATION_CONFIG_FIELD_NUMBER: builtins.int
+    FEDERATION_OPTIONS_FIELD_NUMBER: builtins.int
     @property
     def fab(self) -> flwr.proto.fab_pb2.Fab: ...
     @property
     def override_config(self) -> google.protobuf.internal.containers.MessageMap[typing.Text, flwr.proto.transport_pb2.Scalar]: ...
     @property
-    def federation_config(self) -> google.protobuf.internal.containers.MessageMap[typing.Text, flwr.proto.transport_pb2.Scalar]: ...
+    def federation_options(self) -> flwr.proto.recordset_pb2.ConfigsRecord: ...
     def __init__(self,
         *,
         fab: typing.Optional[flwr.proto.fab_pb2.Fab] = ...,
         override_config: typing.Optional[typing.Mapping[typing.Text, flwr.proto.transport_pb2.Scalar]] = ...,
-        federation_config: typing.Optional[typing.Mapping[typing.Text, flwr.proto.transport_pb2.Scalar]] = ...,
+        federation_options: typing.Optional[flwr.proto.recordset_pb2.ConfigsRecord] = ...,
         ) -> None: ...
-    def HasField(self, field_name: typing_extensions.Literal["fab",b"fab"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing_extensions.Literal["fab",b"fab","federation_config",b"federation_config","override_config",b"override_config"]) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["fab",b"fab","federation_options",b"federation_options"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["fab",b"fab","federation_options",b"federation_options","override_config",b"override_config"]) -> None: ...
 global___StartRunRequest = StartRunRequest
 
 class StartRunResponse(google.protobuf.message.Message):
@@ -78,21 +64,27 @@ global___StartRunResponse = StartRunResponse
 class StreamLogsRequest(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     RUN_ID_FIELD_NUMBER: builtins.int
+    AFTER_TIMESTAMP_FIELD_NUMBER: builtins.int
     run_id: builtins.int
+    after_timestamp: builtins.float
     def __init__(self,
         *,
         run_id: builtins.int = ...,
+        after_timestamp: builtins.float = ...,
         ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["run_id",b"run_id"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["after_timestamp",b"after_timestamp","run_id",b"run_id"]) -> None: ...
 global___StreamLogsRequest = StreamLogsRequest
 
 class StreamLogsResponse(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
     LOG_OUTPUT_FIELD_NUMBER: builtins.int
+    LATEST_TIMESTAMP_FIELD_NUMBER: builtins.int
     log_output: typing.Text
+    latest_timestamp: builtins.float
     def __init__(self,
         *,
         log_output: typing.Text = ...,
+        latest_timestamp: builtins.float = ...,
         ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["log_output",b"log_output"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["latest_timestamp",b"latest_timestamp","log_output",b"log_output"]) -> None: ...
 global___StreamLogsResponse = StreamLogsResponse

flwr/proto/log_pb2.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flwr/proto/log.proto
+# Protobuf Python Version: 4.25.0
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from flwr.proto import node_pb2 as flwr_dot_proto_dot_node__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x14\x66lwr/proto/log.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\"O\n\x0fPushLogsRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x0e\n\x06run_id\x18\x02 \x01(\x04\x12\x0c\n\x04logs\x18\x03 \x03(\t\"\x12\n\x10PushLogsResponseb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.log_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  _globals['_PUSHLOGSREQUEST']._serialized_start=59
+  _globals['_PUSHLOGSREQUEST']._serialized_end=138
+  _globals['_PUSHLOGSRESPONSE']._serialized_start=140
+  _globals['_PUSHLOGSRESPONSE']._serialized_end=158
+# @@protoc_insertion_point(module_scope)

flwr/proto/log_pb2.pyi

@@ -0,0 +1,39 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import flwr.proto.node_pb2
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.message
+import typing
+import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class PushLogsRequest(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    NODE_FIELD_NUMBER: builtins.int
+    RUN_ID_FIELD_NUMBER: builtins.int
+    LOGS_FIELD_NUMBER: builtins.int
+    @property
+    def node(self) -> flwr.proto.node_pb2.Node: ...
+    run_id: builtins.int
+    @property
+    def logs(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[typing.Text]: ...
+    def __init__(self,
+        *,
+        node: typing.Optional[flwr.proto.node_pb2.Node] = ...,
+        run_id: builtins.int = ...,
+        logs: typing.Optional[typing.Iterable[typing.Text]] = ...,
+        ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["node",b"node"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["logs",b"logs","node",b"node","run_id",b"run_id"]) -> None: ...
+global___PushLogsRequest = PushLogsRequest
+
+class PushLogsResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    def __init__(self,
+        ) -> None: ...
+global___PushLogsResponse = PushLogsResponse

flwr/proto/log_pb2_grpc.py

@@ -0,0 +1,4 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+

flwr/proto/log_pb2_grpc.pyi

@@ -0,0 +1,4 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""

flwr/proto/message_pb2.py

@@ -17,7 +17,7 @@ from flwr.proto import recordset_pb2 as flwr_dot_proto_dot_recordset__pb2
 from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18\x66lwr/proto/message.proto\x12\nflwr.proto\x1a\x16\x66lwr/proto/error.proto\x1a\x1a\x66lwr/proto/recordset.proto\x1a\x1a\x66lwr/proto/transport.proto\"{\n\x07Message\x12&\n\x08metadata\x18\x01 \x01(\x0b\x32\x14.flwr.proto.Metadata\x12&\n\x07\x63ontent\x18\x02 \x01(\x0b\x32\x15.flwr.proto.RecordSet\x12 \n\x05\x65rror\x18\x03 \x01(\x0b\x32\x11.flwr.proto.Error\"\xbf\x02\n\x07\x43ontext\x12\x0f\n\x07node_id\x18\x01 \x01(\x04\x12\x38\n\x0bnode_config\x18\x02 \x03(\x0b\x32#.flwr.proto.Context.NodeConfigEntry\x12$\n\x05state\x18\x03 \x01(\x0b\x32\x15.flwr.proto.RecordSet\x12\x36\n\nrun_config\x18\x04 \x03(\x0b\x32\".flwr.proto.Context.RunConfigEntry\x1a\x45\n\x0fNodeConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\x1a\x44\n\x0eRunConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"\xbb\x01\n\x08Metadata\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x12\n\nmessage_id\x18\x02 \x01(\t\x12\x13\n\x0bsrc_node_id\x18\x03 \x01(\x04\x12\x13\n\x0b\x64st_node_id\x18\x04 \x01(\x04\x12\x18\n\x10reply_to_message\x18\x05 \x01(\t\x12\x10\n\x08group_id\x18\x06 \x01(\t\x12\x0b\n\x03ttl\x18\x07 \x01(\x01\x12\x14\n\x0cmessage_type\x18\x08 \x01(\t\x12\x12\n\ncreated_at\x18\t \x01(\x01\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x18\x66lwr/proto/message.proto\x12\nflwr.proto\x1a\x16\x66lwr/proto/error.proto\x1a\x1a\x66lwr/proto/recordset.proto\x1a\x1a\x66lwr/proto/transport.proto\"{\n\x07Message\x12&\n\x08metadata\x18\x01 \x01(\x0b\x32\x14.flwr.proto.Metadata\x12&\n\x07\x63ontent\x18\x02 \x01(\x0b\x32\x15.flwr.proto.RecordSet\x12 \n\x05\x65rror\x18\x03 \x01(\x0b\x32\x11.flwr.proto.Error\"\xcf\x02\n\x07\x43ontext\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x0f\n\x07node_id\x18\x02 \x01(\x04\x12\x38\n\x0bnode_config\x18\x03 \x03(\x0b\x32#.flwr.proto.Context.NodeConfigEntry\x12$\n\x05state\x18\x04 \x01(\x0b\x32\x15.flwr.proto.RecordSet\x12\x36\n\nrun_config\x18\x05 \x03(\x0b\x32\".flwr.proto.Context.RunConfigEntry\x1a\x45\n\x0fNodeConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\x1a\x44\n\x0eRunConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"\xbb\x01\n\x08Metadata\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x12\n\nmessage_id\x18\x02 \x01(\t\x12\x13\n\x0bsrc_node_id\x18\x03 \x01(\x04\x12\x13\n\x0b\x64st_node_id\x18\x04 \x01(\x04\x12\x18\n\x10reply_to_message\x18\x05 \x01(\t\x12\x10\n\x08group_id\x18\x06 \x01(\t\x12\x0b\n\x03ttl\x18\x07 \x01(\x01\x12\x14\n\x0cmessage_type\x18\x08 \x01(\t\x12\x12\n\ncreated_at\x18\t \x01(\x01\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -31,11 +31,11 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_MESSAGE']._serialized_start=120
   _globals['_MESSAGE']._serialized_end=243
   _globals['_CONTEXT']._serialized_start=246
-  _globals['_CONTEXT']._serialized_end=565
-  _globals['_CONTEXT_NODECONFIGENTRY']._serialized_start=426
-  _globals['_CONTEXT_NODECONFIGENTRY']._serialized_end=495
-  _globals['_CONTEXT_RUNCONFIGENTRY']._serialized_start=497
-  _globals['_CONTEXT_RUNCONFIGENTRY']._serialized_end=565
-  _globals['_METADATA']._serialized_start=568
-  _globals['_METADATA']._serialized_end=755
+  _globals['_CONTEXT']._serialized_end=581
+  _globals['_CONTEXT_NODECONFIGENTRY']._serialized_start=442
+  _globals['_CONTEXT_NODECONFIGENTRY']._serialized_end=511
+  _globals['_CONTEXT_RUNCONFIGENTRY']._serialized_start=513
+  _globals['_CONTEXT_RUNCONFIGENTRY']._serialized_end=581
+  _globals['_METADATA']._serialized_start=584
+  _globals['_METADATA']._serialized_end=771
 # @@protoc_insertion_point(module_scope)

flwr/proto/message_pb2.pyi

@@ -67,10 +67,12 @@ class Context(google.protobuf.message.Message):
         def HasField(self, field_name: typing_extensions.Literal["value",b"value"]) -> builtins.bool: ...
         def ClearField(self, field_name: typing_extensions.Literal["key",b"key","value",b"value"]) -> None: ...
 
+    RUN_ID_FIELD_NUMBER: builtins.int
     NODE_ID_FIELD_NUMBER: builtins.int
     NODE_CONFIG_FIELD_NUMBER: builtins.int
     STATE_FIELD_NUMBER: builtins.int
     RUN_CONFIG_FIELD_NUMBER: builtins.int
+    run_id: builtins.int
     node_id: builtins.int
     @property
     def node_config(self) -> google.protobuf.internal.containers.MessageMap[typing.Text, flwr.proto.transport_pb2.Scalar]: ...
@@ -80,13 +82,14 @@ class Context(google.protobuf.message.Message):
     def run_config(self) -> google.protobuf.internal.containers.MessageMap[typing.Text, flwr.proto.transport_pb2.Scalar]: ...
     def __init__(self,
         *,
+        run_id: builtins.int = ...,
         node_id: builtins.int = ...,
         node_config: typing.Optional[typing.Mapping[typing.Text, flwr.proto.transport_pb2.Scalar]] = ...,
         state: typing.Optional[flwr.proto.recordset_pb2.RecordSet] = ...,
         run_config: typing.Optional[typing.Mapping[typing.Text, flwr.proto.transport_pb2.Scalar]] = ...,
         ) -> None: ...
     def HasField(self, field_name: typing_extensions.Literal["state",b"state"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing_extensions.Literal["node_config",b"node_config","node_id",b"node_id","run_config",b"run_config","state",b"state"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["node_config",b"node_config","node_id",b"node_id","run_config",b"run_config","run_id",b"run_id","state",b"state"]) -> None: ...
 global___Context = Context
 
 class Metadata(google.protobuf.message.Message):

flwr/proto/run_pb2.py

@@ -14,10 +14,11 @@ _sym_db = _symbol_database.Default()
 
 from flwr.proto import fab_pb2 as flwr_dot_proto_dot_fab__pb2
 from flwr.proto import node_pb2 as flwr_dot_proto_dot_node__pb2
+from flwr.proto import recordset_pb2 as flwr_dot_proto_dot_recordset__pb2
 from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x14\x66lwr/proto/run.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xd5\x01\n\x03Run\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x0e\n\x06\x66\x61\x62_id\x18\x02 \x01(\t\x12\x13\n\x0b\x66\x61\x62_version\x18\x03 \x01(\t\x12<\n\x0foverride_config\x18\x04 \x03(\x0b\x32#.flwr.proto.Run.OverrideConfigEntry\x12\x10\n\x08\x66\x61\x62_hash\x18\x05 \x01(\t\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"@\n\tRunStatus\x12\x0e\n\x06status\x18\x01 \x01(\t\x12\x12\n\nsub_status\x18\x02 \x01(\t\x12\x0f\n\x07\x64\x65tails\x18\x03 \x01(\t\"\xeb\x01\n\x10\x43reateRunRequest\x12\x0e\n\x06\x66\x61\x62_id\x18\x01 \x01(\t\x12\x13\n\x0b\x66\x61\x62_version\x18\x02 \x01(\t\x12I\n\x0foverride_config\x18\x03 \x03(\x0b\x32\x30.flwr.proto.CreateRunRequest.OverrideConfigEntry\x12\x1c\n\x03\x66\x61\x62\x18\x04 \x01(\x0b\x32\x0f.flwr.proto.Fab\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"#\n\x11\x43reateRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"?\n\rGetRunRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x0e\n\x06run_id\x18\x02 \x01(\x04\".\n\x0eGetRunResponse\x12\x1c\n\x03run\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Run\"S\n\x16UpdateRunStatusRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12)\n\nrun_status\x18\x02 \x01(\x0b\x32\x15.flwr.proto.RunStatus\"\x19\n\x17UpdateRunStatusResponse\"F\n\x13GetRunStatusRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x0f\n\x07run_ids\x18\x02 \x03(\x04\"\xb1\x01\n\x14GetRunStatusResponse\x12L\n\x0frun_status_dict\x18\x01 \x03(\x0b\x32\x33.flwr.proto.GetRunStatusResponse.RunStatusDictEntry\x1aK\n\x12RunStatusDictEntry\x12\x0b\n\x03key\x18\x01 \x01(\x04\x12$\n\x05value\x18\x02 \x01(\x0b\x32\x15.flwr.proto.RunStatus:\x02\x38\x01\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x14\x66lwr/proto/run.proto\x12\nflwr.proto\x1a\x14\x66lwr/proto/fab.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x1a\x66lwr/proto/recordset.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xd5\x01\n\x03Run\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12\x0e\n\x06\x66\x61\x62_id\x18\x02 \x01(\t\x12\x13\n\x0b\x66\x61\x62_version\x18\x03 \x01(\t\x12<\n\x0foverride_config\x18\x04 \x03(\x0b\x32#.flwr.proto.Run.OverrideConfigEntry\x12\x10\n\x08\x66\x61\x62_hash\x18\x05 \x01(\t\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"@\n\tRunStatus\x12\x0e\n\x06status\x18\x01 \x01(\t\x12\x12\n\nsub_status\x18\x02 \x01(\t\x12\x0f\n\x07\x64\x65tails\x18\x03 \x01(\t\"\xeb\x01\n\x10\x43reateRunRequest\x12\x0e\n\x06\x66\x61\x62_id\x18\x01 \x01(\t\x12\x13\n\x0b\x66\x61\x62_version\x18\x02 \x01(\t\x12I\n\x0foverride_config\x18\x03 \x03(\x0b\x32\x30.flwr.proto.CreateRunRequest.OverrideConfigEntry\x12\x1c\n\x03\x66\x61\x62\x18\x04 \x01(\x0b\x32\x0f.flwr.proto.Fab\x1aI\n\x13OverrideConfigEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12!\n\x05value\x18\x02 \x01(\x0b\x32\x12.flwr.proto.Scalar:\x02\x38\x01\"#\n\x11\x43reateRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"?\n\rGetRunRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x0e\n\x06run_id\x18\x02 \x01(\x04\".\n\x0eGetRunResponse\x12\x1c\n\x03run\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Run\"S\n\x16UpdateRunStatusRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\x12)\n\nrun_status\x18\x02 \x01(\x0b\x32\x15.flwr.proto.RunStatus\"\x19\n\x17UpdateRunStatusResponse\"F\n\x13GetRunStatusRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x0f\n\x07run_ids\x18\x02 \x03(\x04\"\xb1\x01\n\x14GetRunStatusResponse\x12L\n\x0frun_status_dict\x18\x01 \x03(\x0b\x32\x33.flwr.proto.GetRunStatusResponse.RunStatusDictEntry\x1aK\n\x12RunStatusDictEntry\x12\x0b\n\x03key\x18\x01 \x01(\x04\x12$\n\x05value\x18\x02 \x01(\x0b\x32\x15.flwr.proto.RunStatus:\x02\x38\x01\"-\n\x1bGetFederationOptionsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x04\"U\n\x1cGetFederationOptionsResponse\x12\x35\n\x12\x66\x65\x64\x65ration_options\x18\x01 \x01(\x0b\x32\x19.flwr.proto.ConfigsRecordb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -30,30 +31,34 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._serialized_options = b'8\001'
   _globals['_GETRUNSTATUSRESPONSE_RUNSTATUSDICTENTRY']._options = None
   _globals['_GETRUNSTATUSRESPONSE_RUNSTATUSDICTENTRY']._serialized_options = b'8\001'
-  _globals['_RUN']._serialized_start=110
-  _globals['_RUN']._serialized_end=323
-  _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_start=250
-  _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_end=323
-  _globals['_RUNSTATUS']._serialized_start=325
-  _globals['_RUNSTATUS']._serialized_end=389
-  _globals['_CREATERUNREQUEST']._serialized_start=392
-  _globals['_CREATERUNREQUEST']._serialized_end=627
-  _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=250
-  _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=323
-  _globals['_CREATERUNRESPONSE']._serialized_start=629
-  _globals['_CREATERUNRESPONSE']._serialized_end=664
-  _globals['_GETRUNREQUEST']._serialized_start=666
-  _globals['_GETRUNREQUEST']._serialized_end=729
-  _globals['_GETRUNRESPONSE']._serialized_start=731
-  _globals['_GETRUNRESPONSE']._serialized_end=777
-  _globals['_UPDATERUNSTATUSREQUEST']._serialized_start=779
-  _globals['_UPDATERUNSTATUSREQUEST']._serialized_end=862
-  _globals['_UPDATERUNSTATUSRESPONSE']._serialized_start=864
-  _globals['_UPDATERUNSTATUSRESPONSE']._serialized_end=889
-  _globals['_GETRUNSTATUSREQUEST']._serialized_start=891
-  _globals['_GETRUNSTATUSREQUEST']._serialized_end=961
-  _globals['_GETRUNSTATUSRESPONSE']._serialized_start=964
-  _globals['_GETRUNSTATUSRESPONSE']._serialized_end=1141
-  _globals['_GETRUNSTATUSRESPONSE_RUNSTATUSDICTENTRY']._serialized_start=1066
-  _globals['_GETRUNSTATUSRESPONSE_RUNSTATUSDICTENTRY']._serialized_end=1141
+  _globals['_RUN']._serialized_start=138
+  _globals['_RUN']._serialized_end=351
+  _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_start=278
+  _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_end=351
+  _globals['_RUNSTATUS']._serialized_start=353
+  _globals['_RUNSTATUS']._serialized_end=417
+  _globals['_CREATERUNREQUEST']._serialized_start=420
+  _globals['_CREATERUNREQUEST']._serialized_end=655
+  _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=278
+  _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=351
+  _globals['_CREATERUNRESPONSE']._serialized_start=657
+  _globals['_CREATERUNRESPONSE']._serialized_end=692
+  _globals['_GETRUNREQUEST']._serialized_start=694
+  _globals['_GETRUNREQUEST']._serialized_end=757
+  _globals['_GETRUNRESPONSE']._serialized_start=759
+  _globals['_GETRUNRESPONSE']._serialized_end=805
+  _globals['_UPDATERUNSTATUSREQUEST']._serialized_start=807
+  _globals['_UPDATERUNSTATUSREQUEST']._serialized_end=890
+  _globals['_UPDATERUNSTATUSRESPONSE']._serialized_start=892
+  _globals['_UPDATERUNSTATUSRESPONSE']._serialized_end=917
+  _globals['_GETRUNSTATUSREQUEST']._serialized_start=919
+  _globals['_GETRUNSTATUSREQUEST']._serialized_end=989
+  _globals['_GETRUNSTATUSRESPONSE']._serialized_start=992
+  _globals['_GETRUNSTATUSRESPONSE']._serialized_end=1169
+  _globals['_GETRUNSTATUSRESPONSE_RUNSTATUSDICTENTRY']._serialized_start=1094
+  _globals['_GETRUNSTATUSRESPONSE_RUNSTATUSDICTENTRY']._serialized_end=1169
+  _globals['_GETFEDERATIONOPTIONSREQUEST']._serialized_start=1171
+  _globals['_GETFEDERATIONOPTIONSREQUEST']._serialized_end=1216
+  _globals['_GETFEDERATIONOPTIONSRESPONSE']._serialized_start=1218
+  _globals['_GETFEDERATIONOPTIONSRESPONSE']._serialized_end=1303
 # @@protoc_insertion_point(module_scope)

flwr/proto/run_pb2.pyi

@@ -5,6 +5,7 @@ isort:skip_file
 import builtins
 import flwr.proto.fab_pb2
 import flwr.proto.node_pb2
+import flwr.proto.recordset_pb2
 import flwr.proto.transport_pb2
 import google.protobuf.descriptor
 import google.protobuf.internal.containers
@@ -223,3 +224,28 @@ class GetRunStatusResponse(google.protobuf.message.Message):
         ) -> None: ...
     def ClearField(self, field_name: typing_extensions.Literal["run_status_dict",b"run_status_dict"]) -> None: ...
 global___GetRunStatusResponse = GetRunStatusResponse
+
+class GetFederationOptionsRequest(google.protobuf.message.Message):
+    """Get Federation Options associated with run"""
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    RUN_ID_FIELD_NUMBER: builtins.int
+    run_id: builtins.int
+    def __init__(self,
+        *,
+        run_id: builtins.int = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["run_id",b"run_id"]) -> None: ...
+global___GetFederationOptionsRequest = GetFederationOptionsRequest
+
+class GetFederationOptionsResponse(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    FEDERATION_OPTIONS_FIELD_NUMBER: builtins.int
+    @property
+    def federation_options(self) -> flwr.proto.recordset_pb2.ConfigsRecord: ...
+    def __init__(self,
+        *,
+        federation_options: typing.Optional[flwr.proto.recordset_pb2.ConfigsRecord] = ...,
+        ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["federation_options",b"federation_options"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["federation_options",b"federation_options"]) -> None: ...
+global___GetFederationOptionsResponse = GetFederationOptionsResponse