CSVStorageHandler

class CSVStorageHandler(path)

Storage handler for CSV files, with ending .csv.

Loads and saves results in CSV format with separator comma, as follows.

The results are stored in a tabular format, where each row corresponds to a single model-validation pair.

Each result is stored as a row in a CSV file with the following columns:

• model_id: The ID of the model.

• validation_id: The ID of the validation run.

• folds: A dictionary of fold results,

  where each key is a fold ID and the value is a dictionary of scores and dataframes.

The following columns are included for each fold:

• folds.{fold_id}.scores.{score_name}: The score value for the given fold and

  score name.

• folds.{fold_id}.ground_truth: The ground truth dataframe for the given fold.

• folds.{fold_id}.predictions: The predictions dataframe for the given fold.

• folds.{fold_id}.train_data: The training data dataframe for the

  given fold.

Columns ground_truth, predictions, and train_data are included only if they were requested during benchmarking.

Parameters:

pathstr or pathlib.Path

Path to the CSV results file. Must refer to a file with a .csv extension, not a directory.

Methods

is_applicable(path)	Return whether this handler supports the given results file path.
load()	Load benchmark results from the file at self.path.
save(results)	Save benchmark results to the CSV file at self.path.

save(results: list[ResultObject])

Save benchmark results to the CSV file at self.path.

Parameters:

resultslist of ResultObject

Benchmark results to persist as one row per model-validation pair.

static is_applicable(path)

Return whether this handler supports the given results file path.

Parameters:

pathpathlib.Path or None

Path to the results file, or None for NullStorageHandler. Must refer to a file, not a directory, when not None.

Returns:

bool

True if this handler should be used for path.

load() → list[ResultObject]

Load benchmark results from the file at self.path.

Returns:

list of ResultObject

Loaded results. Returns an empty list if the file does not exist.