flwr-nightly 1.4.0.dev20230321__py3-none-any.whl → 1.4.0.dev20230323__py3-none-any.whl

flwr/__init__.py

@@ -16,10 +16,11 @@
 
 from flwr.common.version import package_version as _package_version
 
-from . import client, server, simulation
+from . import client, common, server, simulation
 
 __all__ = [
     "client",
+    "common",
     "server",
     "simulation",
 ]

flwr/client/app.py

@@ -49,7 +49,6 @@ from .numpy_client import has_evaluate as numpyclient_has_evaluate
 from .numpy_client import has_fit as numpyclient_has_fit
 from .numpy_client import has_get_parameters as numpyclient_has_get_parameters
 from .numpy_client import has_get_properties as numpyclient_has_get_properties
-from .rest_client.connection import http_request_response
 
 EXCEPTION_MESSAGE_WRONG_RETURN_TYPE_FIT = """
 NumPyClient.fit did not return a tuple with 3 elements.
@@ -81,6 +80,7 @@ Example
 ClientLike = Union[Client, NumPyClient]
 
 
+# pylint: disable=import-outside-toplevel
 def start_client(
     *,
     server_address: str,
@@ -138,7 +138,17 @@ def start_client(
     event(EventType.START_CLIENT_ENTER)
 
     # Use either gRPC bidirectional streaming or REST request/response
-    connection = http_request_response if rest else grpc_connection
+    if rest:
+        try:
+            from .rest_client.connection import http_request_response
+        except ImportError as missing_dep:
+            raise ImportError(
+                "To use the REST API you must install the "
+                "extra dependencies by running `pip install flwr['rest']`."
+            ) from missing_dep
+        connection = http_request_response
+    else:
+        connection = grpc_connection
     while True:
         sleep_duration: int = 0
         with connection(

flwr/client/rest_client/connection.py

@@ -19,7 +19,13 @@ from contextlib import contextmanager
 from logging import ERROR, INFO, WARN
 from typing import Callable, Dict, Iterator, Optional, Tuple
 
-import requests
+try:
+    import requests
+except ImportError as missing_dep:
+    raise ImportError(
+        "To use the REST API you must install the "
+        "extra dependencies by running `pip install flwr['rest']`."
+    ) from missing_dep
 
 from flwr.client.message_handler.task_handler import get_server_message
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH

flwr/server/app.py

@@ -25,7 +25,6 @@ from types import FrameType
 from typing import List, Optional, Tuple
 
 import grpc
-import uvicorn
 
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH, EventType, event
 from flwr.common.logger import log
@@ -40,7 +39,6 @@ from flwr.server.grpc_server.grpc_server import (
     start_grpc_server,
 )
 from flwr.server.history import History
-from flwr.server.rest_server.rest_api import app as fast_api_app
 from flwr.server.server import Server
 from flwr.server.state import StateFactory
 from flwr.server.strategy import FedAvg, Strategy
@@ -436,11 +434,22 @@ def _run_fleet_api_grpc_bidi(
     return fleet_grpc_server
 
 
+# pylint: disable=import-outside-toplevel
 def _run_fleet_api_rest(
     address: str,
     state_factory: StateFactory,
 ) -> None:
     """Run Driver API (REST-based)."""
+    try:
+        import uvicorn
+
+        from flwr.server.rest_server.rest_api import app as fast_api_app
+    except ImportError as missing_dep:
+        raise ImportError(
+            "To use the REST API you must install the "
+            "extra dependencies by running "
+            "`pip install flwr['rest']`."
+        ) from missing_dep
     log(INFO, "Starting Flower REST server")
 
     # See: https://www.starlette.io/applications/#accessing-the-app-instance

flwr/server/rest_server/rest_api.py

@@ -19,8 +19,14 @@ from logging import INFO
 from typing import List, Optional
 from uuid import UUID
 
-from fastapi import FastAPI, HTTPException, Request, Response
-from starlette.datastructures import Headers
+try:
+    from fastapi import FastAPI, HTTPException, Request, Response
+    from starlette.datastructures import Headers
+except ImportError as missing_dep:
+    raise ImportError(
+        "To use the REST API you must install the "
+        "extra dependencies by running `pip install flwr['rest']`."
+    ) from missing_dep
 
 from flwr.common.logger import log
 from flwr.proto.fleet_pb2 import (
@@ -33,10 +39,10 @@ from flwr.proto.fleet_pb2 import (
 from flwr.proto.task_pb2 import TaskIns, TaskRes
 from flwr.server.state import State
 
-app = FastAPI()
+app: FastAPI = FastAPI()
 
 
-@app.post("/api/v0/fleet/pull-task-ins", response_class=Response)
+@app.post("/api/v0/fleet/pull-task-ins", response_class=Response)  # type: ignore
 async def pull_task_ins(request: Request) -> Response:
     """Pull TaskIns."""
     _check_headers(request.headers)
@@ -72,7 +78,7 @@ async def pull_task_ins(request: Request) -> Response:
     )
 
 
-@app.post("/api/v0/fleet/push-task-res", response_class=Response)
+@app.post("/api/v0/fleet/push-task-res", response_class=Response)  # type: ignore
 async def push_task_res(request: Request) -> Response:  # Check if token is needed here
     """Push TaskRes."""
     _check_headers(request.headers)

flwr/server/strategy/fedxgb_nn_avg.py

@@ -37,9 +37,6 @@ from flwr.server.client_proxy import ClientProxy
 from .aggregate import aggregate
 from .fedavg import FedAvg
 
-# from xgboost import XGBClassifier, XGBRegressor  # pylint: disable=W0611
-
-
 WARNING_MIN_AVAILABLE_CLIENTS_TOO_LOW = """
 Setting `min_available_clients` lower than `min_fit_clients` or
 `min_evaluate_clients` can cause the server to fail when there are too few clients

