flwr-nightly 1.5.0.dev20230614__py3-none-any.whl → 1.5.0.dev20230615__py3-none-any.whl

flwr/client/dpfedavg_numpy_client.py

@@ -33,14 +33,82 @@ class DPFedAvgNumPyClient(NumPyClient):
         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)
@@ -80,4 +148,33 @@ class DPFedAvgNumPyClient(NumPyClient):
     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/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/server/state/in_memory_state.py

@@ -158,9 +158,17 @@ class InMemoryState(State):
             del self.task_res_store[task_id]
 
     def num_task_ins(self) -> int:
+        """Calculate the number of task_ins in store.
+
+        This includes delivered but not yet deleted task_ins.
+        """
         return len(self.task_ins_store)
 
     def num_task_res(self) -> int:
+        """Calculate the number of task_res in store.
+
+        This includes delivered but not yet deleted task_res.
+        """
         return len(self.task_res_store)
 
     def register_node(self, node_id: int) -> None:

flwr/server/strategy/dpfedavg_adaptive.py

@@ -113,6 +113,7 @@ class DPFedAvgAdaptive(DPFedAvgFixed):
         results: List[Tuple[ClientProxy, FitRes]],
         failures: List[Union[Tuple[ClientProxy, FitRes], BaseException]],
     ) -> Tuple[Optional[Parameters], Dict[str, Scalar]]:
+        """Aggregate training results as in DPFedAvgFixed and update clip norms."""
         if failures:
             return None, {}
         new_global_model = super().aggregate_fit(server_round, results, failures)

flwr/server/strategy/dpfedavg_fixed.py

@@ -67,12 +67,34 @@ class DPFedAvgFixed(Strategy):
     def initialize_parameters(
         self, client_manager: ClientManager
     ) -> Optional[Parameters]:
+        """Initialize global model parameters using given strategy."""
         return self.strategy.initialize_parameters(client_manager)
 
     def configure_fit(
         self, server_round: int, parameters: Parameters, client_manager: ClientManager
     ) -> List[Tuple[ClientProxy, FitIns]]:
-        """Configure the next round of training."""
+        """Configure the next round of training incorporating Differential Privacy (DP).
+
+        Configuration of the next training round includes information related to DP,
+        such as clip norm and noise stddev.
+
+        Parameters
+        ----------
+        server_round : int
+            The current round of federated learning.
+        parameters : Parameters
+            The current (global) model parameters.
+        client_manager : ClientManager
+            The client manager which holds all currently connected clients.
+
+        Returns
+        -------
+        fit_configuration : List[Tuple[ClientProxy, FitIns]]
+            A list of tuples. Each tuple in the list identifies a `ClientProxy` and the
+            `FitIns` for this particular `ClientProxy`. If a particular `ClientProxy`
+            is not included in this list, it means that this `ClientProxy`
+            will not participate in the next round of federated learning.
+        """
         additional_config = {"dpfedavg_clip_norm": self.clip_norm}
         if not self.server_side_noising:
             additional_config[
@@ -91,6 +113,26 @@ class DPFedAvgFixed(Strategy):
     def configure_evaluate(
         self, server_round: int, parameters: Parameters, client_manager: ClientManager
     ) -> List[Tuple[ClientProxy, EvaluateIns]]:
+        """Configure the next round of evaluation using the specified strategy.
+
+        Parameters
+        ----------
+        server_round : int
+            The current round of federated learning.
+        parameters : Parameters
+            The current (global) model parameters.
+        client_manager : ClientManager
+            The client manager which holds all currently connected clients.
+
+        Returns
+        -------
+        evaluate_configuration : List[Tuple[ClientProxy, EvaluateIns]]
+            A list of tuples. Each tuple in the list identifies a `ClientProxy` and the
+            `EvaluateIns` for this particular `ClientProxy`. If a particular
+            `ClientProxy` is not included in this list, it means that this
+            `ClientProxy` will not participate in the next round of federated
+            evaluation.
+        """
         return self.strategy.configure_evaluate(
             server_round, parameters, client_manager
         )
@@ -101,6 +143,7 @@ class DPFedAvgFixed(Strategy):
         results: List[Tuple[ClientProxy, FitRes]],
         failures: List[Union[Tuple[ClientProxy, FitRes], BaseException]],
     ) -> Tuple[Optional[Parameters], Dict[str, Scalar]]:
+        """Aggregate training results using unweighted aggregation."""
         if failures:
             return None, {}
         # Forcing unweighted aggregation, as in https://arxiv.org/abs/1905.03871.
@@ -121,9 +164,11 @@ class DPFedAvgFixed(Strategy):
         results: List[Tuple[ClientProxy, EvaluateRes]],
         failures: List[Union[Tuple[ClientProxy, EvaluateRes], BaseException]],
     ) -> Tuple[Optional[float], Dict[str, Scalar]]:
+        """Aggregate evaluation losses using the given strategy."""
         return self.strategy.aggregate_evaluate(server_round, results, failures)
 
     def evaluate(
         self, server_round: int, parameters: Parameters
     ) -> Optional[Tuple[float, Dict[str, Scalar]]]:
