flwr-nightly 1.10.0.dev20240722__py3-none-any.whl → 1.11.0.dev20240805__py3-none-any.whl

flwr/proto/fleet_pb2.py

@@ -15,9 +15,10 @@ _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 fab_pb2 as flwr_dot_proto_dot_fab__pb2
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x16\x66lwr/proto/fleet.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x15\x66lwr/proto/task.proto\x1a\x14\x66lwr/proto/run.proto\"*\n\x11\x43reateNodeRequest\x12\x15\n\rping_interval\x18\x01 \x01(\x01\"4\n\x12\x43reateNodeResponse\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\"3\n\x11\x44\x65leteNodeRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\"\x14\n\x12\x44\x65leteNodeResponse\"D\n\x0bPingRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x15\n\rping_interval\x18\x02 \x01(\x01\"\x1f\n\x0cPingResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\"F\n\x12PullTaskInsRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"k\n\x13PullTaskInsResponse\x12(\n\treconnect\x18\x01 \x01(\x0b\x32\x15.flwr.proto.Reconnect\x12*\n\rtask_ins_list\x18\x02 \x03(\x0b\x32\x13.flwr.proto.TaskIns\"@\n\x12PushTaskResRequest\x12*\n\rtask_res_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskRes\"\xae\x01\n\x13PushTaskResResponse\x12(\n\treconnect\x18\x01 \x01(\x0b\x32\x15.flwr.proto.Reconnect\x12=\n\x07results\x18\x02 \x03(\x0b\x32,.flwr.proto.PushTaskResResponse.ResultsEntry\x1a.\n\x0cResultsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\r:\x02\x38\x01\"\x1e\n\tReconnect\x12\x11\n\treconnect\x18\x01 \x01(\x04\x32\xc9\x03\n\x05\x46leet\x12M\n\nCreateNode\x12\x1d.flwr.proto.CreateNodeRequest\x1a\x1e.flwr.proto.CreateNodeResponse\"\x00\x12M\n\nDeleteNode\x12\x1d.flwr.proto.DeleteNodeRequest\x1a\x1e.flwr.proto.DeleteNodeResponse\"\x00\x12;\n\x04Ping\x12\x17.flwr.proto.PingRequest\x1a\x18.flwr.proto.PingResponse\"\x00\x12P\n\x0bPullTaskIns\x12\x1e.flwr.proto.PullTaskInsRequest\x1a\x1f.flwr.proto.PullTaskInsResponse\"\x00\x12P\n\x0bPushTaskRes\x12\x1e.flwr.proto.PushTaskResRequest\x1a\x1f.flwr.proto.PushTaskResResponse\"\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\x16\x66lwr/proto/fleet.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x15\x66lwr/proto/task.proto\x1a\x14\x66lwr/proto/run.proto\x1a\x14\x66lwr/proto/fab.proto\"*\n\x11\x43reateNodeRequest\x12\x15\n\rping_interval\x18\x01 \x01(\x01\"4\n\x12\x43reateNodeResponse\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\"3\n\x11\x44\x65leteNodeRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\"\x14\n\x12\x44\x65leteNodeResponse\"D\n\x0bPingRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x15\n\rping_interval\x18\x02 \x01(\x01\"\x1f\n\x0cPingResponse\x12\x0f\n\x07success\x18\x01 \x01(\x08\"F\n\x12PullTaskInsRequest\x12\x1e\n\x04node\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x10\n\x08task_ids\x18\x02 \x03(\t\"k\n\x13PullTaskInsResponse\x12(\n\treconnect\x18\x01 \x01(\x0b\x32\x15.flwr.proto.Reconnect\x12*\n\rtask_ins_list\x18\x02 \x03(\x0b\x32\x13.flwr.proto.TaskIns\"@\n\x12PushTaskResRequest\x12*\n\rtask_res_list\x18\x01 \x03(\x0b\x32\x13.flwr.proto.TaskRes\"\xae\x01\n\x13PushTaskResResponse\x12(\n\treconnect\x18\x01 \x01(\x0b\x32\x15.flwr.proto.Reconnect\x12=\n\x07results\x18\x02 \x03(\x0b\x32,.flwr.proto.PushTaskResResponse.ResultsEntry\x1a.\n\x0cResultsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\r:\x02\x38\x01\"\x1e\n\tReconnect\x12\x11\n\treconnect\x18\x01 \x01(\x04\x32\x8c\x04\n\x05\x46leet\x12M\n\nCreateNode\x12\x1d.flwr.proto.CreateNodeRequest\x1a\x1e.flwr.proto.CreateNodeResponse\"\x00\x12M\n\nDeleteNode\x12\x1d.flwr.proto.DeleteNodeRequest\x1a\x1e.flwr.proto.DeleteNodeResponse\"\x00\x12;\n\x04Ping\x12\x17.flwr.proto.PingRequest\x1a\x18.flwr.proto.PingResponse\"\x00\x12P\n\x0bPullTaskIns\x12\x1e.flwr.proto.PullTaskInsRequest\x1a\x1f.flwr.proto.PullTaskInsResponse\"\x00\x12P\n\x0bPushTaskRes\x12\x1e.flwr.proto.PushTaskResRequest\x1a\x1f.flwr.proto.PushTaskResResponse\"\x00\x12\x41\n\x06GetRun\x12\x19.flwr.proto.GetRunRequest\x1a\x1a.flwr.proto.GetRunResponse\"\x00\x12\x41\n\x06GetFab\x12\x19.flwr.proto.GetFabRequest\x1a\x1a.flwr.proto.GetFabResponse\"\x00\x62\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -26,30 +27,30 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   DESCRIPTOR._options = None
   _globals['_PUSHTASKRESRESPONSE_RESULTSENTRY']._options = None
   _globals['_PUSHTASKRESRESPONSE_RESULTSENTRY']._serialized_options = b'8\001'
-  _globals['_CREATENODEREQUEST']._serialized_start=106
-  _globals['_CREATENODEREQUEST']._serialized_end=148
-  _globals['_CREATENODERESPONSE']._serialized_start=150
-  _globals['_CREATENODERESPONSE']._serialized_end=202
-  _globals['_DELETENODEREQUEST']._serialized_start=204
-  _globals['_DELETENODEREQUEST']._serialized_end=255
-  _globals['_DELETENODERESPONSE']._serialized_start=257
-  _globals['_DELETENODERESPONSE']._serialized_end=277
-  _globals['_PINGREQUEST']._serialized_start=279
-  _globals['_PINGREQUEST']._serialized_end=347
-  _globals['_PINGRESPONSE']._serialized_start=349
-  _globals['_PINGRESPONSE']._serialized_end=380
-  _globals['_PULLTASKINSREQUEST']._serialized_start=382
-  _globals['_PULLTASKINSREQUEST']._serialized_end=452
-  _globals['_PULLTASKINSRESPONSE']._serialized_start=454
-  _globals['_PULLTASKINSRESPONSE']._serialized_end=561
-  _globals['_PUSHTASKRESREQUEST']._serialized_start=563
-  _globals['_PUSHTASKRESREQUEST']._serialized_end=627
-  _globals['_PUSHTASKRESRESPONSE']._serialized_start=630
-  _globals['_PUSHTASKRESRESPONSE']._serialized_end=804
-  _globals['_PUSHTASKRESRESPONSE_RESULTSENTRY']._serialized_start=758
-  _globals['_PUSHTASKRESRESPONSE_RESULTSENTRY']._serialized_end=804
-  _globals['_RECONNECT']._serialized_start=806
-  _globals['_RECONNECT']._serialized_end=836
-  _globals['_FLEET']._serialized_start=839
-  _globals['_FLEET']._serialized_end=1296
+  _globals['_CREATENODEREQUEST']._serialized_start=128
+  _globals['_CREATENODEREQUEST']._serialized_end=170
+  _globals['_CREATENODERESPONSE']._serialized_start=172
+  _globals['_CREATENODERESPONSE']._serialized_end=224
+  _globals['_DELETENODEREQUEST']._serialized_start=226
+  _globals['_DELETENODEREQUEST']._serialized_end=277
+  _globals['_DELETENODERESPONSE']._serialized_start=279
+  _globals['_DELETENODERESPONSE']._serialized_end=299
+  _globals['_PINGREQUEST']._serialized_start=301
+  _globals['_PINGREQUEST']._serialized_end=369
+  _globals['_PINGRESPONSE']._serialized_start=371
+  _globals['_PINGRESPONSE']._serialized_end=402
+  _globals['_PULLTASKINSREQUEST']._serialized_start=404
+  _globals['_PULLTASKINSREQUEST']._serialized_end=474
+  _globals['_PULLTASKINSRESPONSE']._serialized_start=476
+  _globals['_PULLTASKINSRESPONSE']._serialized_end=583
+  _globals['_PUSHTASKRESREQUEST']._serialized_start=585
+  _globals['_PUSHTASKRESREQUEST']._serialized_end=649
+  _globals['_PUSHTASKRESRESPONSE']._serialized_start=652
+  _globals['_PUSHTASKRESRESPONSE']._serialized_end=826
+  _globals['_PUSHTASKRESRESPONSE_RESULTSENTRY']._serialized_start=780
+  _globals['_PUSHTASKRESRESPONSE_RESULTSENTRY']._serialized_end=826
+  _globals['_RECONNECT']._serialized_start=828
+  _globals['_RECONNECT']._serialized_end=858
+  _globals['_FLEET']._serialized_start=861
+  _globals['_FLEET']._serialized_end=1385
 # @@protoc_insertion_point(module_scope)

flwr/proto/fleet_pb2_grpc.py

@@ -2,6 +2,7 @@
 """Client and server classes corresponding to protobuf-defined services."""
 import grpc
 
+from flwr.proto import fab_pb2 as flwr_dot_proto_dot_fab__pb2
 from flwr.proto import fleet_pb2 as flwr_dot_proto_dot_fleet__pb2
 from flwr.proto import run_pb2 as flwr_dot_proto_dot_run__pb2
 
@@ -45,6 +46,11 @@ class FleetStub(object):
                 request_serializer=flwr_dot_proto_dot_run__pb2.GetRunRequest.SerializeToString,
                 response_deserializer=flwr_dot_proto_dot_run__pb2.GetRunResponse.FromString,
                 )
+        self.GetFab = channel.unary_unary(
+                '/flwr.proto.Fleet/GetFab',
+                request_serializer=flwr_dot_proto_dot_fab__pb2.GetFabRequest.SerializeToString,
+                response_deserializer=flwr_dot_proto_dot_fab__pb2.GetFabResponse.FromString,
+                )
 
 
 class FleetServicer(object):
@@ -92,6 +98,13 @@ class FleetServicer(object):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def GetFab(self, request, context):
+        """Get FAB
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
 
 def add_FleetServicer_to_server(servicer, server):
     rpc_method_handlers = {
@@ -125,6 +138,11 @@ def add_FleetServicer_to_server(servicer, server):
                     request_deserializer=flwr_dot_proto_dot_run__pb2.GetRunRequest.FromString,
                     response_serializer=flwr_dot_proto_dot_run__pb2.GetRunResponse.SerializeToString,
             ),
+            'GetFab': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetFab,
+                    request_deserializer=flwr_dot_proto_dot_fab__pb2.GetFabRequest.FromString,
+                    response_serializer=flwr_dot_proto_dot_fab__pb2.GetFabResponse.SerializeToString,
+            ),
     }
     generic_handler = grpc.method_handlers_generic_handler(
             'flwr.proto.Fleet', rpc_method_handlers)
@@ -236,3 +254,20 @@ class Fleet(object):
             flwr_dot_proto_dot_run__pb2.GetRunResponse.FromString,
             options, channel_credentials,
             insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+    def GetFab(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/flwr.proto.Fleet/GetFab',
+            flwr_dot_proto_dot_fab__pb2.GetFabRequest.SerializeToString,
+            flwr_dot_proto_dot_fab__pb2.GetFabResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)

flwr/proto/fleet_pb2_grpc.pyi

@@ -3,6 +3,7 @@
 isort:skip_file
 """
 import abc
+import flwr.proto.fab_pb2
 import flwr.proto.fleet_pb2
 import flwr.proto.run_pb2
 import grpc
@@ -41,6 +42,11 @@ class FleetStub:
         flwr.proto.run_pb2.GetRunRequest,
         flwr.proto.run_pb2.GetRunResponse]
 
+    GetFab: grpc.UnaryUnaryMultiCallable[
+        flwr.proto.fab_pb2.GetFabRequest,
+        flwr.proto.fab_pb2.GetFabResponse]
+    """Get FAB"""
+
 
 class FleetServicer(metaclass=abc.ABCMeta):
     @abc.abstractmethod
@@ -89,5 +95,13 @@ class FleetServicer(metaclass=abc.ABCMeta):
         context: grpc.ServicerContext,
     ) -> flwr.proto.run_pb2.GetRunResponse: ...
 
