mlos_bench.storage.sql.trial_data module

An interface to access the benchmark trial data stored in SQL DB.

class mlos_bench.storage.sql.trial_data.TrialSqlData(*, engine: Engine, schema: DbSchema, experiment_id: str, trial_id: int, config_id: int, ts_start: datetime, ts_end: datetime | None, status: Status)

Bases: TrialData

An interface to access the trial data stored in the SQL DB.

Attributes:

experiment_id

ID of the experiment this trial belongs to.

metadata_df

Retrieve the trials’ metadata params.

metadata_dict

Retrieve the trials’ metadata parameters as a dict.

results_df

Retrieve the trials’ results from the storage.

results_dict

Retrieve the trials’ results from the storage as a dict.

status

Status of the trial.

telemetry_df

Retrieve the trials’ telemetry from the storage.

trial_id

ID of the trial.

ts_end

End timestamp of the trial (UTC).

ts_start

Start timestamp of the trial (UTC).

tunable_config

Retrieve the trial’s tunable configuration from the storage.

tunable_config_id

ID of the (tunable) configuration of the trial.

tunable_config_trial_group

Retrieve the trial’s tunable config group configuration data from the storage.

property metadata_df: DataFrame

Retrieve the trials’ metadata params.

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

property results_df: DataFrame

Retrieve the trials’ results from the storage.

property telemetry_df: DataFrame

Retrieve the trials’ telemetry from the storage.

property tunable_config: TunableConfigData

Retrieve the trial’s tunable configuration from the storage.

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

property tunable_config_trial_group: TunableConfigTrialGroupData

Retrieve the trial’s tunable config group configuration data from the storage.