flwr-nightly 1.11.0.dev20240821__tar.gz → 1.11.0.dev20240823__tar.gz

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/PKG-INFO

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

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "flwr-nightly"
-version = "1.11.0.dev20240821"
+version = "1.11.0.dev20240823"
 description = "Flower: A Friendly Federated Learning Framework"
 license = "Apache-2.0"
 authors = ["The Flower Authors <hello@flower.ai>"]

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/cli/build.py

@@ -89,7 +89,7 @@ def build(
     # Set the name of the zip file
     fab_filename = (
         f"{conf['tool']['flwr']['app']['publisher']}"
-        f".{app.name}"
+        f".{conf['project']['name']}"
         f".{conf['project']['version'].replace('.', '-')}.fab"
     )
     list_file_content = ""

flwr_nightly-1.11.0.dev20240823/src/py/flwr/cli/new/templates/app/README.md.tpl

@@ -0,0 +1,20 @@
+# $project_name: A Flower / $framework_str app
+
+## Install dependencies and project
+
+```bash
+pip install -e .
+```
+
+## Run with the Simulation Engine
+
+In the `$project_name` directory, use `flwr run` to run a local simulation:
+
+```bash
+flwr run .
+```
+
+## Run with the Deployment Engine
+
+> \[!NOTE\]
+> An update to this example will show how to run this Flower application with the Deployment Engine and TLS certificates, or with Docker.

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/cli/run/run.py

@@ -15,6 +15,7 @@
 """Flower command line interface `run` command."""
 
 import hashlib
+import json
 import subprocess
 import sys
 from logging import DEBUG
@@ -192,6 +193,8 @@ def _run_without_superexec(
 ) -> None:
     try:
         num_supernodes = federation_config["options"]["num-supernodes"]
+        verbose: Optional[bool] = federation_config["options"].get("verbose")
+        backend_cfg = federation_config["options"].get("backend", {})
     except KeyError as err:
         typer.secho(
             "❌ The project's `pyproject.toml` needs to declare the number of"
@@ -212,6 +215,13 @@ def _run_without_superexec(
         f"{num_supernodes}",
     ]
 
+    if backend_cfg:
+        # Stringify as JSON
+        command.extend(["--backend-config", json.dumps(backend_cfg)])
+
+    if verbose:
+        command.extend(["--verbose"])
+
     if config_overrides:
         command.extend(["--run-config", f"{' '.join(config_overrides)}"])
 

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/client/client.py

@@ -33,12 +33,13 @@ from flwr.common import (
     Parameters,
     Status,
 )
+from flwr.common.logger import warn_deprecated_feature_with_example
 
 
 class Client(ABC):
     """Abstract base class for Flower clients."""
 
-    context: Context
+    _context: Context
 
     def get_properties(self, ins: GetPropertiesIns) -> GetPropertiesRes:
         """Return set of client's properties.
@@ -141,6 +142,26 @@ class Client(ABC):
             metrics={},
         )
 
+    @property
+    def context(self) -> Context:
+        """Getter for `Context` client attribute."""
+        warn_deprecated_feature_with_example(
+            "Accessing the context via the client's attribute is deprecated.",
+            example_message="Instead, pass it to the client's "
+            "constructor in your `client_fn()` which already "
+            "receives a context object.",
+            code_example="def client_fn(context: Context) -> Client:\n\n"
+            "\t\t# Your existing client_fn\n\n"
+            "\t\t# Pass `context` to the constructor\n"
+            "\t\treturn FlowerClient(context).to_client()",
+        )
+        return self._context
+
+    @context.setter
+    def context(self, context: Context) -> None:
+        """Setter for `Context` client attribute."""
+        self._context = context
+
     def get_context(self) -> Context:
         """Get the run context from this client."""
         return self.context

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/client/numpy_client.py

@@ -27,6 +27,7 @@ from flwr.common import (
     ndarrays_to_parameters,
     parameters_to_ndarrays,
 )
+from flwr.common.logger import warn_deprecated_feature_with_example
 from flwr.common.typing import (
     Code,
     EvaluateIns,
@@ -70,7 +71,7 @@ Example
 class NumPyClient(ABC):
     """Abstract base class for Flower clients using NumPy."""
 
-    context: Context
+    _context: Context
 
     def get_properties(self, config: Config) -> Dict[str, Scalar]:
         """Return a client's set of properties.
@@ -174,6 +175,26 @@ class NumPyClient(ABC):
         _ = (self, parameters, config)
         return 0.0, 0, {}
 
+    @property
+    def context(self) -> Context:
+        """Getter for `Context` client attribute."""
+        warn_deprecated_feature_with_example(
+            "Accessing the context via the client's attribute is deprecated.",
+            example_message="Instead, pass it to the client's "
+            "constructor in your `client_fn()` which already "
+            "receives a context object.",
+            code_example="def client_fn(context: Context) -> Client:\n\n"
+            "\t\t# Your existing client_fn\n\n"
+            "\t\t# Pass `context` to the constructor\n"
+            "\t\treturn FlowerClient(context).to_client()",
+        )
+        return self._context
+
+    @context.setter
+    def context(self, context: Context) -> None:
+        """Setter for `Context` client attribute."""
+        self._context = context
+
     def get_context(self) -> Context:
         """Get the run context from this client."""
         return self.context

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/client/rest_client/connection.py

@@ -275,7 +275,7 @@ def http_request_response(  # pylint: disable=,R0913, R0914, R0915
         req = DeleteNodeRequest(node=node)
 
         # Send the request
-        res = _request(req, DeleteNodeResponse, PATH_CREATE_NODE)
+        res = _request(req, DeleteNodeResponse, PATH_DELETE_NODE)
         if res is None:
             return
 

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/client/supernode/app.py

@@ -16,7 +16,7 @@
 
 import argparse
 import sys
-from logging import DEBUG, INFO, WARN
+from logging import DEBUG, ERROR, INFO, WARN
 from pathlib import Path
 from typing import Optional, Tuple
 
@@ -90,33 +90,12 @@ def run_supernode() -> None:
 
 def run_client_app() -> None:
     """Run Flower client app."""
-    log(INFO, "Long-running Flower client starting")
-
     event(EventType.RUN_CLIENT_APP_ENTER)
-
-    args = _parse_args_run_client_app().parse_args()
-
-    _warn_deprecated_server_arg(args)
-
-    root_certificates = _get_certificates(args)
-    load_fn = get_load_client_app_fn(
-        default_app_ref=getattr(args, "client-app"),
-        app_path=args.dir,
-        multi_app=False,
-    )
-    authentication_keys = _try_setup_client_authentication(args)
-
-    start_client_internal(
-        server_address=args.superlink,
-        node_config=parse_config_args([args.node_config]),
-        load_client_app_fn=load_fn,
-        transport=args.transport,
-        root_certificates=root_certificates,
-        insecure=args.insecure,
-        authentication_keys=authentication_keys,
-        max_retries=args.max_retries,
-        max_wait_time=args.max_wait_time,
+    log(
+        ERROR,
+        "The command `flower-client-app` has been replaced by `flower-supernode`.",
     )
+    log(INFO, "Execute `flower-supernode --help` to learn how to use it.")
     register_exit_handlers(event_type=EventType.RUN_CLIENT_APP_LEAVE)
 
 
@@ -227,28 +206,6 @@ def _parse_args_run_supernode() -> argparse.ArgumentParser:
     return parser
 
 
-def _parse_args_run_client_app() -> argparse.ArgumentParser:
-    """Parse flower-client-app command line arguments."""
-    parser = argparse.ArgumentParser(
-        description="Start a Flower client app",
-    )
-
-    parser.add_argument(
-        "client-app",
-        help="For example: `client:app` or `project.package.module:wrapper.app`",
-    )
-    _parse_args_common(parser=parser)
-    parser.add_argument(
-        "--dir",
-        default="",
-        help="Add specified directory to the PYTHONPATH and load Flower "
-        "app from there."
-        " Default: current working directory.",
-    )
-
-    return parser
-
-
 def _parse_args_common(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         "--insecure",

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/common/address.py

@@ -14,6 +14,7 @@
 # ==============================================================================
 """Flower IP address utils."""
 
+import socket
 from ipaddress import ip_address
 from typing import Optional, Tuple
 
@@ -57,3 +58,45 @@ def parse_address(address: str) -> Optional[Tuple[str, int, Optional[bool]]]:
 
     except ValueError:
         return None
+
+
+def is_port_in_use(address: str) -> bool:
+    """Check if the port specified in address is in use.
+
+    Parameters
+    ----------
+    address : str
+        The string representation of a domain, an IPv4, or an IPV6 address
+        with the port number.
+
+        For example, '127.0.0.1:8080', or `[::1]:8080`.
+
+    Returns
+    -------
+    bool
+        If the port provided is in use or can't be parsed,
+        the function will return True, otherwise it will return False.
+    """
+    parsed_address = parse_address(address)
+    if not parsed_address:
+        return True
+    host, port, is_v6 = parsed_address
+
+    if is_v6:
+        protocol = socket.AF_INET6
+    else:
+        protocol = socket.AF_INET
+
+    with socket.socket(protocol, socket.SOCK_STREAM) as s:
+        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+        try:
+            if is_v6:
+                # For IPv6, provide `flowinfo` and `scopeid` as 0
+                s.bind((host, port, 0, 0))
+            else:
+                # For IPv4
+                s.bind((host, port))
+        except OSError:
+            return True
+
+        return False

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/server/app.py

@@ -271,6 +271,7 @@ def run_superlink() -> None:
                 ssl_keyfile,
                 ssl_certfile,
                 state_factory,
+                ffs_factory,
                 num_workers,
             ),
         )
@@ -310,6 +311,7 @@ def run_superlink() -> None:
         fleet_server = _run_fleet_api_grpc_adapter(
             address=fleet_address,
             state_factory=state_factory,
+            ffs_factory=ffs_factory,
             certificates=certificates,
         )
         grpc_servers.append(fleet_server)
@@ -516,12 +518,14 @@ def _run_fleet_api_grpc_rere(
 def _run_fleet_api_grpc_adapter(
     address: str,
     state_factory: StateFactory,
+    ffs_factory: FfsFactory,
     certificates: Optional[Tuple[bytes, bytes, bytes]],
 ) -> grpc.Server:
     """Run Fleet API (GrpcAdapter)."""
     # Create Fleet API gRPC server
     fleet_servicer = GrpcAdapterServicer(
         state_factory=state_factory,
+        ffs_factory=ffs_factory,
     )
     fleet_add_servicer_to_server_fn = add_GrpcAdapterServicer_to_server
     fleet_grpc_server = generic_create_grpc_server(
@@ -544,6 +548,7 @@ def _run_fleet_api_rest(
     ssl_keyfile: Optional[str],
     ssl_certfile: Optional[str],
     state_factory: StateFactory,
+    ffs_factory: FfsFactory,
     num_workers: int,
 ) -> None:
     """Run Driver API (REST-based)."""
@@ -558,6 +563,7 @@ def _run_fleet_api_rest(
 
     # See: https://www.starlette.io/applications/#accessing-the-app-instance
     fast_api_app.state.STATE_FACTORY = state_factory
+    fast_api_app.state.FFS_FACTORY = ffs_factory
 
     uvicorn.run(
         app="flwr.server.superlink.fleet.rest_rere.rest_api:app",

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/server/superlink/fleet/grpc_adapter/grpc_adapter_servicer.py

@@ -23,6 +23,7 @@ from google.protobuf.message import Message as GrpcMessage
 
 from flwr.common.logger import log
 from flwr.proto import grpcadapter_pb2_grpc  # pylint: disable=E0611
+from flwr.proto.fab_pb2 import GetFabRequest, GetFabResponse  # pylint: disable=E0611
 from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
     CreateNodeRequest,
     CreateNodeResponse,
@@ -37,6 +38,7 @@ from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
 )
 from flwr.proto.grpcadapter_pb2 import MessageContainer  # pylint: disable=E0611
 from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
+from flwr.server.superlink.ffs.ffs_factory import FfsFactory
 from flwr.server.superlink.fleet.message_handler import message_handler
 from flwr.server.superlink.state import StateFactory
 
@@ -60,10 +62,11 @@ def _handle(
 class GrpcAdapterServicer(grpcadapter_pb2_grpc.GrpcAdapterServicer):
     """Fleet API via GrpcAdapter servicer."""
 
-    def __init__(self, state_factory: StateFactory) -> None:
+    def __init__(self, state_factory: StateFactory, ffs_factory: FfsFactory) -> None:
         self.state_factory = state_factory
+        self.ffs_factory = ffs_factory
 
-    def SendReceive(
+    def SendReceive(  # pylint: disable=too-many-return-statements
         self, request: MessageContainer, context: grpc.ServicerContext
     ) -> MessageContainer:
         """."""
@@ -80,6 +83,8 @@ class GrpcAdapterServicer(grpcadapter_pb2_grpc.GrpcAdapterServicer):
             return _handle(request, PushTaskResRequest, self._push_task_res)
         if request.grpc_message_name == GetRunRequest.__qualname__:
             return _handle(request, GetRunRequest, self._get_run)
+        if request.grpc_message_name == GetFabRequest.__qualname__:
+            return _handle(request, GetFabRequest, self._get_fab)
         raise ValueError(f"Invalid grpc_message_name: {request.grpc_message_name}")
 
     def _create_node(self, request: CreateNodeRequest) -> CreateNodeResponse:
@@ -129,3 +134,11 @@ class GrpcAdapterServicer(grpcadapter_pb2_grpc.GrpcAdapterServicer):
             request=request,
             state=self.state_factory.state(),
         )
+
+    def _get_fab(self, request: GetFabRequest) -> GetFabResponse:
+        """Get FAB."""
+        log(INFO, "GrpcAdapter.GetFab")
+        return message_handler.get_fab(
+            request=request,
+            ffs=self.ffs_factory.ffs(),
+        )

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/server/superlink/fleet/grpc_bidi/grpc_server.py

@@ -23,6 +23,7 @@ from typing import Any, Callable, Optional, Sequence, Tuple, Union
 import grpc
 
 from flwr.common import GRPC_MAX_MESSAGE_LENGTH
+from flwr.common.address import is_port_in_use
 from flwr.common.logger import log
 from flwr.proto.transport_pb2_grpc import (  # pylint: disable=E0611
     add_FlowerServiceServicer_to_server,
@@ -218,6 +219,10 @@ def generic_create_grpc_server(  # pylint: disable=too-many-arguments
     server : grpc.Server
         A non-running instance of a gRPC server.
     """
+    # Check if port is in use
+    if is_port_in_use(server_address):
+        sys.exit(f"Port in server address {server_address} is already in use.")
+
     # Deconstruct tuple into servicer and function
     servicer, add_servicer_to_server_fn = servicer_and_add_fn
 

flwr_nightly-1.11.0.dev20240823/src/py/flwr/server/superlink/fleet/rest_rere/rest_api.py

@@ -0,0 +1,184 @@
+# 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.
+# ==============================================================================
+"""Experimental REST API server."""
+
+
+from __future__ import annotations
+
+import sys
+from typing import Awaitable, Callable, TypeVar
+
+from google.protobuf.message import Message as GrpcMessage
+
+from flwr.common.constant import MISSING_EXTRA_REST
+from flwr.proto.fab_pb2 import GetFabRequest, GetFabResponse  # pylint: disable=E0611
+from flwr.proto.fleet_pb2 import (  # pylint: disable=E0611
+    CreateNodeRequest,
+    CreateNodeResponse,
+    DeleteNodeRequest,
+    DeleteNodeResponse,
+    PingRequest,
+    PingResponse,
+    PullTaskInsRequest,
+    PullTaskInsResponse,
+    PushTaskResRequest,
+    PushTaskResResponse,
+)
+from flwr.proto.run_pb2 import GetRunRequest, GetRunResponse  # pylint: disable=E0611
+from flwr.server.superlink.ffs.ffs import Ffs
+from flwr.server.superlink.fleet.message_handler import message_handler
+from flwr.server.superlink.state import State
+
+try:
+    from starlette.applications import Starlette
+    from starlette.datastructures import Headers
+    from starlette.exceptions import HTTPException
+    from starlette.requests import Request
+    from starlette.responses import Response
+    from starlette.routing import Route
+except ModuleNotFoundError:
+    sys.exit(MISSING_EXTRA_REST)
+
+
+GrpcRequest = TypeVar("GrpcRequest", bound=GrpcMessage)
+GrpcResponse = TypeVar("GrpcResponse", bound=GrpcMessage)
+
+GrpcAsyncFunction = Callable[[GrpcRequest], Awaitable[GrpcResponse]]
+RestEndPoint = Callable[[Request], Awaitable[Response]]
+
+
+def rest_request_response(
+    grpc_request_type: type[GrpcRequest],
+) -> Callable[[GrpcAsyncFunction[GrpcRequest, GrpcResponse]], RestEndPoint]:
+    """Convert an async gRPC-based function into a RESTful HTTP endpoint."""
+
+    def decorator(func: GrpcAsyncFunction[GrpcRequest, GrpcResponse]) -> RestEndPoint:
+        async def wrapper(request: Request) -> Response:
+            _check_headers(request.headers)
+
+            # Get the request body as raw bytes
+            grpc_req_bytes: bytes = await request.body()
+
+            # Deserialize ProtoBuf
+            grpc_req = grpc_request_type.FromString(grpc_req_bytes)
+            grpc_res = await func(grpc_req)
+            return Response(
+                status_code=200,
+                content=grpc_res.SerializeToString(),
+                headers={"Content-Type": "application/protobuf"},
+            )
+
+        return wrapper
+
+    return decorator
+
+
+@rest_request_response(CreateNodeRequest)
+async def create_node(request: CreateNodeRequest) -> CreateNodeResponse:
+    """Create Node."""
+    # Get state from app
+    state: State = app.state.STATE_FACTORY.state()
+
+    # Handle message
+    return message_handler.create_node(request=request, state=state)
+
+
+@rest_request_response(DeleteNodeRequest)
+async def delete_node(request: DeleteNodeRequest) -> DeleteNodeResponse:
+    """Delete Node Id."""
+    # Get state from app
+    state: State = app.state.STATE_FACTORY.state()
+
+    # Handle message
+    return message_handler.delete_node(request=request, state=state)
+
+
+@rest_request_response(PullTaskInsRequest)
+async def pull_task_ins(request: PullTaskInsRequest) -> PullTaskInsResponse:
+    """Pull TaskIns."""
+    # Get state from app
+    state: State = app.state.STATE_FACTORY.state()
+
+    # Handle message
+    return message_handler.pull_task_ins(request=request, state=state)
+
+
+# Check if token is needed here
+@rest_request_response(PushTaskResRequest)
+async def push_task_res(request: PushTaskResRequest) -> PushTaskResResponse:
+    """Push TaskRes."""
+    # Get state from app
+    state: State = app.state.STATE_FACTORY.state()
+
+    # Handle message
+    return message_handler.push_task_res(request=request, state=state)
+
+
+@rest_request_response(PingRequest)
+async def ping(request: PingRequest) -> PingResponse:
+    """Ping."""
+    # Get state from app
+    state: State = app.state.STATE_FACTORY.state()
+
+    # Handle message
+    return message_handler.ping(request=request, state=state)
+
+
+@rest_request_response(GetRunRequest)
+async def get_run(request: GetRunRequest) -> GetRunResponse:
+    """GetRun."""
+    # Get state from app
+    state: State = app.state.STATE_FACTORY.state()
+
+    # Handle message
+    return message_handler.get_run(request=request, state=state)
+
+
+@rest_request_response(GetFabRequest)
+async def get_fab(request: GetFabRequest) -> GetFabResponse:
+    """GetRun."""
+    # Get ffs from app
+    ffs: Ffs = app.state.FFS_FACTORY.state()
+
+    # Handle message
+    return message_handler.get_fab(request=request, ffs=ffs)
+
+
+routes = [
+    Route("/api/v0/fleet/create-node", create_node, methods=["POST"]),
+    Route("/api/v0/fleet/delete-node", delete_node, methods=["POST"]),
+    Route("/api/v0/fleet/pull-task-ins", pull_task_ins, methods=["POST"]),
+    Route("/api/v0/fleet/push-task-res", push_task_res, methods=["POST"]),
+    Route("/api/v0/fleet/ping", ping, methods=["POST"]),
+    Route("/api/v0/fleet/get-run", get_run, methods=["POST"]),
+    Route("/api/v0/fleet/get-fab", get_fab, methods=["POST"]),
+]
+
+app: Starlette = Starlette(
+    debug=False,
+    routes=routes,
+)
+
+
+def _check_headers(headers: Headers) -> None:
+    """Check if expected headers are set."""
+    if "content-type" not in headers:
+        raise HTTPException(status_code=400, detail="Missing header `Content-Type`")
+    if headers["content-type"] != "application/protobuf":
+        raise HTTPException(status_code=400, detail="Unsupported `Content-Type`")
+    if "accept" not in headers:
+        raise HTTPException(status_code=400, detail="Missing header `Accept`")
+    if headers["accept"] != "application/protobuf":
+        raise HTTPException(status_code=400, detail="Unsupported `Accept`")

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/server/superlink/fleet/vce/backend/backend.py

@@ -33,7 +33,7 @@ class Backend(ABC):
         """Construct a backend."""
 
     @abstractmethod
-    def build(self) -> None:
+    def build(self, app_fn: Callable[[], ClientApp]) -> None:
         """Build backend.
 
         Different components need to be in place before workers in a backend are ready
@@ -60,7 +60,6 @@ class Backend(ABC):
     @abstractmethod
     def process_message(
         self,
-        app: Callable[[], ClientApp],
         message: Message,
         context: Context,
     ) -> Tuple[Message, Context]:

{flwr_nightly-1.11.0.dev20240821 → flwr_nightly-1.11.0.dev20240823}/src/py/flwr/server/superlink/fleet/vce/backend/raybackend.py

@@ -16,7 +16,7 @@
 
 import sys
 from logging import DEBUG, ERROR
-from typing import Callable, Dict, Tuple, Union
+from typing import Callable, Dict, Optional, Tuple, Union
 
 import ray
 
@@ -63,6 +63,8 @@ class RayBackend(Backend):
             actor_kwargs=actor_kwargs,
         )
 
+        self.app_fn: Optional[Callable[[], ClientApp]] = None
+
     def _validate_client_resources(self, config: BackendConfig) -> ClientResourcesDict:
         client_resources_config = config.get(self.client_resources_key)
         client_resources: ClientResourcesDict = {}
@@ -126,14 +128,15 @@ class RayBackend(Backend):
         """Report whether the pool has idle actors."""
         return self.pool.is_actor_available()
 
-    def build(self) -> None:
+    def build(self, app_fn: Callable[[], ClientApp]) -> None:
         """Build pool of Ray actors that this backend will submit jobs to."""
         self.pool.add_actors_to_pool(self.pool.actors_capacity)
+        # Set ClientApp callable that ray actors will use
+        self.app_fn = app_fn
         log(DEBUG, "Constructed ActorPool with: %i actors", self.pool.num_actors)
 
     def process_message(
         self,
-        app: Callable[[], ClientApp],
         message: Message,
         context: Context,
     ) -> Tuple[Message, Context]:
@@ -143,11 +146,17 @@ class RayBackend(Backend):
         """
         partition_id = context.node_config[PARTITION_ID_KEY]
 
+        if self.app_fn is None:
+            raise ValueError(
+                "Unspecified function to load a `ClientApp`. "
+                "Call the backend's `build()` method before processing messages."
+            )
+
         try:
             # Submit a task to the pool
             future = self.pool.submit(
                 lambda a, a_fn, mssg, cid, state: a.run.remote(a_fn, mssg, cid, state),
-                (app, message, str(partition_id), context),
+                (self.app_fn, message, str(partition_id), context),
             )
 
             # Fetch result