{flwr_nightly-1.4.0.dev20230321.dist-info → flwr_nightly-1.4.0.dev20230323.dist-info}/METADATA

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

{flwr_nightly-1.4.0.dev20230321.dist-info → flwr_nightly-1.4.0.dev20230323.dist-info}/RECORD

@@ -1,6 +1,6 @@
-flwr/__init__.py,sha256=DguD_tpDL2vR1F6rRs-H3ms6Cmbep0GCCGxln84yftU,907
+flwr/__init__.py,sha256=KJDlgYheeHeI1KlSwlGbjtzO1mqLgtL5zYhthG9flFk,929
 flwr/client/__init__.py,sha256=UkiAEKds0mtpmVTZvvpJHKfTC_VWzflwL5IQUdbAf6U,1164
-flwr/client/app.py,sha256=zOZ3iMUz3T-7yiVQTaFwqjUoWPG2kKK32jaoFqL3d_s,11537
+flwr/client/app.py,sha256=TiCranPrEF20JptsY8ppUAVXkbcLHqFs4OzSciGsogc,11880
 flwr/client/client.py,sha256=pR7A0ojBD2YEqz0nokSxKtbyBxmUQ6qlFmiJ9SAW8jE,6503
 flwr/client/dpfedavg_numpy_client.py,sha256=CGGFLuUCquVSGYm2ap0PjRapJ3A_h5uuO8NYr3k-P3E,3351
 flwr/client/grpc_client/__init__.py,sha256=svcQQhSaBJujNfZevHBsQrMKmqggpq-3I8Y6FUm_trM,728
@@ -10,7 +10,7 @@ flwr/client/message_handler/message_handler.py,sha256=8gXodt8fIZLWTcUJQN63fE78MF
 flwr/client/message_handler/task_handler.py,sha256=KtNnwrHBd1aekkZeWsCfhO-BhYzBCYttwQl0InqpydM,1686
 flwr/client/numpy_client.py,sha256=znnXgAO_BY-QUCqnTiCUJKS9TUY_z0boZ6D1dNHCTUA,5100
 flwr/client/rest_client/__init__.py,sha256=FWlVEPeCUt2VHKQ9oEqmr8HtGruIegCO5iobBWvtb-Q,728
