flwr-nightly 1.9.0.dev20240420__tar.gz → 1.9.0.dev20240423__tar.gz

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.9.0.dev20240420
+Version: 1.9.0.dev20240423
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.9.0.dev20240420"
+version = "1.9.0.dev20240423"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]
@@ -136,7 +136,7 @@ multi_line_output = 3
 include_trailing_comma = true
 force_grid_wrap = 0
 use_parentheses = true
-known_first_party = ["flwr", "flwr_experimental", "flwr_tool"]
+known_first_party = ["flwr", "flwr_tool"]
 
 [tool.black]
 line-length = 88
@@ -170,12 +170,6 @@ plugins = [
 ignore_missing_imports = true
 strict = true
 
-[[tool.mypy.overrides]]
-module = [
-    "flwr_experimental.*",
-]
-ignore_errors = true
-
 [[tool.mypy.overrides]]
 module = [
     "importlib.metadata.*",

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/src/py/flwr/cli/new/new.py

@@ -36,6 +36,7 @@ class MlFramework(str, Enum):
     NUMPY = "NumPy"
     PYTORCH = "PyTorch"
     TENSORFLOW = "TensorFlow"
+    SKLEARN = "sklearn"
 
 
 class TemplateNotFound(Exception):

flwr_nightly-1.9.0.dev20240423/src/py/flwr/cli/new/templates/app/code/client.sklearn.py.tpl

@@ -0,0 +1,94 @@
+"""$project_name: A Flower / Scikit-Learn app."""
+
+import warnings
+
+import numpy as np
+from flwr.client import NumPyClient, ClientApp
+from flwr_datasets import FederatedDataset
+from sklearn.linear_model import LogisticRegression
+from sklearn.metrics import log_loss
+
+
+def get_model_parameters(model):
+    if model.fit_intercept:
+        params = [
+            model.coef_,
+            model.intercept_,
+        ]
+    else:
+        params = [model.coef_]
+    return params
+
+
+def set_model_params(model, params):
+    model.coef_ = params[0]
+    if model.fit_intercept:
+        model.intercept_ = params[1]
+    return model
+
+
+def set_initial_params(model):
+    n_classes = 10  # MNIST has 10 classes
+    n_features = 784  # Number of features in dataset
+    model.classes_ = np.array([i for i in range(10)])
+
+    model.coef_ = np.zeros((n_classes, n_features))
+    if model.fit_intercept:
+        model.intercept_ = np.zeros((n_classes,))
+
+
+class FlowerClient(NumPyClient):
+    def __init__(self, model, X_train, X_test, y_train, y_test):
+        self.model = model
+        self.X_train = X_train
+        self.X_test = X_test
+        self.y_train = y_train
+        self.y_test = y_test
+
+    def get_parameters(self, config):
+        return get_model_parameters(self.model)
+
+    def fit(self, parameters, config):
+        set_model_params(self.model, parameters)
+
+        # Ignore convergence failure due to low local epochs
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore")
+            self.model.fit(self.X_train, self.y_train)
+
+        return get_model_parameters(self.model), len(self.X_train), {}
+
+    def evaluate(self, parameters, config):
+        set_model_params(self.model, parameters)
+
+        loss = log_loss(self.y_test, self.model.predict_proba(self.X_test))
+        accuracy = self.model.score(self.X_test, self.y_test)
+
+        return loss, len(self.X_test), {"accuracy": accuracy}
+
+fds = FederatedDataset(dataset="mnist", partitioners={"train": 2})
+
+def client_fn(cid: str):
+    dataset = fds.load_partition(int(cid), "train").with_format("numpy")
+
+    X, y = dataset["image"].reshape((len(dataset), -1)), dataset["label"]
+
+    # Split the on edge data: 80% train, 20% test
+    X_train, X_test = X[: int(0.8 * len(X))], X[int(0.8 * len(X)) :]
+    y_train, y_test = y[: int(0.8 * len(y))], y[int(0.8 * len(y)) :]
+
+    # Create LogisticRegression Model
+    model = LogisticRegression(
+        penalty="l2",
+        max_iter=1,  # local epoch
+        warm_start=True,  # prevent refreshing weights when fitting
+    )
+
+    # Setting initial parameters, akin to model.compile for keras models
+    set_initial_params(model)
+
+    return FlowerClient(model, X_train, X_test, y_train, y_test).to_client()
+
+
+# Flower ClientApp
+app = ClientApp(client_fn=client_fn)

flwr_nightly-1.9.0.dev20240423/src/py/flwr/cli/new/templates/app/code/server.sklearn.py.tpl

@@ -0,0 +1,17 @@
+"""$project_name: A Flower / Scikit-Learn app."""
+
+from flwr.server import ServerApp, ServerConfig
+from flwr.server.strategy import FedAvg
+
+
+strategy = FedAvg(
+    fraction_fit=1.0,
+    fraction_evaluate=1.0,
+    min_available_clients=2,
+)
+
+# Create ServerApp
+app = ServerApp(
+    config=ServerConfig(num_rounds=3),
+    strategy=strategy,
+)

flwr_nightly-1.9.0.dev20240423/src/py/flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "$project_name"
+version = "1.0.0"
+description = ""
+authors = [
+    { name = "The Flower Authors", email = "hello@flower.ai" },
+]
+license = {text = "Apache License (2.0)"}
+dependencies = [
+    "flwr[simulation]>=1.8.0,<2.0",
+    "flwr-datasets[vision]>=0.0.2,<1.0.0",
+    "scikit-learn>=1.1.1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["."]
+
+[flower.components]
+serverapp = "$project_name.server:app"
+clientapp = "$project_name.client:app"

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/src/py/flwr/client/supernode/app.py

@@ -28,12 +28,11 @@ def run_supernode() -> None:
 
     event(EventType.RUN_SUPERNODE_ENTER)
 
-    args = _parse_args_run_supernode().parse_args()
+    _ = _parse_args_run_supernode().parse_args()
 
     log(
         DEBUG,
-        "Flower will load ClientApp `%s`",
-        getattr(args, "client-app"),
+        "Flower SuperNode starting...",
     )
 
     # Graceful shutdown
@@ -48,7 +47,16 @@ def _parse_args_run_supernode() -> argparse.ArgumentParser:
         description="Start a Flower SuperNode",
     )
 
-    parse_args_run_client_app(parser=parser)
+    parser.add_argument(
+        "client-app",
+        nargs="?",
+        default="",
+        help="For example: `client:app` or `project.package.module:wrapper.app`. "
+        "This is optional and serves as the default ClientApp to be loaded when "
+        "the ServerApp does not specify `fab_id` and `fab_version`. "
+        "If not provided, defaults to an empty string.",
+    )
+    _parse_args_common(parser)
 
     return parser
 
@@ -59,6 +67,10 @@ def parse_args_run_client_app(parser: argparse.ArgumentParser) -> None:
         "client-app",
         help="For example: `client:app` or `project.package.module:wrapper.app`",
     )
+    _parse_args_common(parser)
+
+
+def _parse_args_common(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         "--insecure",
         action="store_true",

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/src/py/flwr/server/compat/app.py

@@ -29,7 +29,7 @@ from flwr.server.server import Server, init_defaults, run_fl
 from flwr.server.server_config import ServerConfig
 from flwr.server.strategy import Strategy
 
-from ..driver import Driver
+from ..driver import Driver, GrpcDriver
 from .app_utils import start_update_client_manager_thread
 
 DEFAULT_SERVER_ADDRESS_DRIVER = "[::]:9091"
@@ -114,7 +114,7 @@ def start_driver(  # pylint: disable=too-many-arguments, too-many-locals
         # Create the Driver
         if isinstance(root_certificates, str):
             root_certificates = Path(root_certificates).read_bytes()
-        driver = Driver(
+        driver = GrpcDriver(
             driver_service_address=address, root_certificates=root_certificates
         )
 

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/src/py/flwr/server/compat/driver_client_proxy.py

@@ -25,7 +25,7 @@ from flwr.common import serde
 from flwr.proto import driver_pb2, node_pb2, task_pb2  # pylint: disable=E0611
 from flwr.server.client_proxy import ClientProxy
 
-from ..driver.driver import GrpcDriverHelper
+from ..driver.grpc_driver import GrpcDriverHelper
 
 SLEEP_TIME = 1
 

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/src/py/flwr/server/driver/__init__.py

@@ -16,7 +16,10 @@
 
 
 from .driver import Driver
+from .grpc_driver import GrpcDriver, GrpcDriverHelper
 
 __all__ = [
     "Driver",
+    "GrpcDriver",
+    "GrpcDriverHelper",
 ]

flwr_nightly-1.9.0.dev20240420/src/py/flwr/server/driver/driver.py → flwr_nightly-1.9.0.dev20240423/src/py/flwr/server/driver/grpc_driver.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
-"""Flower driver service client."""
+"""Flower gRPC Driver."""
 
 import time
 import warnings
@@ -39,6 +39,8 @@ from flwr.proto.driver_pb2_grpc import DriverStub  # pylint: disable=E0611
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.task_pb2 import TaskIns  # pylint: disable=E0611
 
+from .driver import Driver
+
 DEFAULT_SERVER_ADDRESS_DRIVER = "[::]:9091"
 
 ERROR_MESSAGE_DRIVER_NOT_CONNECTED = """
@@ -133,7 +135,7 @@ class GrpcDriverHelper:
         return res
 
 
-class Driver:
+class GrpcDriver(Driver):
     """`Driver` class provides an interface to the Driver API.
 
     Parameters
@@ -198,30 +200,6 @@ class Driver:
 
         This method constructs a new `Message` with given content and metadata.
         The `run_id` and `src_node_id` will be set automatically.
-
-        Parameters
-        ----------
-        content : RecordSet
-            The content for the new message. This holds records that are to be sent
-            to the destination node.
-        message_type : str
-            The type of the message, defining the action to be executed on
-            the receiving end.
-        dst_node_id : int
-            The ID of the destination node to which the message is being sent.
-        group_id : str
-            The ID of the group to which this message is associated. In some settings,
-            this is used as the FL round.
-        ttl : Optional[float] (default: None)
-            Time-to-live for the round trip of this message, i.e., the time from sending
-            this message to receiving a reply. It specifies in seconds the duration for
-            which the message and its potential reply are considered valid. If unset,
-            the default TTL (i.e., `common.DEFAULT_TTL`) will be used.
-
-        Returns
-        -------
-        message : Message
-            A new `Message` instance with the specified content and metadata.
         """
         _, run_id = self._get_grpc_driver_helper_and_run_id()
         if ttl:
@@ -257,17 +235,6 @@ class Driver:
 
         This method takes an iterable of messages and sends each message
         to the node specified in `dst_node_id`.
-
-        Parameters
-        ----------
-        messages : Iterable[Message]
-            An iterable of messages to be sent.
-
-        Returns
-        -------
-        message_ids : Iterable[str]
-            An iterable of IDs for the messages that were sent, which can be used
-            to pull replies.
         """
         grpc_driver_helper, _ = self._get_grpc_driver_helper_and_run_id()
         # Construct TaskIns
@@ -288,18 +255,8 @@ class Driver:
     def pull_messages(self, message_ids: Iterable[str]) -> Iterable[Message]:
         """Pull messages based on message IDs.
 
-        This method is used to collect messages from the SuperLink
-        that correspond to a set of given message IDs.
-
-        Parameters
-        ----------
-        message_ids : Iterable[str]
-            An iterable of message IDs for which reply messages are to be retrieved.
-
-        Returns
-        -------
-        messages : Iterable[Message]
-            An iterable of messages received.
+        This method is used to collect messages from the SuperLink that correspond to a
+        set of given message IDs.
         """
         grpc_driver, _ = self._get_grpc_driver_helper_and_run_id()
         # Pull TaskRes
@@ -319,29 +276,8 @@ class Driver:
         """Push messages to specified node IDs and pull the reply messages.
 
         This method sends a list of messages to their destination node IDs and then
-        waits for the replies. It continues to pull replies until either all
-        replies are received or the specified timeout duration is exceeded.
-
-        Parameters
-        ----------
-        messages : Iterable[Message]
-            An iterable of messages to be sent.
-        timeout : Optional[float] (default: None)
-            The timeout duration in seconds. If specified, the method will wait for
-            replies for this duration. If `None`, there is no time limit and the method
-            will wait until replies for all messages are received.
-
-        Returns
-        -------
-        replies : Iterable[Message]
-            An iterable of reply messages received from the SuperLink.
-
-        Notes
-        -----
-        This method uses `push_messages` to send the messages and `pull_messages`
-        to collect the replies. If `timeout` is set, the method may not return
-        replies for all sent messages. A message remains valid until its TTL,
-        which is not affected by `timeout`.
+        waits for the replies. It continues to pull replies until either all replies are
+        received or the specified timeout duration is exceeded.
         """
         # Push messages
         msg_ids = set(self.push_messages(messages))

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/src/py/flwr/server/run_serverapp.py

@@ -25,7 +25,7 @@ from flwr.common import Context, EventType, RecordSet, event
 from flwr.common.logger import log, update_console_handler
 from flwr.common.object_ref import load_app
 
-from .driver.driver import Driver
+from .driver import Driver, GrpcDriver
 from .server_app import LoadServerAppError, ServerApp
 
 
@@ -128,13 +128,13 @@ def run_server_app() -> None:
     server_app_dir = args.dir
     server_app_attr = getattr(args, "server-app")
 
-    # Initialize Driver
-    driver = Driver(
+    # Initialize GrpcDriver
+    driver = GrpcDriver(
         driver_service_address=args.server,
         root_certificates=root_certificates,
     )
 
-    # Run the Server App with the Driver
+    # Run the ServerApp with the Driver
     run(driver=driver, server_app_dir=server_app_dir, server_app_attr=server_app_attr)
 
     # Clean up

{flwr_nightly-1.9.0.dev20240420 → flwr_nightly-1.9.0.dev20240423}/src/py/flwr/simulation/run_simulation.py

@@ -29,7 +29,7 @@ import grpc
 from flwr.client import ClientApp
 from flwr.common import EventType, event, log
 from flwr.common.typing import ConfigsRecordValues
-from flwr.server.driver.driver import Driver
+from flwr.server.driver import Driver, GrpcDriver
 from flwr.server.run_serverapp import run
 from flwr.server.server_app import ServerApp
 from flwr.server.superlink.driver.driver_grpc import run_driver_api_grpc
@@ -204,7 +204,7 @@ def _main_loop(
     serverapp_th = None
     try:
         # Initialize Driver
-        driver = Driver(
+        driver = GrpcDriver(
             driver_service_address=driver_api_address,
             root_certificates=None,
         )