fedn.utils package

The utils package is responsible for providing utility functions for the FEDn framework. Such as logging, checksums and other model helper functions to aggregate models. THe helper functions is there to support aggregating various models from different ML frameworks, such as Tensorflow, PyTorch and Keras.

Subpackages

• fedn.utils.plugins package
  • Submodules
  • fedn.utils.plugins.helperbase module
    • HelperBase
      • HelperBase.get_tmp_path()
      • HelperBase.increment_average()
      • HelperBase.load()
      • HelperBase.save()
  • fedn.utils.plugins.kerashelper module
    • Helper
      • Helper.increment_average()
      • Helper.increment_average_add()
      • Helper.load()
      • Helper.save()
  • fedn.utils.plugins.numpyarrayhelper module
    • Helper
      • Helper.increment_average()
      • Helper.load()
      • Helper.save()
  • fedn.utils.plugins.pytorchhelper module
    • Helper
      • Helper.increment_average()
      • Helper.load()
      • Helper.save()

Submodules

fedn.utils.checksum module

fedn.utils.checksum.sha(fname)

Calculate the sha256 checksum of a file. Used for computing checksums of compute packages.

Parameters:

fname (str) – The file path.

Returns:

The sha256 checksum.

Return type:

hashlib.sha256

fedn.utils.dispatcher module

class fedn.utils.dispatcher.Dispatcher(config, dir)

Bases: object

Dispatcher class for compute packages.

Parameters:

• config (dict) – The configuration.

• dir (str) – The directory to dispatch to.

run_cmd(cmd_type)

Run a command.

Parameters:

cmd_type (str) – The command type.

Returns:

fedn.utils.helpers module

fedn.utils.helpers.get_helper(helper_module_name)

Return an instance of the helper class.

Parameters:

helper_module_name (str) – The name of the helper plugin module.

Returns:

A helper instance.

Return type:

class: fedn.utils.helpers.HelperBase

fedn.utils.helpers.save_metadata(metadata, filename)

Save metadata to file.

Parameters:

• metadata (dict) – The metadata to save.

• filename (str) – The name of the file to save to.

fedn.utils.helpers.save_metrics(metrics, filename)

Save metrics to file.

Parameters:

• metrics (dict) – The metrics to save.

• filename (str) – The name of the file to save to.

fedn.utils.logger module

class fedn.utils.logger.Logger(log_level=10, to_file='', file_path='/home/docs/checkouts/readthedocs.org/user_builds/fedn/checkouts/v0.6.2/docs')

Bases: object

Logger class for Fedn.

Parameters:

• log_level (int) – The log level.

• to_file (str) – The name of the file to log to.

• file_path (str) – The path to the log file.

fedn.utils.process module

fedn.utils.process.run_process(args, cwd)

Run a process and log the output.

Parameters:

• args (list) – The arguments to the process.

• cwd (str) – The current working directory.

Returns: