mlos_bench.storage.base_tunable_config_data

Base interface for accessing the stored benchmark (tunable) config data.

Note: a configuration in this context is the set of tunable parameter values and can be used by one or more trials.

See also

mlos_bench.storage

The base storage module for mlos_bench, which includes some basic examples in the documentation.

Classes

TunableConfigData

Base interface for accessing the stored experiment benchmark (tunable) config data.

Module Contents

class mlos_bench.storage.base_tunable_config_data.TunableConfigData(*, tunable_config_id: int)[source]

Base interface for accessing the stored experiment benchmark (tunable) config data.

A configuration in this context is the set of tunable parameter values.

Parameters:

tunable_config_id (int)

__eq__(other: Any) → bool[source]
Parameters:

other (Any)

Return type:

bool

__repr__() → str[source]
Return type:

str

property config_df: pandas.DataFrame[source]
Abstractmethod:

Return type:

pandas.DataFrame

Retrieve the trials’ tunable configuration from the storage.

Note: this corresponds to the Trial object’s “tunables” property.

Returns:

config – A dataframe with the tunable configuration of the trial. It has two str columns, “parameter” and “value”.

Return type:

pandas.DataFrame

property config_dict: Dict[str, mlos_bench.tunables.tunable.TunableValue | None][source]

Retrieve the trials’ tunable configuration from the storage as a dict.

Note: this corresponds to the Trial object’s “tunables” property.

Returns:

config

Return type:

dict

property tunable_config_id: int[source]

Unique ID of the (tunable) configuration.

Return type:

int