flwr-nightly 1.9.0.dev20240430__tar.gz → 1.9.0.dev20240501__tar.gz

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.9.0.dev20240430
+Version: 1.9.0.dev20240501
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0
@@ -36,6 +36,7 @@ Requires-Dist: cryptography (>=42.0.4,<43.0.0)
 Requires-Dist: grpcio (>=1.60.0,<2.0.0)
 Requires-Dist: iterators (>=0.0.2,<0.0.3)
 Requires-Dist: numpy (>=1.21.0,<2.0.0)
+Requires-Dist: pathspec (>=0.12.1,<0.13.0)
 Requires-Dist: protobuf (>=4.25.2,<5.0.0)
 Requires-Dist: pycryptodome (>=3.18.0,<4.0.0)
 Requires-Dist: ray (==2.6.3) ; (python_version >= "3.8" and python_version < "3.12") and (extra == "simulation")

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.9.0.dev20240430"
+version = "1.9.0.dev20240501"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]
@@ -59,7 +59,7 @@ flower-superlink = "flwr.server:run_superlink"
 flower-supernode = "flwr.client:run_supernode"
 flower-client-app = "flwr.client:run_client_app"
 flower-server-app = "flwr.server:run_server_app"
-flower-simulation = "flwr.simulation:run_simulation_from_cli"
+flower-simulation = "flwr.simulation.run_simulation:run_simulation_from_cli"
 
 [tool.poetry.dependencies]
 python = "^3.8"
@@ -72,6 +72,7 @@ pycryptodome = "^3.18.0"
 iterators = "^0.0.2"
 typer = { version = "^0.9.0", extras=["all"] }
 tomli = "^2.0.1"
+pathspec = "^0.12.1"
 # Optional dependencies (Simulation Engine)
 ray = { version = "==2.6.3", optional = true, python = ">=3.8,<3.12" }
 # Optional dependencies (REST transport layer)

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/cli/app.py

@@ -16,6 +16,7 @@
 
 import typer
 
+from .build import build
 from .example import example
 from .new import new
 from .run import run
