flwr-nightly 1.12.0.dev20240906__py3-none-any.whl → 1.12.0.dev20240913__py3-none-any.whl

flwr/simulation/app.py

@@ -22,7 +22,7 @@ import threading
 import traceback
 import warnings
 from logging import ERROR, INFO
-from typing import Any, Dict, List, Optional, Type, Union
+from typing import Any, Optional, Union
 
 import ray
 from ray.util.scheduling_strategies import NodeAffinitySchedulingStrategy
@@ -72,7 +72,7 @@ REASON:
 
 """
 
-NodeToPartitionMapping = Dict[int, int]
+NodeToPartitionMapping = dict[int, int]
 
 
 def _create_node_id_to_partition_mapping(
@@ -94,16 +94,16 @@ def start_simulation(
     *,
     client_fn: ClientFnExt,
     num_clients: int,
-    clients_ids: Optional[List[str]] = None,  # UNSUPPORTED, WILL BE REMOVED
-    client_resources: Optional[Dict[str, float]] = None,
+    clients_ids: Optional[list[str]] = None,  # UNSUPPORTED, WILL BE REMOVED
+    client_resources: Optional[dict[str, float]] = None,
     server: Optional[Server] = None,
     config: Optional[ServerConfig] = None,
     strategy: Optional[Strategy] = None,
     client_manager: Optional[ClientManager] = None,
-    ray_init_args: Optional[Dict[str, Any]] = None,
+    ray_init_args: Optional[dict[str, Any]] = None,
     keep_initialised: Optional[bool] = False,
-    actor_type: Type[VirtualClientEngineActor] = ClientAppActor,
-    actor_kwargs: Optional[Dict[str, Any]] = None,
+    actor_type: type[VirtualClientEngineActor] = ClientAppActor,
+    actor_kwargs: Optional[dict[str, Any]] = None,
     actor_scheduling: Union[str, NodeAffinitySchedulingStrategy] = "DEFAULT",
 ) -> History:
     """Start a Ray-based Flower simulation server.
@@ -279,7 +279,7 @@ def start_simulation(
     # An actor factory. This is called N times to add N actors
     # to the pool. If at some point the pool can accommodate more actors
     # this will be called again.
-    def create_actor_fn() -> Type[VirtualClientEngineActor]:
+    def create_actor_fn() -> type[VirtualClientEngineActor]:
         return actor_type.options(  # type: ignore
             **client_resources,
             scheduling_strategy=actor_scheduling,

flwr/simulation/ray_transport/ray_actor.py

@@ -17,7 +17,7 @@
 import threading
 from abc import ABC
 from logging import DEBUG, ERROR, WARNING
-from typing import Any, Callable, Dict, List, Optional, Set, Tuple, Type, Union
+from typing import Any, Callable, Optional, Union
 
 import ray
 from ray import ObjectRef
@@ -44,7 +44,7 @@ class VirtualClientEngineActor(ABC):
         message: Message,
         cid: str,
         context: Context,
-    ) -> Tuple[str, Message, Context]:
+    ) -> tuple[str, Message, Context]:
         """Run a client run."""
         # Pass message through ClientApp and return a message
         # return also cid which is needed to ensure results
@@ -81,7 +81,7 @@ class ClientAppActor(VirtualClientEngineActor):
             on_actor_init_fn()
 
 
