flwr-nightly 1.10.0.dev20240713__tar.gz → 1.10.0.dev20240714__tar.gz

{flwr_nightly-1.10.0.dev20240713 → flwr_nightly-1.10.0.dev20240714}/PKG-INFO

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

{flwr_nightly-1.10.0.dev20240713 → flwr_nightly-1.10.0.dev20240714}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.10.0.dev20240713"
+version = "1.10.0.dev20240714"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]

flwr_nightly-1.10.0.dev20240714/src/py/flwr/cli/new/templates/app/code/server.hf.py.tpl

@@ -0,0 +1,19 @@
+"""$project_name: A Flower / HuggingFace Transformers app."""
+
+from flwr.common import Context
+from flwr.server.strategy import FedAvg
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
+
+
+def server_fn(context: Context):
+    # Define strategy
+    strategy = FedAvg(
+        fraction_fit=1.0,
+        fraction_evaluate=1.0,
+    )
+    config = ServerConfig(num_rounds=3)
+
+    return ServerAppComponents(strategy=strategy, config=config)
+
+# Create ServerApp
+app = ServerApp(server_fn=server_fn)

flwr_nightly-1.10.0.dev20240714/src/py/flwr/cli/new/templates/app/code/server.jax.py.tpl

@@ -0,0 +1,16 @@
+"""$project_name: A Flower / JAX app."""
+
+from flwr.common import Context
+from flwr.server.strategy import FedAvg
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
+
+
+def server_fn(context: Context):
+    # Define strategy
+    strategy = FedAvg()
+    config = ServerConfig(num_rounds=3)
+
+    return ServerAppComponents(strategy=strategy, config=config)
+
+# Create ServerApp
+app = ServerApp(server_fn=server_fn)

flwr_nightly-1.10.0.dev20240714/src/py/flwr/cli/new/templates/app/code/server.mlx.py.tpl

@@ -0,0 +1,16 @@
+"""$project_name: A Flower / MLX app."""
+
+from flwr.common import Context
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
+from flwr.server.strategy import FedAvg
+
+
+def server_fn(context: Context):
+    # Define strategy
+    strategy = FedAvg()
+    config = ServerConfig(num_rounds=3)
+
+    return ServerAppComponents(strategy=strategy, config=config)
+
+# Create ServerApp
+app = ServerApp(server_fn=server_fn)

flwr_nightly-1.10.0.dev20240714/src/py/flwr/cli/new/templates/app/code/server.numpy.py.tpl

@@ -0,0 +1,16 @@
+"""$project_name: A Flower / NumPy app."""
+
+from flwr.common import Context
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
+from flwr.server.strategy import FedAvg
+
+
+def server_fn(context: Context):
+    # Define strategy
+    strategy = FedAvg()
+    config = ServerConfig(num_rounds=3)
+
+    return ServerAppComponents(strategy=strategy, config=config)
+
+# Create ServerApp
+app = ServerApp(server_fn=server_fn)

flwr_nightly-1.10.0.dev20240714/src/py/flwr/cli/new/templates/app/code/server.pytorch.py.tpl

@@ -0,0 +1,27 @@
+"""$project_name: A Flower / PyTorch app."""
+
+from flwr.common import Context, ndarrays_to_parameters
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
+from flwr.server.strategy import FedAvg
+
+from $import_name.task import Net, get_weights
+
+
+# Initialize model parameters
+ndarrays = get_weights(Net())
+parameters = ndarrays_to_parameters(ndarrays)
+
+def server_fn(context: Context):
+    # Define strategy
+    strategy = FedAvg(
+        fraction_fit=1.0,
+        fraction_evaluate=1.0,
+        min_available_clients=2,
+        initial_parameters=parameters,
+    )
+    config = ServerConfig(num_rounds=3)
+
+    return ServerAppComponents(strategy=strategy, config=config)
+
+# Create ServerApp
+app = ServerApp(server_fn=server_fn)

