flwr 1.19.0__tar.gz → 1.21.0__tar.gz

{flwr-1.19.0 → flwr-1.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: flwr
-Version: 1.19.0
+Version: 1.21.0
 Summary: Flower: A Friendly Federated AI Framework
 License: Apache-2.0
 Keywords: Artificial Intelligence,Federated AI,Federated Analytics,Federated Evaluation,Federated Learning,Flower,Machine Learning
@@ -34,6 +34,7 @@ Provides-Extra: simulation
 Requires-Dist: click (<8.2.0)
 Requires-Dist: cryptography (>=44.0.1,<45.0.0)
 Requires-Dist: grpcio (>=1.62.3,<2.0.0,!=1.65.0)
+Requires-Dist: grpcio-health-checking (>=1.62.3,<2.0.0)
 Requires-Dist: iterators (>=0.0.2,<0.0.3)
 Requires-Dist: numpy (>=1.26.0,<3.0.0)
 Requires-Dist: pathspec (>=0.12.1,<0.13.0)
@@ -171,8 +172,9 @@ Flower Baselines is a collection of community-contributed projects that reproduc
 - [FedOpt](https://github.com/adap/flower/tree/main/baselines/flwr_baselines/flwr_baselines/publications/adaptive_federated_optimization)
 
 Please refer to the [Flower Baselines Documentation](https://flower.ai/docs/baselines/) for a detailed categorization of baselines and for additional info including:
-* [How to use Flower Baselines](https://flower.ai/docs/baselines/how-to-use-baselines.html)
-* [How to contribute a new Flower Baseline](https://flower.ai/docs/baselines/how-to-contribute-baselines.html)
+
+- [How to use Flower Baselines](https://flower.ai/docs/baselines/how-to-use-baselines.html)
+- [How to contribute a new Flower Baseline](https://flower.ai/docs/baselines/how-to-contribute-baselines.html)
 
 ## Flower Usage Examples
 

{flwr-1.19.0 → flwr-1.21.0}/README.md

@@ -116,8 +116,9 @@ Flower Baselines is a collection of community-contributed projects that reproduc
 - [FedOpt](https://github.com/adap/flower/tree/main/baselines/flwr_baselines/flwr_baselines/publications/adaptive_federated_optimization)
 
 Please refer to the [Flower Baselines Documentation](https://flower.ai/docs/baselines/) for a detailed categorization of baselines and for additional info including:
-* [How to use Flower Baselines](https://flower.ai/docs/baselines/how-to-use-baselines.html)
-* [How to contribute a new Flower Baseline](https://flower.ai/docs/baselines/how-to-contribute-baselines.html)
+
+- [How to use Flower Baselines](https://flower.ai/docs/baselines/how-to-use-baselines.html)
+- [How to contribute a new Flower Baseline](https://flower.ai/docs/baselines/how-to-contribute-baselines.html)
 
 ## Flower Usage Examples
 

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/__init__.py

@@ -17,12 +17,15 @@
 
 from flwr.common.version import package_version as _package_version
 
-from . import client, common, server, simulation
+from . import app, client, clientapp, common, server, serverapp, simulation
 
 __all__ = [
+    "app",
     "client",
+    "clientapp",
     "common",
     "server",
+    "serverapp",
     "simulation",
 ]
 

flwr-1.21.0/py/flwr/app/__init__.py

@@ -0,0 +1,43 @@
+# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Public Flower App APIs."""
+
+
+from flwr.common.constant import MessageType
+from flwr.common.context import Context
+from flwr.common.message import Message
+from flwr.common.record import (
+    Array,
+    ArrayRecord,
+    ConfigRecord,
+    MetricRecord,
+    RecordDict,
+)
+
+from .error import Error
+from .metadata import Metadata
+
+__all__ = [
+    "Array",
+    "ArrayRecord",
+    "ConfigRecord",
+    "Context",
+    "Error",
+    "Message",
+    "MessageType",
+    "Metadata",
+    "MetricRecord",
+    "RecordDict",
+]

flwr-1.21.0/py/flwr/app/exception.py

@@ -0,0 +1,31 @@
+# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Flower application exceptions."""
+
+
+class AppExitException(BaseException):
+    """Base exception for all application-level errors in ServerApp and ClientApp.
+
+    When raised, the process will exit and report a telemetry event with the associated
+    exit code. This is not intended to be caught by user code.
+    """
+
+    # Default exit code — subclasses must override
+    exit_code = -1
+
+    def __init_subclass__(cls) -> None:
+        """Ensure subclasses override the exit_code attribute."""
+        if cls.exit_code == -1:
+            raise ValueError("Subclasses must override the exit_code attribute.")

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/cli/auth_plugin/oidc_cli_plugin.py

@@ -31,11 +31,11 @@ from flwr.common.constant import (
     AuthType,
 )
 from flwr.common.typing import UserAuthCredentials, UserAuthLoginDetails
-from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
+from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     GetAuthTokensRequest,
     GetAuthTokensResponse,
 )
-from flwr.proto.exec_pb2_grpc import ExecStub
+from flwr.proto.control_pb2_grpc import ControlStub
 
 
 class OidcCliPlugin(CliAuthPlugin):
@@ -49,7 +49,7 @@ class OidcCliPlugin(CliAuthPlugin):
     @staticmethod
     def login(
         login_details: UserAuthLoginDetails,
-        exec_stub: ExecStub,
+        control_stub: ControlStub,
     ) -> UserAuthCredentials:
         """Authenticate the user and retrieve authentication credentials."""
         typer.secho(
@@ -61,7 +61,7 @@ class OidcCliPlugin(CliAuthPlugin):
         time.sleep(login_details.interval)
 
         while (time.time() - start_time) < login_details.expires_in:
-            res: GetAuthTokensResponse = exec_stub.GetAuthTokens(
+            res: GetAuthTokensResponse = control_stub.GetAuthTokens(
                 GetAuthTokensRequest(device_code=login_details.device_code)
             )
 

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/cli/build.py

@@ -25,7 +25,12 @@ import pathspec
 import tomli_w
 import typer
 
-from flwr.common.constant import FAB_ALLOWED_EXTENSIONS, FAB_DATE, FAB_HASH_TRUNCATION
+from flwr.common.constant import (
+    FAB_ALLOWED_EXTENSIONS,
+    FAB_DATE,
+    FAB_HASH_TRUNCATION,
+    FAB_MAX_SIZE,
+)
 
 from .config_utils import load as load_toml
 from .config_utils import load_and_validate
@@ -57,7 +62,7 @@ def build(
         Optional[Path],
         typer.Option(help="Path of the Flower App to bundle into a FAB"),
     ] = None,
-) -> tuple[str, str]:
+) -> None:
     """Build a Flower App into a Flower App Bundle (FAB).
 
     You can run ``flwr build`` without any arguments to bundle the app located in the
@@ -119,8 +124,6 @@ def build(
         f"🎊 Successfully built {fab_filename}", fg=typer.colors.GREEN, bold=True
     )
 
-    return fab_filename, fab_hash
-
 
 def build_fab(app: Path) -> tuple[bytes, str, dict[str, Any]]:
     """Build a FAB in memory and return the bytes, hash, and config.
@@ -181,7 +184,7 @@ def build_fab(app: Path) -> tuple[bytes, str, dict[str, Any]]:
             # Read the file content manually
             file_contents = file_path.read_bytes()
 
-            archive_path = str(file_path.relative_to(app))
+            archive_path = str(file_path.relative_to(app)).replace("\\", "/")
             write_to_zip(fab_file, archive_path, file_contents)
 
             # Calculate file info
@@ -193,6 +196,13 @@ def build_fab(app: Path) -> tuple[bytes, str, dict[str, Any]]:
         write_to_zip(fab_file, ".info/CONTENT", list_file_content)
 
     fab_bytes = fab_buffer.getvalue()
+    if len(fab_bytes) > FAB_MAX_SIZE:
+        raise ValueError(
+            f"FAB size exceeds maximum allowed size of {FAB_MAX_SIZE:,} bytes."
+            "To reduce the package size, consider ignoring unnecessary files "
+            "via your `.gitignore` file or excluding them from the build."
+        )
+
     fab_hash = hashlib.sha256(fab_bytes).hexdigest()
 
     return fab_bytes, fab_hash, config

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/cli/cli_user_auth_interceptor.py

@@ -20,7 +20,7 @@ from typing import Any, Callable, Union
 import grpc
 
 from flwr.common.auth_plugin import CliAuthPlugin
-from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
+from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     StartRunRequest,
     StreamLogsRequest,
 )

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/cli/config_utils.py

@@ -143,7 +143,7 @@ def validate_federation_in_project_config(
     if federation is None:
         typer.secho(
             "❌ No federation name was provided and the project's `pyproject.toml` "
-            "doesn't declare a default federation (with an Exec API address or an "
+            "doesn't declare a default federation (with an Control API address or an "
             "`options.num-supernodes` value).",
             fg=typer.colors.RED,
             bold=True,
@@ -230,8 +230,8 @@ def exit_if_no_address(federation_config: dict[str, Any], cmd: str) -> None:
     """Exit if the provided federation_config has no "address" key."""
     if "address" not in federation_config:
         typer.secho(
-            f"❌ `flwr {cmd}` currently works with a SuperLink. Ensure that the correct"
-            "SuperLink (Exec API) address is provided in `pyproject.toml`.",
+            f"❌ `flwr {cmd}` currently works with a SuperLink. Ensure that the "
+            "correct SuperLink (Control API) address is provided in `pyproject.toml`.",
             fg=typer.colors.RED,
             bold=True,
         )

flwr-1.21.0/py/flwr/cli/constant.py

@@ -0,0 +1,44 @@
+# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+"""Constants for CLI commands."""
+
+
+# General help message for config overrides
+CONFIG_HELP_MESSAGE = (
+    "Override {0} values using one of the following formats:\n\n"
+    "--{1} '<k1>=<v1> <k2>=<v2>' | --{1} '<k1>=<v1>' --{1} '<k2>=<v2>'{2}\n\n"
+    "When providing key-value pairs, values can be of any type supported by TOML "
+    "(e.g., bool, int, float, string). The specified keys (<k1> and <k2> in the "
+    "example) must exist in the {0} under the `{3}` section of `pyproject.toml` to be "
+    "overridden.{4}"
+)
+
+# The help message for `--run-config` option
+RUN_CONFIG_HELP_MESSAGE = CONFIG_HELP_MESSAGE.format(
+    "run configuration",
+    "run-config",
+    " | --run-config <path/to/your/toml>",
+    "[tool.flwr.app.config]",
+    " Alternatively, provide a TOML file containing overrides.",
+)
+
+# The help message for `--federation-config` option
+FEDERATION_CONFIG_HELP_MESSAGE = CONFIG_HELP_MESSAGE.format(
+    "federation configuration",
+    "federation-config",
+    "",
+    "[tool.flwr.federations.<YOUR-FEDERATION>]",
+    "",
+)

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/cli/log.py

@@ -32,8 +32,8 @@ from flwr.cli.config_utils import (
 from flwr.cli.constant import FEDERATION_CONFIG_HELP_MESSAGE
 from flwr.common.constant import CONN_RECONNECT_INTERVAL, CONN_REFRESH_PERIOD
 from flwr.common.logger import log as logger
-from flwr.proto.exec_pb2 import StreamLogsRequest  # pylint: disable=E0611
-from flwr.proto.exec_pb2_grpc import ExecStub
+from flwr.proto.control_pb2 import StreamLogsRequest  # pylint: disable=E0611
+from flwr.proto.control_pb2_grpc import ControlStub
 
 from .utils import flwr_cli_grpc_exc_handler, init_channel, try_obtain_cli_auth_plugin
 
@@ -46,7 +46,7 @@ def start_stream(
     run_id: int, channel: grpc.Channel, refresh_period: int = CONN_REFRESH_PERIOD
 ) -> None:
     """Start log streaming for a given run ID."""
-    stub = ExecStub(channel)
+    stub = ControlStub(channel)
     after_timestamp = 0.0
     try:
         logger(INFO, "Starting logstream for run_id `%s`", run_id)
@@ -69,7 +69,7 @@ def start_stream(
 
 
 def stream_logs(
-    run_id: int, stub: ExecStub, duration: int, after_timestamp: float
+    run_id: int, stub: ControlStub, duration: int, after_timestamp: float
 ) -> float:
     """Stream logs from the beginning of a run with connection refresh.
 
@@ -77,8 +77,8 @@ def stream_logs(
     ----------
     run_id : int
         The identifier of the run.
-    stub : ExecStub
-        The gRPC stub to interact with the Exec service.
+    stub : ControlStub
+        The gRPC stub to interact with the Control service.
     duration : int
         The timeout duration for each stream connection in seconds.
     after_timestamp : float
@@ -112,7 +112,7 @@ def stream_logs(
 
 def print_logs(run_id: int, channel: grpc.Channel, timeout: int) -> None:
     """Print logs from the beginning of a run."""
-    stub = ExecStub(channel)
+    stub = ControlStub(channel)
     req = StreamLogsRequest(run_id=run_id, after_timestamp=0.0)
 
     try:
@@ -173,13 +173,13 @@ def log(
     exit_if_no_address(federation_config, "log")
 
     try:
-        _log_with_exec_api(app, federation, federation_config, run_id, stream)
+        _log_with_control_api(app, federation, federation_config, run_id, stream)
     except Exception as err:  # pylint: disable=broad-except
         typer.secho(str(err), fg=typer.colors.RED, bold=True)
         raise typer.Exit(code=1) from None
 
 
-def _log_with_exec_api(
+def _log_with_control_api(
     app: Path,
     federation: str,
     federation_config: dict[str, Any],

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/cli/login/login.py

@@ -29,11 +29,11 @@ from flwr.cli.config_utils import (
 )
 from flwr.cli.constant import FEDERATION_CONFIG_HELP_MESSAGE
 from flwr.common.typing import UserAuthLoginDetails
-from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
+from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     GetLoginDetailsRequest,
     GetLoginDetailsResponse,
 )
-from flwr.proto.exec_pb2_grpc import ExecStub
+from flwr.proto.control_pb2_grpc import ControlStub
 
 from ..utils import flwr_cli_grpc_exc_handler, init_channel, try_obtain_cli_auth_plugin
 
@@ -89,7 +89,7 @@ def login(  # pylint: disable=R0914
         raise typer.Exit(code=1)
 
     channel = init_channel(app, federation_config, None)
-    stub = ExecStub(channel)
+    stub = ControlStub(channel)
 
     login_request = GetLoginDetailsRequest()
     with flwr_cli_grpc_exc_handler():

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/cli/ls.py

@@ -38,11 +38,11 @@ from flwr.common.date import format_timedelta, isoformat8601_utc
 from flwr.common.logger import print_json_error, redirect_output, restore_output
 from flwr.common.serde import run_from_proto
 from flwr.common.typing import Run
-from flwr.proto.exec_pb2 import (  # pylint: disable=E0611
+from flwr.proto.control_pb2 import (  # pylint: disable=E0611
     ListRunsRequest,
     ListRunsResponse,
 )
-from flwr.proto.exec_pb2_grpc import ExecStub
+from flwr.proto.control_pb2_grpc import ControlStub
 
 from .utils import flwr_cli_grpc_exc_handler, init_channel, try_obtain_cli_auth_plugin
 
@@ -125,7 +125,7 @@ def ls(  # pylint: disable=too-many-locals, too-many-branches, R0913, R0917
                 )
             auth_plugin = try_obtain_cli_auth_plugin(app, federation, federation_config)
             channel = init_channel(app, federation_config, auth_plugin)
-            stub = ExecStub(channel)
+            stub = ControlStub(channel)
 
             # Display information about a specific run ID
             if run_id is not None:
@@ -293,7 +293,7 @@ def _to_json(run_list: list[_RunListType]) -> str:
     return json.dumps({"success": True, "runs": runs_list})
 
 
-def _list_runs(stub: ExecStub) -> list[_RunListType]:
+def _list_runs(stub: ControlStub) -> list[_RunListType]:
     """List all runs."""
     with flwr_cli_grpc_exc_handler():
         res: ListRunsResponse = stub.ListRuns(ListRunsRequest())
@@ -302,7 +302,7 @@ def _list_runs(stub: ExecStub) -> list[_RunListType]:
     return _format_runs(run_dict, res.now)
 
 
-def _display_one_run(stub: ExecStub, run_id: int) -> list[_RunListType]:
+def _display_one_run(stub: ControlStub, run_id: int) -> list[_RunListType]:
     """Display information about a specific run."""
     with flwr_cli_grpc_exc_handler():
         res: ListRunsResponse = stub.ListRuns(ListRunsRequest(run_id=run_id))

{flwr-1.19.0 → flwr-1.21.0}/py/flwr/cli/new/new.py

@@ -35,6 +35,7 @@ class MlFramework(str, Enum):
     """Available frameworks."""
 
     PYTORCH = "PyTorch"
+    PYTORCH_MSG_API = "PyTorch (Message API)"
     TENSORFLOW = "TensorFlow"
     SKLEARN = "sklearn"
     HUGGINGFACE = "HuggingFace"
@@ -154,6 +155,9 @@ def new(
     if framework_str == MlFramework.BASELINE:
         framework_str = "baseline"
 
+    if framework_str == MlFramework.PYTORCH_MSG_API:
+        framework_str = "pytorch_msg_api"
+
     print(
         typer.style(
             f"\n🔨 Creating Flower App {app_name}...",
@@ -243,12 +247,19 @@ def new(
             MlFramework.TENSORFLOW.value,
             MlFramework.SKLEARN.value,
             MlFramework.NUMPY.value,
+            "pytorch_msg_api",
         ]
         if framework_str in frameworks_with_tasks:
             files[f"{import_name}/task.py"] = {
                 "template": f"app/code/task.{template_name}.py.tpl"
             }
 
+        if framework_str == "pytorch_msg_api":
+            # Use custom __init__ that better captures name of framework
+            files[f"{import_name}/__init__.py"] = {
+                "template": f"app/code/__init__.{framework_str}.py.tpl"
+            }
+
         if framework_str == "baseline":
             # Include additional files for baseline template
             for file_name in ["model", "dataset", "strategy", "utils", "__init__"]:
@@ -271,28 +282,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-1.19.0 → flwr-1.21.0}/py/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-1.19.0 → flwr-1.21.0}/py/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-1.21.0/py/flwr/cli/new/templates/app/code/__init__.pytorch_msg_api.py.tpl

@@ -0,0 +1 @@
+"""$project_name: A Flower / PyTorch app."""

flwr-1.21.0/py/flwr/cli/new/templates/app/code/client.pytorch_msg_api.py.tpl

@@ -0,0 +1,80 @@
+"""$project_name: A Flower / $framework_str app."""
+
+import torch
+from flwr.app import ArrayRecord, Context, Message, MetricRecord, RecordDict
+from flwr.clientapp import ClientApp
+
+from $import_name.task import Net, load_data
+from $import_name.task import test as test_fn
+from $import_name.task import train as train_fn
+
+# Flower ClientApp
+app = ClientApp()
+
+
+@app.train()
+def train(msg: Message, context: Context):
+    """Train the model on local data."""
+
+    # Load the model and initialize it with the received weights
+    model = Net()
+    model.load_state_dict(msg.content["arrays"].to_torch_state_dict())
+    device = torch.device("cuda:0" if torch.cuda.is_available() else "cpu")
+    model.to(device)
+
+    # Load the data
+    partition_id = context.node_config["partition-id"]
+    num_partitions = context.node_config["num-partitions"]
+    trainloader, _ = load_data(partition_id, num_partitions)
+
+    # Call the training function
+    train_loss = train_fn(
+        model,
+        trainloader,
+        context.run_config["local-epochs"],
+        msg.content["config"]["lr"],
+        device,
+    )
+
+    # Construct and return reply Message
+    model_record = ArrayRecord(model.state_dict())
+    metrics = {
+        "train_loss": train_loss,
+        "num-examples": len(trainloader.dataset),
+    }
+    metric_record = MetricRecord(metrics)
+    content = RecordDict({"arrays": model_record, "metrics": metric_record})
+    return Message(content=content, reply_to=msg)
+
+
+@app.evaluate()
+def evaluate(msg: Message, context: Context):
+    """Evaluate the model on local data."""
+
+    # Load the model and initialize it with the received weights
+    model = Net()
+    model.load_state_dict(msg.content["arrays"].to_torch_state_dict())
+    device = torch.device("cuda:0" if torch.cuda.is_available() else "cpu")
+    model.to(device)
+
+    # Load the data
+    partition_id = context.node_config["partition-id"]
+    num_partitions = context.node_config["num-partitions"]
+    _, valloader = load_data(partition_id, num_partitions)
+
+    # Call the evaluation function
+    eval_loss, eval_acc = test_fn(
+        model,
+        valloader,
+        device,
+    )
+
+    # Construct and return reply Message
+    metrics = {
+        "eval_loss": eval_loss,
+        "eval_acc": eval_acc,
+        "num-examples": len(valloader.dataset),
+    }
+    metric_record = MetricRecord(metrics)
+    content = RecordDict({"metrics": metric_record})
+    return Message(content=content, reply_to=msg)

flwr-1.21.0/py/flwr/cli/new/templates/app/code/server.pytorch_msg_api.py.tpl

@@ -0,0 +1,41 @@
+"""$project_name: A Flower / $framework_str app."""
+
+import torch
+from flwr.app import ArrayRecord, ConfigRecord, Context
+from flwr.serverapp import Grid, ServerApp
+from flwr.serverapp.strategy import FedAvg
+
+from $import_name.task import Net
+
+# Create ServerApp
+app = ServerApp()
+
+
+@app.main()
+def main(grid: Grid, context: Context) -> None:
+    """Main entry point for the ServerApp."""
+
+    # Read run config
+    fraction_train: float = context.run_config["fraction-train"]
+    num_rounds: int = context.run_config["num-server-rounds"]
+    lr: float = context.run_config["lr"]
+
+    # Load global model
+    global_model = Net()
+    arrays = ArrayRecord(global_model.state_dict())
+
+    # Initialize FedAvg strategy
+    strategy = FedAvg(fraction_train=fraction_train)
+
+    # Start strategy, run FedAvg for `num_rounds`
+    result = strategy.start(
+        grid=grid,
+        initial_arrays=arrays,
+        train_config=ConfigRecord({"lr": lr}),
+        num_rounds=num_rounds,
+    )
+
+    # Save final model to disk
+    print("\nSaving final model to disk...")
+    state_dict = result.arrays.to_torch_state_dict()
+    torch.save(state_dict, "final_model.pt")