flwr-nightly 1.5.0.dev20230608__tar.gz → 1.5.0.dev20230615__tar.gz

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.5.0.dev20230608
+Version: 1.5.0.dev20230615
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.dev
 License: Apache-2.0

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.5.0-dev20230608"
+version = "1.5.0-dev20230615"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.dev>"]
@@ -152,3 +152,7 @@ disallow_untyped_calls = false
 module = "torch.*"
 follow_imports = "skip"
 follow_imports_for_stubs = true
+
+[tool.docformatter]
+wrap-summaries = 88
+wrap-descriptions = 88

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/setup.py

@@ -52,7 +52,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'flwr-nightly',
-    'version': '1.5.0.dev20230608',
+    'version': '1.5.0.dev20230615',
     'description': 'Flower: A Friendly Federated Learning Framework',
     'long_description': '# Flower: A Friendly Federated Learning Framework\n\n<p align="center">\n  <a href="https://flower.dev/">\n    <img src="https://flower.dev/_next/image/?url=%2F_next%2Fstatic%2Fmedia%2Fflower_white_border.c2012e70.png&w=640&q=75" width="140px" alt="Flower Website" />\n  </a>\n</p>\n<p align="center">\n    <a href="https://flower.dev/">Website</a> |\n    <a href="https://flower.dev/blog">Blog</a> |\n    <a href="https://flower.dev/docs/">Docs</a> |\n    <a href="https://flower.dev/conf/flower-summit-2022">Conference</a> |\n    <a href="https://flower.dev/join-slack">Slack</a>\n    <br /><br />\n</p>\n\n[![GitHub license](https://img.shields.io/github/license/adap/flower)](https://github.com/adap/flower/blob/main/LICENSE)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/adap/flower/blob/main/CONTRIBUTING.md)\n![Build](https://github.com/adap/flower/actions/workflows/flower.yml/badge.svg)\n![Downloads](https://pepy.tech/badge/flwr)\n[![Slack](https://img.shields.io/badge/Chat-Slack-red)](https://flower.dev/join-slack)\n\nFlower (`flwr`) is a framework for building federated learning systems. The\ndesign of Flower is based on a few guiding principles:\n\n* **Customizable**: Federated learning systems vary wildly from one use case to\n  another. Flower allows for a wide range of different configurations depending\n  on the needs of each individual use case.\n\n* **Extendable**: Flower originated from a research project at the University of\n  Oxford, so it was built with AI research in mind. Many components can be\n  extended and overridden to build new state-of-the-art systems.\n\n* **Framework-agnostic**: Different machine learning frameworks have different\n  strengths. Flower can be used with any machine learning framework, for\n  example, [PyTorch](https://pytorch.org),\n  [TensorFlow](https://tensorflow.org), [Hugging Face Transformers](https://huggingface.co/), [PyTorch Lightning](https://pytorchlightning.ai/), [MXNet](https://mxnet.apache.org/), [scikit-learn](https://scikit-learn.org/), [JAX](https://jax.readthedocs.io/), [TFLite](https://tensorflow.org/lite/), [fastai](https://www.fast.ai/), [Pandas](https://pandas.pydata.org/\n) for federated analytics, or even raw [NumPy](https://numpy.org/)\n  for users who enjoy computing gradients by hand.\n\n* **Understandable**: Flower is written with maintainability in mind. The\n  community is encouraged to both read and contribute to the codebase.\n\nMeet the Flower community on [flower.dev](https://flower.dev)!\n\n## Federated Learning Tutorial\n\nFlower\'s goal is to make federated learning accessible to everyone. This series of tutorials introduces the fundamentals of federated learning and how to implement them in Flower.\n\n0. **What is Federated Learning?**\n\n   [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial/Flower-0-What-is-FL.ipynb) (or open the [Jupyter Notebook](https://github.com/adap/flower/blob/main/doc/source/tutorial/Flower-0-What-is-FL.ipynb))\n\n1. **An Introduction to Federated Learning**\n\n   [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial/Flower-1-Intro-to-FL-PyTorch.ipynb) (or open the [Jupyter Notebook](https://github.com/adap/flower/blob/main/doc/source/tutorial/Flower-1-Intro-to-FL-PyTorch.ipynb))\n\n2. **Using Strategies in Federated Learning**\n\n   [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial/Flower-2-Strategies-in-FL-PyTorch.ipynb) (or open the [Jupyter Notebook](https://github.com/adap/flower/blob/main/doc/source/tutorial/Flower-2-Strategies-in-FL-PyTorch.ipynb))\n   \n3. **Building Strategies for Federated Learning**\n\n   [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial/Flower-3-Building-a-Strategy-PyTorch.ipynb) (or open the [Jupyter Notebook](https://github.com/adap/flower/blob/main/doc/source/tutorial/Flower-3-Building-a-Strategy-PyTorch.ipynb))\n   \n4. **Custom Clients for Federated Learning**\n\n   [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial/Flower-4-Client-and-NumPyClient-PyTorch.ipynb) (or open the [Jupyter Notebook](https://github.com/adap/flower/blob/main/doc/source/tutorial/Flower-4-Client-and-NumPyClient-PyTorch.ipynb))\n\nStay tuned, more tutorials are coming soon. Topics include **Privacy and Security in Federated Learning**, and **Scaling Federated Learning**.\n\n## Documentation\n\n[Flower Docs](https://flower.dev/docs):\n* [Installation](https://flower.dev/docs/installation.html)\n* [Quickstart (TensorFlow)](https://flower.dev/docs/quickstart-tensorflow.html)\n* [Quickstart (PyTorch)](https://flower.dev/docs/quickstart-pytorch.html)\n* [Quickstart (Hugging Face [code example])](https://flower.dev/docs/quickstart-huggingface.html)\n* [Quickstart (PyTorch Lightning [code example])](https://flower.dev/docs/quickstart-pytorch-lightning.html)\n* [Quickstart (MXNet)](https://flower.dev/docs/example-mxnet-walk-through.html)\n* [Quickstart (Pandas)](https://flower.dev/docs/quickstart-pandas.html)\n* [Quickstart (fastai)](https://flower.dev/docs/quickstart-fastai.html)\n* [Quickstart (JAX)](https://github.com/adap/flower/tree/main/examples/quickstart_jax)\n* [Quickstart (scikit-learn)](https://github.com/adap/flower/tree/main/examples/sklearn-logreg-mnist)\n* [Quickstart (TFLite on Android [code example])](https://github.com/adap/flower/tree/main/examples/android)\n* [Quickstart (iOS)](https://flower.dev/docs/quickstart-ios.html)\n\n## Flower Baselines\n\nFlower Baselines is a collection of community-contributed experiments that reproduce the experiments performed in popular federated learning publications. Researchers can build on Flower Baselines to quickly evaluate new ideas:\n\n* [FedAvg](https://arxiv.org/abs/1602.05629):\n  * [MNIST](https://github.com/adap/flower/tree/main/baselines/flwr_baselines/publications/fedavg_mnist)\n* [FedProx](https://arxiv.org/abs/1812.06127):\n  * [MNIST](https://github.com/adap/flower/tree/main/baselines/flwr_baselines/publications/fedprox_mnist)\n* [FedBN: Federated Learning on non-IID Features via Local Batch Normalization](https://arxiv.org/abs/2102.07623):\n  * [Convergence Rate](https://github.com/adap/flower/tree/main/baselines/flwr_baselines/publications/fedbn/convergence_rate)\n* [Adaptive Federated Optimization](https://arxiv.org/abs/2003.00295):\n  * [CIFAR-10/100](https://github.com/adap/flower/tree/main/baselines/flwr_baselines/publications/adaptive_federated_optimization)\n\nCheck the Flower documentation to learn more: [Using Baselines](https://flower.dev/docs/using-baselines.html)\n\nThe Flower community loves contributions! Make your work more visible and enable others to build on it by contributing it as a baseline: [Contributing Baselines](https://flower.dev/docs/contributing-baselines.html)\n\n## Flower Usage Examples\n\nSeveral code examples show different usage scenarios of Flower (in combination with popular machine learning frameworks such as PyTorch or TensorFlow).\n\nQuickstart examples:\n\n* [Quickstart (TensorFlow)](https://github.com/adap/flower/tree/main/examples/quickstart_tensorflow)\n* [Quickstart (PyTorch)](https://github.com/adap/flower/tree/main/examples/quickstart_pytorch)\n* [Quickstart (Hugging Face)](https://github.com/adap/flower/tree/main/examples/quickstart_huggingface)\n* [Quickstart (PyTorch Lightning)](https://github.com/adap/flower/tree/main/examples/quickstart_pytorch_lightning)\n* [Quickstart (fastai)](https://github.com/adap/flower/tree/main/examples/quickstart_fastai)\n* [Quickstart (Pandas)](https://github.com/adap/flower/tree/main/examples/quickstart_pandas)\n* [Quickstart (MXNet)](https://github.com/adap/flower/tree/main/examples/quickstart_mxnet)\n* [Quickstart (JAX)](https://github.com/adap/flower/tree/main/examples/quickstart_jax)\n* [Quickstart (scikit-learn)](https://github.com/adap/flower/tree/main/examples/sklearn-logreg-mnist)\n* [Quickstart (TFLite on Android)](https://github.com/adap/flower/tree/main/examples/android)\n\nOther [examples](https://github.com/adap/flower/tree/main/examples):\n\n* [Raspberry Pi & Nvidia Jetson Tutorial](https://github.com/adap/flower/tree/main/examples/embedded_devices)\n* [Android & TFLite](https://github.com/adap/flower/tree/main/examples/android)\n* [PyTorch: From Centralized to Federated](https://github.com/adap/flower/tree/main/examples/pytorch_from_centralized_to_federated)\n* [MXNet: From Centralized to Federated](https://github.com/adap/flower/tree/main/examples/mxnet_from_centralized_to_federated)\n* [Advanced Flower with TensorFlow/Keras](https://github.com/adap/flower/tree/main/examples/advanced_tensorflow)\n* [Advanced Flower with PyTorch](https://github.com/adap/flower/tree/main/examples/advanced_pytorch)\n* Single-Machine Simulation of Federated Learning Systems ([PyTorch](https://github.com/adap/flower/tree/main/examples/simulation_pytorch)) ([Tensorflow](https://github.com/adap/flower/tree/main/examples/simulation_tensorflow))\n\n## Community\n\nFlower is built by a wonderful community of researchers and engineers. [Join Slack](https://flower.dev/join-slack) to meet them, [contributions](#contributing-to-flower) are welcome.\n\n<a href="https://github.com/adap/flower/graphs/contributors">\n  <img src="https://contrib.rocks/image?repo=adap/flower" />\n</a>\n\n## Citation\n\nIf you publish work that uses Flower, please cite Flower as follows: \n\n```bibtex\n@article{beutel2020flower,\n  title={Flower: A Friendly Federated Learning Research Framework},\n  author={Beutel, Daniel J and Topal, Taner and Mathur, Akhil and Qiu, Xinchi and Fernandez-Marques, Javier and Gao, Yan and Sani, Lorenzo and Kwing, Hei Li and Parcollet, Titouan and Gusmão, Pedro PB de and Lane, Nicholas D}, \n  journal={arXiv preprint arXiv:2007.14390},\n  year={2020}\n}\n```\n\nPlease also consider adding your publication to the list of Flower-based publications in the docs, just open a Pull Request.\n\n## Contributing to Flower\n\nWe welcome contributions. Please see [CONTRIBUTING.md](CONTRIBUTING.md) to get started!\n',
     'author': 'The Flower Authors',

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/client/app.py