flwr_nightly-1.10.0.dev20240714/src/py/flwr/cli/new/templates/app/code/server.sklearn.py.tpl

@@ -0,0 +1,20 @@
+"""$project_name: A Flower / Scikit-Learn app."""
+
+from flwr.common import Context
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
+from flwr.server.strategy import FedAvg
+
+
+def server_fn(context: Context):
+    # Define strategy
+    strategy = FedAvg(
+        fraction_fit=1.0,
+        fraction_evaluate=1.0,
+        min_available_clients=2,
+    )
+    config = ServerConfig(num_rounds=3)
+
+    return ServerAppComponents(strategy=strategy, config=config)
+
+# Create ServerApp
+app = ServerApp(server_fn=server_fn)

flwr_nightly-1.10.0.dev20240714/src/py/flwr/cli/new/templates/app/code/server.tensorflow.py.tpl

@@ -0,0 +1,27 @@
+"""$project_name: A Flower / TensorFlow app."""
+
+from flwr.common import Context, ndarrays_to_parameters
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
+from flwr.server.strategy import FedAvg
+
+from $import_name.task import load_model
+
+# Define config
+config = ServerConfig(num_rounds=3)
+
+parameters = ndarrays_to_parameters(load_model().get_weights())
+
+def server_fn(context: Context):
+    # Define strategy
+    strategy = strategy = FedAvg(
+        fraction_fit=1.0,
+        fraction_evaluate=1.0,
+        min_available_clients=2,
+        initial_parameters=parameters,
+    )
+    config = ServerConfig(num_rounds=3)
+
+    return ServerAppComponents(strategy=strategy, config=config)
+
+# Create ServerApp
+app = ServerApp(server_fn=server_fn)

{flwr_nightly-1.10.0.dev20240713 → flwr_nightly-1.10.0.dev20240714}/src/py/flwr/cli/run/run.py

@@ -62,7 +62,7 @@ def run(
     config_overrides: Annotated[
         Optional[str],
         typer.Option(
-            "--config",
+            "--run-config",
             "-c",
             help="Override configuration key-value pairs",
         ),

{flwr_nightly-1.10.0.dev20240713 → flwr_nightly-1.10.0.dev20240714}/src/py/flwr/superexec/app.py

@@ -24,6 +24,7 @@ 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.exit_handlers import register_exit_handlers
 from flwr.common.object_ref import load_app, validate
@@ -55,6 +56,7 @@ def run_superexec() -> None:
         address=address,
         executor=_load_executor(args),
         certificates=certificates,
+        config=parse_config_args(args.executor_config),
     )
 
     grpc_servers = [superexec_server]
@@ -74,21 +76,25 @@ def _parse_args_run_superexec() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         description="Start a Flower SuperExec",
     )
-    parser.add_argument(
-        "executor",
-        help="For example: `deployment:exec` or `project.package.module:wrapper.exec`.",
-        default="flwr.superexec.deployment:executor",
-    )
     parser.add_argument(
         "--address",
         help="SuperExec (gRPC) server address (IPv4, IPv6, or a domain name)",
         default=SUPEREXEC_DEFAULT_ADDRESS,
     )
+    parser.add_argument(
+        "--executor",
+        help="For example: `deployment:exec` or `project.package.module:wrapper.exec`.",
+        default="flwr.superexec.deployment:executor",
+    )
     parser.add_argument(
         "--executor-dir",
         help="The directory for the executor.",
         default=".",
     )
