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

flwr/cli/build.py

@@ -85,7 +85,7 @@ def build(
 
     # Set the name of the zip file
     fab_filename = (
-        f"{conf['flower']['publisher']}"
+        f"{conf['tool']['flwr']['publisher']}"
         f".{directory.name}"
         f".{conf['project']['version'].replace('.', '-')}.fab"
     )

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']['publisher']}/{conf['project']['name']}",
         )
 
 
@@ -136,20 +136,20 @@ 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"]:
+        errors.append("Missing [tool.flwr] 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"]:
+            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")
         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"]["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]')
 
     return len(errors) == 0, errors, warnings
 
@@ -165,14 +165,14 @@ def validate(
 
     # Validate serverapp
     is_valid, reason = object_ref.validate(
-        config["flower"]["components"]["serverapp"], check_module
+        config["tool"]["flwr"]["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"]["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"]["publisher"]
     project_name = config["project"]["name"]
     version = config["project"]["version"]
 

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

@@ -1,17 +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, ServerConfig
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
 
 
-# Define strategy
-strategy = FedAvg(
-    fraction_fit=1.0,
-    fraction_evaluate=1.0,
-)
+def server_fn(context: Context):
+    # Define strategy
+    strategy = FedAvg(
+        fraction_fit=1.0,
+        fraction_evaluate=1.0,
+    )
+    config = ServerConfig(num_rounds=3)
 
-# Start server
-app = ServerApp(
-    config=ServerConfig(num_rounds=3),
-    strategy=strategy,
-)
+    return ServerAppComponents(strategy=strategy, config=config)
+
+# Create ServerApp
+app = ServerApp(server_fn=server_fn)

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

@@ -1,12 +1,16 @@
 """$project_name: A Flower / JAX app."""
 
-import flwr as fl
+from flwr.common import Context
+from flwr.server.strategy import FedAvg
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
 
-# Configure the strategy
-strategy = fl.server.strategy.FedAvg()
 
-# Flower ServerApp
-app = fl.server.ServerApp(
-    config=fl.server.ServerConfig(num_rounds=3),
-    strategy=strategy,
-)
+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/cli/new/templates/app/code/server.mlx.py.tpl

@@ -1,15 +1,16 @@
 """$project_name: A Flower / MLX app."""
 
-from flwr.server import ServerApp, ServerConfig
+from flwr.common import Context
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
 from flwr.server.strategy import FedAvg
 
 
-# Define strategy
-strategy = 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(
-    config=ServerConfig(num_rounds=3),
-    strategy=strategy,
-)
+app = ServerApp(server_fn=server_fn)

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

@@ -1,12 +1,16 @@
 """$project_name: A Flower / NumPy app."""
 
-import flwr as fl
+from flwr.common import Context
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
+from flwr.server.strategy import FedAvg
 
-# Configure the strategy
-strategy = fl.server.strategy.FedAvg()
 
-# Flower ServerApp
-app = fl.server.ServerApp(
-    config=fl.server.ServerConfig(num_rounds=1),
-    strategy=strategy,
-)
+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/cli/new/templates/app/code/server.pytorch.py.tpl

@@ -1,7 +1,7 @@
 """$project_name: A Flower / PyTorch app."""
 
-from flwr.common import ndarrays_to_parameters
-from flwr.server import ServerApp, ServerConfig
+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
@@ -11,18 +11,17 @@ from $import_name.task import Net, get_weights
 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)
 
-# Define strategy
-strategy = FedAvg(
-    fraction_fit=1.0,
-    fraction_evaluate=1.0,
-    min_available_clients=2,
-    initial_parameters=parameters,
-)
-
+    return ServerAppComponents(strategy=strategy, config=config)
 
 # Create ServerApp
-app = ServerApp(
-    config=ServerConfig(num_rounds=3),
-    strategy=strategy,
-)
+app = ServerApp(server_fn=server_fn)

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

@@ -1,17 +1,20 @@
 """$project_name: A Flower / Scikit-Learn app."""
 
-from flwr.server import ServerApp, ServerConfig
+from flwr.common import Context
+from flwr.server import ServerApp, ServerAppComponents, ServerConfig
 from flwr.server.strategy import FedAvg
 
 
-strategy = FedAvg(
-    fraction_fit=1.0,
-    fraction_evaluate=1.0,
-    min_available_clients=2,
-)
+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(
-    config=ServerConfig(num_rounds=3),
-    strategy=strategy,
-)
+app = ServerApp(server_fn=server_fn)

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

@@ -1,7 +1,7 @@
 """$project_name: A Flower / TensorFlow app."""
 
-from flwr.common import ndarrays_to_parameters
-from flwr.server import ServerApp, ServerConfig
+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
@@ -11,17 +11,17 @@ 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,
-)
+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(
-    config=config,
-    strategy=strategy,
-)
+app = ServerApp(server_fn=server_fn)

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

@@ -6,9 +6,6 @@ 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)" }
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
@@ -25,18 +22,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.components]
 serverapp = "$import_name.app:server"
 clientapp = "$import_name.app:client"
 
-[flower.engine]
-name = "simulation"
-
-[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,9 +6,6 @@ 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)" }
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
@@ -23,15 +20,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[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,9 +6,6 @@ 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)"}
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
@@ -20,9 +17,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
+
+[tool.flwr.federations]
+default = "localhost"
+
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10

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

@@ -6,9 +6,6 @@ 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)" }
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
@@ -20,15 +17,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[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,9 +6,6 @@ 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)" }
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
@@ -18,15 +15,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[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,9 +6,6 @@ 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)" }
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
@@ -20,15 +17,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[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,9 +6,6 @@ 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)" }
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
@@ -19,15 +16,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[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,9 +6,6 @@ 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)" }
 dependencies = [
     "flwr[simulation]>=1.9.0,<2.0",
@@ -19,15 +16,15 @@ dependencies = [
 [tool.hatch.build.targets.wheel]
 packages = ["."]
 
-[flower]
+[tool.flwr]
 publisher = "$username"
 
-[flower.components]
+[tool.flwr.components]
 serverapp = "$import_name.server:app"
 clientapp = "$import_name.client:app"
 
-[flower.engine]
-name = "simulation"
+[tool.flwr.federations]
+default = "localhost"
 
-[flower.engine.simulation.supernode]
-num = 2
+[tool.flwr.federations.localhost]
+options.num-supernodes = 10