flwr-nightly 1.10.0.dev20240707__py3-none-any.whl → 1.11.0.dev20240724__py3-none-any.whl

flwr/common/object_ref.py

@@ -33,22 +33,41 @@ attribute.
 """
 
 
+_current_sys_path: Optional[str] = None
+
+
 def validate(
     module_attribute_str: str,
     check_module: bool = True,
+    project_dir: Optional[Union[str, Path]] = None,
 ) -> Tuple[bool, Optional[str]]:
     """Validate object reference.
 
-    The object reference string should have the form <module>:<attribute>. Valid
-    examples include `client:app` and `project.package.module:wrapper.app`. It must
-    refer to a module on the PYTHONPATH and the module needs to have the specified
-    attribute.
+    Parameters
+    ----------
+    module_attribute_str : str
+        The reference to the object. It should have the form `<module>:<attribute>`.
+        Valid examples include `client:app` and `project.package.module:wrapper.app`.
+        It must refer to a module on the PYTHONPATH or in the provided `project_dir`
+        and the module needs to have the specified attribute.
+    check_module : bool (default: True)
+        Flag indicating whether to verify the existence of the module and the
+        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.
 
     Returns
     -------
     Tuple[bool, Optional[str]]
         A boolean indicating whether an object reference is valid and
         the reason why it might not be.
+
+    Note
+    ----
+    This function will modify `sys.path` by inserting the provided `project_dir`
+    and removing the previously inserted `project_dir`.
     """
     module_str, _, attributes_str = module_attribute_str.partition(":")
     if not module_str:
@@ -63,6 +82,9 @@ def validate(
         )
 
     if check_module:
+        # Set the system path
+        _set_sys_path(project_dir)
+
         # Load module
         module = find_spec(module_str)
         if module and module.origin:
@@ -89,18 +111,40 @@ def load_app(  # pylint: disable= too-many-branches
 ) -> Any:
     """Return the object specified in a module attribute string.
 
-    The module/attribute string should have the form <module>:<attribute>. Valid
-    examples include `client:app` and `project.package.module:wrapper.app`. It must
-    refer to a module on the PYTHONPATH, the module needs to have the specified
-    attribute.
+    Parameters
+    ----------
+    module_attribute_str : str
+        The reference to the object. It should have the form `<module>:<attribute>`.
+        Valid examples include `client:app` and `project.package.module:wrapper.app`.
+        It must refer to a module on the PYTHONPATH or in the provided `project_dir`
+        and the module needs to have the specified attribute.
+    error_type : Type[Exception]
+        The type of exception to be raised if the provided `module_attribute_str` is
+        in an invalid format.
+    project_dir : Optional[Union[str, Path]], optional (default=None)
+        The directory containing the module. If None, the current working directory
+        is used. The `project_dir` will be inserted into the system path, and the
+        previously inserted `project_dir` will be removed.
+
+    Returns
+    -------
+    Any
+        The object specified by the module attribute string.
+
+    Note
+    ----
+    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)
+    valid, error_msg = validate(module_attribute_str, check_module=False)
     if not valid and error_msg:
         raise error_type(error_msg) from None
 
     module_str, _, attributes_str = module_attribute_str.partition(":")
 
     try:
+        _set_sys_path(project_dir)
+
         if module_str not in sys.modules:
             module = importlib.import_module(module_str)
         # Hack: `tabnet` does not work with `importlib.reload`