@@ -32,6 +33,7 @@ app = typer.Typer(
 app.command()(new)
 app.command()(example)
 app.command()(run)
+app.command()(build)
 
 if __name__ == "__main__":
     app()

flwr_nightly-1.9.0.dev20240501/src/py/flwr/cli/build.py

@@ -0,0 +1,151 @@
+# Copyright 2024 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 command line interface `build` command."""
+
+import hashlib
+import os
+import zipfile
+from pathlib import Path
+from typing import Optional
+
+import pathspec
+import typer
+from typing_extensions import Annotated
+
+from .config_utils import load_and_validate_with_defaults
+from .utils import is_valid_project_name
+
+
+# pylint: disable=too-many-locals
+def build(
+    directory: Annotated[
+        Optional[Path],
+        typer.Option(help="The Flower project directory to bundle into a FAB"),
+    ] = None,
+) -> None:
+    """Build a Flower project into a Flower App Bundle (FAB).
+
+    You can run `flwr build` without any argument to bundle the current directory:
+
+        `flwr build`
+
+    You can also build a specific directory:
+
+        `flwr build --directory ./projects/flower-hello-world`
+    """
+    if directory is None:
+        directory = Path.cwd()
+
+    directory = directory.resolve()
+    if not directory.is_dir():
+        typer.secho(
+            f"❌ The path {directory} is not a valid directory.",
+            fg=typer.colors.RED,
+            bold=True,
+        )
+        raise typer.Exit(code=1)
+
+    if not is_valid_project_name(directory.name):
+        typer.secho(
+            f"❌ The project name {directory.name} is invalid, "
+            "a valid project name must start with a letter or an underscore, "
+            "and can only contain letters, digits, and underscores.",
+            fg=typer.colors.RED,
+            bold=True,
+        )
+        raise typer.Exit(code=1)
+
+    conf, errors, warnings = load_and_validate_with_defaults(
+        directory / "pyproject.toml"
+    )
+    if conf is None:
+        typer.secho(
+            "Project configuration could not be loaded.\npyproject.toml is invalid:\n"
+            + "\n".join([f"- {line}" for line in errors]),
+            fg=typer.colors.RED,
+            bold=True,
+        )
+        raise typer.Exit(code=1)
+
+    if warnings:
+        typer.secho(
+            "Project configuration is missing the following "
+            "recommended properties:\n" + "\n".join([f"- {line}" for line in warnings]),
+            fg=typer.colors.RED,
+            bold=True,
+        )
+
+    # Load .gitignore rules if present
+    ignore_spec = _load_gitignore(directory)
+
+    # Set the name of the zip file
+    fab_filename = (
+        f"{conf['flower']['publisher']}"
+        f".{directory.name}"
+        f".{conf['project']['version'].replace('.', '-')}.fab"
+    )
+    list_file_content = ""
+
+    allowed_extensions = {".py", ".toml", ".md"}
+
+    with zipfile.ZipFile(fab_filename, "w", zipfile.ZIP_DEFLATED) as fab_file:
+        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
+            ]
+
+            for file in files:
+                file_path = Path(root) / file
+                archive_path = file_path.relative_to(directory)
+                fab_file.write(file_path, archive_path)
+
+                # Calculate file info
+                sha256_hash = _get_sha256_hash(file_path)
+                file_size_bits = os.path.getsize(file_path) * 8  # size in bits
+                list_file_content += f"{archive_path},{sha256_hash},{file_size_bits}\n"
+
+        # Add CONTENT and CONTENT.jwt to the zip file
+        fab_file.writestr(".info/CONTENT", list_file_content)
+
+    typer.secho(
+        f"🎊 Successfully built {fab_filename}.", fg=typer.colors.GREEN, bold=True
+    )
+
+
+def _get_sha256_hash(file_path: Path) -> str:
+    """Calculate the SHA-256 hash of a file."""
+    sha256 = hashlib.sha256()
+    with open(file_path, "rb") as f:
+        while True:
+            data = f.read(65536)  # Read in 64kB blocks
+            if not data:
+                break
+            sha256.update(data)
+    return sha256.hexdigest()
+
+
+def _load_gitignore(directory: Path) -> pathspec.PathSpec:
+    """Load and parse .gitignore file, returning a pathspec."""
+    gitignore_path = directory / ".gitignore"
+    patterns = ["__pycache__/"]  # Default pattern
+    if gitignore_path.exists():
+        with open(gitignore_path, encoding="UTF-8") as file:
+            patterns.extend(file.readlines())
+    return pathspec.PathSpec.from_lines("gitwildmatch", patterns)

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/cli/new/new.py

