flwr-nightly 1.8.0.dev20240209__tar.gz → 1.8.0.dev20240211__tar.gz

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/PKG-INFO

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

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.8.0-dev20240209"
+version = "1.8.0-dev20240211"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.dev>"]
@@ -54,8 +54,9 @@ exclude = [
 [tool.poetry.scripts]
 flower-driver-api = "flwr.server:run_driver_api"
 flower-fleet-api = "flwr.server:run_fleet_api"
-flower-server = "flwr.server:run_server"
-flower-client = "flwr.client:run_client"
+flower-superlink = "flwr.server:run_superlink"
+flower-client-app = "flwr.client:run_client_app"
+flower-server-app = "flwr.server:run_server_app"
 
 [tool.poetry.dependencies]
 python = "^3.8"

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/src/py/flwr/__init__.py

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

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/src/py/flwr/client/__init__.py

@@ -15,7 +15,7 @@
 """Flower client."""
 
 
-from .app import run_client as run_client
+from .app import run_client_app as run_client_app
 from .app import start_client as start_client
 from .app import start_numpy_client as start_numpy_client
 from .client import Client as Client
@@ -28,7 +28,7 @@ __all__ = [
     "ClientApp",
     "ClientFn",
     "NumPyClient",
-    "run_client",
+    "run_client_app",
     "start_client",
     "start_numpy_client",
 ]

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/src/py/flwr/client/app.py

@@ -45,13 +45,13 @@ from .node_state import NodeState
 from .numpy_client import NumPyClient
 
 
-def run_client() -> None:
-    """Run Flower client."""
-    event(EventType.RUN_CLIENT_ENTER)
+def run_client_app() -> None:
+    """Run Flower client app."""
+    event(EventType.RUN_CLIENT_APP_ENTER)
 
     log(INFO, "Long-running Flower client starting")
 
-    args = _parse_args_client().parse_args()
+    args = _parse_args_run_client_app().parse_args()
 
     # Obtain certificates
     if args.insecure:
@@ -86,7 +86,7 @@ def run_client() -> None:
 
     log(
         DEBUG,
-        "Flower will load ClientApp `%s` to execute tasks",
+        "Flower will load ClientApp `%s`",
         getattr(args, "client-app"),
     )
 
@@ -105,13 +105,13 @@ def run_client() -> None:
         root_certificates=root_certificates,
         insecure=args.insecure,
     )
-    event(EventType.RUN_CLIENT_LEAVE)
+    event(EventType.RUN_CLIENT_APP_LEAVE)
 
 
-def _parse_args_client() -> argparse.ArgumentParser:
-    """Parse command line arguments."""
+def _parse_args_run_client_app() -> argparse.ArgumentParser:
+    """Parse flower-client-app command line arguments."""
     parser = argparse.ArgumentParser(
-        description="Start a long-running Flower client",
+        description="Start a Flower client app",
     )
 
     parser.add_argument(
@@ -145,7 +145,7 @@ def _parse_args_client() -> argparse.ArgumentParser:
         "--dir",
         default="",
         help="Add specified directory to the PYTHONPATH and load Flower "
-        "callable from there."
+        "app from there."
         " Default: current working directory.",
     )
 

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/src/py/flwr/client/clientapp.py

@@ -46,7 +46,7 @@ class ClientApp:
     If the above code is in a Python module called `client`, it can be started as
     follows:
 
-    >>> flower-client client:app --insecure
+    >>> flower-client-app client:app --insecure
 
     In this `client:app` example, `client` refers to the Python module `client.py` in
     which the previous code lives in and `app` refers to the global attribute `app` that

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/src/py/flwr/common/telemetry.py

@@ -137,8 +137,8 @@ class EventType(str, Enum):
     RUN_FLEET_API_LEAVE = auto()
 
     # Driver API and Fleet API
-    RUN_SERVER_ENTER = auto()
-    RUN_SERVER_LEAVE = auto()
+    RUN_SUPERLINK_ENTER = auto()
+    RUN_SUPERLINK_LEAVE = auto()
 
     # Simulation
     START_SIMULATION_ENTER = auto()