@@ -116,19 +160,15 @@ def load_app(  # pylint: disable= too-many-branches
             module = sys.modules[module_str]
         else:
             module = sys.modules[module_str]
+
             if project_dir is None:
-                path: Optional[str] = getattr(module, "__file__", None)
-                if path is not None:
-                    project_dir = str(Path(path).parent)
-            else:
-                project_dir = str(Path(project_dir).absolute())
+                project_dir = Path.cwd()
 
             # Reload cached modules in the project directory
-            if project_dir is not None:
-                for m in list(sys.modules.values()):
-                    path = getattr(m, "__file__", None)
-                    if path is not None and path.startswith(project_dir):
-                        importlib.reload(m)
+            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)
 
     except ModuleNotFoundError as err:
         raise error_type(
@@ -140,15 +180,38 @@ def load_app(  # pylint: disable= too-many-branches
     try:
         for attribute_str in attributes_str.split("."):
             attribute = getattr(attribute, attribute_str)
-    except AttributeError:
+    except AttributeError as err:
         raise error_type(
             f"Unable to load attribute {attributes_str} from module {module_str}"
             f"{OBJECT_REF_HELP_STR}",
-        ) from None
+        ) from err
 
     return attribute
 
 
+def _set_sys_path(directory: Optional[Union[str, Path]]) -> None:
+    """Set the system path."""
+    if directory is None:
+        directory = Path.cwd()
+    else:
+        directory = Path(directory).absolute()
+
+    # If the directory has already been added to `sys.path`, return
+    if str(directory) in sys.path:
+        return
+
+    # Remove the old path if it exists and is not `""`.
+    global _current_sys_path  # pylint: disable=global-statement
+    if _current_sys_path is not None:
+        sys.path.remove(_current_sys_path)
+
+    # Add the new path to sys.path
+    sys.path.insert(0, str(directory))
+
+    # Update the current_sys_path
+    _current_sys_path = str(directory)
+
+
 def _find_attribute_in_module(file_path: str, attribute_name: str) -> bool:
     """Check if attribute_name exists in module's abstract symbolic tree."""
     with open(file_path, encoding="utf-8") as file:

flwr/common/serde.py

@@ -671,3 +671,48 @@ def message_from_taskres(taskres: TaskRes) -> Message:
     )
     message.metadata.created_at = taskres.task.created_at
     return message
+
+
+# === User configs ===
+
+
+def user_config_to_proto(user_config: typing.UserConfig) -> Any:
+    """Serialize `UserConfig` to ProtoBuf."""
+    proto = {}
+    for key, value in user_config.items():
+        proto[key] = user_config_value_to_proto(value)
+    return proto
+
+
+def user_config_from_proto(proto: Any) -> typing.UserConfig:
+    """Deserialize `UserConfig` from ProtoBuf."""
+    metrics = {}
+    for key, value in proto.items():
+        metrics[key] = user_config_value_from_proto(value)
+    return metrics
+
+
+def user_config_value_to_proto(user_config_value: typing.UserConfigValue) -> Scalar:
+    """Serialize `UserConfigValue` to ProtoBuf."""
+    if isinstance(user_config_value, bool):
+        return Scalar(bool=user_config_value)
+
+    if isinstance(user_config_value, float):
+        return Scalar(double=user_config_value)
+
+    if isinstance(user_config_value, int):
+        return Scalar(sint64=user_config_value)
+
+    if isinstance(user_config_value, str):
+        return Scalar(string=user_config_value)
+
+    raise ValueError(
+        f"Accepted types: {bool, float, int, str} (but not {type(user_config_value)})"
+    )
+
+
+def user_config_value_from_proto(scalar_msg: Scalar) -> typing.UserConfigValue:
+    """Deserialize `UserConfigValue` from ProtoBuf."""
+    scalar_field = scalar_msg.WhichOneof("scalar")
+    scalar = getattr(scalar_msg, cast(str, scalar_field))
+    return cast(typing.UserConfigValue, scalar)

flwr/common/telemetry.py

@@ -64,6 +64,18 @@ def _get_home() -> Path:
     return Path().home()
 
 
+def _get_partner_id() -> str:
+    """Get partner ID."""
+    partner_id = os.getenv("FLWR_TELEMETRY_PARTNER_ID")
+    if not partner_id:
+        return "unavailable"
+    try:
+        uuid.UUID(partner_id)
+    except ValueError:
+        partner_id = "invalid"
+    return partner_id
+
+
 def _get_source_id() -> str:
     """Get existing or new source ID."""
     source_id = "unavailable"
@@ -177,6 +189,7 @@ state: Dict[str, Union[Optional[str], Optional[ThreadPoolExecutor]]] = {
     "executor": None,
     "source": None,
     "cluster": None,
+    "partner": None,
 }
 
 
@@ -202,11 +215,15 @@ def create_event(event_type: EventType, event_details: Optional[Dict[str, Any]])
     if state["cluster"] is None:
         state["cluster"] = str(uuid.uuid4())
 
