openfl.utilities.workspace.ExperimentWorkspace

class openfl.utilities.workspace.ExperimentWorkspace(experiment_name: str, data_file_path: Path, install_requirements: bool = False, remove_archive: bool = True)

Bases: object

Experiment workspace context manager.

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

Class Attributes:

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

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

  • install_requirements (bool) – Whether to install the requirements for the experiment.

  • cwd (Path) – The current working directory.

  • experiment_work_dir (Path) – The working directory for the experiment.

  • remove_archive (bool) – Whether to remove the archive after the experiment.

Methods