+    @abc.abstractmethod
+    def GetFab(self,
+        request: flwr.proto.fab_pb2.GetFabRequest,
+        context: grpc.ServicerContext,
+    ) -> flwr.proto.fab_pb2.GetFabResponse:
+        """Get FAB"""
+        pass
+
 
 def add_FleetServicer_to_server(servicer: FleetServicer, server: grpc.Server) -> None: ...

flwr/proto/run_pb2.py

@@ -15,7 +15,7 @@ _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\x14\x66lwr/proto/run.proto\x12\nflwr.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xc3\x01\n\x03Run\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\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\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\"\x1f\n\rGetRunRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\".\n\x0eGetRunResponse\x12\x1c\n\x03run\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Runb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x14\x66lwr/proto/run.proto\x12\nflwr.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xd5\x01\n\x03Run\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\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\"\x1f\n\rGetRunRequest\x12\x0e\n\x06run_id\x18\x01 \x01(\x12\".\n\x0eGetRunResponse\x12\x1c\n\x03run\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Runb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -25,11 +25,11 @@ if _descriptor._USE_C_DESCRIPTORS == False:
   _globals['_RUN_OVERRIDECONFIGENTRY']._options = None
   _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_options = b'8\001'
   _globals['_RUN']._serialized_start=65
-  _globals['_RUN']._serialized_end=260
-  _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_start=187
-  _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_end=260
-  _globals['_GETRUNREQUEST']._serialized_start=262
-  _globals['_GETRUNREQUEST']._serialized_end=293
-  _globals['_GETRUNRESPONSE']._serialized_start=295
-  _globals['_GETRUNRESPONSE']._serialized_end=341
+  _globals['_RUN']._serialized_end=278
+  _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_start=205
+  _globals['_RUN_OVERRIDECONFIGENTRY']._serialized_end=278
+  _globals['_GETRUNREQUEST']._serialized_start=280
+  _globals['_GETRUNREQUEST']._serialized_end=311
+  _globals['_GETRUNRESPONSE']._serialized_start=313
+  _globals['_GETRUNRESPONSE']._serialized_end=359
 # @@protoc_insertion_point(module_scope)

