flwr-nightly 1.12.0.dev20241007__py3-none-any.whl → 1.12.0.dev20241010__py3-none-any.whl

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

@@ -1,16 +1,21 @@
 """$project_name: A Flower / $framework_str app."""
 
-from flwr.common import Context
+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 get_dummy_model
 
 
 def server_fn(context: Context):
     # Read from config
     num_rounds = context.run_config["num-server-rounds"]
 
+    # Initial model
+    model = get_dummy_model()
+    dummy_parameters = ndarrays_to_parameters([model])
+
     # Define strategy
-    strategy = FedAvg()
+    strategy = FedAvg(initial_parameters=dummy_parameters)
     config = ServerConfig(num_rounds=num_rounds)
 
     return ServerAppComponents(strategy=strategy, config=config)

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

@@ -3,7 +3,6 @@
 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
 
 
@@ -27,5 +26,6 @@ def server_fn(context: Context):
 
     return ServerAppComponents(strategy=strategy, config=config)
 
+
 # Create ServerApp
 app = ServerApp(server_fn=server_fn)

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

@@ -1,19 +1,31 @@
 """$project_name: A Flower / $framework_str app."""
 
-from flwr.common import Context
+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 get_model, get_model_params, set_initial_params
 
 
 def server_fn(context: Context):
     # Read from config
     num_rounds = context.run_config["num-server-rounds"]
 
+    # Create LogisticRegression Model
+    penalty = context.run_config["penalty"]
+    local_epochs = context.run_config["local-epochs"]
+    model = get_model(penalty, local_epochs)
+
+    # Setting initial parameters, akin to model.compile for keras models
+    set_initial_params(model)
+
+    initial_parameters = ndarrays_to_parameters(get_model_params(model))
+
     # Define strategy
     strategy = FedAvg(
         fraction_fit=1.0,
         fraction_evaluate=1.0,
         min_available_clients=2,
+        initial_parameters=initial_parameters,
     )
     config = ServerConfig(num_rounds=num_rounds)
 

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

@@ -2,9 +2,9 @@
 
 import jax
 import jax.numpy as jnp
+import numpy as np
 from sklearn.datasets import make_regression
 from sklearn.model_selection import train_test_split
-import numpy as np
 
 key = jax.random.PRNGKey(0)
 
@@ -33,7 +33,7 @@ def train(params, grad_fn, X, y):
     num_examples = X.shape[0]
     for epochs in range(50):
         grads = grad_fn(params, X, y)
-        params = jax.tree_map(lambda p, g: p - 0.05 * g, params, grads)
+        params = jax.tree.map(lambda p, g: p - 0.05 * g, params, grads)
         loss = loss_fn(params, X, y)
     return params, loss, num_examples
 

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

@@ -3,10 +3,10 @@
 import mlx.core as mx
 import mlx.nn as nn
 import numpy as np
-from datasets.utils.logging import disable_progress_bar
 from flwr_datasets import FederatedDataset
 from flwr_datasets.partitioner import IidPartitioner
 
+from datasets.utils.logging import disable_progress_bar
 
 disable_progress_bar()
 

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

@@ -0,0 +1,7 @@
+"""$project_name: A Flower / $framework_str app."""
+
+import numpy as np
+
+
+def get_dummy_model():
+    return np.ones((1, 1))

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

@@ -5,10 +5,10 @@ from collections import OrderedDict
 import torch
 import torch.nn as nn
 import torch.nn.functional as F
-from torch.utils.data import DataLoader
-from torchvision.transforms import Compose, Normalize, ToTensor
 from flwr_datasets import FederatedDataset
 from flwr_datasets.partitioner import IidPartitioner
+from torch.utils.data import DataLoader
+from torchvision.transforms import Compose, Normalize, ToTensor
 
 
 class Net(nn.Module):
@@ -67,7 +67,7 @@ def train(net, trainloader, epochs, device):
     """Train the model on the training set."""
     net.to(device)  # move model to GPU if available
     criterion = torch.nn.CrossEntropyLoss().to(device)
-    optimizer = torch.optim.SGD(net.parameters(), lr=0.1, momentum=0.9)
+    optimizer = torch.optim.Adam(net.parameters(), lr=0.01)
     net.train()
     running_loss = 0.0
     for _ in range(epochs):

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

