ml_grid.util.create_experiment_directory

Functions

create_experiment_directory(→ str)

Creates a single, timestamped directory for a group of experiment runs.

Module Contents

ml_grid.util.create_experiment_directory.create_experiment_directory(base_dir: str, additional_naming: str | None = None) → str[source]

Creates a single, timestamped directory for a group of experiment runs.

This function should be called once at the beginning of an experiment script to create a unique parent folder for all the runs in that batch.

Parameters:

  • base_dir (str) – The base directory where experiment folders will be stored (e.g., ‘notebooks/HFE_ML_experiments’).

  • additional_naming (Optional[str], optional) – A descriptive name to append to the timestamp. Defaults to None.

Returns:

The full path to the created experiment directory.

Return type:

str