golf_federated.server.process.config.task package

golf_federated.server.process.config.task.asynchronous module

class golf_federated.server.process.config.task.asynchronous.RationAsyncTask(task_name: str, maxround: int, aggregation: golf_federated.server.process.strategy.aggregation.base.BaseFed, evaluation: golf_federated.server.process.strategy.evaluation.base.BaseEval, model: golf_federated.server.process.config.model.base.BaseModel, select: golf_federated.server.process.strategy.selection.base.BaseSelect, ration: int, module_path: str = '', isdocker: bool = False, image_name: str = '')

Bases: golf_federated.server.process.config.task.base.BaseTask

Ration Asynchronous Task object class, inheriting from Task class.

start_aggregation(aggregation_parameter: queue.Queue) → bool

Judge whether the conditions for starting aggregation have been met.

Args:

aggregation_parameter (queue.Queue): Queue for storing aggregated parameters.

Returns:

Bool: Whether to start aggregation.

class golf_federated.server.process.config.task.asynchronous.TimingAsyncTask(task_name: str, maxround: int, aggregation: golf_federated.server.process.strategy.aggregation.base.BaseFed, evaluation: golf_federated.server.process.strategy.evaluation.base.BaseEval, model: golf_federated.server.process.config.model.base.BaseModel, select: golf_federated.server.process.strategy.selection.base.BaseSelect, timing: float, module_path: str = '', isdocker: bool = False, image_name: str = '')

Bases: golf_federated.server.process.config.task.base.BaseTask

Timing Asynchronous Task object class, inheriting from Task class.

start_aggregation(aggregation_parameter: queue.Queue) → bool

Judge whether the conditions for starting aggregation have been met.

Args:

aggregation_parameter (queue.Queue): Queue for storing aggregated parameters.

Returns:

Bool: Whether to start aggregation.

golf_federated.server.process.config.task.base module

class golf_federated.server.process.config.task.base.BaseTask(task_name: str, maxround: int, synchronous: bool, aggregation: golf_federated.server.process.strategy.aggregation.base.BaseFed, evaluation: golf_federated.server.process.strategy.evaluation.base.BaseEval, model: golf_federated.server.process.config.model.base.BaseModel, select: golf_federated.server.process.strategy.selection.base.BaseSelect, module_path: str, isdocker: bool = False, image_name: str = '')

Bases: object

Task object class, the class function supports the main operation of task on Server.

info_tozip() → None

Save task info to zip.

run_aggregation(aggregation_parameter: queue.Queue) → bool

Run global model aggregation.

Args:

aggregation_parameter (queue.Queue): Queue for storing aggregated parameters.

Returns:

Bool: Whether aggregation is executed.

run_evaluation() → bool

Run global model evaluation.

Returns:

Bool: Evaluation result, indicating the continuation or completion of the task.

select_clients() → List

Select clients.

Returns:

List: Selected clients.

start(client_list: List) → None

Start Task.

Args:

client_list (list): List of clients for this task.

abstract start_aggregation(aggregation_parameter: queue.Queue) → bool

Judge whether the conditions for starting aggregation have been met.

Args:

aggregation_parameter (queue.Queue): Queue for storing aggregated parameters.

Returns:

Bool: Whether to start aggregation.

weight_tofile() → None

Save model weight to zip.

golf_federated.server.process.config.task.synchronous module

class golf_federated.server.process.config.task.synchronous.CedarTask(task_name: str, maxround: int, aggregation: golf_federated.server.process.strategy.aggregation.base.BaseFed, model: golf_federated.server.process.config.model.base.BaseModel, select: golf_federated.server.process.strategy.selection.base.BaseSelect, dataset: str, last_path: str, path_now: str, evaluation: golf_federated.server.process.strategy.evaluation.base.BaseEval, module_path: str = '', isdocker: bool = False, image_name: str = '')

Bases: golf_federated.server.process.config.task.base.BaseTask

Cedar Task object class, inheriting from Task class.

run_aggregation(aggregation_parameter: queue.Queue) → bool

Run global model aggregation.

Args:

aggregation_parameter (queue.Queue): Queue for storing aggregated parameters.

Returns:

Bool: Whether aggregation is executed.

run_evaluation() → bool

Run global model evaluation.

Returns:

Bool: Evaluation result, indicating the continuation or completion of the task.

run_localization(local_test_epoch) → pandas.core.frame.DataFrame

Run model localization.

Args:

local_test_epoch (int): Number of localization round.

Returns:

pandas.DataFrame: Localization result, including Loss, Accuracy, Precision, Recall, F1-score, and Mcc.

save_result(save_path: str) → None

Save evaulation result.

Args:

save_path (str): Path to save result.

save_result_layer(save_path: str) → None

Save result of layer.

Args:

save_path (str): Path to save result about layer.

select_clients() → List

Select clients.

Returns:

List: Selected clients.

start_aggregation(aggregation_parameter: queue.Queue) → bool

Judge whether the conditions for starting aggregation have been met.

Args:

aggregation_parameter (queue.Queue): Queue for storing aggregated parameters.

Returns:

Bool: Whether to start aggregation.

weight_tofile(save_path: str) → None

Save model weight to zip.

Args:

save_path (str): Path to save model.

class golf_federated.server.process.config.task.synchronous.SyncTask(task_name: str, maxround: int, aggregation: golf_federated.server.process.strategy.aggregation.base.BaseFed, evaluation: golf_federated.server.process.strategy.evaluation.base.BaseEval, model: golf_federated.server.process.config.model.base.BaseModel, select: golf_federated.server.process.strategy.selection.base.BaseSelect, module_path: str = '', isdocker: bool = False, image_name: str = '')

Bases: golf_federated.server.process.config.task.base.BaseTask

Synchronous Task object class, inheriting from Task class.

start_aggregation(aggregation_parameter: queue.Queue) → bool

Judge whether the conditions for starting aggregation have been met.

Args:

aggregation_parameter (queue.Queue): Queue for storing aggregated parameters.

Returns:

Bool: Whether to start aggregation.