+    if state["partner"] is None:
+        state["partner"] = _get_partner_id()
+
     if event_details is None:
         event_details = {}
 
     date = datetime.datetime.now(tz=datetime.timezone.utc).isoformat()
     context = {
+        "partner": state["partner"],
         "source": state["source"],
         "cluster": state["cluster"],
         "date": date,

flwr/common/typing.py

@@ -60,6 +60,10 @@ MetricsAggregationFn = Callable[[List[Tuple[int, Metrics]]], Metrics]
 Config = Dict[str, Scalar]
 Properties = Dict[str, Scalar]
 
+# Value type for user configs
+UserConfigValue = Union[bool, float, int, str]
+UserConfig = Dict[str, UserConfigValue]
+
 
 class Code(Enum):
     """Client status codes."""
@@ -194,3 +198,4 @@ class Run:
     run_id: int
     fab_id: str
     fab_version: str
+    override_config: UserConfig

flwr/proto/common_pb2.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flwr/proto/common.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()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x17\x66lwr/proto/common.proto\x12\nflwr.proto\"\x1a\n\nDoubleList\x12\x0c\n\x04vals\x18\x01 \x03(\x01\"\x1a\n\nSint64List\x12\x0c\n\x04vals\x18\x01 \x03(\x12\"\x18\n\x08\x42oolList\x12\x0c\n\x04vals\x18\x01 \x03(\x08\"\x1a\n\nStringList\x12\x0c\n\x04vals\x18\x01 \x03(\t\"\x19\n\tBytesList\x12\x0c\n\x04vals\x18\x01 \x03(\x0c\"\xd9\x02\n\x12\x43onfigsRecordValue\x12\x10\n\x06\x64ouble\x18\x01 \x01(\x01H\x00\x12\x10\n\x06sint64\x18\x02 \x01(\x12H\x00\x12\x0e\n\x04\x62ool\x18\x03 \x01(\x08H\x00\x12\x10\n\x06string\x18\x04 \x01(\tH\x00\x12\x0f\n\x05\x62ytes\x18\x05 \x01(\x0cH\x00\x12-\n\x0b\x64ouble_list\x18\x15 \x01(\x0b\x32\x16.flwr.proto.DoubleListH\x00\x12-\n\x0bsint64_list\x18\x16 \x01(\x0b\x32\x16.flwr.proto.Sint64ListH\x00\x12)\n\tbool_list\x18\x17 \x01(\x0b\x32\x14.flwr.proto.BoolListH\x00\x12-\n\x0bstring_list\x18\x18 \x01(\x0b\x32\x16.flwr.proto.StringListH\x00\x12+\n\nbytes_list\x18\x19 \x01(\x0b\x32\x15.flwr.proto.BytesListH\x00\x42\x07\n\x05valueb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.common_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  _globals['_DOUBLELIST']._serialized_start=39
+  _globals['_DOUBLELIST']._serialized_end=65
+  _globals['_SINT64LIST']._serialized_start=67
+  _globals['_SINT64LIST']._serialized_end=93
+  _globals['_BOOLLIST']._serialized_start=95
+  _globals['_BOOLLIST']._serialized_end=119
+  _globals['_STRINGLIST']._serialized_start=121
+  _globals['_STRINGLIST']._serialized_end=147
+  _globals['_BYTESLIST']._serialized_start=149
+  _globals['_BYTESLIST']._serialized_end=174
+  _globals['_CONFIGSRECORDVALUE']._serialized_start=177
+  _globals['_CONFIGSRECORDVALUE']._serialized_end=522
+# @@protoc_insertion_point(module_scope)

flwr/proto/common_pb2.pyi

@@ -0,0 +1,121 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+import builtins
+import google.protobuf.descriptor
+import google.protobuf.internal.containers
+import google.protobuf.message
+import typing
+import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class DoubleList(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    VALS_FIELD_NUMBER: builtins.int
+    @property
+    def vals(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.float]: ...
+    def __init__(self,
+        *,
+        vals: typing.Optional[typing.Iterable[builtins.float]] = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["vals",b"vals"]) -> None: ...
+global___DoubleList = DoubleList
+
+class Sint64List(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    VALS_FIELD_NUMBER: builtins.int
+    @property
+    def vals(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.int]: ...
+    def __init__(self,
+        *,
+        vals: typing.Optional[typing.Iterable[builtins.int]] = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["vals",b"vals"]) -> None: ...
+global___Sint64List = Sint64List
+
+class BoolList(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    VALS_FIELD_NUMBER: builtins.int
+    @property
+    def vals(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.bool]: ...
+    def __init__(self,
+        *,
+        vals: typing.Optional[typing.Iterable[builtins.bool]] = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["vals",b"vals"]) -> None: ...
+global___BoolList = BoolList
+
+class StringList(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    VALS_FIELD_NUMBER: builtins.int
+    @property
+    def vals(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[typing.Text]: ...
+    def __init__(self,
+        *,
+        vals: typing.Optional[typing.Iterable[typing.Text]] = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["vals",b"vals"]) -> None: ...
+global___StringList = StringList
+
+class BytesList(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    VALS_FIELD_NUMBER: builtins.int
+    @property
+    def vals(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.bytes]: ...
+    def __init__(self,
+        *,
+        vals: typing.Optional[typing.Iterable[builtins.bytes]] = ...,
+        ) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["vals",b"vals"]) -> None: ...
+global___BytesList = BytesList
+
+class ConfigsRecordValue(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    DOUBLE_FIELD_NUMBER: builtins.int
+    SINT64_FIELD_NUMBER: builtins.int
+    BOOL_FIELD_NUMBER: builtins.int
+    STRING_FIELD_NUMBER: builtins.int
+    BYTES_FIELD_NUMBER: builtins.int
+    DOUBLE_LIST_FIELD_NUMBER: builtins.int
+    SINT64_LIST_FIELD_NUMBER: builtins.int
+    BOOL_LIST_FIELD_NUMBER: builtins.int
+    STRING_LIST_FIELD_NUMBER: builtins.int
+    BYTES_LIST_FIELD_NUMBER: builtins.int
+    double: builtins.float
+    """Single element"""
+
+    sint64: builtins.int
+    bool: builtins.bool
+    string: typing.Text
+    bytes: builtins.bytes
+    @property
+    def double_list(self) -> global___DoubleList:
+        """List types"""
+        pass
+    @property
+    def sint64_list(self) -> global___Sint64List: ...
+    @property
+    def bool_list(self) -> global___BoolList: ...
+    @property
+    def string_list(self) -> global___StringList: ...
+    @property
+    def bytes_list(self) -> global___BytesList: ...
+    def __init__(self,
+        *,
+        double: builtins.float = ...,
+        sint64: builtins.int = ...,
+        bool: builtins.bool = ...,
+        string: typing.Text = ...,
+        bytes: builtins.bytes = ...,
+        double_list: typing.Optional[global___DoubleList] = ...,
+        sint64_list: typing.Optional[global___Sint64List] = ...,
+        bool_list: typing.Optional[global___BoolList] = ...,
+        string_list: typing.Optional[global___StringList] = ...,
+        bytes_list: typing.Optional[global___BytesList] = ...,
+        ) -> None: ...
+    def HasField(self, field_name: typing_extensions.Literal["bool",b"bool","bool_list",b"bool_list","bytes",b"bytes","bytes_list",b"bytes_list","double",b"double","double_list",b"double_list","sint64",b"sint64","sint64_list",b"sint64_list","string",b"string","string_list",b"string_list","value",b"value"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing_extensions.Literal["bool",b"bool","bool_list",b"bool_list","bytes",b"bytes","bytes_list",b"bytes_list","double",b"double","double_list",b"double_list","sint64",b"sint64","sint64_list",b"sint64_list","string",b"string","string_list",b"string_list","value",b"value"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing_extensions.Literal["value",b"value"]) -> typing.Optional[typing_extensions.Literal["double","sint64","bool","string","bytes","double_list","sint64_list","bool_list","string_list","bytes_list"]]: ...
+global___ConfigsRecordValue = ConfigsRecordValue

flwr/proto/common_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/common_pb2_grpc.pyi

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

flwr/proto/driver_pb2.py

@@ -15,31 +15,36 @@ _sym_db = _symbol_database.Default()
 from flwr.proto import node_pb2 as flwr_dot_proto_dot_node__pb2
 from flwr.proto import task_pb2 as flwr_dot_proto_dot_task__pb2
 from flwr.proto import run_pb2 as flwr_dot_proto_dot_run__pb2
+from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x17\x66lwr/proto/driver.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x15\x66lwr/proto/task.proto\x1a\x14\x66lwr/proto/run.proto\"7\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\"#\n\x11\x43reateRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"!\n\x0fGetNodesRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"3\n\x10GetNodesResponse\x12\x1f\n\x05nodes\x18\x01 \x03(\x0b\x32\x10.flwr.proto.Node\"@\n\x12PushTaskInsRequest\x12*\n\rtask_ins_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskIns\"\'\n\x13PushTaskInsResponse\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"F\n\x12PullTaskResRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"A\n\x13PullTaskResResponse\x12*\n\rtask_res_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskRes2\x84\x03\n\x06\x44river\x12J\n\tCreateRun\x12\x1c.flwr.proto.CreateRunRequest\x1a\x1d.flwr.proto.CreateRunResponse\"\x00\x12G\n\x08GetNodes\x12\x1b.flwr.proto.GetNodesRequest\x1a\x1c.flwr.proto.GetNodesResponse\"\x00\x12P\n\x0bPushTaskIns\x12\x1e.flwr.proto.PushTaskInsRequest\x1a\x1f.flwr.proto.PushTaskInsResponse\"\x00\x12P\n\x0bPullTaskRes\x12\x1e.flwr.proto.PullTaskResRequest\x1a\x1f.flwr.proto.PullTaskResResponse\"\x00\x12\x41\n\x06GetRun\x12\x19.flwr.proto.GetRunRequest\x1a\x1a.flwr.proto.GetRunResponse\"\x00\x62\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x17\x66lwr/proto/driver.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x15\x66lwr/proto/task.proto\x1a\x14\x66lwr/proto/run.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xcd\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\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(\x12\"!\n\x0fGetNodesRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"3\n\x10GetNodesResponse\x12\x1f\n\x05nodes\x18\x01 \x03(\x0b\x32\x10.flwr.proto.Node\"@\n\x12PushTaskInsRequest\x12*\n\rtask_ins_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskIns\"\'\n\x13PushTaskInsResponse\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"F\n\x12PullTaskResRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"A\n\x13PullTaskResResponse\x12*\n\rtask_res_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskRes2\x84\x03\n\x06\x44river\x12J\n\tCreateRun\x12\x1c.flwr.proto.CreateRunRequest\x1a\x1d.flwr.proto.CreateRunResponse\"\x00\x12G\n\x08GetNodes\x12\x1b.flwr.proto.GetNodesRequest\x1a\x1c.flwr.proto.GetNodesResponse\"\x00\x12P\n\x0bPushTaskIns\x12\x1e.flwr.proto.PushTaskInsRequest\x1a\x1f.flwr.proto.PushTaskInsResponse\"\x00\x12P\n\x0bPullTaskRes\x12\x1e.flwr.proto.PullTaskResRequest\x1a\x1f.flwr.proto.PullTaskResResponse\"\x00\x12\x41\n\x06GetRun\x12\x19.flwr.proto.GetRunRequest\x1a\x1a.flwr.proto.GetRunResponse\"\x00\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.driver_pb2', _globals)
 if _descriptor._USE_C_DESCRIPTORS == False:
   DESCRIPTOR._options = None
-  _globals['_CREATERUNREQUEST']._serialized_start=107
-  _globals['_CREATERUNREQUEST']._serialized_end=162
-  _globals['_CREATERUNRESPONSE']._serialized_start=164
-  _globals['_CREATERUNRESPONSE']._serialized_end=199
-  _globals['_GETNODESREQUEST']._serialized_start=201
-  _globals['_GETNODESREQUEST']._serialized_end=234
-  _globals['_GETNODESRESPONSE']._serialized_start=236
-  _globals['_GETNODESRESPONSE']._serialized_end=287
-  _globals['_PUSHTASKINSREQUEST']._serialized_start=289
-  _globals['_PUSHTASKINSREQUEST']._serialized_end=353
-  _globals['_PUSHTASKINSRESPONSE']._serialized_start=355
-  _globals['_PUSHTASKINSRESPONSE']._serialized_end=394
-  _globals['_PULLTASKRESREQUEST']._serialized_start=396
-  _globals['_PULLTASKRESREQUEST']._serialized_end=466
-  _globals['_PULLTASKRESRESPONSE']._serialized_start=468
-  _globals['_PULLTASKRESRESPONSE']._serialized_end=533
-  _globals['_DRIVER']._serialized_start=536
-  _globals['_DRIVER']._serialized_end=924
+  _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._options = None
+  _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._serialized_options = b'8\001'
+  _globals['_CREATERUNREQUEST']._serialized_start=136
+  _globals['_CREATERUNREQUEST']._serialized_end=341
+  _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=268
+  _globals['_CREATERUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=341
+  _globals['_CREATERUNRESPONSE']._serialized_start=343
+  _globals['_CREATERUNRESPONSE']._serialized_end=378
+  _globals['_GETNODESREQUEST']._serialized_start=380
+  _globals['_GETNODESREQUEST']._serialized_end=413
+  _globals['_GETNODESRESPONSE']._serialized_start=415
+  _globals['_GETNODESRESPONSE']._serialized_end=466
+  _globals['_PUSHTASKINSREQUEST']._serialized_start=468
+  _globals['_PUSHTASKINSREQUEST']._serialized_end=532
+  _globals['_PUSHTASKINSRESPONSE']._serialized_start=534
+  _globals['_PUSHTASKINSRESPONSE']._serialized_end=573
+  _globals['_PULLTASKRESREQUEST']._serialized_start=575
+  _globals['_PULLTASKRESREQUEST']._serialized_end=645
+  _globals['_PULLTASKRESRESPONSE']._serialized_start=647
+  _globals['_PULLTASKRESRESPONSE']._serialized_end=712
+  _globals['_DRIVER']._serialized_start=715
+  _globals['_DRIVER']._serialized_end=1103
 # @@protoc_insertion_point(module_scope)

flwr/proto/driver_pb2.pyi

@@ -5,6 +5,7 @@ isort:skip_file
 import builtins
 import flwr.proto.node_pb2
 import flwr.proto.task_pb2
+import flwr.proto.transport_pb2
 import google.protobuf.descriptor
 import google.protobuf.internal.containers
 import google.protobuf.message
@@ -16,16 +17,35 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 class CreateRunRequest(google.protobuf.message.Message):
     """CreateRun"""
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
+    class OverrideConfigEntry(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_ID_FIELD_NUMBER: builtins.int
     FAB_VERSION_FIELD_NUMBER: builtins.int
+    OVERRIDE_CONFIG_FIELD_NUMBER: builtins.int
     fab_id: typing.Text
     fab_version: typing.Text
+    @property
+    def override_config(self) -> google.protobuf.internal.containers.MessageMap[typing.Text, flwr.proto.transport_pb2.Scalar]: ...
     def __init__(self,
         *,
         fab_id: typing.Text = ...,
         fab_version: typing.Text = ...,
+        override_config: typing.Optional[typing.Mapping[typing.Text, flwr.proto.transport_pb2.Scalar]] = ...,
         ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["fab_id",b"fab_id","fab_version",b"fab_version"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["fab_id",b"fab_id","fab_version",b"fab_version","override_config",b"override_config"]) -> None: ...
 global___CreateRunRequest = CreateRunRequest
 
 class CreateRunResponse(google.protobuf.message.Message):

flwr/proto/exec_pb2.py

@@ -12,23 +12,32 @@ from google.protobuf.internal import builder as _builder
 _sym_db = _symbol_database.Default()
 
 
+from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/exec.proto\x12\nflwr.proto\"#\n\x0fStartRunRequest\x12\x10\n\x08\x66\x61\x62_file\x18\x01 \x01(\x0c\"\"\n\x10StartRunResponse\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"#\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"(\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\x1a\x66lwr/proto/transport.proto\"\xd3\x02\n\x0fStartRunRequest\x12\x10\n\x08\x66\x61\x62_file\x18\x01 \x01(\x0c\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(\x12\"#\n\x11StreamLogsRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\"(\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')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.exec_pb2', _globals)
 if _descriptor._USE_C_DESCRIPTORS == False:
   DESCRIPTOR._options = None
-  _globals['_STARTRUNREQUEST']._serialized_start=37
-  _globals['_STARTRUNREQUEST']._serialized_end=72
-  _globals['_STARTRUNRESPONSE']._serialized_start=74
-  _globals['_STARTRUNRESPONSE']._serialized_end=108
-  _globals['_STREAMLOGSREQUEST']._serialized_start=110
-  _globals['_STREAMLOGSREQUEST']._serialized_end=145
-  _globals['_STREAMLOGSRESPONSE']._serialized_start=147
-  _globals['_STREAMLOGSRESPONSE']._serialized_end=187
-  _globals['_EXEC']._serialized_start=190
-  _globals['_EXEC']._serialized_end=350
+  _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=66
+  _globals['_STARTRUNREQUEST']._serialized_end=405
+  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_start=255
+  _globals['_STARTRUNREQUEST_OVERRIDECONFIGENTRY']._serialized_end=328
+  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_start=330
+  _globals['_STARTRUNREQUEST_FEDERATIONCONFIGENTRY']._serialized_end=405
+  _globals['_STARTRUNRESPONSE']._serialized_start=407
+  _globals['_STARTRUNRESPONSE']._serialized_end=441
+  _globals['_STREAMLOGSREQUEST']._serialized_start=443
+  _globals['_STREAMLOGSREQUEST']._serialized_end=478
+  _globals['_STREAMLOGSRESPONSE']._serialized_start=480
+  _globals['_STREAMLOGSRESPONSE']._serialized_end=520
+  _globals['_EXEC']._serialized_start=523
+  _globals['_EXEC']._serialized_end=683
 # @@protoc_insertion_point(module_scope)