add doc string for auxiliaries

doc/source/core.rst

@@ -50,3 +50,10 @@ federatedscope.core.monitors
 .. automodule:: federatedscope.core.monitors
     :members:
     :private-members:
+
+federatedscope.core.auxiliaries
+-----------------------
+
+.. automodule:: federatedscope.core.auxiliaries
+    :members:
+    :private-members:

federatedscope/attack/auxiliary/poisoning_data.py

@@ -2,7 +2,7 @@
 from PIL import Image
 import numpy as np
 from torchvision import transforms
-from federatedscope.core.auxiliaries.transform_builder import get_transform
+from federatedscope.core.auxiliaries import get_transform
 from federatedscope.attack.auxiliary.backdoor_utils import selectTrigger
 from torch.utils.data import DataLoader
 from federatedscope.attack.auxiliary.backdoor_utils import normalize

federatedscope/attack/privacy_attacks/passive_PIA.py

@@ -3,7 +3,7 @@
 import torch
 import numpy as np
 import copy
-from federatedscope.core.auxiliaries.optimizer_builder import get_optimizer
+from federatedscope.core.auxiliaries import get_optimizer
 
 import logging
 

federatedscope/attack/worker_as_attacker/server_attacker.py

@@ -1,7 +1,7 @@
 from federatedscope.core.workers import Server
 from federatedscope.core.message import Message
 
-from federatedscope.core.auxiliaries.criterion_builder import get_criterion
+from federatedscope.core.auxiliaries import get_criterion
 import copy
 from federatedscope.attack.auxiliary.utils import get_data_sav_fn, \
     get_reconstructor

federatedscope/autotune/algos.py

@@ -10,10 +10,8 @@
 import numpy as np
 
 from federatedscope.core.auxiliaries.utils import setup_seed
-from federatedscope.core.auxiliaries.data_builder import get_data
-from federatedscope.core.auxiliaries.worker_builder import get_client_cls, \
-    get_server_cls
-from federatedscope.core.fed_runner import get_runner
+from federatedscope.core.auxiliaries import get_data, get_client_cls, \
+    get_server_cls, get_runner
 from federatedscope.autotune.utils import parse_search_space, \
     config2cmdargs, config2str, summarize_hpo_results
 

federatedscope/autotune/utils.py

@@ -37,12 +37,12 @@ def parse_search_space(config_path):
 
 
 def config2cmdargs(config):
-    '''
+    """
     Arguments:
         config (dict): key is cfg node name, value is the specified value.
     Returns:
         results (list): cmd args
-    '''
+    """
 
     results = []
     for k, v in config.items():
@@ -52,13 +52,13 @@ def config2cmdargs(config):
 
 
 def config2str(config):
-    '''
+    """
     Arguments:
         config (dict): key is cfg node name, value is the choice of
         hyper-parameter.
     Returns:
         name (str): the string representation of this config
