flwr-nightly 1.10.0.dev20240714__py3-none-any.whl → 1.10.0.dev20240716__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['flower']['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['flower']['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 "flower" not in config:
-        errors.append("Missing [flower] 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["flower"]:
-            errors.append('Property "publisher" missing in [flower]')
-        if "config" in config["flower"]:
-            _validate_run_config(config["flower"]["config"], errors)
-        if "components" not in config["flower"]:
-            errors.append("Missing [flower.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["flower"]["components"]:
-                errors.append('Property "serverapp" missing in [flower.components]')
-            if "clientapp" not in config["flower"]["components"]:
-                errors.append('Property "clientapp" missing in [flower.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["flower"]["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["flower"]["components"]["clientapp"], check_module
+        config["tool"]["flwr"]["app"]["components"]["clientapp"], check_module
     )
 
     if not is_valid and isinstance(reason, str):

flwr/cli/install.py

@@ -149,7 +149,7 @@ def validate_and_install(
         )
         raise typer.Exit(code=1)
 
-    publisher = config["flower"]["publisher"]
+    publisher = config["tool"]["flwr"]["app"]["publisher"]
     project_name = config["project"]["name"]
     version = config["project"]["version"]
 

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,10 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-authors = [
-    { name = "The Flower Authors", email = "hello@flower.ai" },
-]
-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",
@@ -25,18 +22,18 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr.app]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.app:server"
 clientapp = "$import_name.app:client"
 
-[flower.engine]
-name = "simulation"
+[tool.flwr.app.config]
+num-server-rounds = "3"
 
-[flower.engine.simulation.supernode]
-num = $num_clients
+[tool.flwr.federations]
+default = "localhost"
 
-[flower.engine.simulation]
-backend_config = { client_resources = { num_cpus = 8, num_gpus = 1.0 } }
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10

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

@@ -6,10 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-authors = [
-    { name = "The Flower Authors", email = "hello@flower.ai" },
-]
-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",
@@ -23,15 +20,18 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr.app]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[tool.flwr.app.config]
+num-server-rounds = "3"
+
+[tool.flwr.federations]
+default = "localhost"
 
-[flower.engine.simulation.supernode]
-num = 2
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10

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

@@ -6,10 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-authors = [
-    { name = "The Flower Authors", email = "hello@flower.ai" },
-]
-license = {text = "Apache License (2.0)"}
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "jax==0.4.26",
@@ -20,9 +17,18 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr.app]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
+
+[tool.flwr.app.config]
+num-server-rounds = "3"
+
+[tool.flwr.federations]
+default = "localhost"
+
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10

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

@@ -6,10 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-authors = [
-    { name = "The Flower Authors", email = "hello@flower.ai" },
-]
-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",
@@ -20,15 +17,18 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr.app]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[tool.flwr.app.config]
+num-server-rounds = "3"
+
+[tool.flwr.federations]
+default = "localhost"
 
-[flower.engine.simulation.supernode]
-num = 2
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10

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

@@ -6,10 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-authors = [
-    { name = "The Flower Authors", email = "hello@flower.ai" },
-]
-license = { text = "Apache License (2.0)" }
+license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
     "numpy>=1.21.0",
@@ -18,15 +15,18 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr.app]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[tool.flwr.app.config]
+num-server-rounds = "3"
+
+[tool.flwr.federations]
+default = "localhost"
 
-[flower.engine.simulation.supernode]
-num = 2
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10

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

@@ -6,10 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-authors = [
-    { name = "The Flower Authors", email = "hello@flower.ai" },
-]
-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",
@@ -20,15 +17,18 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr.app]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[tool.flwr.app.config]
+num-server-rounds = "3"
+
+[tool.flwr.federations]
+default = "localhost"
 
-[flower.engine.simulation.supernode]
-num = 2
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10

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

@@ -6,10 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-authors = [
-    { name = "The Flower Authors", email = "hello@flower.ai" },
-]
-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",
@@ -19,15 +16,18 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr.app]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[tool.flwr.app.config]
+num-server-rounds = "3"
+
+[tool.flwr.federations]
+default = "localhost"
 
-[flower.engine.simulation.supernode]
-num = 2
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10

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

@@ -6,10 +6,7 @@ build-backend = "hatchling.build"
 name = "$package_name"
 version = "1.0.0"
 description = ""
-authors = [
-    { name = "The Flower Authors", email = "hello@flower.ai" },
-]
-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",
@@ -19,15 +16,18 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr.app]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.app.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[tool.flwr.app.config]
+num-server-rounds = "3"
+
+[tool.flwr.federations]
+default = "localhost"
 
-[flower.engine.simulation.supernode]
-num = 2
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10