-flwr/client/rest_client/connection.py,sha256=4qOMlGztSQedxVyaCPb5yF4LEfuwzGrmhrMdbYcOWfo,7245
+flwr/client/rest_client/connection.py,sha256=JsMGhNc9ZAhqvh_rG9GtRDUzTKrMedZXNvt5lOkk3IM,7455
 flwr/common/__init__.py,sha256=JLu4NbyMb-zrvS-uXB9T5biOz1FzJa5h6xIvAu1QX14,2816
 flwr/common/date.py,sha256=CKvSQd-BcQ-Drr6VBOgjhUY8xTPmmIae-UeAW7HXODs,884
 flwr/common/dp.py,sha256=yifOQAOcLkVLt7XrOed1A_n_Ep2wKWZZz75PF2Wu8Jo,1827
@@ -46,7 +46,7 @@ flwr/proto/transport_pb2_grpc.py,sha256=vLN3EHtx2aEEMCO4f1Upu-l27BPzd3-5pV-u8wPc
 flwr/proto/transport_pb2_grpc.pyi,sha256=AGXf8RiIiW2J5IKMlm_3qT3AzcDa4F3P5IqUjve_esA,766
 flwr/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 flwr/server/__init__.py,sha256=4-X514k82t4YCNn66UqEWAnyxpHsOhX1j-NRIoUSzFs,1331
-flwr/server/app.py,sha256=tyQKbkNkcD2zf7Z-RQG2RIuBAQJPFybJoXlaHIjqU6I,17009
+flwr/server/app.py,sha256=yct8HwpA0bJdmAFENxpS1Euz3TwPUVurnA6-tzRoUuc,17313
 flwr/server/client_manager.py,sha256=OjJsIFos4kgol_knpGLa2IVCnFQJ1NuN-Qdr5BD6lYU,5941
 flwr/server/client_proxy.py,sha256=f0XnGrhaBzWsKN7j0KD288GqlebhVeJuSOMN38cD8Dc,2228
 flwr/server/criterion.py,sha256=9qfnUrDzgPhF8XIeBzJc1TrGrAmHOgAq24BEmZRN5BQ,1058
@@ -63,7 +63,7 @@ flwr/server/grpc_server/grpc_server.py,sha256=WiCurb8Juum4npU0I9Yz3GaBQX348d6Gdh
 flwr/server/grpc_server/ins_scheduler.py,sha256=HgxavTZx6ejBRrf-9jxCyEzS8sHDSA0imiwOvfeHdS8,6314
 flwr/server/history.py,sha256=i40ikSJcSLKT_W8DbxFuw6Zy8zx1xlNk0VfdMl-27dQ,4456
 flwr/server/rest_server/__init__.py,sha256=2rG5KG7xojkD8jgwUrJPrW4Nsdm_HhwZaQ1poy9x3KQ,728
-flwr/server/rest_server/rest_api.py,sha256=JsQIT9azBDf6G5smLaXU6TqJ3ZAQ6TUhVkjSEdp88z8,4385
+flwr/server/rest_server/rest_api.py,sha256=X8XmSR4GpzwdEhi0qAq564t5Nymw8pictGaUXi4fugU,4640
 flwr/server/server.py,sha256=X7hbDv39zaibGqAnUurmn9GrUYIP4pEea-p9dCpWXvg,15855
 flwr/server/state/__init__.py,sha256=2ZRkns3PkXxUi_WzjbDWfSkLvGK4RE8o3SHgSHgoclQ,995
 flwr/server/state/in_memory_state.py,sha256=Vsk0smDQ1pNLUeI5vIGkRLmTT-a0P6yOvyfMX8fDbv4,6521
@@ -83,8 +83,7 @@ flwr/server/strategy/fedavgm.py,sha256=mFhsEKkJHJQQPUXV5tMNOAckl6SJ41-DYFciomKmz
 flwr/server/strategy/fedmedian.py,sha256=MAWrLijv2_wDT9KZeYLJ6W_dnVQGKEp2DK40V6qLr78,6469
 flwr/server/strategy/fedopt.py,sha256=eXH1lIrjCNUEBkAs-ziULzwACxqcArooHWg9vlj9A3Q,5393
 flwr/server/strategy/fedprox.py,sha256=sjHbjl9iUr6MTbinCYj5q2R0Tmr9o0X_5JrsUWXa7cE,7708