+        """Evaluate model parameters using an evaluation function from the strategy."""
         return self.strategy.evaluate(server_round, parameters)

flwr/server/utils/tensorboard.py

@@ -73,8 +73,7 @@ def tensorboard(logdir: str) -> Callable[[Strategy], Strategy]:
         """Return overloaded Strategy Wrapper."""
 
         class TBWrapper(strategy_class):  # type: ignore
-            """Strategy wrapper which hooks into some methods for TensorBoard
-            logging."""
+            """Strategy wrapper that hooks into some methods for TensorBoard logging."""
 
             def aggregate_evaluate(
                 self,

{flwr_nightly-1.5.0.dev20230614.dist-info → flwr_nightly-1.5.0.dev20230615.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.5.0.dev20230614
+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.dev20230614.dist-info → flwr_nightly-1.5.0.dev20230615.dist-info}/RECORD

@@ -2,7 +2,7 @@ flwr/__init__.py,sha256=kuBqHEfjUCwKVS60acHjXOEQhxfqg5S3ldIh3FJ4VYk,952
 flwr/client/__init__.py,sha256=UkiAEKds0mtpmVTZvvpJHKfTC_VWzflwL5IQUdbAf6U,1164
 flwr/client/app.py,sha256=0pRrsuqThwOGFv8tBEV-7YU_1t4mLQCMCVG2nGzyvq0,13835
 flwr/client/client.py,sha256=-jPs28BQC3h5QFahPEHn1zHdiy6fTyk7TG9NS5Nw_e8,7677
-flwr/client/dpfedavg_numpy_client.py,sha256=CGGFLuUCquVSGYm2ap0PjRapJ3A_h5uuO8NYr3k-P3E,3351
+flwr/client/dpfedavg_numpy_client.py,sha256=5mOZuwdnwYtoytlxD0RsVLcIENkFM7a5amScSBzVpDw,7209
 flwr/client/grpc_client/__init__.py,sha256=svcQQhSaBJujNfZevHBsQrMKmqggpq-3I8Y6FUm_trM,728
 flwr/client/grpc_client/connection.py,sha256=SyQRnlfdXkuoc9aYXbwRU6GlPDwmNB5O_u_JMxCzO6Q,4293
 flwr/client/grpc_rere_client/__init__.py,sha256=9v4H6EumqwZePsY9icP0WdVSJ4UzH1t9MRyYX-a0--Q,745
@@ -28,7 +28,7 @@ flwr/common/version.py,sha256=lSE8kmuIEtB4E9Es2JmLi0W6CMn3YB74L_-VQyGNknI,848
 flwr/driver/__init__.py,sha256=G9gvW60tQNN_yfXHr5gqwR5p_LSitE1r4I0GquysHZo,809
 flwr/driver/app.py,sha256=BSFOBQpIS_3gSpfZ-D_McuuYac0-gG13h7mBrz_QExI,4826
 flwr/driver/driver.py,sha256=XpdgPMLbWzKIPS3g0PW9o8eU8-rIFD5mMG3lTKs-eTI,3906
-flwr/driver/driver_client_manager.py,sha256=na1A8INKGGe3JbOdCwmeh9Tz3dN6NopOoJ5sgKJ62BA,4414
+flwr/driver/driver_client_manager.py,sha256=Xt4HxI88DVv7Oq1OPPtn0ceWJo2at_dc06nlmDYdL4Q,4877
 flwr/driver/driver_client_proxy.py,sha256=tpMb8Ti-OV0Qv-TwfCzG6Lt9IYRHE3JuZt3SnRKtV0k,5653
 flwr/proto/__init__.py,sha256=fg57BzxAeODasVkv19rCvp5UMA0Gh8E2HVhw3ietB6Q,676
 flwr/proto/driver_pb2.py,sha256=aQSzL3aUlyeazgt_JKfP64D-1pI1uz9QoCAlcH_2uNU,4663
@@ -76,14 +76,14 @@ flwr/server/fleet/rest_rere/rest_api.py,sha256=4FYkB7aGC7qR5Qmdgbkm_FzYW0pWw3EYp
 flwr/server/history.py,sha256=xI7LfjV67VQZkKoHRpzILG1zKb_a0pMyL2vpn15BsxM,4897
 flwr/server/server.py,sha256=amrh_Xpfkq8EQdnDubDn3NPyIuv8-SIm6wZ8bhdb9mE,15958
 flwr/server/state/__init__.py,sha256=jcTV_f7T8w72NWkAY9kNPFis-FOd3Zm5jLE3CRmvOkE,996
-flwr/server/state/in_memory_state.py,sha256=V7GSG-NFagV1NV954y9Jgt1Wm9E7ZozOnhQ2VQDgRl8,6516
+flwr/server/state/in_memory_state.py,sha256=jnnQ5xmXbOISUxud2XJZC2U5AAX2_8AOsoTR2QXkg28,6774
 flwr/server/state/sqlite_state.py,sha256=A25q1qioWo-_oP4ThM-CuLIH6FCTBRKPBKxbzn9_GAY,19296
 flwr/server/state/state.py,sha256=nIzCzAzNwPrfXTltn1sroG6JN-Ti0PJAE4Mhhhm7lzU,4833
 flwr/server/state/state_factory.py,sha256=nrHildx-4O6ko48TCHRwJSWg7ebAxCAqdENdcIlrSkA,1647
 flwr/server/strategy/__init__.py,sha256=_y7B6IAmP7e6m09yNLtS26M8wc8JQLmuezgsKpdgxV4,1667
 flwr/server/strategy/aggregate.py,sha256=lshQsPyTRx5VxxRGejLw1klsg4mtGcYQJtMVXJou3sY,6099
-flwr/server/strategy/dpfedavg_adaptive.py,sha256=rgEVeXAyOkq2L_l_hCC551Sy63-i9LMwpfxacd54an4,4507
-flwr/server/strategy/dpfedavg_fixed.py,sha256=PAyFGKUUf7-ynHxDHH5_up-HV3xb_W4UC6CdvofTH08,4866
+flwr/server/strategy/dpfedavg_adaptive.py,sha256=ZqcVBgA1YZ0JCsXbxkgHNCef9xG3Ri1MhZoA7Pxk6xI,4591
+flwr/server/strategy/dpfedavg_fixed.py,sha256=FCY0KaVvNZ81H-KN3HSujRG44Tu8uVOnGeDg-7v4dG0,6932
 flwr/server/strategy/fault_tolerant_fedavg.py,sha256=nuDBxqXjH4Qo9BMgsxnvFMo3MNE-xsxdteVw-1QqSg4,5830
 flwr/server/strategy/fedadagrad.py,sha256=Z-L2-C0IpdBO_sypKXakTMPdKNYOEHEoNXylky3Uwq4,6722
 flwr/server/strategy/fedadam.py,sha256=sjpIfZankmvEBOZMiWvO4GlynxtoqMtaSiGzl2O4EpE,7004
@@ -100,14 +100,14 @@ flwr/server/strategy/krum.py,sha256=70aRw6_J2Ny9i8-kEOAyVLnONn-oGefgM0Ks5OHLa0A,
 flwr/server/strategy/qfedavg.py,sha256=V9p0jRLnEbQaO4UDNB7675XQfGXrbw_E-_p-Lq6LrzE,10131
 flwr/server/strategy/strategy.py,sha256=wrlVh4Kam-B5Np1Q7NxMNk6lF6EnwhUowjovVsUKPWo,7484
 flwr/server/utils/__init__.py,sha256=I3aifvGufkoK1Od-w1Xz_nicgAYllqXScQiRU6A5xvA,901
-flwr/server/utils/tensorboard.py,sha256=DP0jkyMuKMDar_fdUlummwu1jEY9iGBGkX7gt66PFu0,5082
+flwr/server/utils/tensorboard.py,sha256=VNxz2BvOMu4q1Y5s-Mgoweb63YvYb0Hqu5hhMJK3SDU,5069
 flwr/server/utils/validator.py,sha256=hp4PU5FB-W68HaFT8fLLWba-ftGhfTBB880Opes_pok,4940
 flwr/simulation/__init__.py,sha256=ZtAt5bMbbp9IJp1QQOhACN6_qhSPDtGmHF8gypUOZ9s,1271
 flwr/simulation/app.py,sha256=vYnyaX9pjAYAosFtciSunUYLY7UQ15nBhOFZt8mW45Q,7826
 flwr/simulation/ray_transport/__init__.py,sha256=eJ3pijYkI7XhbX2rLu6FBGTo8hZkFL8RSj4twhApOGw,727
 flwr/simulation/ray_transport/ray_client_proxy.py,sha256=EE11BBsvM1zOGfQK1ilpWXTPyaJrgH4ehDN3XSe1rsw,5535
-flwr_nightly-1.5.0.dev20230614.dist-info/METADATA,sha256=gcGfIFsPaVa--eAcfy7cwAqKuu9DA6psxd4sMb57rg0,12838
-flwr_nightly-1.5.0.dev20230614.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-flwr_nightly-1.5.0.dev20230614.dist-info/entry_points.txt,sha256=1uLlD5tIunkzALMfMWnqjdE_D5hRUX_I1iMmOMv6tZI,181
-flwr_nightly-1.5.0.dev20230614.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
-flwr_nightly-1.5.0.dev20230614.dist-info/RECORD,,
+flwr_nightly-1.5.0.dev20230615.dist-info/METADATA,sha256=9TIY9A0TWNWC8o0GeAMW1uhVfAJ_2_tw6ZEG5HbAMKM,12838
+flwr_nightly-1.5.0.dev20230615.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+flwr_nightly-1.5.0.dev20230615.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+flwr_nightly-1.5.0.dev20230615.dist-info/entry_points.txt,sha256=1uLlD5tIunkzALMfMWnqjdE_D5hRUX_I1iMmOMv6tZI,181
+flwr_nightly-1.5.0.dev20230615.dist-info/RECORD,,