@@ -150,7 +150,6 @@ def start_client(
     >>>     root_certificates=Path("/crts/root.pem").read_bytes(),
     >>> )
     """
-
     event(EventType.START_CLIENT_ENTER)
 
     # Parse IP address
@@ -278,7 +277,6 @@ def start_numpy_client(
     >>>     root_certificates=Path("/crts/root.pem").read_bytes(),
     >>> )
     """
-
     # Start
     start_client(
         server_address=server_address,
@@ -321,7 +319,6 @@ def _get_parameters(self: Client, ins: GetParametersIns) -> GetParametersRes:
 
 def _fit(self: Client, ins: FitIns) -> FitRes:
     """Refine the provided parameters using the locally held dataset."""
-
     # Deconstruct FitIns
     parameters: NDArrays = parameters_to_ndarrays(ins.parameters)
 

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/client/client.py

@@ -161,7 +161,6 @@ def maybe_call_get_properties(
     client: Client, get_properties_ins: GetPropertiesIns
 ) -> GetPropertiesRes:
     """Call `get_properties` if the client overrides it."""
-
     # Check if client overrides `get_properties`
     if not has_get_properties(client=client):
         # If client does not override `get_properties`, don't call it
@@ -182,7 +181,6 @@ def maybe_call_get_parameters(
     client: Client, get_parameters_ins: GetParametersIns
 ) -> GetParametersRes:
     """Call `get_parameters` if the client overrides it."""
-
     # Check if client overrides `get_parameters`
     if not has_get_parameters(client=client):
         # If client does not override `get_parameters`, don't call it
@@ -201,7 +199,6 @@ def maybe_call_get_parameters(
 
 def maybe_call_fit(client: Client, fit_ins: FitIns) -> FitRes:
     """Call `fit` if the client overrides it."""
-
     # Check if client overrides `fit`
     if not has_fit(client=client):
         # If client does not override `fit`, don't call it
@@ -222,7 +219,6 @@ def maybe_call_fit(client: Client, fit_ins: FitIns) -> FitRes:
 
 def maybe_call_evaluate(client: Client, evaluate_ins: EvaluateIns) -> EvaluateRes:
     """Call `evaluate` if the client overrides it."""
-
     # Check if client overrides `evaluate`
     if not has_evaluate(client=client):
         # If client does not override `evaluate`, don't call it

flwr_nightly-1.5.0.dev20230615/src/py/flwr/client/dpfedavg_numpy_client.py

@@ -0,0 +1,180 @@
+# Copyright 2020 Adap 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.
+# ==============================================================================
+"""Wrapper for configuring a Flower client for DP."""
+
+
+import copy
+from typing import Dict, Tuple
+
+import numpy as np
+
+from flwr.client.numpy_client import NumPyClient
+from flwr.common.dp import add_gaussian_noise, clip_by_l2
+from flwr.common.typing import Config, NDArrays, Scalar
+
+
+class DPFedAvgNumPyClient(NumPyClient):
+    """Wrapper for configuring a Flower client for DP."""
+
+    def __init__(self, client: NumPyClient) -> None:
+        super().__init__()
+        self.client = client
+
+    def get_properties(self, config: Config) -> Dict[str, Scalar]:
+        """Get client properties using the given Numpy client.
+
+        Parameters
+        ----------
+        config : Config
+            Configuration parameters requested by the server.
+            This can be used to tell the client which properties
+            are needed along with some Scalar attributes.
+
+        Returns
+        -------
+        properties : Dict[str, Scalar]
+            A dictionary mapping arbitrary string keys to values of type
+            bool, bytes, float, int, or str. It can be used to communicate
+            arbitrary property values back to the server.
+        """
+        return self.client.get_properties(config)
+
+    def get_parameters(self, config: Dict[str, Scalar]) -> NDArrays:
+        """Return the current local model parameters.
+
+        Parameters
+        ----------
+        config : Config
+            Configuration parameters requested by the server.
+            This can be used to tell the client which parameters
+            are needed along with some Scalar attributes.
+
+        Returns
+        -------
+        parameters : NDArrays
+            The local model parameters as a list of NumPy ndarrays.
+        """
+        return self.client.get_parameters(config)
+
+    def fit(
+        self, parameters: NDArrays, config: Dict[str, Scalar]
+    ) -> Tuple[NDArrays, int, Dict[str, Scalar]]:
+        """Train the provided parameters using the locally held dataset.
+
+        This method first updates the local model using the original parameters
+        provided. It then calculates the update by subtracting the original
+        parameters from the updated model. The update is then clipped by an L2
+        norm and Gaussian noise is added if specified by the configuration.
+
+        The update is then applied to the original parameters to obtain the
+        updated parameters which are returned along with the number of examples
+        used and metrics computed during the fitting process.
+
+        Parameters
+        ----------
+        parameters : NDArrays
+            The current (global) model parameters.
+        config : Dict[str, Scalar]
+            Configuration parameters which allow the
+            server to influence training on the client. It can be used to
+            communicate arbitrary values from the server to the client, for
+            example, to set the number of (local) training epochs.
+
+        Returns
+        -------
+        parameters : NDArrays
+            The locally updated model parameters.
+        num_examples : int
+            The number of examples used for training.
+        metrics : Dict[str, Scalar]
+            A dictionary mapping arbitrary string keys to values of type
+            bool, bytes, float, int, or str. It can be used to communicate
+            arbitrary values back to the server.
+
+        Raises
+        ------
+        Exception
+            If any required configuration parameters are not provided or are of
+            the wrong type.
+        """
+        original_params = copy.deepcopy(parameters)
+        # Getting the updated model from the wrapped client
+        updated_params, num_examples, metrics = self.client.fit(parameters, config)
+
+        # Update = updated model - original model
+        update = [np.subtract(x, y) for (x, y) in zip(updated_params, original_params)]
+
+        if "dpfedavg_clip_norm" not in config:
+            raise Exception("Clipping threshold not supplied by the server.")
+        if not isinstance(config["dpfedavg_clip_norm"], float):
+            raise Exception("Clipping threshold should be a floating point value.")
+
+        # Clipping
+        update, clipped = clip_by_l2(update, config["dpfedavg_clip_norm"])
+
+        if "dpfedavg_noise_stddev" in config:
+            if not isinstance(config["dpfedavg_noise_stddev"], float):
+                raise Exception(
+                    "Scale of noise to be added should be a floating point value."
+                )
+            # Noising
+            update = add_gaussian_noise(update, config["dpfedavg_noise_stddev"])
+
+        for i, _ in enumerate(original_params):
+            updated_params[i] = original_params[i] + update[i]
+
+        # Calculating value of norm indicator bit, required for adaptive clipping
+        if "dpfedavg_adaptive_clip_enabled" in config:
+            if not isinstance(config["dpfedavg_adaptive_clip_enabled"], bool):
+                raise Exception(
+                    "dpfedavg_adaptive_clip_enabled should be a boolean-valued flag."
+                )
+            metrics["dpfedavg_norm_bit"] = not clipped
+
+        return updated_params, num_examples, metrics
+
+    def evaluate(
+        self, parameters: NDArrays, config: Dict[str, Scalar]
+    ) -> Tuple[float, int, Dict[str, Scalar]]:
+        """Evaluate the provided parameters using the locally held dataset.
+
+        Parameters
+        ----------
+        parameters : NDArrays
+            The current (global) model parameters.
+        config : Dict[str, Scalar]
+            Configuration parameters which allow the server to influence
+            evaluation on the client. It can be used to communicate
+            arbitrary values from the server to the client, for example,
+            to influence the number of examples used for evaluation.
+
+        Returns
+        -------
+        loss : float
+            The evaluation loss of the model on the local dataset.
+        num_examples : int
+            The number of examples used for evaluation.
+        metrics : Dict[str, Scalar]
+            A dictionary mapping arbitrary string keys to values of
+            type bool, bytes, float, int, or str. It can be used to
+            communicate arbitrary values back to the server.
+
+        Warning
+        -------
+        The previous return type format (int, float, float) and the
+        extended format (int, float, float, Dict[str, Scalar]) have been
+        deprecated and removed since Flower 0.19.
+        """
+        return self.client.evaluate(parameters, config)

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/client/grpc_rere_client/connection.py

@@ -98,7 +98,6 @@ def grpc_request_response(
 
     def receive() -> Optional[ServerMessage]:
         """Receive next task from server."""
-
         # Request instructions (task) from server
         request = PullTaskInsRequest(
             node=Node(node_id=0, anonymous=True),
@@ -121,7 +120,6 @@ def grpc_request_response(
 
     def send(client_message_proto: ClientMessage) -> None:
         """Send task result back to server."""
-
         if state[KEY_TASK_INS] is None:
             log(ERROR, "No current TaskIns")
             return

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/client/message_handler/task_handler.py

@@ -26,7 +26,6 @@ def get_server_message(
     pull_task_ins_response: PullTaskInsResponse,
 ) -> Optional[Tuple[TaskIns, ServerMessage]]:
     """Get the first ServerMessage, if available."""
-
     # Extract a single ServerMessage from the response, if possible
     if len(pull_task_ins_response.task_ins_list) == 0:
         return None

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/client/numpy_client.py

@@ -25,7 +25,7 @@ class NumPyClient(ABC):
     """Abstract base class for Flower clients using NumPy."""
 
     def get_properties(self, config: Config) -> Dict[str, Scalar]:
-        """Returns a client's set of properties.
+        """Return a client's set of properties.
 
         Parameters
         ----------

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/client/rest_client/connection.py

@@ -79,7 +79,6 @@ def http_request_response(
     -------
     receive, send : Callable, Callable
     """
-
     log(
         WARN,
         """
@@ -113,7 +112,6 @@ def http_request_response(
 
     def receive() -> Optional[ServerMessage]:
         """Receive next task from server."""
-
         # Serialize ProtoBuf to bytes
         pull_task_ins_req_proto = PullTaskInsRequest(
             node=Node(node_id=0, anonymous=True),
@@ -170,7 +168,6 @@ def http_request_response(
 
     def send(client_message_proto: ClientMessage) -> None:
         """Send task result back to server."""
-
         if state[KEY_TASK_INS] is None:
             log(ERROR, "No current TaskIns")
             return

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/common/address.py

@@ -21,7 +21,7 @@ IPV6: int = 6
 
 
 def parse_address(address: str) -> Optional[Tuple[str, int, Optional[bool]]]:
-    """Parses an IP address into host, port, and version.
+    """Parse an IP address into host, port, and version.
 
     Parameters
     ----------

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/common/dp.py

@@ -31,8 +31,7 @@ def _get_update_norm(update: NDArrays) -> float:
 
 
 def add_gaussian_noise(update: NDArrays, std_dev: float) -> NDArrays:
-    """Adds iid Gaussian noise of the given standard deviation to each floating
-    point value in the update."""
+    """Add iid Gaussian noise to each floating point value in the update."""
     update_noised = [
         layer + np.random.normal(0, std_dev, layer.shape) for layer in update
     ]

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/common/grpc.py

@@ -31,7 +31,6 @@ def create_channel(
     max_message_length: int = GRPC_MAX_MESSAGE_LENGTH,
 ) -> grpc.Channel:
     """Create a gRPC channel, either secure or insecure."""
-
     # Possible options:
     # https://github.com/grpc/grpc/blob/v1.43.x/include/grpc/impl/codegen/grpc_types.h
     channel_options = [

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/common/logger.py

@@ -70,7 +70,6 @@ def configure(
     identifier: str, filename: Optional[str] = None, host: Optional[str] = None
 ) -> None:
     """Configure logging to file and/or remote log server."""
-
     # Create formatter
     string_to_input = f"{identifier} | %(levelname)s %(name)s %(asctime)s "
     string_to_input += "| %(filename)s:%(lineno)d | %(message)s"

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/common/serde.py

@@ -458,7 +458,6 @@ def metrics_from_proto(proto: Any) -> typing.Metrics:
 
 def scalar_to_proto(scalar: typing.Scalar) -> Scalar:
     """Serialize `Scalar` to ProtoBuf."""
-
     if isinstance(scalar, bool):
         return Scalar(bool=scalar)
 

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/driver/driver.py

@@ -75,7 +75,6 @@ class Driver:
 
     def get_nodes(self, req: driver_pb2.GetNodesRequest) -> driver_pb2.GetNodesResponse:
         """Get client IDs."""
-
         # Check if channel is open
         if self.stub is None:
             log(ERROR, ERROR_MESSAGE_DRIVER_NOT_CONNECTED)
@@ -89,7 +88,6 @@ class Driver:
         self, req: driver_pb2.PushTaskInsRequest
     ) -> driver_pb2.PushTaskInsResponse:
         """Schedule tasks."""
-
         # Check if channel is open
         if self.stub is None:
             log(ERROR, ERROR_MESSAGE_DRIVER_NOT_CONNECTED)
@@ -103,7 +101,6 @@ class Driver:
         self, req: driver_pb2.PullTaskResRequest
     ) -> driver_pb2.PullTaskResResponse:
         """Get task results."""
-
         # Check if channel is open
         if self.stub is None:
             log(ERROR, ERROR_MESSAGE_DRIVER_NOT_CONNECTED)

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/driver/driver_client_manager.py

@@ -85,10 +85,12 @@ class DriverClientManager(ClientManager):
         raise NotImplementedError("DriverClientManager.unregister is not implemented")
 
     def all(self) -> Dict[str, ClientProxy]:
+        """Return all available clients."""
         self._update_nodes()
         return self.clients
 
     def wait_for(self, num_clients: int, timeout: int = 86400) -> bool:
+        """Wait until at least `num_clients` are available."""
         start_time = time.time()
         while time.time() < start_time + timeout:
             self._update_nodes()
@@ -103,6 +105,7 @@ class DriverClientManager(ClientManager):
         min_num_clients: Optional[int] = None,
         criterion: Optional[Criterion] = None,
     ) -> List[ClientProxy]:
+        """Sample a number of Flower ClientProxy instances."""
         if min_num_clients is None:
             min_num_clients = num_clients
         self.wait_for(min_num_clients)
@@ -128,6 +131,12 @@ class DriverClientManager(ClientManager):
         return [self.clients[cid] for cid in sampled_cids]
 
     def _update_nodes(self) -> None:
+        """Update the nodes list in the client manager.
+
+        This method communicates with the associated driver to get all node ids. Each
+        node id is then converted into a `DriverClientProxy` instance and stored in the
+        `clients` dictionary with node id as key.
+        """
         get_nodes_res = self.driver.get_nodes(req=driver_pb2.GetNodesRequest())
         all_node_ids = get_nodes_res.node_ids
         for node_id in all_node_ids:

{flwr_nightly-1.5.0.dev20230608 → flwr_nightly-1.5.0.dev20230615}/src/py/flwr/driver/driver_client_proxy.py

@@ -40,7 +40,7 @@ class DriverClientProxy(ClientProxy):
     def get_properties(
         self, ins: common.GetPropertiesIns, timeout: Optional[float]
     ) -> common.GetPropertiesRes:
-        """Returns client's properties."""
+        """Return client's properties."""
         server_message_proto: transport_pb2.ServerMessage = (
             serde.server_message_to_proto(
                 server_message=common.ServerMessage(get_properties_ins=ins)

flwr_nightly-1.5.0.dev20230615/src/py/flwr/proto/task_pb2.py

@@ -0,0 +1,148 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: flwr/proto/task.proto
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import message as _message
+from google.protobuf import reflection as _reflection
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from flwr.proto import node_pb2 as flwr_dot_proto_dot_node__pb2
+from flwr.proto import transport_pb2 as flwr_dot_proto_dot_transport__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x15\x66lwr/proto/task.proto\x12\nflwr.proto\x1a\x15\x66lwr/proto/node.proto\x1a\x1a\x66lwr/proto/transport.proto\"\xbe\x02\n\x04Task\x12\"\n\x08producer\x18\x01 \x01(\x0b\x32\x10.flwr.proto.Node\x12\"\n\x08\x63onsumer\x18\x02 \x01(\x0b\x32\x10.flwr.proto.Node\x12\x12\n\ncreated_at\x18\x03 \x01(\t\x12\x14\n\x0c\x64\x65livered_at\x18\x04 \x01(\t\x12\x0b\n\x03ttl\x18\x05 \x01(\t\x12\x10\n\x08\x61ncestry\x18\x06 \x03(\t\x12)\n\x02sa\x18\x07 \x01(\x0b\x32\x1d.flwr.proto.SecureAggregation\x12<\n\x15legacy_server_message\x18\x65 \x01(\x0b\x32\x19.flwr.proto.ServerMessageB\x02\x18\x01\x12<\n\x15legacy_client_message\x18\x66 \x01(\x0b\x32\x19.flwr.proto.ClientMessageB\x02\x18\x01\"a\n\x07TaskIns\x12\x0f\n\x07task_id\x18\x01 \x01(\t\x12\x10\n\x08group_id\x18\x02 \x01(\t\x12\x13\n\x0bworkload_id\x18\x03 \x01(\t\x12\x1e\n\x04task\x18\x04 \x01(\x0b\x32\x10.flwr.proto.Task\"a\n\x07TaskRes\x12\x0f\n\x07task_id\x18\x01 \x01(\t\x12\x10\n\x08group_id\x18\x02 \x01(\t\x12\x13\n\x0bworkload_id\x18\x03 \x01(\t\x12\x1e\n\x04task\x18\x04 \x01(\x0b\x32\x10.flwr.proto.Task\"\xf3\x03\n\x05Value\x12\x10\n\x06\x64ouble\x18\x01 \x01(\x01H\x00\x12\x10\n\x06sint64\x18\x02 \x01(\x12H\x00\x12\x0e\n\x04\x62ool\x18\x03 \x01(\x08H\x00\x12\x10\n\x06string\x18\x04 \x01(\tH\x00\x12\x0f\n\x05\x62ytes\x18\x05 \x01(\x0cH\x00\x12\x33\n\x0b\x64ouble_list\x18\x15 \x01(\x0b\x32\x1c.flwr.proto.Value.DoubleListH\x00\x12\x33\n\x0bsint64_list\x18\x16 \x01(\x0b\x32\x1c.flwr.proto.Value.Sint64ListH\x00\x12/\n\tbool_list\x18\x17 \x01(\x0b\x32\x1a.flwr.proto.Value.BoolListH\x00\x12\x33\n\x0bstring_list\x18\x18 \x01(\x0b\x32\x1c.flwr.proto.Value.StringListH\x00\x12\x31\n\nbytes_list\x18\x19 \x01(\x0b\x32\x1b.flwr.proto.Value.BytesListH\x00\x1a\x1a\n\nDoubleList\x12\x0c\n\x04vals\x18\x01 \x03(\x01\x1a\x1a\n\nSint64List\x12\x0c\n\x04vals\x18\x01 \x03(\x12\x1a\x18\n\x08\x42oolList\x12\x0c\n\x04vals\x18\x01 \x03(\x08\x1a\x1a\n\nStringList\x12\x0c\n\x04vals\x18\x01 \x03(\t\x1a\x19\n\tBytesList\x12\x0c\n\x04vals\x18\x01 \x03(\x0c\x42\x07\n\x05value\"\xa0\x01\n\x11SecureAggregation\x12\x44\n\x0cnamed_values\x18\x01 \x03(\x0b\x32..flwr.proto.SecureAggregation.NamedValuesEntry\x1a\x45\n\x10NamedValuesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12 \n\x05value\x18\x02 \x01(\x0b\x32\x11.flwr.proto.Value:\x02\x38\x01\x62\x06proto3')
+
+
+
+_TASK = DESCRIPTOR.message_types_by_name['Task']
+_TASKINS = DESCRIPTOR.message_types_by_name['TaskIns']
+_TASKRES = DESCRIPTOR.message_types_by_name['TaskRes']
+_VALUE = DESCRIPTOR.message_types_by_name['Value']
+_VALUE_DOUBLELIST = _VALUE.nested_types_by_name['DoubleList']
+_VALUE_SINT64LIST = _VALUE.nested_types_by_name['Sint64List']
+_VALUE_BOOLLIST = _VALUE.nested_types_by_name['BoolList']
+_VALUE_STRINGLIST = _VALUE.nested_types_by_name['StringList']
+_VALUE_BYTESLIST = _VALUE.nested_types_by_name['BytesList']
+_SECUREAGGREGATION = DESCRIPTOR.message_types_by_name['SecureAggregation']
+_SECUREAGGREGATION_NAMEDVALUESENTRY = _SECUREAGGREGATION.nested_types_by_name['NamedValuesEntry']
+Task = _reflection.GeneratedProtocolMessageType('Task', (_message.Message,), {
+  'DESCRIPTOR' : _TASK,
+  '__module__' : 'flwr.proto.task_pb2'
+  # @@protoc_insertion_point(class_scope:flwr.proto.Task)
+  })
+_sym_db.RegisterMessage(Task)
+
+TaskIns = _reflection.GeneratedProtocolMessageType('TaskIns', (_message.Message,), {
+  'DESCRIPTOR' : _TASKINS,
+  '__module__' : 'flwr.proto.task_pb2'
+  # @@protoc_insertion_point(class_scope:flwr.proto.TaskIns)
+  })
+_sym_db.RegisterMessage(TaskIns)
+
+TaskRes = _reflection.GeneratedProtocolMessageType('TaskRes', (_message.Message,), {
+  'DESCRIPTOR' : _TASKRES,
+  '__module__' : 'flwr.proto.task_pb2'
+  # @@protoc_insertion_point(class_scope:flwr.proto.TaskRes)
+  })
+_sym_db.RegisterMessage(TaskRes)
+
+Value = _reflection.GeneratedProtocolMessageType('Value', (_message.Message,), {
+
+  'DoubleList' : _reflection.GeneratedProtocolMessageType('DoubleList', (_message.Message,), {
+    'DESCRIPTOR' : _VALUE_DOUBLELIST,
+    '__module__' : 'flwr.proto.task_pb2'
+    # @@protoc_insertion_point(class_scope:flwr.proto.Value.DoubleList)
+    })
+  ,
+
+  'Sint64List' : _reflection.GeneratedProtocolMessageType('Sint64List', (_message.Message,), {
+    'DESCRIPTOR' : _VALUE_SINT64LIST,
+    '__module__' : 'flwr.proto.task_pb2'
+    # @@protoc_insertion_point(class_scope:flwr.proto.Value.Sint64List)
+    })
+  ,
+
+  'BoolList' : _reflection.GeneratedProtocolMessageType('BoolList', (_message.Message,), {
+    'DESCRIPTOR' : _VALUE_BOOLLIST,
+    '__module__' : 'flwr.proto.task_pb2'
+    # @@protoc_insertion_point(class_scope:flwr.proto.Value.BoolList)
+    })
+  ,
+
+  'StringList' : _reflection.GeneratedProtocolMessageType('StringList', (_message.Message,), {
+    'DESCRIPTOR' : _VALUE_STRINGLIST,
+    '__module__' : 'flwr.proto.task_pb2'
+    # @@protoc_insertion_point(class_scope:flwr.proto.Value.StringList)
+    })
+  ,
+
+  'BytesList' : _reflection.GeneratedProtocolMessageType('BytesList', (_message.Message,), {
+    'DESCRIPTOR' : _VALUE_BYTESLIST,
+    '__module__' : 'flwr.proto.task_pb2'
+    # @@protoc_insertion_point(class_scope:flwr.proto.Value.BytesList)
+    })
+  ,
+  'DESCRIPTOR' : _VALUE,
+  '__module__' : 'flwr.proto.task_pb2'
+  # @@protoc_insertion_point(class_scope:flwr.proto.Value)
+  })
+_sym_db.RegisterMessage(Value)
+_sym_db.RegisterMessage(Value.DoubleList)
+_sym_db.RegisterMessage(Value.Sint64List)
+_sym_db.RegisterMessage(Value.BoolList)
+_sym_db.RegisterMessage(Value.StringList)
+_sym_db.RegisterMessage(Value.BytesList)
+
+SecureAggregation = _reflection.GeneratedProtocolMessageType('SecureAggregation', (_message.Message,), {
+
+  'NamedValuesEntry' : _reflection.GeneratedProtocolMessageType('NamedValuesEntry', (_message.Message,), {
+    'DESCRIPTOR' : _SECUREAGGREGATION_NAMEDVALUESENTRY,
+    '__module__' : 'flwr.proto.task_pb2'
+    # @@protoc_insertion_point(class_scope:flwr.proto.SecureAggregation.NamedValuesEntry)
+    })
+  ,
+  'DESCRIPTOR' : _SECUREAGGREGATION,
+  '__module__' : 'flwr.proto.task_pb2'
+  # @@protoc_insertion_point(class_scope:flwr.proto.SecureAggregation)
+  })
+_sym_db.RegisterMessage(SecureAggregation)
+_sym_db.RegisterMessage(SecureAggregation.NamedValuesEntry)
+
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  _TASK.fields_by_name['legacy_server_message']._options = None
+  _TASK.fields_by_name['legacy_server_message']._serialized_options = b'\030\001'
+  _TASK.fields_by_name['legacy_client_message']._options = None
+  _TASK.fields_by_name['legacy_client_message']._serialized_options = b'\030\001'
+  _SECUREAGGREGATION_NAMEDVALUESENTRY._options = None
+  _SECUREAGGREGATION_NAMEDVALUESENTRY._serialized_options = b'8\001'
+  _TASK._serialized_start=89
+  _TASK._serialized_end=407
+  _TASKINS._serialized_start=409
+  _TASKINS._serialized_end=506
+  _TASKRES._serialized_start=508
+  _TASKRES._serialized_end=605
+  _VALUE._serialized_start=608
+  _VALUE._serialized_end=1107
+  _VALUE_DOUBLELIST._serialized_start=963
+  _VALUE_DOUBLELIST._serialized_end=989
+  _VALUE_SINT64LIST._serialized_start=991
+  _VALUE_SINT64LIST._serialized_end=1017
+  _VALUE_BOOLLIST._serialized_start=1019
+  _VALUE_BOOLLIST._serialized_end=1043
+  _VALUE_STRINGLIST._serialized_start=1045
+  _VALUE_STRINGLIST._serialized_end=1071
+  _VALUE_BYTESLIST._serialized_start=1073
+  _VALUE_BYTESLIST._serialized_end=1098
+  _SECUREAGGREGATION._serialized_start=1110
+  _SECUREAGGREGATION._serialized_end=1270
+  _SECUREAGGREGATION_NAMEDVALUESENTRY._serialized_start=1201
+  _SECUREAGGREGATION_NAMEDVALUESENTRY._serialized_end=1270
+# @@protoc_insertion_point(module_scope)