-flwr/server/strategy/fedxgb.py,sha256=klRj1bykXK3iXYf7vJ1mqjw9BHsRKChzB9lK29j7Oq4,5373
-flwr/server/strategy/fedxgb_nn_avg.py,sha256=fNvV2Mi2o8HDyx0PRZ1czevfTAGlDB1iilyQGXby97M,7849
+flwr/server/strategy/fedxgb_nn_avg.py,sha256=-_iAjQtpmHUDC3qnvSEKdtazPHdW1V1mdaxyZfsj6NI,7772
 flwr/server/strategy/fedyogi.py,sha256=cC9WoIci3xmVs5HBGrkXHM0cpdMjApBWZS4d7-bKnZE,7044
 flwr/server/strategy/krum.py,sha256=PVfP8or0Rgj9TcxOzbngkYmm4VctX44NjOh1rs3Xmn8,7011
 flwr/server/strategy/qfedavg.py,sha256=2CJE7jvtVUcWpofBg8mG1w79PwBUoltY8wkyHMaFdag,10744
@@ -96,8 +95,8 @@ flwr/simulation/__init__.py,sha256=7gYUX6zr_yJd1wtv65xRHajBvurkfoPVXv66buUy4H8,1
 flwr/simulation/app.py,sha256=4UKy2OgCsTveHmtvIvqL2NsuL0OiIR4n1wDRLrugK88,7737
 flwr/simulation/ray_transport/__init__.py,sha256=eJ3pijYkI7XhbX2rLu6FBGTo8hZkFL8RSj4twhApOGw,727
 flwr/simulation/ray_transport/ray_client_proxy.py,sha256=WLO9ZagPCOyj-7e3x3gz-w0oiMVRdIhdHOkbrnmYvQo,5472
-flwr_nightly-1.4.0.dev20230321.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-flwr_nightly-1.4.0.dev20230321.dist-info/entry_points.txt,sha256=1uLlD5tIunkzALMfMWnqjdE_D5hRUX_I1iMmOMv6tZI,181
-flwr_nightly-1.4.0.dev20230321.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
-flwr_nightly-1.4.0.dev20230321.dist-info/METADATA,sha256=EAJHuM2CJqJZNqpECYbaHoHvNOokVkIH7Yk87eFvp3A,12839
-flwr_nightly-1.4.0.dev20230321.dist-info/RECORD,,
+flwr_nightly-1.4.0.dev20230323.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+flwr_nightly-1.4.0.dev20230323.dist-info/entry_points.txt,sha256=1uLlD5tIunkzALMfMWnqjdE_D5hRUX_I1iMmOMv6tZI,181
+flwr_nightly-1.4.0.dev20230323.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+flwr_nightly-1.4.0.dev20230323.dist-info/METADATA,sha256=X68ZNpzTS1Blep8olTcQaE6LIp_HCb-QdqU4zJjpib0,12839
+flwr_nightly-1.4.0.dev20230323.dist-info/RECORD,,

flwr/server/strategy/fedxgb.py

