flwr-nightly 1.10.0.dev20240716__tar.gz → 1.10.0.dev20240719__tar.gz

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/PKG-INFO

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

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/pyproject.toml

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

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/install.py

@@ -16,6 +16,7 @@
 
 
 import shutil
+import subprocess
 import tempfile
 import zipfile
 from io import BytesIO
@@ -192,6 +193,21 @@ def validate_and_install(
         else:
             shutil.copy2(item, install_dir / item.name)
 
+    try:
+        subprocess.run(
+            ["pip", "install", "-e", install_dir, "--no-deps"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+    except subprocess.CalledProcessError as e:
+        typer.secho(
+            f"❌ Failed to `pip install` package(s) from {install_dir}:\n{e.stderr}",
+            fg=typer.colors.RED,
+            bold=True,
+        )
+        raise typer.Exit(code=1) from e
+
     typer.secho(
         f"🎊 Successfully installed {project_name} to {install_dir}.",
         fg=typer.colors.GREEN,

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/new.py

@@ -136,6 +136,7 @@ def new(
 
     framework_str = framework_str.lower()
 
+    llm_challenge_str = None
     if framework_str == "flowertune":
         llm_challenge_value = prompt_options(
             "Please select LLM challenge by typing in the number",
@@ -171,7 +172,7 @@ def new(
     }
 
     # List of files to render
-    if framework_str == "flowertune":
+    if llm_challenge_str:
         files = {
             ".gitignore": {"template": "app/.gitignore.tpl"},
             "pyproject.toml": {"template": f"app/pyproject.{framework_str}.toml.tpl"},
@@ -228,10 +229,10 @@ def new(
             "README.md": {"template": "app/README.md.tpl"},
             "pyproject.toml": {"template": f"app/pyproject.{framework_str}.toml.tpl"},
             f"{import_name}/__init__.py": {"template": "app/code/__init__.py.tpl"},
-            f"{import_name}/server.py": {
+            f"{import_name}/server_app.py": {
                 "template": f"app/code/server.{framework_str}.py.tpl"
             },
-            f"{import_name}/client.py": {
+            f"{import_name}/client_app.py": {
                 "template": f"app/code/client.{framework_str}.py.tpl"
             },
         }

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/code/client.hf.py.tpl

@@ -30,7 +30,11 @@ class FlowerClient(NumPyClient):
 
     def fit(self, parameters, config):
         self.set_parameters(parameters)
-        train(self.net, self.trainloader, epochs=1)
+        train(
+            self.net,
+            self.trainloader,
+            epochs=int(self.context.run_config["local-epochs"]),
+        )
         return self.get_parameters(config={}), len(self.trainloader), {}
 
     def evaluate(self, parameters, config):
@@ -45,8 +49,8 @@ def client_fn(context: Context):
         CHECKPOINT, num_labels=2
     ).to(DEVICE)
 
-    partition_id = int(context.node_config['partition-id'])
-    num_partitions = int(context.node_config['num-partitions])
+    partition_id = int(context.node_config["partition-id"])
+    num_partitions = int(context.node_config["num-partitions"])
     trainloader, valloader = load_data(partition_id, num_partitions)
 
     # Return Client instance

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/code/client.mlx.py.tpl

@@ -20,17 +20,19 @@ from $import_name.task import (
 # Define Flower Client and client_fn
 class FlowerClient(NumPyClient):
     def __init__(self, data):
-        num_layers = 2
-        hidden_dim = 32
+        num_layers = int(self.context.run_config["num-layers"])
+        hidden_dim = int(self.context.run_config["hidden-dim"])
         num_classes = 10
-        batch_size = 256
-        num_epochs = 1
-        learning_rate = 1e-1
+        batch_size = int(self.context.run_config["batch-size"])
+        learning_rate = float(self.context.run_config["lr"])
+        num_epochs = int(self.context.run_config["local-epochs"])
 
         self.train_images, self.train_labels, self.test_images, self.test_labels = data
-        self.model = MLP(num_layers, self.train_images.shape[-1], hidden_dim, num_classes) 
-        self.optimizer = optim.SGD(learning_rate=learning_rate) 
-        self.loss_and_grad_fn = nn.value_and_grad(self.model, loss_fn) 
+        self.model = MLP(
+            num_layers, self.train_images.shape[-1], hidden_dim, num_classes
+        )
+        self.optimizer = optim.SGD(learning_rate=learning_rate)
+        self.loss_and_grad_fn = nn.value_and_grad(self.model, loss_fn)
         self.num_epochs = num_epochs
         self.batch_size = batch_size
 

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/code/client.pytorch.py.tpl

@@ -23,7 +23,13 @@ class FlowerClient(NumPyClient):
 
     def fit(self, parameters, config):
         set_weights(self.net, parameters)
-        results = train(self.net, self.trainloader, self.valloader, 1, DEVICE)
+        results = train(
+            self.net,
+            self.trainloader,
+            self.valloader,
+            int(self.context.run_config["local-epochs"]),
+            DEVICE,
+        )
         return get_weights(self.net), len(self.trainloader.dataset), results
 
     def evaluate(self, parameters, config):

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/code/client.sklearn.py.tpl

@@ -67,10 +67,11 @@ class FlowerClient(NumPyClient):
 
         return loss, len(self.X_test), {"accuracy": accuracy}
 
-fds = FederatedDataset(dataset="mnist", partitioners={"train": 2})
 
 def client_fn(context: Context):
     partition_id = int(context.node_config["partition-id"])
+    num_partitions = int(context.node_config["num-partitions"])
+    fds = FederatedDataset(dataset="mnist", partitioners={"train": num_partitions})
     dataset = fds.load_partition(partition_id, "train").with_format("numpy")
 
     X, y = dataset["image"].reshape((len(dataset), -1)), dataset["label"]

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/code/client.tensorflow.py.tpl

@@ -20,7 +20,13 @@ class FlowerClient(NumPyClient):
 
     def fit(self, parameters, config):
         self.model.set_weights(parameters)
-        self.model.fit(self.x_train, self.y_train, epochs=1, batch_size=32, verbose=0)
+        self.model.fit(
+            self.x_train,
+            self.y_train,
+            epochs=int(self.context.run_config["local-epochs"]),
+            batch_size=int(self.context.run_config["batch-size"]),
+            verbose=bool(self.context.run_config.get("verbose")),
+        )
         return self.model.get_weights(), len(self.x_train), {}
 
     def evaluate(self, parameters, config):
@@ -34,7 +40,8 @@ def client_fn(context: Context):
     net = load_model()
 
     partition_id = int(context.node_config["partition-id"])
-    x_train, y_train, x_test, y_test = load_data(partition_id, 2)
+    num_partitions = int(context.node_config["num-partitions"])
+    x_train, y_train, x_test, y_test = load_data(partition_id, num_partitions)
 
     # Return Client instance
     return FlowerClient(net, x_train, y_train, x_test, y_test).to_client()

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/code/flwr_tune/app.py.tpl

@@ -12,10 +12,10 @@ from flwr.client import ClientApp
 from flwr.common import ndarrays_to_parameters
 from flwr.server import ServerApp, ServerConfig
 
-from $import_name.client import gen_client_fn, get_parameters
+from $import_name.client_app import gen_client_fn, get_parameters
 from $import_name.dataset import get_tokenizer_and_data_collator_and_propt_formatting
 from $import_name.models import get_model
-from $import_name.server import fit_weighted_average, get_evaluate_fn, get_on_fit_config
+from $import_name.server_app import fit_weighted_average, get_evaluate_fn, get_on_fit_config
 
 # Avoid warnings
 warnings.filterwarnings("ignore", category=UserWarning)

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/code/flwr_tune/server.py.tpl

@@ -1,6 +1,6 @@
 """$project_name: A Flower / FlowerTune app."""
 
-from $import_name.client import set_parameters
+from $import_name.client_app import set_parameters
 from $import_name.models import get_model
 
 

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/pyproject.hf.toml.tpl

@@ -24,11 +24,12 @@ packages = ["."]
 publisher = "$username"
 
 [tool.flwr.app.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = "3"
+local-epochs = "1"
 
 [tool.flwr.federations]
 default = "localhost"

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/pyproject.jax.toml.tpl

@@ -21,8 +21,8 @@ packages = ["."]
 publisher = "$username"
 
 [tool.flwr.app.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = "3"

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/pyproject.mlx.toml.tpl

@@ -21,11 +21,16 @@ packages = ["."]
 publisher = "$username"
 
 [tool.flwr.app.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = "3"
+local-epochs = "1"
+num-layers = "2"
+hidden-dim = "32"
+batch-size = "256"
+lr = "0.1"
 
 [tool.flwr.federations]
 default = "localhost"

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/pyproject.numpy.toml.tpl

@@ -19,8 +19,8 @@ packages = ["."]
 publisher = "$username"
 
 [tool.flwr.app.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = "3"

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl

@@ -21,11 +21,12 @@ packages = ["."]
 publisher = "$username"
 
 [tool.flwr.app.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = "3"
+local-epochs = "1"
 
 [tool.flwr.federations]
 default = "localhost"

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl

@@ -20,8 +20,8 @@ packages = ["."]
 publisher = "$username"
 
 [tool.flwr.app.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = "3"

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl

@@ -20,11 +20,14 @@ packages = ["."]
 publisher = "$username"
 
 [tool.flwr.app.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = "3"
+local-epochs = "1"
+batch-size = "32"
+verbose = ""  # Empty string means False
 
 [tool.flwr.federations]
 default = "localhost"

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/cli/run/run.py

@@ -18,7 +18,7 @@ import subprocess
 import sys
 from logging import DEBUG
 from pathlib import Path
-from typing import Any, Dict, Optional
+from typing import Any, Dict, List, Optional
 
 import typer
 from typing_extensions import Annotated
@@ -43,7 +43,7 @@ def run(
         typer.Argument(help="Name of the federation to run the app on"),
     ] = None,
     config_overrides: Annotated[
-        Optional[str],
+        Optional[List[str]],
         typer.Option(
             "--run-config",
             "-c",
@@ -94,11 +94,13 @@ def run(
     # Validate the federation exists in the configuration
     federation = config["tool"]["flwr"]["federations"].get(federation_name)
     if federation is None:
-        available_feds = list(config["tool"]["flwr"]["federations"])
+        available_feds = {
+            fed for fed in config["tool"]["flwr"]["federations"] if fed != "default"
+        }
         typer.secho(
             f"❌ There is no `{federation_name}` federation declared in the "
             "`pyproject.toml`.\n The following federations were found:\n\n"
-            "\n".join(available_feds) + "\n\n",
+            + "\n".join(available_feds),
             fg=typer.colors.RED,
             bold=True,
         )
@@ -113,7 +115,7 @@ def run(
 def _run_with_superexec(
     federation: Dict[str, str],
     directory: Optional[Path],
-    config_overrides: Optional[str],
+    config_overrides: Optional[List[str]],
 ) -> None:
 
     def on_channel_state_change(channel_connectivity: str) -> None:
@@ -172,7 +174,7 @@ def _run_without_superexec(
     app_path: Optional[Path],
     federation: Dict[str, Any],
     federation_name: str,
-    config_overrides: Optional[str],
+    config_overrides: Optional[List[str]],
 ) -> None:
     try:
         num_supernodes = federation["options"]["num-supernodes"]
@@ -197,7 +199,7 @@ def _run_without_superexec(
     ]
 
     if config_overrides:
-        command.extend(["--run-config", f"{config_overrides}"])
+        command.extend(["--run-config", f"{','.join(config_overrides)}"])
 
     # Run the simulation
     subprocess.run(

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/client/supernode/app.py

@@ -77,7 +77,7 @@ def run_supernode() -> None:
         authentication_keys=authentication_keys,
         max_retries=args.max_retries,
         max_wait_time=args.max_wait_time,
-        node_config=parse_config_args(args.node_config),
+        node_config=parse_config_args([args.node_config]),
         flwr_path=get_flwr_dir(args.flwr_dir),
     )
 
@@ -107,7 +107,7 @@ def run_client_app() -> None:
 
     _start_client_internal(
         server_address=args.superlink,
-        node_config=parse_config_args(args.node_config),
+        node_config=parse_config_args([args.node_config]),
         load_client_app_fn=load_fn,
         transport=args.transport,
         root_certificates=root_certificates,

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/common/config.py

@@ -130,7 +130,7 @@ def flatten_dict(raw_dict: Dict[str, Any], parent_key: str = "") -> Dict[str, st
 
 
 def parse_config_args(
-    config: Optional[str],
+    config: Optional[List[str]],
     separator: str = ",",
 ) -> Dict[str, str]:
     """Parse separator separated list of key-value pairs separated by '='."""
@@ -139,17 +139,19 @@ def parse_config_args(
     if config is None:
         return overrides
 
-    overrides_list = config.split(separator)
-    if (
-        len(overrides_list) == 1
-        and "=" not in overrides_list
-        and overrides_list[0].endswith(".toml")
-    ):
-        with Path(overrides_list[0]).open("rb") as config_file:
-            overrides = flatten_dict(tomli.load(config_file))
-    else:
-        for kv_pair in overrides_list:
-            key, value = kv_pair.split("=")
-            overrides[key] = value
+    for config_line in config:
+        if config_line:
+            overrides_list = config_line.split(separator)
+            if (
+                len(overrides_list) == 1
+                and "=" not in overrides_list
+                and overrides_list[0].endswith(".toml")
+            ):
+                with Path(overrides_list[0]).open("rb") as config_file:
+                    overrides = flatten_dict(tomli.load(config_file))
+            else:
+                for kv_pair in overrides_list:
+                    key, value = kv_pair.split("=")
+                    overrides[key] = value
 
     return overrides

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/simulation/run_simulation.py

@@ -132,7 +132,7 @@ def run_simulation_from_cli() -> None:
         client_app_attr = app_components["clientapp"]
         server_app_attr = app_components["serverapp"]
 
-        override_config = parse_config_args(args.run_config)
+        override_config = parse_config_args([args.run_config])
         fused_config = get_fused_config_from_dir(app_path, override_config)
         app_dir = args.app
         is_app = True

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/superexec/app.py

@@ -56,7 +56,7 @@ def run_superexec() -> None:
         address=address,
         executor=_load_executor(args),
         certificates=certificates,
-        config=parse_config_args(args.executor_config),
+        config=parse_config_args([args.executor_config]),
     )
 
     grpc_servers = [superexec_server]

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/superexec/deployment.py

@@ -15,7 +15,6 @@
 """Deployment engine executor."""
 
 import subprocess
-import sys
 from logging import ERROR, INFO
 from pathlib import Path
 from typing import Dict, Optional
@@ -131,14 +130,7 @@ class DeploymentEngine(Executor):
         try:
             # Install FAB to flwr dir
             fab_version, fab_id = get_fab_metadata(fab_file)
-            fab_path = install_from_fab(fab_file, None, True)
-
-            # Install FAB Python package
-            subprocess.check_call(
-                [sys.executable, "-m", "pip", "install", "--no-deps", str(fab_path)],
-                stdout=subprocess.DEVNULL,
-                stderr=subprocess.DEVNULL,
-            )
+            install_from_fab(fab_file, None, True)
 
             # Call SuperLink to create run
             run_id: int = self._create_run(fab_id, fab_version, override_config)

{flwr_nightly-1.10.0.dev20240716 → flwr_nightly-1.10.0.dev20240719}/src/py/flwr/superexec/simulation.py

@@ -82,11 +82,6 @@ class SimulationEngine(Executor):
     ) -> Optional[RunTracker]:
         """Start run using the Flower Simulation Engine."""
         try:
-            if override_config:
-                raise ValueError(
-                    "Overriding the run config is not yet supported with the "
-                    "simulation executor.",
-                )
 
             # Install FAB to flwr dir
             fab_path = install_from_fab(fab_file, None, True)
@@ -111,11 +106,6 @@ class SimulationEngine(Executor):
                     "Config extracted from FAB's pyproject.toml is not valid"
                 )
 
-            # Get ClientApp and SeverApp components
-            flower_components = config["tool"]["flwr"]["app"]["components"]
-            clientapp = flower_components["clientapp"]
-            serverapp = flower_components["serverapp"]
-
             # In Simulation there is no SuperLink, still we create a run_id
             run_id = generate_rand_int_from_bytes(RUN_ID_NUM_BYTES)
             log(INFO, "Created run %s", str(run_id))
@@ -123,21 +113,21 @@ class SimulationEngine(Executor):
             # Prepare commnand
             command = [
                 "flower-simulation",
-                "--client-app",
-                f"{clientapp}",
-                "--server-app",
-                f"{serverapp}",
+                "--app",
+                f"{str(fab_path)}",
                 "--num-supernodes",
                 f"{self.num_supernodes}",
                 "--run-id",
                 str(run_id),
             ]
 
+            if override_config:
+                command.extend(["--run-config", f"{override_config}"])
+
             # Start Simulation
-            proc = subprocess.Popen(  # pylint: disable=consider-using-with
+            proc = subprocess.run(  # pylint: disable=consider-using-with
                 command,
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
+                check=True,
                 text=True,
             )
 
@@ -145,7 +135,7 @@ class SimulationEngine(Executor):
 
             return RunTracker(
                 run_id=run_id,
-                proc=proc,
+                proc=proc,  # type:ignore
             )
 
         # pylint: disable-next=broad-except