-def pool_size_from_resources(client_resources: Dict[str, Union[int, float]]) -> int:
+def pool_size_from_resources(client_resources: dict[str, Union[int, float]]) -> int:
     """Calculate number of Actors that fit in the cluster.
 
     For this we consider the resources available on each node and those required per
@@ -124,14 +124,14 @@ def pool_size_from_resources(client_resources: Dict[str, Union[int, float]]) ->
             WARNING,
             "The ActorPool is empty. The system (CPUs=%s, GPUs=%s) "
             "does not meet the criteria to host at least one client with resources:"
-            " %s. Lowering the `client_resources` could help.",
+            " %s. Lowering these resources could help.",
             num_cpus,
             num_gpus,
             client_resources,
         )
         raise ValueError(
             "ActorPool is empty. Stopping Simulation. "
-            "Check 'client_resources' passed to `start_simulation`"
+            "Check `num_cpus` and/or `num_gpus` passed to the simulation engine"
         )
 
     return total_num_actors
@@ -162,9 +162,9 @@ class VirtualClientEngineActorPool(ActorPool):
 
     def __init__(
         self,
-        create_actor_fn: Callable[[], Type[VirtualClientEngineActor]],
-        client_resources: Dict[str, Union[int, float]],
-        actor_list: Optional[List[Type[VirtualClientEngineActor]]] = None,
+        create_actor_fn: Callable[[], type[VirtualClientEngineActor]],
+        client_resources: dict[str, Union[int, float]],
+        actor_list: Optional[list[type[VirtualClientEngineActor]]] = None,
     ):
         self.client_resources = client_resources
         self.create_actor_fn = create_actor_fn
@@ -183,10 +183,10 @@ class VirtualClientEngineActorPool(ActorPool):
 
         # A dict that maps cid to another dict containing: a reference to the remote job
         # and its status (i.e. whether it is ready or not)
-        self._cid_to_future: Dict[
-            str, Dict[str, Union[bool, Optional[ObjectRef[Any]]]]
+        self._cid_to_future: dict[
+            str, dict[str, Union[bool, Optional[ObjectRef[Any]]]]
         ] = {}
-        self.actor_to_remove: Set[str] = set()  # a set
+        self.actor_to_remove: set[str] = set()  # a set
         self.num_actors = len(actors)
 
         self.lock = threading.RLock()
@@ -210,7 +210,7 @@ class VirtualClientEngineActorPool(ActorPool):
             self._idle_actors.extend(new_actors)
             self.num_actors += num_actors
 
-    def submit(self, fn: Any, value: Tuple[ClientAppFn, Message, str, Context]) -> None:
+    def submit(self, fn: Any, value: tuple[ClientAppFn, Message, str, Context]) -> None:
         """Take an idle actor and assign it to run a client app and Message.
 
         Submit a job to an actor by first removing it from the list of idle actors, then
@@ -220,7 +220,7 @@ class VirtualClientEngineActorPool(ActorPool):
         actor = self._idle_actors.pop()
         if self._check_and_remove_actor_from_pool(actor):
             future = fn(actor, app_fn, mssg, cid, context)
-            future_key = tuple(future) if isinstance(future, List) else future
+            future_key = tuple(future) if isinstance(future, list) else future
             self._future_to_actor[future_key] = (self._next_task_index, actor, cid)
             self._next_task_index += 1
 
@@ -228,7 +228,7 @@ class VirtualClientEngineActorPool(ActorPool):
             self._cid_to_future[cid]["future"] = future_key
 
     def submit_client_job(
-        self, actor_fn: Any, job: Tuple[ClientAppFn, Message, str, Context]
+        self, actor_fn: Any, job: tuple[ClientAppFn, Message, str, Context]
     ) -> None:
         """Submit a job while tracking client ids."""
         _, _, cid, _ = job
@@ -268,7 +268,7 @@ class VirtualClientEngineActorPool(ActorPool):
 
         return self._cid_to_future[cid]["ready"]  # type: ignore
 