@@ -1,153 +0,0 @@
-# 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.
-# ==============================================================================
-"""Federated XGBoost utility functions."""
-
-from typing import Any, List, Optional, Tuple, Union
-
-import numpy as np
-import torch  # pylint: disable=E0401
-import xgboost as xgb  # pylint: disable=E0401
-from matplotlib import pyplot as plt  # pylint: disable=E0401
-from torch.utils.data import DataLoader, Dataset  # pylint: disable=E0401
-from xgboost import XGBClassifier, XGBRegressor  # pylint: disable=E0401
-
-from flwr.common.typing import NDArray
-
-
-def plot_xgbtree(tree: Union[XGBClassifier, XGBRegressor], n_tree: int) -> None:
-    """Visualize the built xgboost tree."""
-    xgb.plot_tree(tree, num_trees=n_tree)
-    plt.rcParams["figure.figsize"] = [50, 10]
-    plt.show()
-
-
-def construct_tree(
-    dataset: Dataset, label: NDArray, n_estimators: int, tree_type: str
-) -> Union[XGBClassifier, XGBRegressor]:
-    """Construct a xgboost tree form tabular dataset."""
-    if tree_type == "BINARY":
-        tree = xgb.XGBClassifier(
-            objective="binary:logistic",
-            learning_rate=0.1,
-            max_depth=8,
-            n_estimators=n_estimators,
-            subsample=0.8,
-            colsample_bylevel=1,
-            colsample_bynode=1,
-            colsample_bytree=1,
-            alpha=5,
-            gamma=5,
-            num_parallel_tree=1,
-            min_child_weight=1,
-        )
-
-    elif tree_type == "REG":
-        tree = xgb.XGBRegressor(
-            objective="reg:squarederror",
-            learning_rate=0.1,
-            max_depth=8,
-            n_estimators=n_estimators,
-            subsample=0.8,
-            colsample_bylevel=1,
-            colsample_bynode=1,
-            colsample_bytree=1,
-            alpha=5,
-            gamma=5,
-            num_parallel_tree=1,
-            min_child_weight=1,
-        )
-
-    tree.fit(dataset, label)
-    return tree
-
-
-def construct_tree_from_loader(
-    dataset_loader: DataLoader, n_estimators: int, tree_type: str
-) -> Union[XGBClassifier, XGBRegressor]:
-    """Construct a xgboost tree form tabular dataset loader."""
-    for dataset in dataset_loader:
-        data, label = dataset[0], dataset[1]
-    return construct_tree(data, label, n_estimators, tree_type)
-
-
-def single_tree_prediction(
-    tree: Union[XGBClassifier, XGBRegressor], n_tree: int, dataset: NDArray
-) -> Optional[NDArray]:
-    """Extract the prediction result of a single tree in the xgboost tree
-    ensemble."""
-    # How to access a single tree
-    # https://github.com/bmreiniger/datascience.stackexchange/blob/master/57905.ipynb
-    num_t = len(tree.get_booster().get_dump())
-    if n_tree > num_t:
-        print(
-            "The tree index to be extracted is larger than the total number of trees."
-        )
-        return None
-
-    return tree.predict(  # type: ignore
-        dataset, iteration_range=(n_tree, n_tree + 1), output_margin=True
-    )
-
-
-def tree_encoding(  # pylint: disable=R0914
-    trainloader: DataLoader,
-    client_trees: Union[
-        Tuple[XGBClassifier, int],
-        Tuple[XGBRegressor, int],
-        List[Union[Tuple[XGBClassifier, int], Tuple[XGBRegressor, int]]],
-    ],
-    client_tree_num: int,
-    client_num: int,
-) -> Optional[Tuple[NDArray, NDArray]]:
-    """Transform the tabular dataset into prediction results using the
-    aggregated xgboost tree ensembles from all clients."""
-    if trainloader is None:
-        return None
-
-    for local_dataset in trainloader:
-        x_train, y_train = local_dataset[0], local_dataset[1]
-
-    x_train_enc = np.zeros((x_train.shape[0], client_num * client_tree_num))
-    x_train_enc = np.array(x_train_enc, copy=True)
-
-    temp_trees: Any = None
-    if isinstance(client_trees, list) is False:
-        temp_trees = [client_trees[0]] * client_num
-    elif isinstance(client_trees, list) and len(client_trees) != client_num:
-        temp_trees = [client_trees[0][0]] * client_num
-    else:
-        cids = []
-        temp_trees = []
-        for i, _ in enumerate(client_trees):
-            temp_trees.append(client_trees[i][0])  # type: ignore
-            cids.append(client_trees[i][1])  # type: ignore
-        sorted_index = np.argsort(np.asarray(cids))
-        temp_trees = np.asarray(temp_trees)[sorted_index]
-
-    for i, _ in enumerate(temp_trees):
-        for j in range(client_tree_num):
-            x_train_enc[:, i * client_tree_num + j] = single_tree_prediction(
-                temp_trees[i], j, x_train
-            )
-
-    x_train_enc32: Any = np.float32(x_train_enc)
-    y_train32: Any = np.float32(y_train)
-
-    x_train_enc32, y_train32 = torch.from_numpy(
-        np.expand_dims(x_train_enc32, axis=1)  # type: ignore
-    ), torch.from_numpy(
-        np.expand_dims(y_train32, axis=-1)  # type: ignore
-    )
-    return x_train_enc32, y_train32