@@ -0,0 +1,67 @@
+"""$project_name: A Flower / $framework_str app."""
+
+import numpy as np
+from flwr_datasets import FederatedDataset
+from flwr_datasets.partitioner import IidPartitioner
+from sklearn.linear_model import LogisticRegression
+
+fds = None  # Cache FederatedDataset
+
+
+def load_data(partition_id: int, num_partitions: int):
+    """Load partition MNIST data."""
+    # Only initialize `FederatedDataset` once
+    global fds
+    if fds is None:
+        partitioner = IidPartitioner(num_partitions=num_partitions)
+        fds = FederatedDataset(
+            dataset="mnist",
+            partitioners={"train": partitioner},
+        )
+
+    dataset = fds.load_partition(partition_id, "train").with_format("numpy")
+
+    X, y = dataset["image"].reshape((len(dataset), -1)), dataset["label"]
+
+    # Split the on edge data: 80% train, 20% test
+    X_train, X_test = X[: int(0.8 * len(X))], X[int(0.8 * len(X)) :]
+    y_train, y_test = y[: int(0.8 * len(y))], y[int(0.8 * len(y)) :]
+
+    return X_train, X_test, y_train, y_test
+
+
+def get_model(penalty: str, local_epochs: int):
+
+    return LogisticRegression(
+        penalty=penalty,
+        max_iter=local_epochs,
+        warm_start=True,
+    )
+
+
+def get_model_params(model):
+    if model.fit_intercept:
+        params = [
+            model.coef_,
+            model.intercept_,
+        ]
+    else:
+        params = [model.coef_]
+    return params
+
+
+def set_model_params(model, params):
+    model.coef_ = params[0]
+    if model.fit_intercept:
+        model.intercept_ = params[1]
+    return model
+
+
+def set_initial_params(model):
+    n_classes = 10  # MNIST has 10 classes
+    n_features = 784  # Number of features in dataset
+    model.classes_ = np.array([i for i in range(10)])
+
+    model.coef_ = np.zeros((n_classes, n_features))
+    if model.fit_intercept:
+        model.intercept_ = np.zeros((n_classes,))

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

