Class - ExperimentWorkspace

Class - ExperimentWorkspace#

class openfl.utilities.workspace.ExperimentWorkspace(experiment_name, data_file_path, install_requirements=False, remove_archive=True)[source]#

Bases: object

Experiment workspace context manager.

This class is a context manager for creating a workspace for an experiment.

Parameters:

  • experiment_name (str)

  • data_file_path (Path)

  • install_requirements (bool)

  • remove_archive (bool)

experiment_name#

The name of the experiment.

Type:

str

data_file_path#

The path to the data file for the experiment.

Type:

Path

install_requirements#

Whether to install the requirements for the experiment.

Type:

bool

cwd#

The current working directory.

Type:

Path

experiment_work_dir#

The working directory for the experiment.

Type:

Path

remove_archive#

Whether to remove the archive after the experiment.

Type:

bool

__init__(experiment_name, data_file_path, install_requirements=False, remove_archive=True)[source]#

Initialize workspace context manager.

Parameters:

  • experiment_name (str) – The name of the experiment.

  • data_file_path (Path) – The path to the data file for the experiment.

  • install_requirements (bool, optional) – Whether to install the requirements for the experiment. Defaults to False.

  • remove_archive (bool, optional) – Whether to remove the archive after the experiment. Defaults to True.

Return type:

None

Methods

__init__(experiment_name, data_file_path[, ...])

Initialize workspace context manager.
Contents