flwr-nightly 1.11.0.dev20240818__tar.gz → 1.11.0.dev20240819__tar.gz

{flwr_nightly-1.11.0.dev20240818 → flwr_nightly-1.11.0.dev20240819}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.11.0.dev20240818
+Version: 1.11.0.dev20240819
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0
@@ -212,7 +212,7 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 Flower is built by a wonderful community of researchers and engineers. [Join Slack](https://flower.ai/join-slack) to meet them, [contributions](#contributing-to-flower) are welcome.
 
 <a href="https://github.com/adap/flower/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=adap/flower" />
+  <img src="https://contrib.rocks/image?repo=adap/flower&columns=10" />
 </a>
 
 ## Citation

{flwr_nightly-1.11.0.dev20240818 → flwr_nightly-1.11.0.dev20240819}/README.md

@@ -160,7 +160,7 @@ Other [examples](https://github.com/adap/flower/tree/main/examples):
 Flower is built by a wonderful community of researchers and engineers. [Join Slack](https://flower.ai/join-slack) to meet them, [contributions](#contributing-to-flower) are welcome.
 
 <a href="https://github.com/adap/flower/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=adap/flower" />
+  <img src="https://contrib.rocks/image?repo=adap/flower&columns=10" />
 </a>
 
 ## Citation

{flwr_nightly-1.11.0.dev20240818 → flwr_nightly-1.11.0.dev20240819}/pyproject.toml

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

{flwr_nightly-1.11.0.dev20240818 → flwr_nightly-1.11.0.dev20240819}/src/py/flwr/cli/install.py

@@ -173,7 +173,9 @@ def validate_and_install(
         / project_name
         / version
     )
-    if install_dir.exists() and not skip_prompt:
+    if install_dir.exists():
+        if skip_prompt:
+            return install_dir
         if not typer.confirm(
             typer.style(
                 f"\n💬 {project_name} version {version} is already installed, "

{flwr_nightly-1.11.0.dev20240818 → flwr_nightly-1.11.0.dev20240819}/src/py/flwr/client/app.py

@@ -52,7 +52,7 @@ from flwr.proto.clientappio_pb2_grpc import add_ClientAppIoServicer_to_server
 from flwr.server.superlink.fleet.grpc_bidi.grpc_server import generic_create_grpc_server
 from flwr.server.superlink.state.utils import generate_rand_int_from_bytes
 
-from .clientapp.clientappio_servicer import ClientAppIoInputs, ClientAppIoServicer
+from .clientapp.clientappio_servicer import ClientAppInputs, ClientAppIoServicer
 from .grpc_adapter_client.connection import grpc_adapter
 from .grpc_client.connection import grpc_connection
 from .grpc_rere_client.connection import grpc_request_response
@@ -62,6 +62,9 @@ from .numpy_client import NumPyClient
 
 ADDRESS_CLIENTAPPIO_API_GRPC_RERE = "0.0.0.0:9094"
 
+ISOLATION_MODE_SUBPROCESS = "subprocess"
+ISOLATION_MODE_PROCESS = "process"
+
 
 def _check_actionable_client(
     client: Optional[Client], client_fn: Optional[ClientFnExt]
@@ -207,7 +210,7 @@ def start_client_internal(
     max_retries: Optional[int] = None,
     max_wait_time: Optional[float] = None,
     flwr_path: Optional[Path] = None,
-    isolate: Optional[bool] = False,
+    isolation: Optional[str] = None,
     supernode_address: Optional[str] = ADDRESS_CLIENTAPPIO_API_GRPC_RERE,
 ) -> None:
     """Start a Flower client node which connects to a Flower server.
@@ -256,11 +259,13 @@ def start_client_internal(
         If set to None, there is no limit to the total time.
     flwr_path: Optional[Path] (default: None)
         The fully resolved path containing installed Flower Apps.
-    isolate : Optional[bool] (default: False)
-        Whether to run `ClientApp` in a separate process. By default, this value is
-        `False`, and the `ClientApp` runs in the same process as the SuperNode. If
-        `True`, the `ClientApp` runs in an isolated process and communicates using
-        gRPC at the address `supernode_address`.
+    isolation : Optional[str] (default: None)
+        Isolation mode for `ClientApp`. Possible values are `subprocess` and
+        `process`. Defaults to `None`, which runs the `ClientApp` in the same process
+        as the SuperNode. If `subprocess`, the `ClientApp` runs in a subprocess started
+        by the SueprNode and communicates using gRPC at the address
+        `supernode_address`. If `process`, the `ClientApp` runs in a separate isolated
+        process and communicates using gRPC at the address `supernode_address`.
     supernode_address : Optional[str] (default: `ADDRESS_CLIENTAPPIO_API_GRPC_RERE`)
         The SuperNode gRPC server address.
     """
@@ -288,9 +293,12 @@ def start_client_internal(
 
         load_client_app_fn = _load_client_app
 
-    if isolate:
+    if isolation:
         if supernode_address is None:
-            raise ValueError("`supernode_address` required when `isolate` is set")
+            raise ValueError(
+                f"`supernode_address` required when `isolation` is "
+                f"{ISOLATION_MODE_SUBPROCESS} or {ISOLATION_MODE_PROCESS}",
+            )
         _clientappio_grpc_server, clientappio_servicer = run_clientappio_api_grpc(
             address=supernode_address
         )
@@ -390,6 +398,7 @@ def start_client_internal(
                     )
 
             app_state_tracker.register_signal_handler()
+            # pylint: disable=too-many-nested-blocks
             while not app_state_tracker.interrupt:
                 try:
                     # Receive
@@ -431,7 +440,9 @@ def start_client_internal(
                     run: Run = runs[run_id]
                     if get_fab is not None and run.fab_hash:
                         fab = get_fab(run.fab_hash)
-                        install_from_fab(fab.content, flwr_path, True)
+                        if not isolation:
+                            # If `ClientApp` runs in the same process, install the FAB
+                            install_from_fab(fab.content, flwr_path, True)
                         fab_id, fab_version = get_fab_metadata(fab.content)
                     else:
                         fab = None
@@ -455,39 +466,51 @@ def start_client_internal(
 
                     # Handle app loading and task message
                     try:
-                        if isolate:
+                        if isolation:
+                            # Two isolation modes:
+                            # 1. `subprocess`: SuperNode is starting the ClientApp
+                            #    process as a subprocess.
+                            # 2. `process`: ClientApp process gets started separately
+                            #    (via `flwr-clientapp`), for example, in a separate
+                            #    Docker container.
+
                             # Generate SuperNode token
                             token: int = generate_rand_int_from_bytes(RUN_ID_NUM_BYTES)
 
+                            # Mode 1: SuperNode starts ClientApp as subprocess
+                            start_subprocess = isolation == ISOLATION_MODE_SUBPROCESS
+
                             # Share Message and Context with servicer
                             clientappio_servicer.set_inputs(
-                                clientapp_input=ClientAppIoInputs(
+                                clientapp_input=ClientAppInputs(
                                     message=message,
                                     context=context,
                                     run=run,
+                                    fab=fab,
                                     token=token,
                                 ),
-                                token_returned=True,
-                            )
-
-                            # Run `ClientApp` in subprocess
-                            command = [
-                                "flwr-clientapp",
-                                "--supernode",
-                                supernode_address,
-                                "--token",
-                                str(token),
-                            ]
-                            subprocess.run(
-                                command,
-                                stdout=None,
-                                stderr=None,
-                                check=True,
+                                token_returned=start_subprocess,
                             )
 
-                            # Wait for output to become available
-                            while not clientappio_servicer.has_outputs():
-                                time.sleep(0.1)
+                            if start_subprocess:
+                                # Start ClientApp subprocess
+                                command = [
+                                    "flwr-clientapp",
+                                    "--supernode",
+                                    supernode_address,
+                                    "--token",
+                                    str(token),
+                                ]
+                                subprocess.run(
+                                    command,
+                                    stdout=None,
+                                    stderr=None,
+                                    check=True,
+                                )
+                            else:
+                                # Wait for output to become available
+                                while not clientappio_servicer.has_outputs():
+                                    time.sleep(0.1)
 
                             outputs = clientappio_servicer.get_outputs()
                             reply_message, context = outputs.message, outputs.context
@@ -544,6 +567,7 @@ def start_client_internal(
                 except StopIteration:
                     sleep_duration = 0
                     break
+            # pylint: enable=too-many-nested-blocks
 
             # Unregister node
             if delete_node is not None and app_state_tracker.is_connected:

flwr_nightly-1.11.0.dev20240819/src/py/flwr/client/clientapp/app.py

@@ -0,0 +1,233 @@
+# 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 ClientApp process."""
+
+import argparse
+import time
+from logging import DEBUG, ERROR, INFO
+from typing import Optional, Tuple
+
+import grpc
+
+from flwr.cli.install import install_from_fab
+from flwr.client.client_app import ClientApp, LoadClientAppError
+from flwr.common import Context, Message
+from flwr.common.constant import ErrorCode
+from flwr.common.grpc import create_channel
+from flwr.common.logger import log
+from flwr.common.message import Error
+from flwr.common.serde import (
+    context_from_proto,
+    context_to_proto,
+    fab_from_proto,
+    message_from_proto,
+    message_to_proto,
+    run_from_proto,
+)
+from flwr.common.typing import Fab, Run
+
+# pylint: disable=E0611
+from flwr.proto.clientappio_pb2 import (
+    GetTokenRequest,
+    GetTokenResponse,
+    PullClientAppInputsRequest,
+    PullClientAppInputsResponse,
+    PushClientAppOutputsRequest,
+    PushClientAppOutputsResponse,
+)
+from flwr.proto.clientappio_pb2_grpc import ClientAppIoStub
+
+from .utils import get_load_client_app_fn
+
+
+def flwr_clientapp() -> None:
+    """Run process-isolated Flower ClientApp."""
+    log(INFO, "Starting Flower ClientApp")
+
+    parser = argparse.ArgumentParser(
+        description="Run a Flower ClientApp",
+    )
+    parser.add_argument(
+        "--supernode",
+        type=str,
+        help="Address of SuperNode ClientAppIo gRPC servicer",
+    )
+    parser.add_argument(
+        "--token",
+        type=int,
+        required=False,
+        help="Unique token generated by SuperNode for each ClientApp execution",
+    )
+    args = parser.parse_args()
+
+    log(
+        DEBUG,
+        "Staring isolated `ClientApp` connected to SuperNode ClientAppIo at %s "
+        "with token %s",
+        args.supernode,
+        args.token,
+    )
+    run_clientapp(supernode=args.supernode, token=args.token)
+
+
+def on_channel_state_change(channel_connectivity: str) -> None:
+    """Log channel connectivity."""
+    log(DEBUG, channel_connectivity)
+
+
+def run_clientapp(  # pylint: disable=R0914
+    supernode: str,
+    token: Optional[int] = None,
+) -> None:
+    """Run Flower ClientApp process.
+
+    Parameters
+    ----------
+    supernode : str
+        Address of SuperNode
+    token : Optional[int] (default: None)
+        Unique SuperNode token for ClientApp-SuperNode authentication
+    """
+    channel = create_channel(
+        server_address=supernode,
+        insecure=True,
+    )
+    channel.subscribe(on_channel_state_change)
+
+    try:
+        stub = ClientAppIoStub(channel)
+
+        only_once = token is not None
+        while True:
+            # If token is not set, loop until token is received from SuperNode
+            while token is None:
+                token = get_token(stub)
+                time.sleep(1)
+
+            # Pull Message, Context, Run and (optional) FAB from SuperNode
+            message, context, run, fab = pull_message(stub=stub, token=token)
+
+            # Install FAB, if provided
+            if fab:
+                log(DEBUG, "Flower ClientApp starts FAB installation.")
+                install_from_fab(fab.content, flwr_dir=None, skip_prompt=True)
+
+            load_client_app_fn = get_load_client_app_fn(
+                default_app_ref="",
+                app_path=None,
+                multi_app=True,
+                flwr_dir=None,
+            )
+
+            try:
+                # Load ClientApp
+                client_app: ClientApp = load_client_app_fn(run.fab_id, run.fab_version)
+
+                # Execute ClientApp
+                reply_message = client_app(message=message, context=context)
+            except Exception as ex:  # pylint: disable=broad-exception-caught
+                # Don't update/change NodeState
+
+                e_code = ErrorCode.CLIENT_APP_RAISED_EXCEPTION
+                # Ex fmt: "<class 'ZeroDivisionError'>:<'division by zero'>"
+                reason = str(type(ex)) + ":<'" + str(ex) + "'>"
+                exc_entity = "ClientApp"
+                if isinstance(ex, LoadClientAppError):
+                    reason = (
+                        "An exception was raised when attempting to load `ClientApp`"
+                    )
+                    e_code = ErrorCode.LOAD_CLIENT_APP_EXCEPTION
+
+                log(ERROR, "%s raised an exception", exc_entity, exc_info=ex)
+
+                # Create error message
+                reply_message = message.create_error_reply(
+                    error=Error(code=e_code, reason=reason)
+                )
+
+            # Push Message and Context to SuperNode
+            _ = push_message(
+                stub=stub, token=token, message=reply_message, context=context
+            )
+
+            # Reset token to `None` to prevent flwr-clientapp from trying to pull the
+            # same inputs again
+            token = None
+
+            # Stop the loop if `flwr-clientapp` is expected to process only a single
+            # message
+            if only_once:
+                break
+
+    except KeyboardInterrupt:
+        log(INFO, "Closing connection")
+    except grpc.RpcError as e:
+        log(ERROR, "GRPC error occurred: %s", str(e))
+    finally:
+        channel.close()
+
+
+def get_token(stub: grpc.Channel) -> Optional[int]:
+    """Get a token from SuperNode."""
+    log(DEBUG, "Flower ClientApp process requests token")
+    try:
+        res: GetTokenResponse = stub.GetToken(GetTokenRequest())
+        log(DEBUG, "[GetToken] Received token: %s", res.token)
+        return res.token
+    except grpc.RpcError as e:
+        if e.code() == grpc.StatusCode.FAILED_PRECONDITION:  # pylint: disable=no-member
+            log(DEBUG, "[GetToken] No token available yet")
+        else:
+            log(ERROR, "[GetToken] gRPC error occurred: %s", str(e))
+        return None
+
+
+def pull_message(
+    stub: grpc.Channel, token: int
+) -> Tuple[Message, Context, Run, Optional[Fab]]:
+    """Pull message from SuperNode to ClientApp."""
+    log(INFO, "Pulling ClientAppInputs for token %s", token)
+    try:
+        res: PullClientAppInputsResponse = stub.PullClientAppInputs(
+            PullClientAppInputsRequest(token=token)
+        )
+        message = message_from_proto(res.message)
+        context = context_from_proto(res.context)
+        run = run_from_proto(res.run)
+        fab = fab_from_proto(res.fab) if res.fab else None
+        return message, context, run, fab
+    except grpc.RpcError as e:
+        log(ERROR, "[PullClientAppInputs] gRPC error occurred: %s", str(e))
+        raise e
+
+
+def push_message(
+    stub: grpc.Channel, token: int, message: Message, context: Context
+) -> PushClientAppOutputsResponse:
+    """Push message to SuperNode from ClientApp."""
+    log(INFO, "Pushing ClientAppOutputs for token %s", token)
+    proto_message = message_to_proto(message)
+    proto_context = context_to_proto(context)
+
+    try:
+        res: PushClientAppOutputsResponse = stub.PushClientAppOutputs(
+            PushClientAppOutputsRequest(
+                token=token, message=proto_message, context=proto_context
+            )
+        )
+        return res
+    except grpc.RpcError as e:
+        log(ERROR, "[PushClientAppOutputs] gRPC error occurred: %s", str(e))
+        raise e

{flwr_nightly-1.11.0.dev20240818 → flwr_nightly-1.11.0.dev20240819}/src/py/flwr/client/clientapp/clientappio_servicer.py

@@ -27,11 +27,12 @@ from flwr.common.serde import (
     clientappstatus_to_proto,
     context_from_proto,
     context_to_proto,
+    fab_to_proto,
     message_from_proto,
     message_to_proto,
     run_to_proto,
 )
-from flwr.common.typing import Run
+from flwr.common.typing import Fab, Run
 
 # pylint: disable=E0611
 from flwr.proto import clientappio_pb2_grpc
@@ -46,17 +47,18 @@ from flwr.proto.clientappio_pb2 import (  # pylint: disable=E0401
 
 
 @dataclass
-class ClientAppIoInputs:
+class ClientAppInputs:
     """Specify the inputs to the ClientApp."""
 
     message: Message
     context: Context
     run: Run
+    fab: Optional[Fab]
     token: int
 
 
 @dataclass
-class ClientAppIoOutputs:
+class ClientAppOutputs:
     """Specify the outputs from the ClientApp."""
 
     message: Message
@@ -68,8 +70,8 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
     """ClientAppIo API servicer."""
 
     def __init__(self) -> None:
-        self.clientapp_input: Optional[ClientAppIoInputs] = None
-        self.clientapp_output: Optional[ClientAppIoOutputs] = None
+        self.clientapp_input: Optional[ClientAppInputs] = None
+        self.clientapp_output: Optional[ClientAppOutputs] = None
         self.token_returned: bool = False
         self.inputs_returned: bool = False
 
@@ -79,13 +81,13 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         """Get token."""
         log(DEBUG, "ClientAppIo.GetToken")
 
-        # Fail if no ClientAppIoInputs are available
+        # Fail if no ClientAppInputs are available
         if self.clientapp_input is None:
             context.abort(
                 grpc.StatusCode.FAILED_PRECONDITION,
                 "No inputs available.",
             )
-        clientapp_input = cast(ClientAppIoInputs, self.clientapp_input)
+        clientapp_input = cast(ClientAppInputs, self.clientapp_input)
 
         # Fail if token was already returned in a previous call
         if self.token_returned:
@@ -95,7 +97,7 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
             )
 
         # If
-        # - ClientAppIoInputs is set, and
+        # - ClientAppInputs is set, and
         # - token hasn't been returned before,
         # return token
         self.token_returned = True
@@ -107,13 +109,13 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         """Pull Message, Context, and Run."""
         log(DEBUG, "ClientAppIo.PullClientAppInputs")
 
-        # Fail if no ClientAppIoInputs are available
+        # Fail if no ClientAppInputs are available
         if self.clientapp_input is None:
             context.abort(
                 grpc.StatusCode.FAILED_PRECONDITION,
                 "No inputs available.",
             )
-        clientapp_input = cast(ClientAppIoInputs, self.clientapp_input)
+        clientapp_input = cast(ClientAppInputs, self.clientapp_input)
 
         # Fail if token wasn't returned in a previous call
         if not self.token_returned:
@@ -136,6 +138,7 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
             message=message_to_proto(clientapp_input.message),
             context=context_to_proto(clientapp_input.context),
             run=run_to_proto(clientapp_input.run),
+            fab=fab_to_proto(clientapp_input.fab) if clientapp_input.fab else None,
         )
 
     def PushClientAppOutputs(
@@ -144,13 +147,13 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         """Push Message and Context."""
         log(DEBUG, "ClientAppIo.PushClientAppOutputs")
 
-        # Fail if no ClientAppIoInputs are available
+        # Fail if no ClientAppInputs are available
         if not self.clientapp_input:
             context.abort(
                 grpc.StatusCode.FAILED_PRECONDITION,
                 "No inputs available.",
             )
-        clientapp_input = cast(ClientAppIoInputs, self.clientapp_input)
+        clientapp_input = cast(ClientAppInputs, self.clientapp_input)
 
         # Fail if token wasn't returned in a previous call
         if not self.token_returned:
@@ -178,7 +181,7 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         # Preconditions met
         try:
             # Update Message and Context
-            self.clientapp_output = ClientAppIoOutputs(
+            self.clientapp_output = ClientAppOutputs(
                 message=message_from_proto(request.message),
                 context=context_from_proto(request.context),
             )
@@ -196,13 +199,13 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         return PushClientAppOutputsResponse(status=proto_status)
 
     def set_inputs(
-        self, clientapp_input: ClientAppIoInputs, token_returned: bool
+        self, clientapp_input: ClientAppInputs, token_returned: bool
     ) -> None:
         """Set ClientApp inputs.
 
         Parameters
         ----------
-        clientapp_input : ClientAppIoInputs
+        clientapp_input : ClientAppInputs
             The inputs to the ClientApp.
         token_returned : bool
             A boolean indicating if the token has been returned.
@@ -215,9 +218,10 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
             or self.token_returned
         ):
             raise ValueError(
-                "ClientAppIoInputs and ClientAppIoOutputs must not be set before "
+                "ClientAppInputs and ClientAppOutputs must not be set before "
                 "calling `set_inputs`."
             )
+        log(DEBUG, "ClientAppInputs set (token: %s)", clientapp_input.token)
         self.clientapp_input = clientapp_input
         self.token_returned = token_returned
 
@@ -225,13 +229,13 @@ class ClientAppIoServicer(clientappio_pb2_grpc.ClientAppIoServicer):
         """Check if ClientAppOutputs are available."""
         return self.clientapp_output is not None
 
-    def get_outputs(self) -> ClientAppIoOutputs:
+    def get_outputs(self) -> ClientAppOutputs:
         """Get ClientApp outputs."""
         if self.clientapp_output is None:
-            raise ValueError("ClientAppIoOutputs not set before calling `get_outputs`.")
+            raise ValueError("ClientAppOutputs not set before calling `get_outputs`.")
 
         # Set outputs to a local variable and clear state
-        output: ClientAppIoOutputs = self.clientapp_output
+        output: ClientAppOutputs = self.clientapp_output
         self.clientapp_input = None
         self.clientapp_output = None
         self.token_returned = False

{flwr_nightly-1.11.0.dev20240818 → flwr_nightly-1.11.0.dev20240819}/src/py/flwr/client/supernode/app.py

@@ -37,7 +37,11 @@ from flwr.common.constant import (
 from flwr.common.exit_handlers import register_exit_handlers
 from flwr.common.logger import log, warn_deprecated_feature
 
-from ..app import start_client_internal
+from ..app import (
+    ISOLATION_MODE_PROCESS,
+    ISOLATION_MODE_SUBPROCESS,
+    start_client_internal,
+)
 from ..clientapp.utils import get_load_client_app_fn
 
 ADDRESS_FLEET_API_GRPC_RERE = "0.0.0.0:9092"
@@ -62,6 +66,8 @@ def run_supernode() -> None:
     )
     authentication_keys = _try_setup_client_authentication(args)
 
+    log(DEBUG, "Isolation mode: %s", args.isolation)
+
     start_client_internal(
         server_address=args.superlink,
         load_client_app_fn=load_fn,
@@ -72,7 +78,7 @@ def run_supernode() -> None:
         max_retries=args.max_retries,
         max_wait_time=args.max_wait_time,
         node_config=parse_config_args([args.node_config]),
-        isolate=args.isolate,
+        isolation=args.isolation,
         supernode_address=args.supernode_address,
     )
 
@@ -199,10 +205,18 @@ def _parse_args_run_supernode() -> argparse.ArgumentParser:
     """,
     )
     parser.add_argument(
-        "--isolate",
-        action="store_true",
-        help="Run `ClientApp` in an isolated subprocess. By default, `ClientApp` "
-        "runs in the same process that executes the SuperNode.",
+        "--isolation",
+        default=None,
+        required=False,
+        choices=[
+            ISOLATION_MODE_SUBPROCESS,
+            ISOLATION_MODE_PROCESS,
+        ],
+        help="Isolation mode when running `ClientApp` (optional, possible values: "
+        "`subprocess`, `process`). By default, `ClientApp` runs in the same process "
+        "that executes the SuperNode. Use `subprocess` to configure SuperNode to run "
+        "`ClientApp` in a subprocess. Use `process` to indicate that a separate "
+        "independent process gets created outside of SuperNode.",
     )
     parser.add_argument(
         "--supernode-address",