flwr/proto/run_pb2.pyi

@@ -33,19 +33,22 @@ class Run(google.protobuf.message.Message):
     FAB_ID_FIELD_NUMBER: builtins.int
     FAB_VERSION_FIELD_NUMBER: builtins.int
     OVERRIDE_CONFIG_FIELD_NUMBER: builtins.int
+    FAB_HASH_FIELD_NUMBER: builtins.int
     run_id: 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]: ...
+    fab_hash: typing.Text
     def __init__(self,
         *,
         run_id: builtins.int = ...,
         fab_id: typing.Text = ...,
         fab_version: typing.Text = ...,
         override_config: typing.Optional[typing.Mapping[typing.Text, flwr.proto.transport_pb2.Scalar]] = ...,
+        fab_hash: typing.Text = ...,
         ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["fab_id",b"fab_id","fab_version",b"fab_version","override_config",b"override_config","run_id",b"run_id"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["fab_hash",b"fab_hash","fab_id",b"fab_id","fab_version",b"fab_version","override_config",b"override_config","run_id",b"run_id"]) -> None: ...
 global___Run = Run
 
 class GetRunRequest(google.protobuf.message.Message):

flwr/server/run_serverapp.py

@@ -57,9 +57,6 @@ def run(
             "but not both."
         )
 
-    if server_app_dir is not None:
-        sys.path.insert(0, str(Path(server_app_dir).absolute()))
-
     # Load ServerApp if needed
     def _load() -> ServerApp:
         if server_app_attr:

flwr/server/superlink/driver/driver_servicer.py

@@ -35,6 +35,7 @@ from flwr.proto.driver_pb2 import (  # pylint: disable=E0611
     PushTaskInsRequest,
     PushTaskInsResponse,
 )
+from flwr.proto.fab_pb2 import GetFabRequest, GetFabResponse  # pylint: disable=E0611
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.run_pb2 import (  # pylint: disable=E0611
     GetRunRequest,
@@ -163,6 +164,12 @@ class DriverServicer(driver_pb2_grpc.DriverServicer):
             )
         )
 
