nvflare.private.fed.server.server_state module

class Cold2HotState(host: str = '', port: str = '', ssid: str = '')[source]

Bases: ServerState

aux_communicate(fl_ctx: FLContext) → dict[source]
get_task(fl_ctx: FLContext) → dict[source]
handle_sd_callback(sp: SP, fl_ctx: FLContext) → ServerState[source]
heartbeat(fl_ctx: FLContext) → dict[source]
register(fl_ctx: FLContext) → dict[source]

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

submit_result(fl_ctx: FLContext) → dict[source]
class ColdState(host: str = '', port: str = '', ssid: str = '')[source]

Bases: ServerState

aux_communicate(fl_ctx: FLContext) → dict[source]
get_task(fl_ctx: FLContext) → dict[source]
handle_sd_callback(sp: SP, fl_ctx: FLContext) → ServerState[source]
heartbeat(fl_ctx: FLContext) → dict[source]
register(fl_ctx: FLContext) → dict[source]

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

submit_result(fl_ctx: FLContext) → dict[source]
class Hot2ColdState(host: str = '', port: str = '', ssid: str = '')[source]

Bases: ServerState

aux_communicate(fl_ctx: FLContext) → dict[source]
get_task(fl_ctx: FLContext) → dict[source]
handle_sd_callback(sp: SP, fl_ctx: FLContext) → ServerState[source]
heartbeat(fl_ctx: FLContext) → dict[source]
register(fl_ctx: FLContext) → dict[source]

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

submit_result(fl_ctx: FLContext) → dict[source]
class HotState(host: str = '', port: str = '', ssid: str = '')[source]

Bases: ServerState

aux_communicate(fl_ctx: FLContext) → dict[source]
get_task(fl_ctx: FLContext) → dict[source]
handle_sd_callback(sp: SP, fl_ctx: FLContext) → ServerState[source]
heartbeat(fl_ctx: FLContext) → dict[source]
register(fl_ctx: FLContext) → dict[source]

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

submit_result(fl_ctx: FLContext) → dict[source]
class ServerState(host: str = '', port: str = '', ssid: str = '')[source]

Bases: ABC

ABORT_CURRENT_RUN = {'_action': 'Abort Run', '_message': 'Abort current run'}
IN_SERVICE = {'_action': 'In Service', '_message': 'Server in service'}
NOT_IN_SERVICE = {'_action': 'Not In Service', '_message': 'Server not in service'}
abstract aux_communicate(fl_ctx: FLContext) → dict[source]
abstract get_task(fl_ctx: FLContext) → dict[source]
abstract handle_sd_callback(sp: SP, fl_ctx: FLContext) → ServerState[source]
abstract heartbeat(fl_ctx: FLContext) → dict[source]
logger = <Logger ServerState (WARNING)>
abstract register(fl_ctx: FLContext) → dict[source]

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

abstract submit_result(fl_ctx: FLContext) → dict[source]
class ServiceSession(host: str = '', port: str = '', ssid: str = '')[source]

Bases: object

class ShutdownState(host: str = '', port: str = '', ssid: str = '')[source]

Bases: ServerState

aux_communicate(fl_ctx: FLContext) → dict[source]
get_task(fl_ctx: FLContext) → dict[source]
handle_sd_callback(sp: SP, fl_ctx: FLContext) → ServerState[source]
heartbeat(fl_ctx: FLContext) → dict[source]
register(fl_ctx: FLContext) → dict[source]

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

submit_result(fl_ctx: FLContext) → dict[source]