-    def _fetch_future_result(self, cid: str) -> Tuple[Message, Context]:
+    def _fetch_future_result(self, cid: str) -> tuple[Message, Context]:
         """Fetch result and updated context for a VirtualClient from Object Store.
 
         The job submitted by the ClientProxy interfacing with client with cid=cid is
@@ -382,7 +382,7 @@ class VirtualClientEngineActorPool(ActorPool):
 
     def get_client_result(
         self, cid: str, timeout: Optional[float]
-    ) -> Tuple[Message, Context]:
+    ) -> tuple[Message, Context]:
         """Get result from VirtualClient with specific cid."""
         # Loop until all jobs submitted to the pool are completed. Break early
         # if the result for the ClientProxy calling this method is ready
@@ -403,14 +403,14 @@ class BasicActorPool:
 
     def __init__(
         self,
-        actor_type: Type[VirtualClientEngineActor],
-        client_resources: Dict[str, Union[int, float]],
-        actor_kwargs: Dict[str, Any],
+        actor_type: type[VirtualClientEngineActor],
+        client_resources: dict[str, Union[int, float]],
+        actor_kwargs: dict[str, Any],
     ):
         self.client_resources = client_resources
 
         # Queue of idle actors
-        self.pool: List[VirtualClientEngineActor] = []
+        self.pool: list[VirtualClientEngineActor] = []
         self.num_actors = 0
 
         # Resolve arguments to pass during actor init
@@ -424,7 +424,7 @@ class BasicActorPool:
         # Figure out how many actors can be created given the cluster resources
         # and the resources the user indicates each VirtualClient will need
         self.actors_capacity = pool_size_from_resources(client_resources)
-        self._future_to_actor: Dict[Any, VirtualClientEngineActor] = {}
+        self._future_to_actor: dict[Any, VirtualClientEngineActor] = {}
 
     def is_actor_available(self) -> bool:
         """Return true if there is an idle actor."""
@@ -450,7 +450,7 @@ class BasicActorPool:
         log(DEBUG, "Terminated %i actors", num_terminated)
 
     def submit(
-        self, actor_fn: Any, job: Tuple[ClientAppFn, Message, str, Context]
+        self, actor_fn: Any, job: tuple[ClientAppFn, Message, str, Context]
     ) -> Any:
         """On idle actor, submit job and return future."""
         # Remove idle actor from pool
@@ -470,7 +470,7 @@ class BasicActorPool:
 
     def fetch_result_and_return_actor_to_pool(
         self, future: Any
-    ) -> Tuple[Message, Context]:
+    ) -> tuple[Message, Context]:
         """Pull result given a future and add actor back to pool."""
         # Retrieve result for object store
         # Instead of doing ray.get(future) we await it

flwr/simulation/run_simulation.py

@@ -25,7 +25,7 @@ from argparse import Namespace
 from logging import DEBUG, ERROR, INFO, WARNING
 from pathlib import Path
 from time import sleep
-from typing import Any, List, Optional
+from typing import Any, Optional
 
 from flwr.cli.config_utils import load_and_validate
 from flwr.client import ClientApp
@@ -56,7 +56,7 @@ def _check_args_do_not_interfere(args: Namespace) -> bool:
     mode_one_args = ["app", "run_config"]
     mode_two_args = ["client_app", "server_app"]
 
-    def _resolve_message(conflict_keys: List[str]) -> str:
+    def _resolve_message(conflict_keys: list[str]) -> str:
         return ",".join([f"`--{key}`".replace("_", "-") for key in conflict_keys])
 
     # When passing `--app`, `--app-dir` is ignored
@@ -216,6 +216,7 @@ def run_simulation_from_cli() -> None:
         app_dir=app_dir,
         run=run,
         enable_tf_gpu_growth=args.enable_tf_gpu_growth,
+        delay_start=args.delay_start,
         verbose_logging=args.verbose,
         server_app_run_config=fused_config,
         is_app=is_app,
@@ -309,7 +310,6 @@ def run_serverapp_th(
     f_stop: threading.Event,
     has_exception: threading.Event,
     enable_tf_gpu_growth: bool,
-    delay_launch: int = 3,
 ) -> threading.Thread:
     """Run SeverApp in a thread."""
 
@@ -365,7 +365,6 @@ def run_serverapp_th(
             server_app,
         ),
     )
-    sleep(delay_launch)
     serverapp_th.start()
     return serverapp_th
 
@@ -380,6 +379,7 @@ def _main_loop(
     enable_tf_gpu_growth: bool,
     run: Run,
     exit_event: EventType,
+    delay_start: int,
     flwr_dir: Optional[str] = None,
     client_app: Optional[ClientApp] = None,
     client_app_attr: Optional[str] = None,
@@ -419,6 +419,9 @@ def _main_loop(
             enable_tf_gpu_growth=enable_tf_gpu_growth,
         )
 
+        # Buffer time so the `ServerApp` in separate thread is ready
+        log(DEBUG, "Buffer time delay: %ds", delay_start)
+        sleep(delay_start)
         # Start Simulation Engine
         vce.start_vce(
             num_supernodes=num_supernodes,
@@ -467,6 +470,7 @@ def _run_simulation(
     flwr_dir: Optional[str] = None,
     run: Optional[Run] = None,
     enable_tf_gpu_growth: bool = False,
+    delay_start: int = 5,
     verbose_logging: bool = False,
     is_app: bool = False,
 ) -> None:
@@ -523,6 +527,7 @@ def _run_simulation(
         enable_tf_gpu_growth,
         run,
         exit_event,
+        delay_start,
         flwr_dir,
         client_app,
         client_app_attr,
@@ -610,6 +615,13 @@ def _parse_args_run_simulation() -> argparse.ArgumentParser:
         "Read more about how `tf.config.experimental.set_memory_growth()` works in "
         "the TensorFlow documentation: https://www.tensorflow.org/api/stable.",
     )
+    parser.add_argument(
+        "--delay-start",
+        type=int,
+        default=3,
+        help="Buffer time (in seconds) to delay the start the simulation engine after "
+        "the `ServerApp`, which runs in a separate thread, has been launched.",
+    )
     parser.add_argument(
         "--verbose",
         action="store_true",

flwr/superexec/app.py

@@ -18,14 +18,14 @@ import argparse
 import sys
 from logging import INFO, WARN
 from pathlib import Path
-from typing import Optional, Tuple
+from typing import Optional
 
 import grpc
 
 from flwr.common import EventType, event, log
 from flwr.common.address import parse_address
 from flwr.common.config import parse_config_args
-from flwr.common.constant import SUPEREXEC_DEFAULT_ADDRESS
+from flwr.common.constant import EXEC_API_DEFAULT_ADDRESS
 from flwr.common.exit_handlers import register_exit_handlers
 from flwr.common.object_ref import load_app, validate
 
@@ -81,7 +81,7 @@ def _parse_args_run_superexec() -> argparse.ArgumentParser:
     parser.add_argument(
         "--address",
         help="SuperExec (gRPC) server address (IPv4, IPv6, or a domain name)",
-        default=SUPEREXEC_DEFAULT_ADDRESS,
+        default=EXEC_API_DEFAULT_ADDRESS,
     )
     parser.add_argument(
         "--executor",
@@ -130,7 +130,7 @@ def _parse_args_run_superexec() -> argparse.ArgumentParser:
 
 def _try_obtain_certificates(
     args: argparse.Namespace,
-) -> Optional[Tuple[bytes, bytes, bytes]]:
+) -> Optional[tuple[bytes, bytes, bytes]]:
     # Obtain certificates
     if args.insecure:
         log(WARN, "Option `--insecure` was set. Starting insecure HTTP server.")

flwr/superexec/deployment.py

@@ -23,13 +23,13 @@ from typing import Optional
 from typing_extensions import override
 
 from flwr.cli.install import install_from_fab
+from flwr.common.constant import DRIVER_API_DEFAULT_ADDRESS
 from flwr.common.grpc import create_channel
 from flwr.common.logger import log
 from flwr.common.serde import fab_to_proto, user_config_to_proto
 from flwr.common.typing import Fab, UserConfig
 from flwr.proto.driver_pb2 import CreateRunRequest  # pylint: disable=E0611
 from flwr.proto.driver_pb2_grpc import DriverStub
-from flwr.server.driver.grpc_driver import DEFAULT_SERVER_ADDRESS_DRIVER
 
 from .executor import Executor, RunTracker
 
@@ -50,7 +50,7 @@ class DeploymentEngine(Executor):
 
     def __init__(
         self,
-        superlink: str = DEFAULT_SERVER_ADDRESS_DRIVER,
+        superlink: str = DRIVER_API_DEFAULT_ADDRESS,
         root_certificates: Optional[str] = None,
         flwr_dir: Optional[str] = None,
     ) -> None:

flwr/superexec/exec_grpc.py

@@ -15,7 +15,7 @@
 """SuperExec gRPC API."""
 
 from logging import INFO
-from typing import Optional, Tuple
+from typing import Optional
 
 import grpc
 
@@ -32,7 +32,7 @@ from .executor import Executor
 def run_superexec_api_grpc(
     address: str,
     executor: Executor,
-    certificates: Optional[Tuple[bytes, bytes, bytes]],
+    certificates: Optional[tuple[bytes, bytes, bytes]],
     config: UserConfig,
 ) -> grpc.Server:
     """Run SuperExec API (gRPC, request-response)."""

flwr/superexec/exec_servicer.py

@@ -15,8 +15,9 @@
 """SuperExec API servicer."""
 
 
+from collections.abc import Generator
 from logging import ERROR, INFO
-from typing import Any, Dict, Generator
+from typing import Any
 
 import grpc
 
@@ -38,7 +39,7 @@ class ExecServicer(exec_pb2_grpc.ExecServicer):
 
     def __init__(self, executor: Executor) -> None:
         self.executor = executor
-        self.runs: Dict[int, RunTracker] = {}
+        self.runs: dict[int, RunTracker] = {}
 
     def StartRun(
         self, request: StartRunRequest, context: grpc.ServicerContext

{flwr_nightly-1.12.0.dev20240906.dist-info → flwr_nightly-1.12.0.dev20240913.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.12.0.dev20240906
+Version: 1.12.0.dev20240913
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0
 Keywords: flower,fl,federated learning,federated analytics,federated evaluation,machine learning
 Author: The Flower Authors
 Author-email: hello@flower.ai
-Requires-Python: >=3.8,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -16,7 +16,6 @@ Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -33,13 +32,13 @@ Classifier: Typing :: Typed
 Provides-Extra: rest
 Provides-Extra: simulation
 Requires-Dist: cryptography (>=42.0.4,<43.0.0)
-Requires-Dist: grpcio (>=1.60.0,<2.0.0,!=1.64.2,!=1.65.1,!=1.65.2,!=1.65.4)
+Requires-Dist: grpcio (>=1.60.0,<2.0.0,!=1.64.2,!=1.65.1,!=1.65.2,!=1.65.4,!=1.65.5,!=1.66.0,!=1.66.1)
 Requires-Dist: iterators (>=0.0.2,<0.0.3)
 Requires-Dist: numpy (>=1.21.0,<2.0.0)
 Requires-Dist: pathspec (>=0.12.1,<0.13.0)
 Requires-Dist: protobuf (>=4.25.2,<5.0.0)
 Requires-Dist: pycryptodome (>=3.18.0,<4.0.0)
-Requires-Dist: ray (==2.10.0) ; (python_version >= "3.8" and python_version < "3.12") and (extra == "simulation")
+Requires-Dist: ray (==2.10.0) ; (python_version >= "3.9" and python_version < "3.12") and (extra == "simulation")
 Requires-Dist: requests (>=2.31.0,<3.0.0) ; extra == "rest"
 Requires-Dist: starlette (>=0.31.0,<0.32.0) ; extra == "rest"
 Requires-Dist: tomli (>=2.0.1,<3.0.0)
@@ -199,7 +198,6 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [Federated Finetuning of a Vision Transformer](https://github.com/adap/flower/tree/main/examples/flowertune-vit)
 - [Advanced Flower with TensorFlow/Keras](https://github.com/adap/flower/tree/main/examples/advanced-tensorflow)
 - [Advanced Flower with PyTorch](https://github.com/adap/flower/tree/main/examples/advanced-pytorch)
-- Single-Machine Simulation of Federated Learning Systems ([PyTorch](https://github.com/adap/flower/tree/main/examples/simulation-pytorch)) ([Tensorflow](https://github.com/adap/flower/tree/main/examples/simulation-tensorflow))
 - [Comprehensive Flower+XGBoost](https://github.com/adap/flower/tree/main/examples/xgboost-comprehensive)
 - [Flower through Docker Compose and with Grafana dashboard](https://github.com/adap/flower/tree/main/examples/flower-via-docker-compose)
 - [Flower with KaplanMeierFitter from the lifelines library](https://github.com/adap/flower/tree/main/examples/federated-kaplan-meier-fitter)