-    '''
+    """
 
     vals = []
     for k in config:
@@ -136,10 +136,9 @@ def process(file):
 def eval_in_fs(cfg, config, budget):
     import ConfigSpace as CS
     from federatedscope.core.auxiliaries.utils import setup_seed
-    from federatedscope.core.auxiliaries.data_builder import get_data
     from federatedscope.core.auxiliaries.worker_builder import \
         get_client_cls, get_server_cls
-    from federatedscope.core.fed_runner import get_runner
+    from federatedscope.core.auxiliaries import get_runner, get_data
     from federatedscope.autotune.utils import config2cmdargs
     from os.path import join as osp
 

federatedscope/core/aggregators/fedopt_aggregator.py

@@ -1,7 +1,7 @@
 import torch
 
 from federatedscope.core.aggregators import ClientsAvgAggregator
-from federatedscope.core.auxiliaries.optimizer_builder import get_optimizer
+from federatedscope.core.auxiliaries import get_optimizer
 
 
 class FedOptAggregator(ClientsAvgAggregator):

federatedscope/core/auxiliaries/__init__.py

@@ -0,0 +1,22 @@
+from federatedscope.core.auxiliaries.aggregator_builder import get_aggregator
+from federatedscope.core.auxiliaries.criterion_builder import get_criterion
+from federatedscope.core.auxiliaries.data_builder import get_data
+from federatedscope.core.auxiliaries.dataloader_builder import get_dataloader
+from federatedscope.core.auxiliaries.metric_builder import get_metric
+from federatedscope.core.auxiliaries.model_builder import get_model
+from federatedscope.core.auxiliaries.optimizer_builder import get_optimizer
+from federatedscope.core.auxiliaries.sampler_builder import get_sampler
+from federatedscope.core.auxiliaries.scheduler_builder import get_scheduler
+from federatedscope.core.auxiliaries.splitter_builder import get_splitter
+from federatedscope.core.auxiliaries.trainer_builder import get_trainer
+from federatedscope.core.auxiliaries.transform_builder import get_transform
+from federatedscope.core.auxiliaries.runner_builder import get_runner
+from federatedscope.core.auxiliaries.worker_builder import get_client_cls, \
+    get_server_cls
+
+__all__ = [
+    'get_aggregator', 'get_criterion', 'get_data', 'get_dataloader',
+    'get_metric', 'get_model', 'get_optimizer', 'get_sampler', 'get_scheduler',
+    'get_splitter', 'get_trainer', 'get_transform', 'get_client_cls',
+    'get_server_cls', 'get_runner'
+]

federatedscope/core/auxiliaries/runner_builder.py

@@ -0,0 +1,15 @@
+from federatedscope.core.fed_runner import StandaloneRunner, DistributedRunner
+
+
+def get_runner(data, server_class, client_class, config, client_configs=None):
+    # Instantiate a Runner based on a configuration file
+    mode = config.federate.mode.lower()
+    runner_dict = {
+        'standalone': StandaloneRunner,
+        'distributed': DistributedRunner
+    }
+    return runner_dict[mode](data=data,
+                             server_class=server_class,
+                             client_class=client_class,
+                             config=config,
+                             client_configs=client_configs)

federatedscope/core/auxiliaries/trainer_builder.py

@@ -44,7 +44,7 @@ def get_trainer(model=None,
         data: data used in FL course
         device: where to train model (``cpu`` or ``gpu``)
         config: configurations for FL, see ``federatedscope.core.configs``
-        only_for_eval: ``True`` or ``False``, if ``True``, ``train`` \
+        only_for_eval: ``True`` or ``False``, if ``True``, train \
         routine will be removed in this trainer
         is_attacker: ``True`` or ``False`` to determine whether this client \
         is an attacker

federatedscope/core/data/base_data.py

@@ -1,6 +1,6 @@
 import logging
 from federatedscope.core.data.utils import merge_data
-from federatedscope.core.auxiliaries.dataloader_builder import get_dataloader
+from federatedscope.core.auxiliaries import get_dataloader
 
 logger = logging.getLogger(__name__)
 

federatedscope/core/data/base_translator.py

@@ -1,7 +1,7 @@
 import logging
 import numpy as np
 
-from federatedscope.core.auxiliaries.splitter_builder import get_splitter
+from federatedscope.core.auxiliaries import get_splitter
 from federatedscope.core.data import ClientData, StandaloneDataDict
 
 logger = logging.getLogger(__name__)

federatedscope/core/data/utils.py

@@ -111,7 +111,7 @@ def load_external_data(config=None):
     import torch
     from importlib import import_module
     from torch.utils.data import DataLoader
-    from federatedscope.core.auxiliaries.transform_builder import get_transform
+    from federatedscope.core.auxiliaries import get_transform
 
     def load_torchvision_data(name, splits=None, config=None):
         dataset_func = getattr(import_module('torchvision.datasets'), name)

federatedscope/core/fed_runner.py

@@ -8,27 +8,12 @@
 
 from federatedscope.core.workers import Server, Client
 from federatedscope.core.gpu_manager import GPUManager
-from federatedscope.core.auxiliaries.model_builder import get_model
+from federatedscope.core.auxiliaries import get_model
 from federatedscope.core.auxiliaries.utils import get_resource_info
-from federatedscope.core.data.utils import merge_data
 
 logger = logging.getLogger(__name__)
 
 
-def get_runner(data, server_class, client_class, config, client_configs=None):
-    # Instantiate a Runner based on a configuration file
-    mode = config.federate.mode.lower()
-    runner_dict = {
-        'standalone': StandaloneRunner,
-        'distributed': DistributedRunner
-    }
-    return runner_dict[mode](data=data,
-                             server_class=server_class,
-                             client_class=client_class,
-                             config=config,
-                             client_configs=client_configs)
-
-
 class BaseRunner(object):
     """
     This class is used to construct an FL course, which includes `_set_up`

federatedscope/core/monitors/metric_calculator.py

@@ -5,7 +5,7 @@
 from scipy.special import softmax
 from sklearn.metrics import roc_auc_score, average_precision_score, f1_score
 
-from federatedscope.core.auxiliaries.metric_builder import get_metric
+from federatedscope.core.auxiliaries import get_metric
 
 # Blind torch
 try:

federatedscope/core/trainers/context.py

@@ -1,7 +1,7 @@
 import logging
 import collections
 
-from federatedscope.core.auxiliaries.criterion_builder import get_criterion
+from federatedscope.core.auxiliaries import get_criterion
 from federatedscope.core.auxiliaries.model_builder import \
     get_trainable_para_names
 from federatedscope.core.auxiliaries.regularizer_builder import get_regularizer

federatedscope/core/trainers/torch_trainer.py

@@ -13,11 +13,10 @@
 from federatedscope.core.trainers.enums import MODE, LIFECYCLE
 from federatedscope.core.trainers.trainer import Trainer
 from federatedscope.core.trainers.context import CtxVar
-from federatedscope.core.auxiliaries.optimizer_builder import get_optimizer
-from federatedscope.core.auxiliaries.scheduler_builder import get_scheduler
+from federatedscope.core.auxiliaries import get_optimizer, get_dataloader, \
+    get_scheduler
 from federatedscope.core.data import ClientData
 from federatedscope.core.data.wrap_dataset import WrapDataset
-from federatedscope.core.auxiliaries.dataloader_builder import get_dataloader
 from federatedscope.core.auxiliaries.ReIterator import ReIterator
 from federatedscope.core.auxiliaries.utils import param2tensor, \
     merge_param_dict

federatedscope/core/trainers/trainer_Ditto.py

@@ -3,7 +3,7 @@
 
 import torch
 
-from federatedscope.core.auxiliaries.optimizer_builder import get_optimizer
+from federatedscope.core.auxiliaries import get_optimizer
 from federatedscope.core.trainers.torch_trainer import GeneralTorchTrainer
 from federatedscope.core.optimizer import wrap_regularized_optimizer
 from federatedscope.core.trainers.utils import calculate_batch_epoch_num

federatedscope/core/trainers/trainer_multi_model.py

@@ -2,7 +2,7 @@
 from types import FunctionType
 from typing import Type
 
-from federatedscope.core.auxiliaries.optimizer_builder import get_optimizer
+from federatedscope.core.auxiliaries import get_optimizer
 from federatedscope.core.trainers.torch_trainer import GeneralTorchTrainer
 
 import numpy as np

federatedscope/core/workers/client.py

@@ -7,8 +7,7 @@
 from federatedscope.core.communication import StandaloneCommManager, \
     gRPCCommManager
 from federatedscope.core.monitors.early_stopper import EarlyStopper
-from federatedscope.core.workers import Worker
-from federatedscope.core.auxiliaries.trainer_builder import get_trainer
+from federatedscope.core.auxiliaries import get_trainer
 from federatedscope.core.secret_sharing import AdditiveSecretSharing
 from federatedscope.core.auxiliaries.utils import merge_dict_of_results, \
     calculate_time_cost

federatedscope/core/workers/server.py

@@ -10,11 +10,11 @@
 from federatedscope.core.message import Message
 from federatedscope.core.communication import StandaloneCommManager, \
     gRPCCommManager
-from federatedscope.core.auxiliaries.aggregator_builder import get_aggregator
-from federatedscope.core.auxiliaries.sampler_builder import get_sampler
+from federatedscope.core.auxiliaries import get_aggregator
+from federatedscope.core.auxiliaries import get_sampler
 from federatedscope.core.auxiliaries.utils import merge_dict_of_results, \
     Timeout, merge_param_dict
-from federatedscope.core.auxiliaries.trainer_builder import get_trainer
+from federatedscope.core.auxiliaries import get_trainer
 from federatedscope.core.secret_sharing import AdditiveSecretSharing
 from federatedscope.core.workers.base_server import BaseServer
 

federatedscope/cv/dataloader/dataloader.py

@@ -1,5 +1,5 @@
 from federatedscope.cv.dataset.leaf_cv import LEAF_CV
-from federatedscope.core.auxiliaries.transform_builder import get_transform
+from federatedscope.core.auxiliaries import get_transform
 
 
 def load_cv_dataset(config=None):

federatedscope/gfl/dataloader/dataloader_graph.py

@@ -1,7 +1,7 @@
 from torch_geometric import transforms
 from torch_geometric.datasets import TUDataset, MoleculeNet
 
-from federatedscope.core.auxiliaries.transform_builder import get_transform
+from federatedscope.core.auxiliaries import get_transform
 from federatedscope.gfl.dataset.cikm_cup import CIKMCUPDataset
 
 

federatedscope/gfl/dataloader/dataloader_link.py

@@ -3,8 +3,7 @@
 from torch_geometric.utils import add_self_loops, remove_self_loops, \
     to_undirected
 
-from federatedscope.core.auxiliaries.splitter_builder import get_splitter
-from federatedscope.core.auxiliaries.transform_builder import get_transform
+from federatedscope.core.auxiliaries import get_splitter, get_transform
 
 
 def load_linklevel_dataset(config=None):

federatedscope/gfl/dataloader/dataloader_node.py

@@ -6,8 +6,7 @@
     to_undirected
 from torch_geometric.data import Data
 
-from federatedscope.core.auxiliaries.splitter_builder import get_splitter
-from federatedscope.core.auxiliaries.transform_builder import get_transform
+from federatedscope.core.auxiliaries import get_splitter, get_transform
 
 INF = np.iinfo(np.int64).max
 

federatedscope/main.py

@@ -8,13 +8,11 @@
     sys.path.append(file_dir)
 
 from federatedscope.core.cmd_args import parse_args
-from federatedscope.core.auxiliaries.data_builder import get_data
+from federatedscope.core.auxiliaries import get_runner, get_server_cls, \
+    get_client_cls, get_data
 from federatedscope.core.auxiliaries.utils import setup_seed
 from federatedscope.core.auxiliaries.logging import update_logger
-from federatedscope.core.auxiliaries.worker_builder import get_client_cls, \
-    get_server_cls
 from federatedscope.core.configs.config import global_cfg, CfgNode
-from federatedscope.core.fed_runner import get_runner
 
 if os.environ.get('https_proxy'):
     del os.environ['https_proxy']

federatedscope/nlp/dataloader/dataloader.py

@@ -1,7 +1,7 @@
 from federatedscope.nlp.dataset.leaf_nlp import LEAF_NLP
 from federatedscope.nlp.dataset.leaf_twitter import LEAF_TWITTER
 from federatedscope.nlp.dataset.leaf_synthetic import LEAF_SYNTHETIC
-from federatedscope.core.auxiliaries.transform_builder import get_transform
+from federatedscope.core.auxiliaries import get_transform
 
 
 def load_nlp_dataset(config=None):

federatedscope/organizer/utils.py

@@ -7,7 +7,7 @@
 
 from federatedscope.core.cmd_args import parse_args
 from federatedscope.core.configs.config import global_cfg
-from federatedscope.core.auxiliaries.data_builder import get_data
+from federatedscope.core.auxiliaries import get_data
 from federatedscope.organizer.cfg_client import env_name, root_path, fs_version
 
 logger = logging.getLogger('federatedscope')

tests/test_CRA_gan_attack.py

@@ -1,12 +1,11 @@
 # Copyright (c) Alibaba, Inc. and its affiliates.
 import unittest
 
-from federatedscope.core.auxiliaries.data_builder import get_data
 from federatedscope.core.auxiliaries.utils import setup_seed
 from federatedscope.core.auxiliaries.logging import update_logger
 from federatedscope.core.configs.config import global_cfg
-from federatedscope.core.fed_runner import get_runner
-from federatedscope.core.auxiliaries.worker_builder import get_server_cls, get_client_cls
+from federatedscope.core.auxiliaries import get_runner, get_server_cls, \
+    get_client_cls, get_data
 
 
 class CRATest(unittest.TestCase):

tests/test_MIA_gradient_ascent.py

@@ -1,12 +1,11 @@
 # Copyright (c) Alibaba, Inc. and its affiliates.
 import unittest
 
-from federatedscope.core.auxiliaries.data_builder import get_data
 from federatedscope.core.auxiliaries.utils import setup_seed
 from federatedscope.core.auxiliaries.logging import update_logger
 from federatedscope.core.configs.config import global_cfg
-from federatedscope.core.fed_runner import get_runner
-from federatedscope.core.auxiliaries.worker_builder import get_server_cls, get_client_cls
+from federatedscope.core.auxiliaries import get_runner, get_server_cls, \
+    get_client_cls
 
 
 class GradAscentTest(unittest.TestCase):

tests/test_PIA_toy.py

@@ -1,12 +1,11 @@
 # Copyright (c) Alibaba, Inc. and its affiliates.
 import unittest
 
-from federatedscope.core.auxiliaries.data_builder import get_data
 from federatedscope.core.auxiliaries.utils import setup_seed
 from federatedscope.core.auxiliaries.logging import update_logger
 from federatedscope.core.configs.config import global_cfg
-from federatedscope.core.fed_runner import get_runner
-from federatedscope.core.auxiliaries.worker_builder import get_server_cls, get_client_cls
+from federatedscope.core.auxiliaries import get_runner, get_server_cls, \
+    get_client_cls, get_data
 
 
 class PIA_ToyLRTest(unittest.TestCase):