vak.common.paths.generate_results_dir_name_as_path#
- vak.common.paths.generate_results_dir_name_as_path(root_results_dir=None)[source]#
generates a name for a new results directory, returns as a path
- Parameters:
root_results_dir (str, pathlib.Path) – root directory within which a new results directory will be made. Default is None, in which case the new results directory name will be relative to the current working directory.
- Returns:
results_path – path to a new results directory, with name of the following format:
f'{vak.constants.RESULTS_DIR_PREFIX}{vak.timenow.get_timenow_as_str}'. e.g.,results_210211_142329. This function simply builds the name and path with a consistent format. To actually make this directory, callresults_path.mkdir()- Return type: