culebra.tools.Results class

class Results(dict=None, /, **kwargs)

Manages the results produced by the evaluation of a trainer.

Class methods

classmethod Results.load_pickle(filename: str) → Base

Load a pickled object from a file.

Parameters:

filename (str) – The file name.

Raises:

• TypeError – If filename is not a valid file name

• ValueError – If the filename extension is not PICKLE_FILE_EXTENSION

classmethod Results.from_csv_files(files: Sequence[str], keys: Sequence[str] | None = None, sep: str | None = None) → None

Load some results from several csv files.

Parameters:

• files (Sequence of str, path objects or file-like objects) – Sequence of files containing the results

• keys (Sequence of str) – Keys for the different results. One key for each csv file. If omitted, the basename of each file in files (without extension) is used. Defaults to None

• sep (str, optional) – Separator. If None is provided, DEFAULT_SEP is used. Defaults to None

Raises:

• TypeError – If sep is not a string

• ValueError – If files and keys have different lengths

• ValueError – If any key in keys is not a string

• FileNotFoundError – If any file in files is not found

Methods

Results.save_pickle(filename: str) → None

Pickle this object and save it to a file.

Parameters:

filename (str) – The file name.

Raises:

• TypeError – If filename is not a valid file name

• ValueError – If the filename extension is not PICKLE_FILE_EXTENSION

Results.to_excel(filename: str) → None

Save the results to a Excel file.

Parameters:

filename (str) – File path

Raises:

• TypeError – If filename is not a valid file name

• ValueError – If the filename extension is not EXCEL_FILE_EXTENSION

Dunder methods

Results.__setitem__(key: str, data: DataFrame) → DataFrame

Overridden to verify the key and value.

Assure that the key is a str and the value is a DataFrame.

Parameters:

• key (str) – Key for the results

• data (DataFrame) – The data

Returns:

The data inserted

Return type:

DataFrame