+    def GetFab(
+        self, request: GetFabRequest, context: grpc.ServicerContext
+    ) -> GetFabResponse:
+        """Will be implemented later."""
+        raise NotImplementedError
+
 
 def _raise_if(validation_error: bool, detail: str) -> None:
     if validation_error:

flwr/server/superlink/fleet/grpc_rere/fleet_servicer.py

@@ -21,6 +21,7 @@ import grpc
 
 from flwr.common.logger import log
 from flwr.proto import fleet_pb2_grpc  # pylint: disable=E0611
+from flwr.proto.fab_pb2 import GetFabRequest, GetFabResponse  # pylint: disable=E0611
 from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeRequest,
     CreateNodeResponse,
@@ -101,3 +102,9 @@ class FleetServicer(fleet_pb2_grpc.FleetServicer):
             request=request,
             state=self.state_factory.state(),
         )
+
+    def GetFab(
+        self, request: GetFabRequest, context: grpc.ServicerContext
+    ) -> GetFabResponse:
+        """Will be implemented later."""
+        raise NotImplementedError

flwr/server/superlink/fleet/vce/backend/__init__.py

@@ -38,7 +38,7 @@ else:
 
     To install the necessary dependencies, install `flwr` with the `simulation` extra:
 
-        pip install -U flwr["simulation"]
+        pip install -U "flwr[simulation]"
     """
 
 

flwr/server/superlink/fleet/vce/vce_api.py

@@ -72,8 +72,8 @@ def _register_node_states(
         node_states[node_id] = NodeState(
             node_id=node_id,
             node_config={
-                PARTITION_ID_KEY: str(partition_id),
-                NUM_PARTITIONS_KEY: str(num_partitions),
+                PARTITION_ID_KEY: partition_id,
+                NUM_PARTITIONS_KEY: num_partitions,
             },
         )
 
@@ -347,8 +347,8 @@ def start_vce(
         if client_app_attr:
             app = _get_load_client_app_fn(
                 default_app_ref=client_app_attr,
-                dir_arg=app_dir,
-                flwr_dir_arg=flwr_dir,
+                project_dir=app_dir,
+                flwr_dir=flwr_dir,
                 multi_app=True,
             )(run.fab_id, run.fab_version)
 

flwr/simulation/__init__.py

@@ -28,7 +28,7 @@ else:
 
 To install the necessary dependencies, install `flwr` with the `simulation` extra:
 
-    pip install -U flwr["simulation"]
+    pip install -U "flwr[simulation]"
 """
 
     def start_simulation(*args, **kwargs):  # type: ignore

