boa.wrapper_utils.make_experiment_dir#

boa.wrapper_utils.make_experiment_dir(working_dir: Optional[PathLike] = None, experiment_dir: Optional[PathLike] = None, experiment_name: str = '', append_timestamp: bool = True)[source]#

Creates directory for the experiment and returns the path. The directory is named with the experiment name and the current datetime.

Parameters

  • working_dir (os.Pathlike) – Working directory, the parent directory where the experiment directory will be written. Specify either a working directory and an experiment name or an experiment_dir

  • experiment_dir (os.Pathlike) – The exact dir the experiment directory boa will use to write the runs to. Specify either a working directory and an experiment name or an experiment_dir

  • experiment_name (str) – Name of the experiment

  • append_timestamp (bool) – Whether to append a timestamp to the end of the experiment directory to ensure uniqueness

Returns

Path to the directory for the experiment

Return type

Path