flwr-nightly 1.10.0.dev20240619__tar.gz → 1.10.0.dev20240620__tar.gz

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.10.0.dev20240619
+Version: 1.10.0.dev20240620
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0
@@ -204,6 +204,7 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [Flower with KaplanMeierFitter from the lifelines library](https://github.com/adap/flower/tree/main/examples/federated-kaplan-meier-fitter)
 - [Sample Level Privacy with Opacus](https://github.com/adap/flower/tree/main/examples/opacus)
 - [Sample Level Privacy with TensorFlow-Privacy](https://github.com/adap/flower/tree/main/examples/tensorflow-privacy)
+- [Flower with a Tabular Dataset] (https://github.com/adap/flower/tree/main/examples/fl-tabular)
 
 ## Community
 

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/README.md

@@ -153,6 +153,7 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 - [Flower with KaplanMeierFitter from the lifelines library](https://github.com/adap/flower/tree/main/examples/federated-kaplan-meier-fitter)
 - [Sample Level Privacy with Opacus](https://github.com/adap/flower/tree/main/examples/opacus)
 - [Sample Level Privacy with TensorFlow-Privacy](https://github.com/adap/flower/tree/main/examples/tensorflow-privacy)
+- [Flower with a Tabular Dataset] (https://github.com/adap/flower/tree/main/examples/fl-tabular)
 
 ## Community
 

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.10.0.dev20240619"
+version = "1.10.0.dev20240620"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]
@@ -105,6 +105,7 @@ rope = "==1.11.0"
 semver = "==3.0.2"
 sphinx = "==6.2.1"
 sphinx-intl = "==2.2.0"
+sphinx-click = "==5.1.0"
 myst-parser = "==1.0.0"
 sphinx-design = "==0.5.0"
 sphinx-copybutton = "==0.5.2"

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/cli/app.py

@@ -15,6 +15,7 @@
 """Flower command line interface."""
 
 import typer
+from typer.main import get_command
 
 from .build import build
 from .example import example
@@ -37,5 +38,7 @@ app.command()(run)
 app.command()(build)
 app.command()(install)
 
+typer_click_object = get_command(app)
+
 if __name__ == "__main__":
     app()

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/cli/build.py

@@ -36,13 +36,9 @@ def build(
 ) -> str:
     """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`
+    You can run ``flwr build`` without any arguments to bundle the current directory,
+    or you can use ``--directory`` to build a specific directory:
+    ``flwr build --directory ./projects/flower-hello-world``.
     """
     if directory is None:
         directory = Path.cwd()

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/cli/new/new.py

@@ -190,7 +190,7 @@ def new(
     )
     print(
         typer.style(
-            f"	cd {project_name}\n" + "	pip install -e .\n	flwr run\n",
+            f"	cd {package_name}\n" + "	pip install -e .\n	flwr run\n",
             fg=typer.colors.BRIGHT_CYAN,
             bold=True,
         )

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/cli/run/run.py

@@ -41,7 +41,10 @@ class Engine(str, Enum):
 def run(
     engine: Annotated[
         Optional[Engine],
-        typer.Option(case_sensitive=False, help="The execution engine to run the app"),
+        typer.Option(
+            case_sensitive=False,
+            help="The engine to run FL with (currently only simulation is supported).",
+        ),
     ] = None,
     use_superexec: Annotated[
         bool,
@@ -87,12 +90,16 @@ def run(
 
     if engine == Engine.SIMULATION:
         num_supernodes = config["flower"]["engine"]["simulation"]["supernode"]["num"]
+        backend_config = config["flower"]["engine"]["simulation"].get(
+            "backend_config", None
+        )
 
         typer.secho("Starting run... ", fg=typer.colors.BLUE)
         _run_simulation(
             server_app_attr=server_app_ref,
             client_app_attr=client_app_ref,
             num_supernodes=num_supernodes,
+            backend_config=backend_config,
         )
     else:
         typer.secho(

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/client_app.py

@@ -1,4 +1,4 @@
-# Copyright 2023 Flower Labs GmbH. All Rights Reserved.
+# 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/dpfedavg_numpy_client.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2022 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/grpc_rere_client/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/grpc_rere_client/connection.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619/src/py/flwr/server/superlink/fleet → flwr_nightly-1.10.0.dev20240620/src/py/flwr/client/message_handler}/__init__.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-"""Flower fleet service."""
+"""Client-side message handling."""

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/message_handler/message_handler.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2022 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/mod/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2023 Flower Labs GmbH. All Rights Reserved.
+# 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/mod/secure_aggregation/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2023 Flower Labs GmbH. All Rights Reserved.
+# 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/mod/utils.py

@@ -1,4 +1,4 @@
-# Copyright 2023 Flower Labs GmbH. All Rights Reserved.
+# 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/rest_client/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/rest_client/connection.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/client/supernode/app.py

@@ -267,7 +267,7 @@ def _parse_args_run_supernode() -> argparse.ArgumentParser:
         "--flwr-dir",
         default=None,
         help="""The path containing installed Flower Apps.
-    By default, this value isequal to:
+    By default, this value is equal to:
 
         - `$FLWR_HOME/` if `$FLWR_HOME` is defined
         - `$XDG_DATA_HOME/.flwr/` if `$XDG_DATA_HOME` is defined

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/address.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/config.py

@@ -24,14 +24,16 @@ from flwr.cli.config_utils import validate_fields
 from flwr.common.constant import APP_DIR, FAB_CONFIG_FILE, FLWR_HOME
 
 
-def get_flwr_dir() -> Path:
+def get_flwr_dir(provided_path: Optional[str] = None) -> Path:
     """Return the Flower home directory based on env variables."""
-    return Path(
-        os.getenv(
-            FLWR_HOME,
-            f"{os.getenv('XDG_DATA_HOME', os.getenv('HOME'))}/.flwr",
+    if provided_path is None or not Path(provided_path).is_dir():
+        return Path(
+            os.getenv(
+                FLWR_HOME,
+                f"{os.getenv('XDG_DATA_HOME', os.getenv('HOME'))}/.flwr",
+            )
         )
-    )
+    return Path(provided_path).absolute()
 
 
 def get_project_dir(

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/constant.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/date.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/dp.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2022 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/grpc.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2022 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/secure_aggregation/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/secure_aggregation/crypto/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/secure_aggregation/crypto/shamir.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/secure_aggregation/crypto/symmetric_encryption.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/secure_aggregation/ndarrays_arithmetic.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/secure_aggregation/quantization.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/secure_aggregation/secaggplus_constants.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/common/secure_aggregation/secaggplus_utils.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# Copyright 2023 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.

flwr_nightly-1.10.0.dev20240620/src/py/flwr/common/version.py

@@ -0,0 +1,42 @@
+# Copyright 2023 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 package version helper."""
+
+import importlib.metadata as importlib_metadata
+from typing import Tuple
+
+
+def _check_package(name: str) -> Tuple[str, str]:
+    version: str = importlib_metadata.version(name)
+    return name, version
+
+
+def _version() -> Tuple[str, str]:
+    """Read and return Flower package name and version.
+
+    Returns
+    -------
+    package_name, package_version : Tuple[str, str]
+    """
+    for name in ["flwr", "flwr-nightly"]:
+        try:
+            return _check_package(name)
+        except importlib_metadata.PackageNotFoundError:
+            pass
+
+    return ("unknown", "unknown")
+
+
+package_name, package_version = _version()

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/server/compat/app.py

@@ -1,4 +1,4 @@
-# Copyright 2022 Flower Labs GmbH. All Rights Reserved.
+# 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/server/compat/app_utils.py

@@ -91,7 +91,7 @@ def _update_client_manager(
                 node_id=node_id,
                 driver=driver,
                 anonymous=False,
-                run_id=driver.run_id,  # type: ignore
+                run_id=driver.run.run_id,
             )
             if client_manager.register(client_proxy):
                 registered_nodes[node_id] = client_proxy

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/server/compat/driver_client_proxy.py

@@ -1,4 +1,4 @@
-# Copyright 2020 Flower Labs GmbH. All Rights Reserved.
+# 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.

{flwr_nightly-1.10.0.dev20240619 → flwr_nightly-1.10.0.dev20240620}/src/py/flwr/server/driver/driver.py

@@ -19,11 +19,17 @@ from abc import ABC, abstractmethod
 from typing import Iterable, List, Optional
 
 from flwr.common import Message, RecordSet
+from flwr.common.typing import Run
 
 
 class Driver(ABC):
     """Abstract base Driver class for the Driver API."""
 
+    @property
+    @abstractmethod
+    def run(self) -> Run:
+        """Run information."""
+
     @abstractmethod
     def create_message(  # pylint: disable=too-many-arguments
         self,