flwr/simulation/run_simulation.py

@@ -32,7 +32,11 @@ from flwr.client import ClientApp
 from flwr.common import EventType, event, log
 from flwr.common.config import get_fused_config_from_dir, parse_config_args
 from flwr.common.constant import RUN_ID_NUM_BYTES
-from flwr.common.logger import set_logger_propagation, update_console_handler
+from flwr.common.logger import (
+    set_logger_propagation,
+    update_console_handler,
+    warn_deprecated_feature_with_example,
+)
 from flwr.common.typing import Run, UserConfig
 from flwr.server.driver import Driver, InMemoryDriver
 from flwr.server.run_serverapp import run as run_server_app
@@ -93,6 +97,14 @@ def run_simulation_from_cli() -> None:
     """Run Simulation Engine from the CLI."""
     args = _parse_args_run_simulation().parse_args()
 
+    if args.enable_tf_gpu_growth:
+        warn_deprecated_feature_with_example(
+            "Passing `--enable-tf-gpu-growth` is deprecated.",
+            example_message="Instead, set the `TF_FORCE_GPU_ALLOW_GROWTH` environmnet "
+            "variable to true.",
+            code_example='TF_FORCE_GPU_ALLOW_GROWTH="true" flower-simulation <...>',
+        )
+
     # We are supporting two modes for the CLI entrypoint:
     # 1) Running an app dir containing a `pyproject.toml`
     # 2) Running any ClientApp and SeverApp w/o pyproject.toml being present
