flwr 1.18.0__py3-none-any.whl → 1.20.0__py3-none-any.whl

flwr/cli/new/new.py

@@ -271,28 +271,36 @@ def new(
 
     prompt = typer.style(
         "🎊 Flower App creation successful.\n\n"
-        "To run your Flower App, use the following command:\n\n",
+        "To run your Flower App, first install its dependencies:\n\n",
         fg=typer.colors.GREEN,
         bold=True,
     )
 
     _add = "	huggingface-cli login\n" if llm_challenge_str else ""
+
     prompt += typer.style(
-        _add + f"	flwr run {package_name}\n\n",
+        f"	cd {package_name} && pip install -e .\n" + _add + "\n",
         fg=typer.colors.BRIGHT_CYAN,
         bold=True,
     )
 
     prompt += typer.style(
-        "If you haven't installed all dependencies yet, follow these steps:\n\n",
+        "then, run the app:\n\n ",
         fg=typer.colors.GREEN,
         bold=True,
     )
 
     prompt += typer.style(
-        f"	cd {package_name}\n" + "	pip install -e .\n" + _add + "	flwr run .\n",
+        "\tflwr run .\n\n",
         fg=typer.colors.BRIGHT_CYAN,
         bold=True,
     )
 
+    prompt += typer.style(
+        "💡 Check the README in your app directory to learn how to\n"
+        "customize it and how to run it using the Deployment Runtime.\n",
+        fg=typer.colors.GREEN,
+        bold=True,
+    )
+
     print(prompt)

flwr/cli/new/templates/app/README.flowertune.md.tpl

@@ -21,6 +21,8 @@ Project dependencies are defined in `pyproject.toml`. Install them in an activat
 pip install -e .
 ```
 
+> **Tip:** Learn how to configure your `pyproject.toml` file for Flower apps in [this guide](https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html).
+
 ## Experimental setup
 
 The dataset is divided into $num_clients partitions in an IID fashion, a partition is assigned to each ClientApp.

flwr/cli/new/templates/app/README.md.tpl

@@ -2,10 +2,15 @@
 
 ## Install dependencies and project
 
+The dependencies are listed in the `pyproject.toml` and you can install them as follows:
+
 ```bash
 pip install -e .
 ```
 
+> **Tip:** Your `pyproject.toml` file can define more than just the dependencies of your Flower app. You can also use it to specify hyperparameters for your runs and control which Flower Runtime is used. By default, it uses the Simulation Runtime, but you can switch to the Deployment Runtime when needed.
+> Learn more in the [TOML configuration guide](https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html).
+
 ## Run with the Simulation Engine
 
 In the `$project_name` directory, use `flwr run` to run a local simulation:

flwr/cli/new/templates/app/code/client.baseline.py.tpl

@@ -1,9 +1,9 @@
 """$project_name: A Flower Baseline."""
 
 import torch
-
 from flwr.client import ClientApp, NumPyClient
 from flwr.common import Context
+
 from $import_name.dataset import load_data
 from $import_name.model import Net, get_weights, set_weights, test, train
 

flwr/cli/new/templates/app/code/model.baseline.py.tpl

@@ -76,5 +76,5 @@ def get_weights(net):
 def set_weights(net, parameters):
     """Apply parameters to an existing model."""
     params_dict = zip(net.state_dict().keys(), parameters)
-    state_dict = OrderedDict({k: torch.tensor(v) for k, v in params_dict})
+    state_dict = OrderedDict({k: torch.from_numpy(v) for k, v in params_dict})
     net.load_state_dict(state_dict, strict=True)

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

@@ -1,15 +1,14 @@
 """$project_name: A Flower Baseline."""
 
-from typing import List, Tuple
-
 from flwr.common import Context, Metrics, ndarrays_to_parameters
 from flwr.server import ServerApp, ServerAppComponents, ServerConfig
 from flwr.server.strategy import FedAvg
+
 from $import_name.model import Net, get_weights
 
 
 # Define metric aggregation function
-def weighted_average(metrics: List[Tuple[int, Metrics]]) -> Metrics:
+def weighted_average(metrics: list[tuple[int, Metrics]]) -> Metrics:
     """Do weighted average of accuracy metric."""
     # Multiply accuracy of each client by number of examples used
     accuracies = [num_examples * float(m["accuracy"]) for num_examples, m in metrics]

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,11 +12,12 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "flwr-datasets[vision]>=0.5.0",
-    "torch==2.5.1",
-    "torchvision==0.20.1",
+    "torch==2.7.1",
+    "torchvision==0.22.1",
 ]
 
 [tool.hatch.metadata]
@@ -23,28 +29,23 @@ dev = [
     "black==24.2.0",
     "docformatter==1.7.5",
     "mypy==1.8.0",
-    "pylint==3.2.6",
-    "flake8==5.0.4",
-    "pytest==6.2.4",
+    "pylint==3.3.1",
+    "pytest==7.4.4",
     "pytest-watch==4.2.0",
-    "ruff==0.1.9",
+    "ruff==0.4.5",
     "types-requests==2.31.0.20240125",
 ]
 
 [tool.isort]
 profile = "black"
-known_first_party = ["flwr"]
 
 [tool.black]
 line-length = 88
-target-version = ["py38", "py39", "py310", "py311"]
+target-version = ["py310", "py311", "py312"]
 
 [tool.pytest.ini_options]
 minversion = "6.2"
 addopts = "-qq"
-testpaths = [
-    "flwr_baselines",
-]
 
 [tool.mypy]
 ignore_missing_imports = true
@@ -82,11 +83,8 @@ wrap-summaries = 88
 wrap-descriptions = 88
 
 [tool.ruff]
-target-version = "py38"
+target-version = "py310"
 line-length = 88
-select = ["D", "E", "F", "W", "B", "ISC", "C4"]
-fixable = ["D", "E", "F", "W", "B", "ISC", "C4"]
-ignore = ["B024", "B027"]
 exclude = [
     ".bzr",
     ".direnv",
@@ -111,7 +109,12 @@ exclude = [
     "proto",
 ]
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint]
+select = ["D", "E", "F", "W", "B", "ISC", "C4", "UP"]
+fixable = ["D", "E", "F", "W", "B", "ISC", "C4", "UP"]
+ignore = ["B024", "B027", "D205", "D209"]
+
+[tool.ruff.lint.pydocstyle]
 convention = "numpy"
 
 [tool.hatch.build.targets.wheel]
@@ -120,18 +123,23 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 fraction-fit = 0.5
 local-epochs = 1
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
 options.backend.client-resources.num-cpus = 2

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "flwr-datasets>=0.5.0",
     "torch==2.4.0",
     "trl==0.8.1",
@@ -27,10 +33,13 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 model.name = "mistralai/Mistral-7B-v0.3"
 model.quantization = 4
@@ -56,12 +65,15 @@ strategy.fraction-fit = $fraction_fit
 strategy.fraction-evaluate = 0.0
 num-server-rounds = 200
 
+# Dataset config (static for FlowerTune LLM Leaderboard)
 [tool.flwr.app.config.static]
 dataset.name = "$dataset_name"
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with $num_clients virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = $num_clients
 options.backend.client-resources.num-cpus = 6

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,10 +12,11 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "flwr-datasets>=0.5.0",
-    "torch==2.5.1",
+    "torch==2.7.1",
     "transformers>=4.30.0,<5.0",
     "evaluate>=0.4.0,<1.0",
     "datasets>=2.0.0, <3.0",
@@ -23,10 +29,13 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 fraction-fit = 0.5
@@ -34,13 +43,23 @@ local-epochs = 1
 model-name = "prajjwal1/bert-tiny" # Set a larger model if you have access to more GPU resources
 num-labels = 2
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "localhost"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.localhost]
 options.num-supernodes = 10
 
+# Local simulation federation with 10 virtual SuperNodes
+# making use of GPUs
 [tool.flwr.federations.localhost-gpu]
 options.num-supernodes = 10
 options.backend.client-resources.num-cpus = 4 # each ClientApp assumes to use 4CPUs
 options.backend.client-resources.num-gpus = 0.25 # at most 4 ClientApps will run in a given GPU
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "jax==0.4.30",
     "jaxlib==0.4.30",
     "scikit-learn==1.6.1",
@@ -20,16 +26,27 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 input-dim = 3
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,10 +12,11 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "flwr-datasets[vision]>=0.5.0",
-    "mlx==0.21.1",
+    "mlx==0.26.5",
 ]
 
 [tool.hatch.build.targets.wheel]
@@ -19,10 +25,13 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 local-epochs = 1
@@ -32,8 +41,16 @@ hidden-dim = 32
 batch-size = 256
 lr = 0.1
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "numpy>=2.0.2",
 ]
 
@@ -18,15 +24,26 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,11 +12,12 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "flwr-datasets[vision]>=0.5.0",
-    "torch==2.5.1",
-    "torchvision==0.20.1",
+    "torch==2.7.1",
+    "torchvision==0.22.1",
 ]
 
 [tool.hatch.build.targets.wheel]
@@ -20,17 +26,28 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 fraction-fit = 0.5
 local-epochs = 1
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "flwr-datasets[vision]>=0.5.0",
     "scikit-learn>=1.6.1",
 ]
@@ -19,17 +25,28 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 penalty = "l2"
 local-epochs = 1
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup

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

@@ -1,3 +1,8 @@
+# =====================================================================
+# For a full TOML configuration guide, check the Flower docs:
+# https://flower.ai/docs/framework/how-to-configure-pyproject-toml.html
+# =====================================================================
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -7,8 +12,9 @@ name = "$package_name"
 version = "1.0.0"
 description = ""
 license = "Apache-2.0"
+# Dependencies for your Flower App
 dependencies = [
-    "flwr[simulation]>=1.18.0",
+    "flwr[simulation]>=1.20.0",
     "flwr-datasets[vision]>=0.5.0",
     "tensorflow>=2.11.1,<2.18.0",
 ]
@@ -19,18 +25,29 @@ packages = ["."]
 [tool.flwr.app]
 publisher = "$username"
 
+# Point to your ServerApp and ClientApp objects
+# Format: "<module>:<object>"
 [tool.flwr.app.components]
 serverapp = "$import_name.server_app:app"
 clientapp = "$import_name.client_app:app"
 
+# Custom config values accessible via `context.run_config`
 [tool.flwr.app.config]
 num-server-rounds = 3
 local-epochs = 1
 batch-size = 32
 verbose = false
 
+# Default federation to use when running the app
 [tool.flwr.federations]
 default = "local-simulation"
 
+# Local simulation federation with 10 virtual SuperNodes
 [tool.flwr.federations.local-simulation]
 options.num-supernodes = 10
+
+# Remote federation example for use with SuperLink
+[tool.flwr.federations.remote-federation]
+address = "<SUPERLINK-ADDRESS>:<PORT>"
+insecure = true  # Remove this line to enable TLS
+# root-certificates = "<PATH/TO/ca.crt>"  # For TLS setup