@@ -153,6 +153,7 @@ def new(
     # Depending on the framework, generate task.py file
     frameworks_with_tasks = [
         MlFramework.PYTORCH.value.lower(),
+        MlFramework.TENSORFLOW.value.lower(),
     ]
     if framework_str in frameworks_with_tasks:
         files[f"{import_name}/task.py"] = {

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/cli/new/templates/app/README.md.tpl

@@ -8,7 +8,7 @@ pip install .
 
 ## Run (Simulation Engine)
 
-In the `$import_name` directory, use `flwr run` to run a local simulation:
+In the `$project_name` directory, use `flwr run` to run a local simulation:
 
 ```bash
 flwr run

flwr_nightly-1.9.0.dev20240501/src/py/flwr/cli/new/templates/app/code/client.tensorflow.py.tpl

@@ -0,0 +1,43 @@
+"""$project_name: A Flower / TensorFlow app."""
+
+from flwr.client import NumPyClient, ClientApp
+
+from $import_name.task import load_data, load_model
+
+
+# Define Flower Client and client_fn
+class FlowerClient(NumPyClient):
+    def __init__(self, model, x_train, y_train, x_test, y_test):
+        self.model = model
+        self.x_train = x_train
+        self.y_train = y_train
+        self.x_test = x_test
+        self.y_test = y_test
+
+    def get_parameters(self, config):
+        return self.model.get_weights()
+
+    def fit(self, parameters, config):
+        self.model.set_weights(parameters)
+        self.model.fit(self.x_train, self.y_train, epochs=1, batch_size=32, verbose=0)
+        return self.model.get_weights(), len(self.x_train), {}
+
+    def evaluate(self, parameters, config):
+        self.model.set_weights(parameters)
+        loss, accuracy = self.model.evaluate(self.x_test, self.y_test, verbose=0)
+        return loss, len(self.x_test), {"accuracy": accuracy}
+
+
+def client_fn(cid):
+    # Load model and data
+    net = load_model()
+    x_train, y_train, x_test, y_test = load_data(int(cid), 2)
+
+    # Return Client instance
+    return FlowerClient(net, x_train, y_train, x_test, y_test).to_client()
+
+
+# Flower ClientApp
+app = ClientApp(
+    client_fn=client_fn,
+)

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/cli/new/templates/app/code/server.tensorflow.py.tpl

@@ -1,18 +1,26 @@
 """$project_name: A Flower / TensorFlow app."""
 
+from flwr.common import ndarrays_to_parameters
 from flwr.server import ServerApp, ServerConfig
 from flwr.server.strategy import FedAvg
 
+from $import_name.task import load_model
+
 # Define config
 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,
 )
 
-# Flower ServerApp
+
+# Create ServerApp
 app = ServerApp(
     config=config,
     strategy=strategy,

flwr_nightly-1.9.0.dev20240501/src/py/flwr/cli/new/templates/app/code/task.tensorflow.py.tpl

@@ -0,0 +1,29 @@
+"""$project_name: A Flower / TensorFlow app."""
+
+import os
+
+import tensorflow as tf
+from flwr_datasets import FederatedDataset
+
+
+# Make TensorFlow log less verbose
+os.environ["TF_CPP_MIN_LOG_LEVEL"] = "3"
+
+def load_model():
+    # Load model and data (MobileNetV2, CIFAR-10)
+    model = tf.keras.applications.MobileNetV2((32, 32, 3), classes=10, weights=None)
+    model.compile("adam", "sparse_categorical_crossentropy", metrics=["accuracy"])
+    return model
+
+
+def load_data(partition_id, num_partitions):
+    # Download and partition dataset
+    fds = FederatedDataset(dataset="cifar10", partitioners={"train": num_partitions})
+    partition = fds.load_partition(partition_id, "train")
+    partition.set_format("numpy")
+
+    # Divide data on each node: 80% train, 20% test
+    partition = partition.train_test_split(test_size=0.2)
+    x_train, y_train = partition["train"]["img"] / 255.0, partition["train"]["label"]
+    x_test, y_test = partition["test"]["img"] / 255.0, partition["test"]["label"]
+    return x_train, y_train, x_test, y_test

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/cli/new/templates/app/pyproject.numpy.toml.tpl

@@ -9,7 +9,7 @@ description = ""
 authors = [
     { name = "The Flower Authors", email = "hello@flower.ai" },
 ]
-license = {text = "Apache License (2.0)"}
+license = { text = "Apache License (2.0)" }
 dependencies = [
     "flwr[simulation]>=1.8.0,<2.0",
     "numpy>=1.21.0",

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl

@@ -9,7 +9,7 @@ description = ""
 authors = [
     { name = "The Flower Authors", email = "hello@flower.ai" },
 ]
-license = {text = "Apache License (2.0)"}
+license = { text = "Apache License (2.0)" }
 dependencies = [
     "flwr[simulation]>=1.8.0,<2.0",
     "flwr-datasets[vision]>=0.0.2,<1.0.0",

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl

@@ -9,7 +9,7 @@ description = ""
 authors = [
     { name = "The Flower Authors", email = "hello@flower.ai" },
 ]
-license = {text = "Apache License (2.0)"}
+license = { text = "Apache License (2.0)" }
 dependencies = [
     "flwr[simulation]>=1.8.0,<2.0",
     "flwr-datasets[vision]>=0.0.2,<1.0.0",

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl

@@ -9,7 +9,7 @@ description = ""
 authors = [
     { name = "The Flower Authors", email = "hello@flower.ai" },
 ]
-license = {text = "Apache License (2.0)"}
+license = { text = "Apache License (2.0)" }
 dependencies = [
     "flwr[simulation]>=1.8.0,<2.0",
     "flwr-datasets[vision]>=0.0.2,<1.0.0",

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/client/mod/centraldp_mods.py

@@ -82,7 +82,9 @@ def fixedclipping_mod(
         clipping_norm,
     )
 
-    log(INFO, "fixedclipping_mod: parameters are clipped by value: %s.", clipping_norm)
+    log(
+        INFO, "fixedclipping_mod: parameters are clipped by value: %.4f.", clipping_norm
+    )
 
     fit_res.parameters = ndarrays_to_parameters(client_to_server_params)
     out_msg.content = compat.fitres_to_recordset(fit_res, keep_input=True)
@@ -146,7 +148,7 @@ def adaptiveclipping_mod(
     )
     log(
         INFO,
-        "adaptiveclipping_mod: parameters are clipped by value: %s.",
+        "adaptiveclipping_mod: parameters are clipped by value: %.4f.",
         clipping_norm,
     )
 

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/client/mod/localdp_mod.py

@@ -128,7 +128,9 @@ class LocalDpMod:
             self.clipping_norm,
         )
         log(
-            INFO, "LocalDpMod: parameters are clipped by value: %s.", self.clipping_norm
+            INFO,
+            "LocalDpMod: parameters are clipped by value: %.4f.",
+            self.clipping_norm,
         )
 
         fit_res.parameters = ndarrays_to_parameters(client_to_server_params)
@@ -137,11 +139,15 @@ class LocalDpMod:
         add_localdp_gaussian_noise_to_params(
             fit_res.parameters, self.sensitivity, self.epsilon, self.delta
         )
+
+        noise_value_sd = (
+            self.sensitivity * np.sqrt(2 * np.log(1.25 / self.delta)) / self.epsilon
+        )
         log(
             INFO,
             "LocalDpMod: local DP noise with "
-            "standard deviation: %s added to parameters.",
-            self.sensitivity * np.sqrt(2 * np.log(1.25 / self.delta)) / self.epsilon,
+            "standard deviation: %.4f added to parameters.",
+            noise_value_sd,
         )
 
         out_msg.content = compat.fitres_to_recordset(fit_res, keep_input=True)

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/server/strategy/dp_adaptive_clipping.py

@@ -200,7 +200,7 @@ class DifferentialPrivacyServerSideAdaptiveClipping(Strategy):
 
             log(
                 INFO,
-                "aggregate_fit: parameters are clipped by value: %s.",
+                "aggregate_fit: parameters are clipped by value: %.4f.",
                 self.clipping_norm,
             )
 
@@ -234,7 +234,8 @@ class DifferentialPrivacyServerSideAdaptiveClipping(Strategy):
             )
             log(
                 INFO,
-                "aggregate_fit: central DP noise with standard deviation: %s added to parameters.",
+                "aggregate_fit: central DP noise with "
+                "standard deviation: %.4f added to parameters.",
                 compute_stdv(
                     self.noise_multiplier, self.clipping_norm, self.num_sampled_clients
                 ),
@@ -424,7 +425,8 @@ class DifferentialPrivacyClientSideAdaptiveClipping(Strategy):
             )
             log(
                 INFO,
-                "aggregate_fit: central DP noise with standard deviation: %s added to parameters.",
+                "aggregate_fit: central DP noise with "
+                "standard deviation: %.4f added to parameters.",
                 compute_stdv(
                     self.noise_multiplier, self.clipping_norm, self.num_sampled_clients
                 ),

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/server/strategy/dp_fixed_clipping.py

@@ -158,7 +158,7 @@ class DifferentialPrivacyServerSideFixedClipping(Strategy):
             )
             log(
                 INFO,
-                "aggregate_fit: parameters are clipped by value: %s.",
+                "aggregate_fit: parameters are clipped by value: %.4f.",
                 self.clipping_norm,
             )
             # Convert back to parameters
@@ -180,7 +180,8 @@ class DifferentialPrivacyServerSideFixedClipping(Strategy):
 
             log(
                 INFO,
-                "aggregate_fit: central DP noise with standard deviation: %s added to parameters.",
+                "aggregate_fit: central DP noise with "
+                "standard deviation: %.4f added to parameters.",
                 compute_stdv(
                     self.noise_multiplier, self.clipping_norm, self.num_sampled_clients
                 ),
@@ -337,11 +338,13 @@ class DifferentialPrivacyClientSideFixedClipping(Strategy):
             )
             log(
                 INFO,
-                "aggregate_fit: central DP noise with standard deviation: %s added to parameters.",
+                "aggregate_fit: central DP noise with "
+                "standard deviation: %.4f added to parameters.",
                 compute_stdv(
                     self.noise_multiplier, self.clipping_norm, self.num_sampled_clients
                 ),
             )
+
         return aggregated_params, metrics
 
     def aggregate_evaluate(

{flwr_nightly-1.9.0.dev20240430 → flwr_nightly-1.9.0.dev20240501}/src/py/flwr/simulation/__init__.py

@@ -17,7 +17,7 @@
 
 import importlib
 
-from flwr.simulation.run_simulation import run_simulation, run_simulation_from_cli
+from flwr.simulation.run_simulation import run_simulation
 
 is_ray_installed = importlib.util.find_spec("ray") is not None
 
@@ -36,4 +36,4 @@ To install the necessary dependencies, install `flwr` with the `simulation` extr
         raise ImportError(RAY_IMPORT_ERROR)
 
 
-__all__ = ["start_simulation", "run_simulation_from_cli", "run_simulation"]
+__all__ = ["start_simulation", "run_simulation"]

flwr_nightly-1.9.0.dev20240430/src/py/flwr/cli/new/templates/app/code/client.tensorflow.py.tpl

@@ -1,57 +0,0 @@
-"""$project_name: A Flower / TensorFlow app."""
-
-import os
-
-import tensorflow as tf
-from flwr.client import ClientApp, NumPyClient
-from flwr_datasets import FederatedDataset
-
-
-os.environ["TF_CPP_MIN_LOG_LEVEL"] = "3"
-
-# Define Flower client
-class FlowerClient(NumPyClient):
-    def __init__(self, model, train_data, test_data):
-        self.model = model
-        self.x_train, self.y_train = train_data
-        self.x_test, self.y_test = test_data
-        
-    def get_parameters(self, config):
-        return self.model.get_weights()
-
-    def fit(self, parameters, config):
-        self.model.set_weights(parameters)
-        self.model.fit(self.x_train, self.y_train, epochs=1, batch_size=32, verbose=0)
-        return self.model.get_weights(), len(self.x_train), {}
-
-    def evaluate(self, parameters, config):
-        self.model.set_weights(parameters)
-        loss, accuracy = self.model.evaluate(self.x_test, self.y_test, verbose=0)
-        return loss, len(self.x_test), {"accuracy": accuracy}
-
-
-fds = FederatedDataset(dataset="cifar10", partitioners={"train": 2})
-
-def client_fn(cid: str):
-    """Create and return an instance of Flower `Client`."""
-
-    # Load model and data (MobileNetV2, CIFAR-10)
-    model = tf.keras.applications.MobileNetV2((32, 32, 3), classes=10, weights=None)
-    model.compile("adam", "sparse_categorical_crossentropy", metrics=["accuracy"])
-
-    # Download and partition dataset
-    partition = fds.load_partition(int(cid), "train")
-    partition.set_format("numpy")
-
-    # Divide data on each node: 80% train, 20% test
-    partition = partition.train_test_split(test_size=0.2, seed=42)
-    train_data = partition["train"]["img"] / 255.0, partition["train"]["label"]
-    test_data = partition["test"]["img"] / 255.0, partition["test"]["label"]
-
-    return FlowerClient(model, train_data, test_data).to_client()
-
-
-# Flower ClientApp
-app = ClientApp(
-    client_fn=client_fn,
-)