@@ -223,6 +235,15 @@ def run_simulation(
         When disabled, only INFO, WARNING and ERROR log messages will be shown. If
         enabled, DEBUG-level logs will be displayed.
     """
+    if enable_tf_gpu_growth:
+        warn_deprecated_feature_with_example(
+            "Passing `enable_tf_gpu_growth=True` is deprecated.",
+            example_message="Instead, set the `TF_FORCE_GPU_ALLOW_GROWTH` environmnet "
+            "variable to true.",
+            code_example='import os;os.environ["TF_FORCE_GPU_ALLOW_GROWTH"]="true"'
+            "\n\tflwr.simulation.run_simulationt(...)",
+        )
+
     _run_simulation(
         num_supernodes=num_supernodes,
         client_app=client_app,
@@ -264,7 +285,7 @@ def run_serverapp_th(
         """
         try:
             if tf_gpu_growth:
-                log(INFO, "Enabling GPU growth for Tensorflow on the main thread.")
+                log(INFO, "Enabling GPU growth for Tensorflow on the server thread.")
                 enable_gpu_growth()
 
             # Run ServerApp
@@ -475,6 +496,14 @@ def _run_simulation(
     if "init_args" not in backend_config:
         backend_config["init_args"] = {}
 
+    # Set default client_resources if not passed
+    if "client_resources" not in backend_config:
+        backend_config["client_resources"] = {"num_cpus": 2, "num_gpus": 0}
+
+    # Initialization of backend config to enable GPU growth globally when set
+    if "actor" not in backend_config:
+        backend_config["actor"] = {"tensorflow": 0}
+
     # Set logging level
     logger = logging.getLogger("flwr")
     if verbose_logging:
@@ -580,8 +609,7 @@ def _parse_args_run_simulation() -> argparse.ArgumentParser:
     parser.add_argument(
         "--backend-config",
         type=str,
-        default='{"client_resources": {"num_cpus":2, "num_gpus":0.0},'
-        '"actor": {"tensorflow": 0}}',
+        default="{}",
         help='A JSON formatted stream, e.g \'{"<keyA>":<value>, "<keyB>":<value>}\' to '
         "configure a backend. Values supported in <value> are those included by "
         "`flwr.common.typing.ConfigsRecordValues`. ",

flwr/superexec/app.py

@@ -93,7 +93,9 @@ def _parse_args_run_superexec() -> argparse.ArgumentParser:
     )
     parser.add_argument(
         "--executor-config",
-        help="Key-value pairs for the executor config, separated by commas.",
+        help="Key-value pairs for the executor config, separated by commas. "
+        'For example:\n\n`--executor-config superlink="superlink:9091",'
+        'root-certificates="certificates/superlink-ca.crt"`',
     )
     parser.add_argument(
         "--insecure",
@@ -163,11 +165,8 @@ def _load_executor(
     args: argparse.Namespace,
 ) -> Executor:
     """Get the executor plugin."""
-    if args.executor_dir is not None:
-        sys.path.insert(0, args.executor_dir)
-
     executor_ref: str = args.executor
-    valid, error_msg = validate(executor_ref)
+    valid, error_msg = validate(executor_ref, project_dir=args.executor_dir)
     if not valid and error_msg:
         raise LoadExecutorError(error_msg) from None
 

flwr/superexec/deployment.py

@@ -135,6 +135,7 @@ class DeploymentEngine(Executor):
         self,
         fab_file: bytes,
         override_config: UserConfig,
+        federation_config: UserConfig,
     ) -> Optional[RunTracker]:
         """Start run using the Flower Deployment Engine."""
         try:
@@ -167,8 +168,6 @@ class DeploymentEngine(Executor):
             # Execute the command
             proc = subprocess.Popen(  # pylint: disable=consider-using-with
                 command,
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
                 text=True,
             )
             log(INFO, "Started run %s", str(run_id))

flwr/superexec/exec_servicer.py

@@ -47,7 +47,9 @@ class ExecServicer(exec_pb2_grpc.ExecServicer):
         log(INFO, "ExecServicer.StartRun")
 
         run = self.executor.start_run(
-            request.fab_file, user_config_from_proto(request.override_config)
+            request.fab_file,
+            user_config_from_proto(request.override_config),
+            user_config_from_proto(request.federation_config),
         )
 
         if run is None:

flwr/superexec/executor.py

@@ -51,6 +51,7 @@ class Executor(ABC):
         self,
         fab_file: bytes,
         override_config: UserConfig,
+        federation_config: UserConfig,
     ) -> Optional[RunTracker]:
         """Start a run using the given Flower FAB ID and version.
 
@@ -63,6 +64,8 @@ class Executor(ABC):
             The Flower App Bundle file bytes.
         override_config: UserConfig
             The config overrides dict sent by the user (using `flwr run`).
+        federation_config: UserConfig
+            The federation options dict sent by the user (using `flwr run`).
 
         Returns
         -------

flwr/superexec/simulation.py

@@ -32,6 +32,25 @@ from flwr.server.superlink.state.utils import generate_rand_int_from_bytes
 from .executor import Executor, RunTracker
 
 
+def _user_config_to_str(user_config: UserConfig) -> str:
+    """Convert override user config to string."""
+    user_config_list_str = []
+    for key, value in user_config.items():
+        if isinstance(value, bool):
+            user_config_list_str.append(f"{key}={str(value).lower()}")
+        elif isinstance(value, (int, float)):
+            user_config_list_str.append(f"{key}={value}")
+        elif isinstance(value, str):
+            user_config_list_str.append(f'{key}="{value}"')
+        else:
+            raise ValueError(
+                "Only types `bool`, `float`, `int` and `str` are supported"
+            )
+
+    user_config_str = ",".join(user_config_list_str)
+    return user_config_str
+
+
 class SimulationEngine(Executor):
     """Simulation engine executor.
 
@@ -44,8 +63,10 @@ class SimulationEngine(Executor):
     def __init__(
         self,
         num_supernodes: Optional[int] = None,
+        verbose: Optional[bool] = False,
     ) -> None:
         self.num_supernodes = num_supernodes
+        self.verbose = verbose
 
     @override
     def set_config(
@@ -61,14 +82,14 @@ class SimulationEngine(Executor):
             Supported configuration key/value pairs:
             - "num-supernodes": int
                 Number of nodes to register for the simulation.
+            - "verbose": bool
+                Set verbosity of logs.
         """
-        if not config:
-            return
         if num_supernodes := config.get("num-supernodes"):
             if not isinstance(num_supernodes, int):
                 raise ValueError("The `num-supernodes` value should be of type `int`.")
             self.num_supernodes = num_supernodes
-        else:
+        elif self.num_supernodes is None:
             log(
                 ERROR,
                 "To start a run with the simulation plugin, please specify "
@@ -80,21 +101,42 @@ class SimulationEngine(Executor):
                 "positive integer."
             )
 
+        if verbose := config.get("verbose"):
+            if not isinstance(verbose, bool):
+                raise ValueError(
+                    "The `verbose` value must be a string `true` or `false`."
+                )
+            self.verbose = verbose
+
     @override
     def start_run(
-        self, fab_file: bytes, override_config: UserConfig
+        self,
+        fab_file: bytes,
+        override_config: UserConfig,
+        federation_config: UserConfig,
     ) -> Optional[RunTracker]:
         """Start run using the Flower Simulation Engine."""
+        if self.num_supernodes is None:
+            raise ValueError(
+                "Error in `SuperExec` (`SimulationEngine` executor):\n\n"
+                "`num-supernodes` must not be `None`, it must be a valid "
+                "positive integer. In order to start this simulation executor "
+                "with a specified number of `SuperNodes`, you can either provide "
+                "a `--executor` that has been initialized with a number of nodes "
+                "to the `flower-superexec` CLI, or `--executor-config num-supernodes=N`"
+                "to the `flower-superexec` CLI."
+            )
         try:
 
             # Install FAB to flwr dir
             fab_path = install_from_fab(fab_file, None, True)
 
             # Install FAB Python package
-            subprocess.check_call(
+            subprocess.run(
                 [sys.executable, "-m", "pip", "install", "--no-deps", str(fab_path)],
-                stdout=subprocess.DEVNULL,
-                stderr=subprocess.DEVNULL,
+                stdout=None if self.verbose else subprocess.DEVNULL,
+                stderr=None if self.verbose else subprocess.DEVNULL,
+                check=True,
             )
 
             # Load and validate config
@@ -120,18 +162,18 @@ class SimulationEngine(Executor):
                 "--app",
                 f"{str(fab_path)}",
                 "--num-supernodes",
-                f"{self.num_supernodes}",
+                f"{federation_config.get('num-supernodes', self.num_supernodes)}",
                 "--run-id",
                 str(run_id),
             ]
 
             if override_config:
-                command.extend(["--run-config", f"{override_config}"])
+                override_config_str = _user_config_to_str(override_config)
+                command.extend(["--run-config", f"{override_config_str}"])
 
             # Start Simulation
-            proc = subprocess.run(  # pylint: disable=consider-using-with
+            proc = subprocess.Popen(  # pylint: disable=consider-using-with
                 command,
-                check=True,
                 text=True,
             )
 
@@ -139,7 +181,7 @@ class SimulationEngine(Executor):
 
             return RunTracker(
                 run_id=run_id,
-                proc=proc,  # type:ignore
+                proc=proc,
             )
 
         # pylint: disable-next=broad-except

{flwr_nightly-1.10.0.dev20240722.dist-info → flwr_nightly-1.11.0.dev20240805.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.10.0.dev20240722
+Version: 1.11.0.dev20240805
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0