# 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
#
# 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.
import time
import nvflare.fuel.utils.app_config_utils as acu
from nvflare.apis.event_type import EventType
from nvflare.apis.fl_component import FLComponent
from nvflare.apis.fl_constant import ConfigVarName, FLContextKey
from nvflare.apis.fl_context import FLContext
from nvflare.apis.fl_exception import NotReadyToEndRun
[docs]
class TBI(FLComponent):
"""(TBI) Task Based Interaction is the base class for ServerRunner and ClientRunner that implement details of
task based interactions.
TBI implements common behavior of ServerRunner and ClientRunner.
"""
def __init__(self):
super().__init__()
[docs]
@staticmethod
def get_positive_float_var(var_name, default):
return acu.get_positive_float_var(var_name, default)
[docs]
@staticmethod
def get_positive_int_var(var_name, default):
return acu.get_positive_int_var(var_name, default)
def _any_component_is_not_ready(self, fl_ctx: FLContext) -> bool:
any_component_not_ready = fl_ctx.get_prop(FLContextKey.NOT_READY_TO_END_RUN, False)
if any_component_not_ready:
self.log_debug(fl_ctx, "NOT_READY_TO_END_RUN property is set")
return True
# check any one has raised NotReadyToEndRun exception
exceptions = fl_ctx.get_prop(FLContextKey.EXCEPTIONS)
if isinstance(exceptions, dict):
for handler_name, ex in exceptions.items():
if isinstance(ex, NotReadyToEndRun):
self.log_debug(fl_ctx, f"component {handler_name} is not ready to end run")
return True
return False
[docs]
def check_end_run_readiness(self, fl_ctx: FLContext):
"""Check with all components for their readiness to end run
Args:
fl_ctx: the FL context
Returns:
"""
max_wait = self.get_positive_float_var(ConfigVarName.END_RUN_READINESS_TIMEOUT, 5.0)
check_interval = self.get_positive_float_var(ConfigVarName.END_RUN_READINESS_CHECK_INTERVAL, 0.5)
self.log_debug(fl_ctx, f"=== end_run_readiness: {max_wait=} {check_interval=}")
check_start_time = time.time()
while True:
fl_ctx.remove_prop(FLContextKey.NOT_READY_TO_END_RUN, force_removal=True)
fl_ctx.remove_prop(FLContextKey.EXCEPTIONS, force_removal=True)
self.log_info(fl_ctx, "Firing CHECK_END_RUN_READINESS ...")
self.fire_event(EventType.CHECK_END_RUN_READINESS, fl_ctx)
if self._any_component_is_not_ready(fl_ctx):
if time.time() - check_start_time > max_wait:
# we have waited too long
self.log_warning(fl_ctx, f"quit waiting for component ready-to-end-run after {max_wait} seconds")
return
else:
time.sleep(check_interval)
else:
# all components are ready to end
return