mlos_viz.util module

Utility functions for manipulating experiment results data.

mlos_viz.util.expand_results_data_args(exp_data: ExperimentData | None = None, results_df: DataFrame | None = None, objectives: Dict[str, Literal['min', 'max']] | None = None) → Tuple[DataFrame, Dict[str, bool]]

Expands some common arguments for working with results data.

Used by mlos_viz as well.

Parameters:

exp_dataOptional[ExperimentData], optional

ExperimentData to operate on.

results_dfOptional[pandas.DataFrame], optional

Optional results_df argument. Defaults to exp_data.results_df property.

objectivesOptional[Dict[str, Literal[“min”, “max”]]], optional

Optional objectives set to operate on. Defaults to exp_data.objectives property.

Returns:

Tuple[pandas.DataFrame, Dict[str, bool]]

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