@@ -14,7 +14,7 @@ dependencies = [
     "bitsandbytes==0.43.0",
     "scipy==1.13.0",
     "peft==0.6.2",
-    "transformers==4.39.3",
+    "transformers==4.43.1",
     "sentencepiece==0.2.0",
     "omegaconf==2.3.0",
     "hf_transfer==0.1.8",

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

@@ -9,8 +9,8 @@ description = ""
 license = "Apache-2.0"
 dependencies = [
     "flwr[simulation]>=1.10.0",
-    "jax==0.4.13",
-    "jaxlib==0.4.13",
+    "jax==0.4.30",
+    "jaxlib==0.4.30",
     "scikit-learn==1.3.2",
 ]
 
@@ -26,6 +26,7 @@ clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = 3
+input-dim = 3
 
 [tool.flwr.federations]
 default = "local-simulation"

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

@@ -28,6 +28,7 @@ clientapp = "$import_name.client_app:app"
 num-server-rounds = 3
 local-epochs = 1
 num-layers = 2
+input-dim = 784 # 28*28
 hidden-dim = 32
 batch-size = 256
 lr = 0.1

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

@@ -25,6 +25,8 @@ clientapp = "$import_name.client_app:app"
 
 [tool.flwr.app.config]
 num-server-rounds = 3
+penalty = "l2"
+local-epochs = 1
 
 [tool.flwr.federations]
 default = "local-simulation"

flwr/cli/run/run.py

@@ -14,7 +14,6 @@
 # ==============================================================================
 """Flower command line interface `run` command."""
 
-import hashlib
 import json
 import subprocess
 import sys
@@ -134,6 +133,7 @@ def run(
         _run_without_superexec(app, federation_config, config_overrides, federation)
 
 
+# pylint: disable=too-many-locals
 def _run_with_superexec(
     app: Path,
     federation_config: dict[str, Any],
@@ -179,9 +179,9 @@ def _run_with_superexec(
     channel.subscribe(on_channel_state_change)
     stub = ExecStub(channel)
 
-    fab_path = Path(build(app))
-    content = fab_path.read_bytes()
-    fab = Fab(hashlib.sha256(content).hexdigest(), content)
+    fab_path, fab_hash = build(app)
+    content = Path(fab_path).read_bytes()
+    fab = Fab(fab_hash, content)
 
     req = StartRunRequest(
         fab=fab_to_proto(fab),
@@ -193,7 +193,7 @@ def _run_with_superexec(
     res = stub.StartRun(req)
 
     # Delete FAB file once it has been sent to the SuperExec
-    fab_path.unlink()
+    Path(fab_path).unlink()
     typer.secho(f"🎊 Successfully started run {res.run_id}", fg=typer.colors.GREEN)
 
     if stream:

flwr/client/app.py

@@ -132,6 +132,11 @@ def start_client(
         - 'grpc-bidi': gRPC, bidirectional streaming
         - 'grpc-rere': gRPC, request-response (experimental)
         - 'rest': HTTP (experimental)
+    authentication_keys : Optional[Tuple[PrivateKey, PublicKey]] (default: None)
+        Tuple containing the elliptic curve private key and public key for
+        authentication from the cryptography library.
+        Source: https://cryptography.io/en/latest/hazmat/primitives/asymmetric/ec/
+        Used to establish an authenticated connection with the server.
     max_retries: Optional[int] (default: None)
         The maximum number of times the client will try to connect to the
         server before giving up in case of a connection error. If set to None,
@@ -197,7 +202,7 @@ def start_client_internal(
     *,
     server_address: str,
     node_config: UserConfig,
-    load_client_app_fn: Optional[Callable[[str, str], ClientApp]] = None,
+    load_client_app_fn: Optional[Callable[[str, str, str], ClientApp]] = None,
     client_fn: Optional[ClientFnExt] = None,
     client: Optional[Client] = None,
     grpc_max_message_length: int = GRPC_MAX_MESSAGE_LENGTH,
@@ -249,6 +254,11 @@ def start_client_internal(
         - 'grpc-bidi': gRPC, bidirectional streaming
         - 'grpc-rere': gRPC, request-response (experimental)
         - 'rest': HTTP (experimental)
+    authentication_keys : Optional[Tuple[PrivateKey, PublicKey]] (default: None)
+        Tuple containing the elliptic curve private key and public key for
+        authentication from the cryptography library.
+        Source: https://cryptography.io/en/latest/hazmat/primitives/asymmetric/ec/
+        Used to establish an authenticated connection with the server.
     max_retries: Optional[int] (default: None)
         The maximum number of times the client will try to connect to the
         server before giving up in case of a connection error. If set to None,
@@ -288,7 +298,7 @@ def start_client_internal(
 
             client_fn = single_client_factory
 
-        def _load_client_app(_1: str, _2: str) -> ClientApp:
+        def _load_client_app(_1: str, _2: str, _3: str) -> ClientApp:
             return ClientApp(client_fn=client_fn)
 
         load_client_app_fn = _load_client_app
@@ -519,7 +529,7 @@ def start_client_internal(
                         else:
                             # Load ClientApp instance
                             client_app: ClientApp = load_client_app_fn(
-                                fab_id, fab_version
+                                fab_id, fab_version, run.fab_hash
                             )
 
                             # Execute ClientApp

flwr/client/clientapp/app.py

@@ -132,8 +132,11 @@ def run_clientapp(  # pylint: disable=R0914
             )
 
             try:
-                # Load ClientApp
-                client_app: ClientApp = load_client_app_fn(run.fab_id, run.fab_version)
+                if fab:
+                    # Load ClientApp
+                    client_app: ClientApp = load_client_app_fn(
+                        run.fab_id, run.fab_version, fab.hash_str
+                    )
 
                 # Execute ClientApp
                 reply_message = client_app(message=message, context=context)

flwr/client/clientapp/utils.py

@@ -34,7 +34,7 @@ def get_load_client_app_fn(
     app_path: Optional[str],
     multi_app: bool,
     flwr_dir: Optional[str] = None,
-) -> Callable[[str, str], ClientApp]:
+) -> Callable[[str, str, str], ClientApp]:
     """Get the load_client_app_fn function.
 
     If `multi_app` is True, this function loads the specified ClientApp
@@ -55,13 +55,14 @@ def get_load_client_app_fn(
         if not valid and error_msg:
             raise LoadClientAppError(error_msg) from None
 
-    def _load(fab_id: str, fab_version: str) -> ClientApp:
+    def _load(fab_id: str, fab_version: str, fab_hash: str) -> ClientApp:
         runtime_app_dir = Path(app_path if app_path else "").absolute()
         # If multi-app feature is disabled
         if not multi_app:
             # Set app reference
             client_app_ref = default_app_ref
-        # If multi-app feature is enabled but app directory is provided
+        # If multi-app feature is enabled but app directory is provided.
+        # `fab_hash` is not required since the app is loaded from `runtime_app_dir`.
         elif app_path is not None:
             config = get_project_config(runtime_app_dir)
             this_fab_version, this_fab_id = get_metadata_from_config(config)
@@ -81,11 +82,16 @@ def get_load_client_app_fn(
         else:
             try:
                 runtime_app_dir = get_project_dir(
-                    fab_id, fab_version, get_flwr_dir(flwr_dir)
+                    fab_id, fab_version, fab_hash, get_flwr_dir(flwr_dir)
                 )
                 config = get_project_config(runtime_app_dir)
             except Exception as e:
-                raise LoadClientAppError("Failed to load ClientApp") from e
+                raise LoadClientAppError(
+                    "Failed to load ClientApp."
+                    "Possible reasons for error include mismatched "
+                    "`fab_id`, `fab_version`, or `fab_hash` in "
+                    f"{str(get_flwr_dir(flwr_dir).resolve())}."
+                ) from e
 
             # Set app reference
             client_app_ref = config["tool"]["flwr"]["app"]["components"]["clientapp"]

flwr/client/grpc_rere_client/connection.py

@@ -120,6 +120,9 @@ def grpc_request_response(  # pylint: disable=R0913, R0914, R0915
         authentication from the cryptography library.
         Source: https://cryptography.io/en/latest/hazmat/primitives/asymmetric/ec/
         Used to establish an authenticated connection with the server.
+    adapter_cls: Optional[Union[type[FleetStub], type[GrpcAdapter]]] (default: None)
+        A GrpcStub Class that can be used to send messages. By default the FleetStub
+        will be used.
 
     Returns
     -------

flwr/common/config.py

@@ -22,7 +22,12 @@ from typing import Any, Optional, Union, cast, get_args
 import tomli
 
 from flwr.cli.config_utils import get_fab_config, validate_fields
-from flwr.common.constant import APP_DIR, FAB_CONFIG_FILE, FLWR_HOME
+from flwr.common.constant import (
+    APP_DIR,
+    FAB_CONFIG_FILE,
+    FAB_HASH_TRUNCATION,
+    FLWR_HOME,
+)
 from flwr.common.typing import Run, UserConfig, UserConfigValue
 
 
@@ -39,7 +44,10 @@ def get_flwr_dir(provided_path: Optional[str] = None) -> Path:
 
 
 def get_project_dir(
-    fab_id: str, fab_version: str, flwr_dir: Optional[Union[str, Path]] = None
+    fab_id: str,
+    fab_version: str,
+    fab_hash: str,
+    flwr_dir: Optional[Union[str, Path]] = None,
 ) -> Path:
     """Return the project directory based on the given fab_id and fab_version."""
     # Check the fab_id
@@ -50,7 +58,11 @@ def get_project_dir(
     publisher, project_name = fab_id.split("/")
     if flwr_dir is None:
         flwr_dir = get_flwr_dir()
-    return Path(flwr_dir) / APP_DIR / publisher / project_name / fab_version
+    return (
+        Path(flwr_dir)
+        / APP_DIR
+        / f"{publisher}.{project_name}.{fab_version}.{fab_hash[:FAB_HASH_TRUNCATION]}"
+    )
 
 
 def get_project_config(project_dir: Union[str, Path]) -> dict[str, Any]:
@@ -127,7 +139,7 @@ def get_fused_config(run: Run, flwr_dir: Optional[Path]) -> UserConfig:
     if not run.fab_id or not run.fab_version:
         return {}
 
-    project_dir = get_project_dir(run.fab_id, run.fab_version, flwr_dir)
+    project_dir = get_project_dir(run.fab_id, run.fab_version, run.fab_hash, flwr_dir)
 
     # Return empty dict if project directory does not exist
     if not project_dir.is_dir():
@@ -205,8 +217,9 @@ def parse_config_args(
             matches = pattern.findall(config_line)
             toml_str = "\n".join(f"{k} = {v}" for k, v in matches)
             overrides.update(tomli.loads(toml_str))
+            flat_overrides = flatten_dict(overrides)
 
-    return overrides
+    return flat_overrides
 
 
 def get_metadata_from_config(config: dict[str, Any]) -> tuple[str, str]:

flwr/common/constant.py

@@ -63,7 +63,10 @@ NODE_ID_NUM_BYTES = 8
 
 # Constants for FAB
 APP_DIR = "apps"
+FAB_ALLOWED_EXTENSIONS = {".py", ".toml", ".md"}
 FAB_CONFIG_FILE = "pyproject.toml"
+FAB_DATE = (2024, 10, 1, 0, 0, 0)
+FAB_HASH_TRUNCATION = 8
 FLWR_HOME = "FLWR_HOME"
 
 # Constants entries in Node config for Simulation

flwr/common/message.py

@@ -290,6 +290,11 @@ class Message:
             follows the equation:
 
             ttl = msg.meta.ttl - (reply.meta.created_at - msg.meta.created_at)
+
+        Returns
+        -------
+        message : Message
+            A Message containing only the relevant error and metadata.
         """
         # If no TTL passed, use default for message creation (will update after
         # message creation)

flwr/common/recordset_compat.py

@@ -59,6 +59,11 @@ def parametersrecord_to_parameters(
     keep_input : bool
         A boolean indicating whether entries in the record should be deleted from the
         input dictionary immediately after adding them to the record.
+
+    Returns
+    -------
+    parameters : Parameters
+        The parameters in the legacy format Parameters.
     """
     parameters = Parameters(tensors=[], tensor_type="")
 
@@ -94,6 +99,11 @@ def parameters_to_parametersrecord(
         A boolean indicating whether parameters should be deleted from the input
         Parameters object (i.e. a list of serialized NumPy arrays) immediately after
         adding them to the record.
+
+    Returns
+    -------
+    ParametersRecord
+        The ParametersRecord containing the provided parameters.
     """
     tensor_type = parameters.tensor_type
 

flwr/common/retry_invoker.py

@@ -38,6 +38,11 @@ def exponential(
         Factor by which the delay is multiplied after each retry.
     max_delay: Optional[float] (default: None)
         The maximum delay duration between two consecutive retries.
+
+    Returns
+    -------
+    Generator[float, None, None]
+        A generator for the delay between 2 retries.
     """
     delay = base_delay if max_delay is None else min(base_delay, max_delay)
     while True:
@@ -56,6 +61,11 @@ def constant(
     ----------
     interval: Union[float, Iterable[float]] (default: 1)
         A constant value to yield or an iterable of such values.
+
+    Returns
+    -------
+    Generator[float, None, None]
+        A generator for the delay between 2 retries.
     """
     if not isinstance(interval, Iterable):
         interval = itertools.repeat(interval)
@@ -73,6 +83,11 @@ def full_jitter(max_value: float) -> float:
     ----------
     max_value : float
         The upper limit for the randomized value.
+
+    Returns
+    -------
+    float
+        A random float that is less than max_value.
     """
     return random.uniform(0, max_value)
 

flwr/server/client_manager.py

@@ -47,6 +47,7 @@ class ClientManager(ABC):
         Parameters
         ----------
         client : flwr.server.client_proxy.ClientProxy
+            The ClientProxy of the Client to register.
 
         Returns
         -------
@@ -64,6 +65,7 @@ class ClientManager(ABC):
         Parameters
         ----------
         client : flwr.server.client_proxy.ClientProxy
+            The ClientProxy of the Client to unregister.
         """
 
     @abstractmethod

flwr/server/compat/driver_client_proxy.py

@@ -15,7 +15,6 @@
 """Flower ClientProxy implementation for Driver API."""
 
 
-import time
 from typing import Optional
 
 from flwr import common
@@ -25,8 +24,6 @@ from flwr.server.client_proxy import ClientProxy
 
 from ..driver.driver import Driver
 
-SLEEP_TIME = 1
-
 
 class DriverClientProxy(ClientProxy):
     """Flower client proxy which delegates work using the Driver API."""
@@ -122,29 +119,18 @@ class DriverClientProxy(ClientProxy):
             ttl=timeout,
         )
 
-        # Push message
-        message_ids = list(self.driver.push_messages(messages=[message]))
-        if len(message_ids) != 1:
-            raise ValueError("Unexpected number of message_ids")
-
-        message_id = message_ids[0]
-        if message_id == "":
-            raise ValueError(f"Failed to send message to node {self.node_id}")
-
-        if timeout:
-            start_time = time.time()
-
-        while True:
-            messages = list(self.driver.pull_messages(message_ids))
-            if len(messages) == 1:
-                msg: Message = messages[0]
-                if msg.has_error():
-                    raise ValueError(
-                        f"Message contains an Error (reason: {msg.error.reason}). "
-                        "It originated during client-side execution of a message."
-                    )
-                return msg.content
-
-            if timeout is not None and time.time() > start_time + timeout:
-                raise RuntimeError("Timeout reached")
-            time.sleep(SLEEP_TIME)
+        # Send message and wait for reply
+        messages = list(self.driver.send_and_receive(messages=[message]))
+
+        # A single reply is expected
+        if len(messages) != 1:
+            raise ValueError(f"Expected one Message but got: {len(messages)}")
+
+        # Only messages without errors can be handled beyond these point
+        msg: Message = messages[0]
+        if msg.has_error():
+            raise ValueError(
+                f"Message contains an Error (reason: {msg.error.reason}). "
+                "It originated during client-side execution of a message."
+            )
+        return msg.content