nvflare.private.fed.server.server_commands module¶
FL Admin commands.
- class AbortCommand[source]¶
Bases:
CommandProcessor
To implement the abort command.
- class ByeCommand[source]¶
Bases:
CommandProcessor
To implement the ShutdownCommand.
- class CommandProcessor[source]¶
Bases:
ABC
The CommandProcessor is responsible for processing a command from parent process.
- class GetErrorsCommand[source]¶
Bases:
CommandProcessor
To implement the show_errors command.
- class GetRunInfoCommand[source]¶
Bases:
CommandProcessor
Implements the GET_RUN_INFO command.
- class GetTaskCommand[source]¶
Bases:
CommandProcessor
,ServerStateCheck
To implement the server GetTask command.
- class HandleDeadJobCommand[source]¶
Bases:
CommandProcessor
To implement the server HandleDeadJob command.
- class HeartbeatCommand[source]¶
Bases:
CommandProcessor
To implement the HEARTBEATCommand.
- class ResetErrorsCommand[source]¶
Bases:
CommandProcessor
To implement the show_errors command.
- class ServerCommands[source]¶
Bases:
object
AdminCommands contains all the commands for processing the commands from the parent process.
- client_request_commands_names = ['get_task', 'submit_update']¶
- commands: List[CommandProcessor] = [<nvflare.private.fed.server.server_commands.AbortCommand object>, <nvflare.private.fed.server.server_commands.ByeCommand object>, <nvflare.private.fed.server.server_commands.GetRunInfoCommand object>, <nvflare.private.fed.server.server_commands.GetTaskCommand object>, <nvflare.private.fed.server.server_commands.SubmitUpdateCommand object>, <nvflare.private.fed.server.server_commands.HandleDeadJobCommand object>, <nvflare.private.fed.server.server_commands.ShowStatsCommand object>, <nvflare.private.fed.server.server_commands.GetErrorsCommand object>, <nvflare.private.fed.server.server_commands.ResetErrorsCommand object>, <nvflare.private.fed.server.server_commands.HeartbeatCommand object>, <nvflare.private.fed.server.server_commands.ServerStateCommand object>]¶
- static get_command(command_name)[source]¶
Call to return the AdminCommand object.
- Parameters:
command_name – AdminCommand name
Returns: AdminCommand object
- static register_command(command_processor: CommandProcessor)[source]¶
Call to register the AdminCommand processor.
- Parameters:
command_processor – AdminCommand processor
- class ServerStateCommand[source]¶
Bases:
CommandProcessor
To implement the ServerStateCommand.
- class ShowStatsCommand[source]¶
Bases:
CommandProcessor
To implement the show_stats command.
- class SubmitUpdateCommand[source]¶
Bases:
CommandProcessor
,ServerStateCheck
To implement the server GetTask command.