nvflare.app_opt.xgboost.histogram_based_v2.runners.xgb_client_runner module

class XGBClientRunner(data_loader_id: str, model_file_name: str, metrics_writer_id: str | None = None)

Bases: AppRunner, FLComponent

initialize(fl_ctx: FLContext)

Called by Controller/Executor to initialize the runner. This happens when the job is about to start.

Parameters:

fl_ctx – FL context

Returns: None

is_stopped() → Tuple[bool, int]

Called to check whether the runner is already stopped.

Returns: whether the runner is stopped. If stopped, the exit code.

run(ctx: dict)

Called to start the execution of app processing logic.

Parameters:

ctx – the contextual info to help the runner execution

Returns: None

stop()

Called to stop the runner.

Returns: