Source code for nvflare.app_common.abstract.launcher

# Copyright (c) 2023, NVIDIA CORPORATION.  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
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.

import os
from abc import ABC, abstractmethod

from nvflare.apis.fl_context import FLContext
from nvflare.apis.shareable import Shareable
from nvflare.apis.signal import Signal
from nvflare.apis.workspace import Workspace

[docs]class LauncherRunStatus: COMPLETE_SUCCESS = "success" COMPLETE_FAILED = "failed" RUNNING = "running" NOT_RUNNING = "not_running"
[docs]class Launcher(ABC):
[docs] def initialize(self, fl_ctx: FLContext) -> None: pass
[docs] def finalize(self, fl_ctx: FLContext) -> None: pass
[docs] @staticmethod def get_app_dir(fl_ctx: FLContext) -> str: """Gets the deployed application directory.""" workspace: Workspace = fl_ctx.get_engine().get_workspace() app_dir = workspace.get_app_dir(fl_ctx.get_job_id()) return os.path.abspath(app_dir)
[docs] @abstractmethod def launch_task(self, task_name: str, shareable: Shareable, fl_ctx: FLContext, abort_signal: Signal) -> bool: """Launches external system to handle a task. Args: task_name (str): task name. shareable (Shareable): input shareable. fl_ctx (FLContext): fl context. abort_signal (Signal): signal to check during execution to determine whether this task is aborted. Returns: Whether launch success or not. """ pass
[docs] @abstractmethod def stop_task(self, task_name: str, fl_ctx: FLContext, abort_signal: Signal) -> None: """Stops external system and free up resources. Args: task_name (str): task name. fl_ctx (FLContext): fl context. """ pass
[docs] @abstractmethod def check_run_status(self, task_name: str, fl_ctx: FLContext) -> str: """Checks the run status of Launcher.""" pass