mlos_viz.util

Utility functions for manipulating experiment results data.

Functions

expand_results_data_args(→ tuple[pandas.DataFrame, ...)

Expands some common arguments for working with results data.

Module Contents

mlos_viz.util.expand_results_data_args(exp_data: mlos_bench.storage.base_experiment_data.ExperimentData | None = None, results_df: pandas.DataFrame | None = None, objectives: dict[str, Literal['min', 'max']] | None = None) → tuple[pandas.DataFrame, dict[str, bool]][source]

Expands some common arguments for working with results data.

Used by mlos_viz as well.

Parameters:

exp_data (ExperimentData | None) – ExperimentData to operate on.
results_df (pandas.DataFrame | None) – Optional results_df argument. If not provided, defaults to ExperimentData.results_df property.
objectives (Optional[dict[str, Literal["min", "max"]]]) – Optional objectives set to operate on. If not provided, defaults to ExperimentData.objectives property.

Returns:

The results dataframe and the objectives columns in the dataframe, plus whether or not they are in ascending order.

Return type:

tuple[pandas.DataFrame, dict[str, bool]]