@@ -152,9 +152,13 @@ class EventType(str, Enum):
     START_DRIVER_ENTER = auto()
     START_DRIVER_LEAVE = auto()
 
-    # SuperNode: flower-client
-    RUN_CLIENT_ENTER = auto()
-    RUN_CLIENT_LEAVE = auto()
+    # flower-client-app
+    RUN_CLIENT_APP_ENTER = auto()
+    RUN_CLIENT_APP_LEAVE = auto()
+
+    # flower-server-app
+    RUN_SERVER_APP_ENTER = auto()
+    RUN_SERVER_APP_LEAVE = auto()
 
 
 # Use the ThreadPoolExecutor with max_workers=1 to have a queue

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/src/py/flwr/server/__init__.py

@@ -15,11 +15,12 @@
 """Flower server."""
 
 
-from . import strategy
+from . import driver, strategy
 from .app import ServerConfig as ServerConfig
 from .app import run_driver_api as run_driver_api
 from .app import run_fleet_api as run_fleet_api
-from .app import run_server as run_server
+from .app import run_server_app as run_server_app
+from .app import run_superlink as run_superlink
 from .app import start_server as start_server
 from .client_manager import ClientManager as ClientManager
 from .client_manager import SimpleClientManager as SimpleClientManager
@@ -28,10 +29,12 @@ from .server import Server as Server
 
 __all__ = [
     "ClientManager",
+    "driver",
     "History",
     "run_driver_api",
     "run_fleet_api",
-    "run_server",
+    "run_server_app",
+    "run_superlink",
     "Server",
     "ServerConfig",
     "SimpleClientManager",

{flwr_nightly-1.8.0.dev20240209 → flwr_nightly-1.8.0.dev20240211}/src/py/flwr/server/app.py

@@ -20,7 +20,7 @@ import importlib.util
 import sys
 import threading
 from dataclasses import dataclass
-from logging import ERROR, INFO, WARN
+from logging import DEBUG, ERROR, INFO, WARN
 from os.path import isfile
 from pathlib import Path
 from signal import SIGINT, SIGTERM, signal
@@ -44,16 +44,16 @@ from flwr.proto.fleet_pb2_grpc import (  # pylint: disable=E0611
     add_FleetServicer_to_server,
 )
 from flwr.server.client_manager import ClientManager, SimpleClientManager
-from flwr.server.driver.driver_servicer import DriverServicer
-from flwr.server.fleet.grpc_bidi.grpc_server import (
-    generic_create_grpc_server,
-    start_grpc_server,
-)
-from flwr.server.fleet.grpc_rere.fleet_servicer import FleetServicer
 from flwr.server.history import History
 from flwr.server.server import Server
-from flwr.server.state import StateFactory
 from flwr.server.strategy import FedAvg, Strategy
+from flwr.server.superlink.driver.driver_servicer import DriverServicer
+from flwr.server.superlink.fleet.grpc_bidi.grpc_server import (
+    generic_create_grpc_server,
+    start_grpc_server,
+)
+from flwr.server.superlink.fleet.grpc_rere.fleet_servicer import FleetServicer
+from flwr.server.superlink.state import StateFactory
 
 ADDRESS_DRIVER_API = "0.0.0.0:9091"
 ADDRESS_FLEET_API_GRPC_RERE = "0.0.0.0:9092"
@@ -75,6 +75,60 @@ class ServerConfig:
     round_timeout: Optional[float] = None
 
 
+def run_server_app() -> None:
+    """Run Flower server app."""
+    event(EventType.RUN_SERVER_APP_ENTER)
+
+    args = _parse_args_run_server_app().parse_args()
+
+    # Obtain certificates
+    if args.insecure:
+        if args.root_certificates is not None:
+            sys.exit(
+                "Conflicting options: The '--insecure' flag disables HTTPS, "
+                "but '--root-certificates' was also specified. Please remove "
+                "the '--root-certificates' option when running in insecure mode, "
+                "or omit '--insecure' to use HTTPS."
+            )
+        log(
+            WARN,
+            "Option `--insecure` was set. "
+            "Starting insecure HTTP client connected to %s.",
+            args.server,
+        )
+        root_certificates = None
+    else:
+        # Load the certificates if provided, or load the system certificates
+        cert_path = args.root_certificates
+        if cert_path is None:
+            root_certificates = None
+        else:
+            root_certificates = Path(cert_path).read_bytes()
+        log(
+            DEBUG,
+            "Starting secure HTTPS client connected to %s "
+            "with the following certificates: %s.",
+            args.server,
+            cert_path,
+        )
+
+    log(
+        DEBUG,
+        "Flower will load ServerApp `%s`",
+        getattr(args, "server-app"),
+    )
+
+    log(
+        DEBUG,
+        "root_certificates: `%s`",
+        root_certificates,
+    )
+
+    log(WARN, "Not implemented: run_server_app")
+
+    event(EventType.RUN_SERVER_APP_LEAVE)
+
+
 def start_server(  # pylint: disable=too-many-arguments,too-many-locals
     *,
     server_address: str = ADDRESS_FLEET_API_GRPC_BIDI,
@@ -239,7 +293,7 @@ def run_driver_api() -> None:
     """Run Flower server (Driver API)."""
     log(INFO, "Starting Flower server (Driver API)")
     event(EventType.RUN_DRIVER_API_ENTER)
-    args = _parse_args_driver().parse_args()
+    args = _parse_args_run_driver_api().parse_args()
 
     # Parse IP address
     parsed_address = parse_address(args.driver_api_address)
@@ -276,7 +330,7 @@ def run_fleet_api() -> None:
     """Run Flower server (Fleet API)."""
     log(INFO, "Starting Flower server (Fleet API)")
     event(EventType.RUN_FLEET_API_ENTER)
-    args = _parse_args_fleet().parse_args()
+    args = _parse_args_run_fleet_api().parse_args()
 
     # Obtain certificates
     certificates = _try_obtain_certificates(args)
@@ -344,11 +398,11 @@ def run_fleet_api() -> None:
 
 
 # pylint: disable=too-many-branches, too-many-locals, too-many-statements
-def run_server() -> None:
+def run_superlink() -> None:
     """Run Flower server (Driver API and Fleet API)."""
     log(INFO, "Starting Flower server")
-    event(EventType.RUN_SERVER_ENTER)
-    args = _parse_args_server().parse_args()
+    event(EventType.RUN_SUPERLINK_ENTER)
+    args = _parse_args_run_superlink().parse_args()
 
     # Parse IP address
     parsed_address = parse_address(args.driver_api_address)
@@ -419,7 +473,7 @@ def run_server() -> None:
     _register_exit_handlers(
         grpc_servers=grpc_servers,
         bckg_threads=bckg_threads,
-        event_type=EventType.RUN_SERVER_LEAVE,
+        event_type=EventType.RUN_SUPERLINK_LEAVE,
     )
 
     # Block
@@ -561,7 +615,7 @@ def _run_fleet_api_rest(
     try:
         import uvicorn
 
-        from flwr.server.fleet.rest_rere.rest_api import app as fast_api_app
+        from flwr.server.superlink.fleet.rest_rere.rest_api import app as fast_api_app
     except ModuleNotFoundError:
         sys.exit(MISSING_EXTRA_REST)
     if workers != 1:
@@ -584,7 +638,7 @@ def _run_fleet_api_rest(
         raise ValueError(validation_exceptions)
 
     uvicorn.run(
-        app="flwr.server.fleet.rest_rere.rest_api:app",
+        app="flwr.server.superlink.fleet.rest_rere.rest_api:app",
         port=port,
         host=host,
         reload=False,
@@ -621,7 +675,7 @@ def _validate_ssl_files(
     return validation_exceptions
 
 
-def _parse_args_driver() -> argparse.ArgumentParser:
+def _parse_args_run_driver_api() -> argparse.ArgumentParser:
     """Parse command line arguments for Driver API."""
     parser = argparse.ArgumentParser(
         description="Start a Flower Driver API server. "
@@ -638,7 +692,7 @@ def _parse_args_driver() -> argparse.ArgumentParser:
     return parser
 
 
-def _parse_args_fleet() -> argparse.ArgumentParser:
+def _parse_args_run_fleet_api() -> argparse.ArgumentParser:
     """Parse command line arguments for Fleet API."""
     parser = argparse.ArgumentParser(
         description="Start a Flower Fleet API server."
@@ -655,7 +709,7 @@ def _parse_args_fleet() -> argparse.ArgumentParser:
     return parser
 
 
-def _parse_args_server() -> argparse.ArgumentParser:
+def _parse_args_run_superlink() -> argparse.ArgumentParser:
     """Parse command line arguments for both Driver API and Fleet API."""
     parser = argparse.ArgumentParser(
         description="This will start a Flower server "
@@ -760,3 +814,42 @@ def _add_args_fleet_api(parser: argparse.ArgumentParser) -> None:
         type=int,
         default=1,
     )
+
+
+def _parse_args_run_server_app() -> argparse.ArgumentParser:
+    """Parse flower-server-app command line arguments."""
+    parser = argparse.ArgumentParser(
+        description="Start a Flower server app",
+    )
+
+    parser.add_argument(
+        "server-app",
+        help="For example: `server:app` or `project.package.module:wrapper.app`",
+    )
+    parser.add_argument(
+        "--insecure",
+        action="store_true",
+        help="Run the server app without HTTPS. By default, the app runs with "
+        "HTTPS enabled. Use this flag only if you understand the risks.",
+    )
+    parser.add_argument(
+        "--root-certificates",
+        metavar="ROOT_CERT",
+        type=str,
+        help="Specifies the path to the PEM-encoded root certificate file for "
+        "establishing secure HTTPS connections.",
+    )
+    parser.add_argument(
+        "--server",
+        default="0.0.0.0:9092",
+        help="Server address",
+    )
+    parser.add_argument(
+        "--dir",
+        default="",
+        help="Add specified directory to the PYTHONPATH and load Flower "
+        "app from there."
+        " Default: current working directory.",
+    )
+
+    return parser

{flwr_nightly-1.8.0.dev20240209/src/py/flwr → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server}/driver/app.py

@@ -72,7 +72,7 @@ def start_driver(  # pylint: disable=too-many-arguments, too-many-locals
         An implementation of the abstract base class
         `flwr.server.strategy.Strategy`. If no strategy is provided, then
         `start_server` will use `flwr.server.strategy.FedAvg`.
-    client_manager : Optional[flwr.server.DriverClientManager] (default: None)
+    client_manager : Optional[flwr.server.ClientManager] (default: None)
         An implementation of the class `flwr.server.ClientManager`. If no
         implementation is provided, then `start_driver` will use
         `flwr.server.SimpleClientManager`.

{flwr_nightly-1.8.0.dev20240209/src/py/flwr → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server}/driver/driver.py

@@ -17,7 +17,6 @@
 
 from typing import Iterable, List, Optional, Tuple
 
-from flwr.driver.grpc_driver import DEFAULT_SERVER_ADDRESS_DRIVER, GrpcDriver
 from flwr.proto.driver_pb2 import (  # pylint: disable=E0611
     CreateRunRequest,
     GetNodesRequest,
@@ -26,6 +25,7 @@ from flwr.proto.driver_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
+from flwr.server.driver.grpc_driver import DEFAULT_SERVER_ADDRESS_DRIVER, GrpcDriver
 
 
 class Driver:

flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink/__init__.py

@@ -0,0 +1,15 @@
+# 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.
+# 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 SuperLink."""

{flwr_nightly-1.8.0.dev20240209/src/py/flwr/server → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink}/driver/driver_servicer.py

@@ -35,7 +35,7 @@ from flwr.proto.driver_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.task_pb2 import TaskRes  # pylint: disable=E0611
-from flwr.server.state import State, StateFactory
+from flwr.server.superlink.state import State, StateFactory
 from flwr.server.utils.validator import validate_task_ins_or_res
 
 

{flwr_nightly-1.8.0.dev20240209/src/py/flwr/server → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink}/fleet/grpc_bidi/flower_service_servicer.py

@@ -30,8 +30,12 @@ from flwr.proto.transport_pb2 import (  # pylint: disable=E0611
     ServerMessage,
 )
 from flwr.server.client_manager import ClientManager
-from flwr.server.fleet.grpc_bidi.grpc_bridge import GrpcBridge, InsWrapper, ResWrapper
-from flwr.server.fleet.grpc_bidi.grpc_client_proxy import GrpcClientProxy
+from flwr.server.superlink.fleet.grpc_bidi.grpc_bridge import (
+    GrpcBridge,
+    InsWrapper,
+    ResWrapper,
+)
+from flwr.server.superlink.fleet.grpc_bidi.grpc_client_proxy import GrpcClientProxy
 
 
 def default_bridge_factory() -> GrpcBridge:

{flwr_nightly-1.8.0.dev20240209/src/py/flwr/server → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink}/fleet/grpc_bidi/grpc_client_proxy.py

@@ -24,7 +24,11 @@ from flwr.proto.transport_pb2 import (  # pylint: disable=E0611
     ServerMessage,
 )
 from flwr.server.client_proxy import ClientProxy
-from flwr.server.fleet.grpc_bidi.grpc_bridge import GrpcBridge, InsWrapper, ResWrapper
+from flwr.server.superlink.fleet.grpc_bidi.grpc_bridge import (
+    GrpcBridge,
+    InsWrapper,
+    ResWrapper,
+)
 
 
 class GrpcClientProxy(ClientProxy):

{flwr_nightly-1.8.0.dev20240209/src/py/flwr/server → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink}/fleet/grpc_bidi/grpc_server.py

@@ -28,9 +28,11 @@ from flwr.proto.transport_pb2_grpc import (  # pylint: disable=E0611
     add_FlowerServiceServicer_to_server,
 )
 from flwr.server.client_manager import ClientManager
-from flwr.server.driver.driver_servicer import DriverServicer
-from flwr.server.fleet.grpc_bidi.flower_service_servicer import FlowerServiceServicer
-from flwr.server.fleet.grpc_rere.fleet_servicer import FleetServicer
+from flwr.server.superlink.driver.driver_servicer import DriverServicer
+from flwr.server.superlink.fleet.grpc_bidi.flower_service_servicer import (
+    FlowerServiceServicer,
+)
+from flwr.server.superlink.fleet.grpc_rere.fleet_servicer import FleetServicer
 
 INVALID_CERTIFICATES_ERR_MSG = """
     When setting any of root_certificate, certificate, or private_key,

{flwr_nightly-1.8.0.dev20240209/src/py/flwr/server → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink}/fleet/grpc_rere/fleet_servicer.py

@@ -31,8 +31,8 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     PushTaskResRequest,
     PushTaskResResponse,
 )
-from flwr.server.fleet.message_handler import message_handler
-from flwr.server.state import StateFactory
+from flwr.server.superlink.fleet.message_handler import message_handler
+from flwr.server.superlink.state import StateFactory
 
 
 class FleetServicer(fleet_pb2_grpc.FleetServicer):

{flwr_nightly-1.8.0.dev20240209/src/py/flwr/server → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink}/fleet/message_handler/message_handler.py

@@ -31,7 +31,7 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.node_pb2 import Node  # pylint: disable=E0611
 from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
-from flwr.server.state import State
+from flwr.server.superlink.state import State
 
 
 def create_node(

{flwr_nightly-1.8.0.dev20240209/src/py/flwr/server → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink}/fleet/rest_rere/rest_api.py

@@ -24,8 +24,8 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     PullTaskInsRequest,
     PushTaskResRequest,
 )
-from flwr.server.fleet.message_handler import message_handler
-from flwr.server.state import State
+from flwr.server.superlink.fleet.message_handler import message_handler
+from flwr.server.superlink.state import State
 
 try:
     from starlette.applications import Starlette

{flwr_nightly-1.8.0.dev20240209/src/py/flwr/server → flwr_nightly-1.8.0.dev20240211/src/py/flwr/server/superlink}/state/in_memory_state.py

@@ -23,7 +23,7 @@ from uuid import UUID, uuid4
 
 from flwr.common import log, now
 from flwr.proto.task_pb2 import TaskIns, TaskRes  # pylint: disable=E0611
-from flwr.server.state.state import State
+from flwr.server.superlink.state.state import State
 from flwr.server.utils import validate_task_ins_or_res