nvflare.app_opt.xgboost.histogram_based_v2.runner module

class XGBRunner[source]

Bases: ABC

An XGBRunner implements XGB (server or client) processing logic.

initialize(fl_ctx: FLContext)[source]

Initializes the runner. This happens when the job is about to start.

Parameters:

fl_ctx – FL context

Returns:

None

abstract is_stopped() → Tuple[bool, int][source]

Checks whether the runner is already stopped.

Returns:

A tuple of (whether the runner is stopped, exit code)

abstract run(ctx: dict)[source]

Runs XGB processing logic.

Parameters:

ctx – the contextual info to help the runner execution

Returns:

None

abstract stop()[source]

Stops the runner.

Returns:

None