+    parser.add_argument(
+        "--executor-config",
+        help="Key-value pairs for the executor config, separated by commas.",
+    )
     parser.add_argument(
         "--insecure",
         action="store_true",

{flwr_nightly-1.10.0.dev20240713 → flwr_nightly-1.10.0.dev20240714}/src/py/flwr/superexec/deployment.py

@@ -17,6 +17,7 @@
 import subprocess
 import sys
 from logging import ERROR, INFO
+from pathlib import Path
 from typing import Dict, Optional
 
 from typing_extensions import override
@@ -33,25 +34,73 @@ from .executor import Executor, RunTracker
 
 
 class DeploymentEngine(Executor):
-    """Deployment engine executor."""
+    """Deployment engine executor.
+
+    Parameters
+    ----------
+    superlink: str (default: "0.0.0.0:9091")
+        Address of the SuperLink to connect to.
+    root_certificates: Optional[str] (default: None)
+        Specifies the path to the PEM-encoded root certificate file for
+        establishing secure HTTPS connections.
+    flwr_dir: Optional[str] (default: None)
+        The path containing installed Flower Apps.
+    """
 
     def __init__(
         self,
-        address: str = DEFAULT_SERVER_ADDRESS_DRIVER,
-        root_certificates: Optional[bytes] = None,
+        superlink: str = DEFAULT_SERVER_ADDRESS_DRIVER,
+        root_certificates: Optional[str] = None,
+        flwr_dir: Optional[str] = None,
     ) -> None:
-        self.address = address
-        self.root_certificates = root_certificates
+        self.superlink = superlink
+        if root_certificates is None:
+            self.root_certificates = None
+            self.root_certificates_bytes = None
+        else:
+            self.root_certificates = root_certificates
+            self.root_certificates_bytes = Path(root_certificates).read_bytes()
+        self.flwr_dir = flwr_dir
         self.stub: Optional[DriverStub] = None
 
+    @override
+    def set_config(
+        self,
+        config: Dict[str, str],
+    ) -> None:
+        """Set executor config arguments.
+
+        Parameters
+        ----------
+        config : Dict[str, str]
+            A dictionary for configuration values.
+            Supported configuration key/value pairs:
+            - "superlink": str
+                The address of the SuperLink Driver API.
+            - "root-certificates": str
+                The path to the root certificates.
+            - "flwr-dir": str
+                The path to the Flower directory.
+        """
+        if not config:
+            return
+        if superlink_address := config.get("superlink"):
+            self.superlink = superlink_address
+        if root_certificates := config.get("root-certificates"):
+            self.root_certificates = root_certificates
+            self.root_certificates_bytes = Path(root_certificates).read_bytes()
+        if flwr_dir := config.get("flwr-dir"):
+            self.flwr_dir = flwr_dir
+
     def _connect(self) -> None:
-        if self.stub is None:
-            channel = create_channel(
-                server_address=self.address,
-                insecure=(self.root_certificates is None),
-                root_certificates=self.root_certificates,
-            )
-            self.stub = DriverStub(channel)
+        if self.stub is not None:
+            return
+        channel = create_channel(
+            server_address=self.superlink,
+            insecure=(self.root_certificates_bytes is None),
+            root_certificates=self.root_certificates_bytes,
+        )
+        self.stub = DriverStub(channel)
 
     def _create_run(
         self,
@@ -74,7 +123,9 @@ class DeploymentEngine(Executor):
 
     @override
     def start_run(
-        self, fab_file: bytes, override_config: Dict[str, str]
+        self,
+        fab_file: bytes,
+        override_config: Dict[str, str],
     ) -> Optional[RunTracker]:
         """Start run using the Flower Deployment Engine."""
         try:
@@ -84,7 +135,7 @@ class DeploymentEngine(Executor):
 
             # Install FAB Python package
             subprocess.check_call(
-                [sys.executable, "-m", "pip", "install", str(fab_path)],
+                [sys.executable, "-m", "pip", "install", "--no-deps", str(fab_path)],
                 stdout=subprocess.DEVNULL,
                 stderr=subprocess.DEVNULL,
             )
@@ -93,14 +144,27 @@ class DeploymentEngine(Executor):
             run_id: int = self._create_run(fab_id, fab_version, override_config)
             log(INFO, "Created run %s", str(run_id))
 
-            # Start ServerApp
+            command = [
+                "flower-server-app",
+                "--run-id",
+                str(run_id),
+                "--superlink",
+                str(self.superlink),
+            ]
+
+            if self.flwr_dir:
+                command.append("--flwr-dir")
+                command.append(self.flwr_dir)
+
+            if self.root_certificates is None:
+                command.append("--insecure")
+            else:
+                command.append("--root-certificates")
+                command.append(self.root_certificates)
+
+            # Execute the command
             proc = subprocess.Popen(  # pylint: disable=consider-using-with
-                [
-                    "flower-server-app",
-                    "--run-id",
-                    str(run_id),
-                    "--insecure",
-                ],
+                command,
                 stdout=subprocess.PIPE,
                 stderr=subprocess.PIPE,
                 text=True,

{flwr_nightly-1.10.0.dev20240713 → flwr_nightly-1.10.0.dev20240714}/src/py/flwr/superexec/exec_grpc.py

@@ -15,7 +15,7 @@
 """SuperExec gRPC API."""
 
 from logging import INFO
-from typing import Optional, Tuple
+from typing import Dict, Optional, Tuple
 
 import grpc
 
@@ -32,8 +32,11 @@ def run_superexec_api_grpc(
     address: str,
     executor: Executor,
     certificates: Optional[Tuple[bytes, bytes, bytes]],
+    config: Dict[str, str],
 ) -> grpc.Server:
     """Run SuperExec API (gRPC, request-response)."""
+    executor.set_config(config)
+
     exec_servicer: grpc.Server = ExecServicer(
         executor=executor,
     )
@@ -45,7 +48,7 @@ def run_superexec_api_grpc(
         certificates=certificates,
     )
 
-    log(INFO, "Flower ECE: Starting SuperExec API (gRPC-rere) on %s", address)
+    log(INFO, "Starting Flower SuperExec gRPC server on %s", address)
     superexec_grpc_server.start()
 
     return superexec_grpc_server

{flwr_nightly-1.10.0.dev20240713 → flwr_nightly-1.10.0.dev20240714}/src/py/flwr/superexec/executor.py

@@ -31,9 +31,24 @@ class RunTracker:
 class Executor(ABC):
     """Execute and monitor a Flower run."""
 
+    @abstractmethod
+    def set_config(
+        self,
+        config: Dict[str, str],
+    ) -> None:
+        """Register provided config as class attributes.
+
+        Parameters
+        ----------
+        config : Optional[Dict[str, str]]
+            A dictionary for configuration values.
+        """
+
     @abstractmethod
     def start_run(
-        self, fab_file: bytes, override_config: Dict[str, str]
+        self,
+        fab_file: bytes,
+        override_config: Dict[str, str],
     ) -> Optional[RunTracker]:
         """Start a run using the given Flower FAB ID and version.
 
@@ -44,6 +59,8 @@ class Executor(ABC):
         ----------
         fab_file : bytes
             The Flower App Bundle file bytes.
+        override_config: Dict[str, str]
+            The config overrides dict sent by the user (using `flwr run`).
 
         Returns
         -------

flwr_nightly-1.10.0.dev20240713/src/py/flwr/cli/new/templates/app/code/server.hf.py.tpl

@@ -1,17 +0,0 @@
-"""$project_name: A Flower / HuggingFace Transformers app."""
-
-from flwr.server.strategy import FedAvg
-from flwr.server import ServerApp, ServerConfig
-
-
-# Define strategy
-strategy = FedAvg(
-    fraction_fit=1.0,
-    fraction_evaluate=1.0,
-)
-
-# Start server
-app = ServerApp(
-    config=ServerConfig(num_rounds=3),
-    strategy=strategy,
-)

flwr_nightly-1.10.0.dev20240713/src/py/flwr/cli/new/templates/app/code/server.jax.py.tpl

@@ -1,12 +0,0 @@
-"""$project_name: A Flower / JAX app."""
-
-import flwr as fl
-
-# Configure the strategy
-strategy = fl.server.strategy.FedAvg()
-
-# Flower ServerApp
-app = fl.server.ServerApp(
-    config=fl.server.ServerConfig(num_rounds=3),
-    strategy=strategy,
-)

flwr_nightly-1.10.0.dev20240713/src/py/flwr/cli/new/templates/app/code/server.mlx.py.tpl

@@ -1,15 +0,0 @@
-"""$project_name: A Flower / MLX app."""
-
-from flwr.server import ServerApp, ServerConfig
-from flwr.server.strategy import FedAvg
-
-
-# Define strategy
-strategy = FedAvg()
-
-
-# Create ServerApp
-app = ServerApp(
-    config=ServerConfig(num_rounds=3),
-    strategy=strategy,
-)

flwr_nightly-1.10.0.dev20240713/src/py/flwr/cli/new/templates/app/code/server.numpy.py.tpl

@@ -1,12 +0,0 @@
-"""$project_name: A Flower / NumPy app."""
-
-import flwr as fl
-
-# Configure the strategy
-strategy = fl.server.strategy.FedAvg()
-
-# Flower ServerApp
-app = fl.server.ServerApp(
-    config=fl.server.ServerConfig(num_rounds=1),
-    strategy=strategy,
-)

flwr_nightly-1.10.0.dev20240713/src/py/flwr/cli/new/templates/app/code/server.pytorch.py.tpl

@@ -1,28 +0,0 @@
-"""$project_name: A Flower / PyTorch app."""
-
-from flwr.common import ndarrays_to_parameters
-from flwr.server import ServerApp, ServerConfig
-from flwr.server.strategy import FedAvg
-
-from $import_name.task import Net, get_weights
-
-
-# Initialize model parameters
-ndarrays = get_weights(Net())
-parameters = ndarrays_to_parameters(ndarrays)
-
-
-# Define strategy
-strategy = FedAvg(
-    fraction_fit=1.0,
-    fraction_evaluate=1.0,
-    min_available_clients=2,
-    initial_parameters=parameters,
-)
-
-
-# Create ServerApp
-app = ServerApp(
-    config=ServerConfig(num_rounds=3),
-    strategy=strategy,
-)

flwr_nightly-1.10.0.dev20240713/src/py/flwr/cli/new/templates/app/code/server.sklearn.py.tpl

@@ -1,17 +0,0 @@
-"""$project_name: A Flower / Scikit-Learn app."""
-
-from flwr.server import ServerApp, ServerConfig
-from flwr.server.strategy import FedAvg
-
-
-strategy = FedAvg(
-    fraction_fit=1.0,
-    fraction_evaluate=1.0,
-    min_available_clients=2,
-)
-
-# Create ServerApp
-app = ServerApp(
-    config=ServerConfig(num_rounds=3),
-    strategy=strategy,
-)

flwr_nightly-1.10.0.dev20240713/src/py/flwr/cli/new/templates/app/code/server.tensorflow.py.tpl

@@ -1,27 +0,0 @@
-"""$project_name: A Flower / TensorFlow app."""
-
-from flwr.common import ndarrays_to_parameters
-from flwr.server import ServerApp, ServerConfig
-from flwr.server.strategy import FedAvg
-
-from $import_name.task import load_model
-
-# Define config
-config = ServerConfig(num_rounds=3)
-
-parameters = ndarrays_to_parameters(load_model().get_weights())
-
-# Define strategy
-strategy = FedAvg(
-    fraction_fit=1.0,
-    fraction_evaluate=1.0,
-    min_available_clients=2,
-    initial_parameters=parameters,
-)
-
-
-# Create ServerApp
-app = ServerApp(
-    config=config,
-    strategy=strategy,
-)