flwr-nightly 1.10.0.dev20240715__py3-none-any.whl → 1.10.0.dev20240717__py3-none-any.whl

flwr/cli/build.py

@@ -20,6 +20,7 @@ from pathlib import Path
 from typing import Optional
 
 import pathspec
+import tomli_w
 import typer
 from typing_extensions import Annotated
 
@@ -85,7 +86,7 @@ def build(
 
     # Set the name of the zip file
     fab_filename = (
-        f"{conf['tool']['flwr']['publisher']}"
+        f"{conf['tool']['flwr']['app']['publisher']}"
         f".{directory.name}"
         f".{conf['project']['version'].replace('.', '-')}.fab"
     )
@@ -93,15 +94,28 @@ def build(
 
     allowed_extensions = {".py", ".toml", ".md"}
 
+    # Remove the 'federations' field from 'tool.flwr' if it exists
+    if (
+        "tool" in conf
+        and "flwr" in conf["tool"]
+        and "federations" in conf["tool"]["flwr"]
+    ):
+        del conf["tool"]["flwr"]["federations"]
+
+    toml_contents = tomli_w.dumps(conf)
+
     with zipfile.ZipFile(fab_filename, "w", zipfile.ZIP_DEFLATED) as fab_file:
+        fab_file.writestr("pyproject.toml", toml_contents)
+
+        # Continue with adding other files
         for root, _, files in os.walk(directory, topdown=True):
-            # Filter directories and files based on .gitignore
             files = [
                 f
                 for f in files
                 if not ignore_spec.match_file(Path(root) / f)
                 and f != fab_filename
                 and Path(f).suffix in allowed_extensions
+                and f != "pyproject.toml"  # Exclude the original pyproject.toml
             ]
 
             for file in files:

flwr/cli/config_utils.py

@@ -60,7 +60,7 @@ def get_fab_metadata(fab_file: Union[Path, bytes]) -> Tuple[str, str]:
 
         return (
             conf["project"]["version"],
-            f"{conf['tool']['flwr']['publisher']}/{conf['project']['name']}",
+            f"{conf['tool']['flwr']['app']['publisher']}/{conf['project']['name']}",
         )
 
 
@@ -136,20 +136,28 @@ def validate_fields(config: Dict[str, Any]) -> Tuple[bool, List[str], List[str]]
         if "authors" not in config["project"]:
             warnings.append('Recommended property "authors" missing in [project]')
 
-    if "tool" not in config or "flwr" not in config["tool"]:
-        errors.append("Missing [tool.flwr] section")
+    if (
+        "tool" not in config
+        or "flwr" not in config["tool"]
+        or "app" not in config["tool"]["flwr"]
+    ):
+        errors.append("Missing [tool.flwr.app] section")
     else:
-        if "publisher" not in config["tool"]["flwr"]:
-            errors.append('Property "publisher" missing in [tool.flwr]')
-        if "config" in config["tool"]["flwr"]:
-            _validate_run_config(config["tool"]["flwr"]["config"], errors)
-        if "components" not in config["tool"]["flwr"]:
-            errors.append("Missing [tool.flwr.components] section")
+        if "publisher" not in config["tool"]["flwr"]["app"]:
+            errors.append('Property "publisher" missing in [tool.flwr.app]')
+        if "config" in config["tool"]["flwr"]["app"]:
+            _validate_run_config(config["tool"]["flwr"]["app"]["config"], errors)
+        if "components" not in config["tool"]["flwr"]["app"]:
+            errors.append("Missing [tool.flwr.app.components] section")
         else:
-            if "serverapp" not in config["tool"]["flwr"]["components"]:
-                errors.append('Property "serverapp" missing in [tool.flwr.components]')
-            if "clientapp" not in config["tool"]["flwr"]["components"]:
-                errors.append('Property "clientapp" missing in [tool.flwr.components]')
+            if "serverapp" not in config["tool"]["flwr"]["app"]["components"]:
+                errors.append(
+                    'Property "serverapp" missing in [tool.flwr.app.components]'
+                )
+            if "clientapp" not in config["tool"]["flwr"]["app"]["components"]:
+                errors.append(
+                    'Property "clientapp" missing in [tool.flwr.app.components]'
+                )
 
     return len(errors) == 0, errors, warnings
 
@@ -165,14 +173,14 @@ def validate(
 
     # Validate serverapp
     is_valid, reason = object_ref.validate(
-        config["tool"]["flwr"]["components"]["serverapp"], check_module
+        config["tool"]["flwr"]["app"]["components"]["serverapp"], check_module
     )
     if not is_valid and isinstance(reason, str):
         return False, [reason], []
 
     # Validate clientapp
     is_valid, reason = object_ref.validate(
-        config["tool"]["flwr"]["components"]["clientapp"], check_module
+        config["tool"]["flwr"]["app"]["components"]["clientapp"], check_module
     )
 
     if not is_valid and isinstance(reason, str):

flwr/cli/install.py

@@ -16,6 +16,7 @@
 
 
 import shutil
+import subprocess
 import tempfile
 import zipfile
 from io import BytesIO
@@ -149,7 +150,7 @@ def validate_and_install(
         )
         raise typer.Exit(code=1)
 
-    publisher = config["tool"]["flwr"]["publisher"]
+    publisher = config["tool"]["flwr"]["app"]["publisher"]
     project_name = config["project"]["name"]
     version = config["project"]["version"]
 
@@ -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/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/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/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/cli/new/templates/app/code/server.hf.py.tpl

@@ -6,12 +6,15 @@ from flwr.server import ServerApp, ServerAppComponents, ServerConfig
 
 
 def server_fn(context: Context):
+    # Read from config
+    num_rounds = int(context.run_config["num-server-rounds"])
+
     # Define strategy
     strategy = FedAvg(
         fraction_fit=1.0,
         fraction_evaluate=1.0,
     )
-    config = ServerConfig(num_rounds=3)
+    config = ServerConfig(num_rounds=num_rounds)
 
     return ServerAppComponents(strategy=strategy, config=config)
 

flwr/cli/new/templates/app/code/server.jax.py.tpl

@@ -6,9 +6,12 @@ from flwr.server import ServerApp, ServerAppComponents, ServerConfig
 
 
 def server_fn(context: Context):
+    # Read from config
+    num_rounds = int(context.run_config["num-server-rounds"])
+
     # Define strategy
     strategy = FedAvg()
-    config = ServerConfig(num_rounds=3)
+    config = ServerConfig(num_rounds=num_rounds)
 
     return ServerAppComponents(strategy=strategy, config=config)
 

flwr/cli/new/templates/app/code/server.mlx.py.tpl

@@ -6,9 +6,12 @@ from flwr.server.strategy import FedAvg
 
 
 def server_fn(context: Context):
+    # Read from config
+    num_rounds = int(context.run_config["num-server-rounds"])
+
     # Define strategy
     strategy = FedAvg()
-    config = ServerConfig(num_rounds=3)
+    config = ServerConfig(num_rounds=num_rounds)
 
     return ServerAppComponents(strategy=strategy, config=config)
 

flwr/cli/new/templates/app/code/server.numpy.py.tpl

@@ -6,9 +6,12 @@ from flwr.server.strategy import FedAvg
 
 
 def server_fn(context: Context):
+    # Read from config
+    num_rounds = int(context.run_config["num-server-rounds"])
+
     # Define strategy
     strategy = FedAvg()
-    config = ServerConfig(num_rounds=3)
+    config = ServerConfig(num_rounds=num_rounds)
 
     return ServerAppComponents(strategy=strategy, config=config)
 

flwr/cli/new/templates/app/code/server.pytorch.py.tpl

@@ -12,6 +12,9 @@ ndarrays = get_weights(Net())
 parameters = ndarrays_to_parameters(ndarrays)
 
 def server_fn(context: Context):
+    # Read from config
+    num_rounds = int(context.run_config["num-server-rounds"])
+
     # Define strategy
     strategy = FedAvg(
         fraction_fit=1.0,
@@ -19,7 +22,7 @@ def server_fn(context: Context):
         min_available_clients=2,
         initial_parameters=parameters,
     )
-    config = ServerConfig(num_rounds=3)
+    config = ServerConfig(num_rounds=num_rounds)
 
     return ServerAppComponents(strategy=strategy, config=config)
 

flwr/cli/new/templates/app/code/server.sklearn.py.tpl

@@ -6,13 +6,16 @@ from flwr.server.strategy import FedAvg
 
 
 def server_fn(context: Context):
+    # Read from config
+    num_rounds = int(context.run_config["num-server-rounds"])
+
     # Define strategy
     strategy = FedAvg(
         fraction_fit=1.0,
         fraction_evaluate=1.0,
         min_available_clients=2,
     )
-    config = ServerConfig(num_rounds=3)
+    config = ServerConfig(num_rounds=num_rounds)
 
     return ServerAppComponents(strategy=strategy, config=config)
 

flwr/cli/new/templates/app/code/server.tensorflow.py.tpl

@@ -12,6 +12,9 @@ config = ServerConfig(num_rounds=3)
 parameters = ndarrays_to_parameters(load_model().get_weights())
 
 def server_fn(context: Context):
+    # Read from config
+    num_rounds = int(context.run_config["num-server-rounds"])
+
     # Define strategy
     strategy = strategy = FedAvg(
         fraction_fit=1.0,
@@ -19,7 +22,7 @@ def server_fn(context: Context):
         min_available_clients=2,
         initial_parameters=parameters,
     )
-    config = ServerConfig(num_rounds=3)
+    config = ServerConfig(num_rounds=num_rounds)
 
     return ServerAppComponents(strategy=strategy, config=config)
 

flwr/cli/new/templates/app/pyproject.flowertune.toml.tpl

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-license = { text = "Apache License (2.0)" }
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "flwr-datasets>=0.1.0,<1.0.0",
@@ -22,13 +22,16 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[tool.flwr]
+[tool.flwr.app]
 publisher = "$username"
 
-[tool.flwr.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.app:server"
 clientapp = "$import_name.app:client"
 
+[tool.flwr.app.config]
+num-server-rounds = "3"
+
 [tool.flwr.federations]
 default = "localhost"
 

flwr/cli/new/templates/app/pyproject.hf.toml.tpl

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-license = { text = "Apache License (2.0)" }
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "flwr-datasets>=0.0.2,<1.0.0",
@@ -20,12 +20,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[tool.flwr]
+[tool.flwr.app]
 publisher = "$username"
 
-[tool.flwr.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+[tool.flwr.app.components]
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
+
+[tool.flwr.app.config]
+num-server-rounds = "3"
 
 [tool.flwr.federations]
 default = "localhost"

flwr/cli/new/templates/app/pyproject.jax.toml.tpl

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-license = {text = "Apache License (2.0)"}
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "jax==0.4.26",
@@ -17,12 +17,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[tool.flwr]
+[tool.flwr.app]
 publisher = "$username"
 
-[tool.flwr.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+[tool.flwr.app.components]
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
+
+[tool.flwr.app.config]
+num-server-rounds = "3"
 
 [tool.flwr.federations]
 default = "localhost"

flwr/cli/new/templates/app/pyproject.mlx.toml.tpl

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-license = { text = "Apache License (2.0)" }
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "flwr-datasets[vision]>=0.0.2,<1.0.0",
@@ -17,12 +17,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[tool.flwr]
+[tool.flwr.app]
 publisher = "$username"
 
-[tool.flwr.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+[tool.flwr.app.components]
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
+
+[tool.flwr.app.config]
+num-server-rounds = "3"
 
 [tool.flwr.federations]
 default = "localhost"

flwr/cli/new/templates/app/pyproject.numpy.toml.tpl

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-license = { text = "Apache License (2.0)" }
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "numpy>=1.21.0",
@@ -15,12 +15,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[tool.flwr]
+[tool.flwr.app]
 publisher = "$username"
 
-[tool.flwr.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+[tool.flwr.app.components]
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
+
+[tool.flwr.app.config]
+num-server-rounds = "3"
 
 [tool.flwr.federations]
 default = "localhost"

flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-license = { text = "Apache License (2.0)" }
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "flwr-datasets[vision]>=0.0.2,<1.0.0",
@@ -17,12 +17,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[tool.flwr]
+[tool.flwr.app]
 publisher = "$username"
 
-[tool.flwr.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+[tool.flwr.app.components]
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
+
+[tool.flwr.app.config]
+num-server-rounds = "3"
 
 [tool.flwr.federations]
 default = "localhost"

flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-license = { text = "Apache License (2.0)" }
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "flwr-datasets[vision]>=0.0.2,<1.0.0",
@@ -16,12 +16,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[tool.flwr]
+[tool.flwr.app]
 publisher = "$username"
 
-[tool.flwr.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+[tool.flwr.app.components]
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
+
+[tool.flwr.app.config]
+num-server-rounds = "3"
 
 [tool.flwr.federations]
 default = "localhost"

flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-license = { text = "Apache License (2.0)" }
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "flwr-datasets[vision]>=0.0.2,<1.0.0",
@@ -16,12 +16,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[tool.flwr]
+[tool.flwr.app]
 publisher = "$username"
 
-[tool.flwr.components]
-serverapp = "$import_name.server:app"
-clientapp = "$import_name.client:app"
+[tool.flwr.app.components]
+serverapp = "$import_name.server_app:app"
+clientapp = "$import_name.client_app:app"
+
+[tool.flwr.app.config]
+num-server-rounds = "3"
 
 [tool.flwr.federations]
 default = "localhost"

flwr/cli/run/run.py

@@ -14,10 +14,11 @@
 # ==============================================================================
 """Flower command line interface `run` command."""
 
+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
@@ -29,7 +30,6 @@ from flwr.common.grpc import GRPC_MAX_MESSAGE_LENGTH, create_channel
 from flwr.common.logger import log
 from flwr.proto.exec_pb2 import StartRunRequest  # pylint: disable=E0611
 from flwr.proto.exec_pb2_grpc import ExecStub
-from flwr.simulation.run_simulation import _run_simulation
 
 
 # pylint: disable-next=too-many-locals
@@ -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,
         )
@@ -107,13 +109,13 @@ def run(
     if "address" in federation:
         _run_with_superexec(federation, directory, config_overrides)
     else:
-        _run_without_superexec(config, federation, federation_name)
+        _run_without_superexec(directory, federation, federation_name, config_overrides)
 
 
 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:
@@ -169,11 +171,11 @@ def _run_with_superexec(
 
 
 def _run_without_superexec(
-    config: Dict[str, Any], federation: Dict[str, Any], federation_name: str
+    app_path: Optional[Path],
+    federation: Dict[str, Any],
+    federation_name: str,
+    config_overrides: Optional[List[str]],
 ) -> None:
-    server_app_ref = config["tool"]["flwr"]["components"]["serverapp"]
-    client_app_ref = config["tool"]["flwr"]["components"]["clientapp"]
-
     try:
         num_supernodes = federation["options"]["num-supernodes"]
     except KeyError as err:
@@ -188,8 +190,20 @@ def _run_without_superexec(
         )
         raise typer.Exit(code=1) from err
 
-    _run_simulation(
-        server_app_attr=server_app_ref,
-        client_app_attr=client_app_ref,
-        num_supernodes=num_supernodes,
+    command = [
+        "flower-simulation",
+        "--app",
+        f"{app_path}",
+        "--num-supernodes",
+        f"{num_supernodes}",
+    ]
+
+    if config_overrides:
+        command.extend(["--run-config", f"{config_overrides}"])
+
+    # Run the simulation
+    subprocess.run(
+        command,
+        check=True,
+        text=True,
     )