cave.analyzer.budgets.budget_correlation module

class cave.analyzer.budgets.budget_correlation.BudgetCorrelation(runscontainer)[source]

Bases: cave.analyzer.base_analyzer.BaseAnalyzer

Use spearman correlation to get a correlation-value and a p-value for every pairwise combination of budgets. First value is the correlation, second is the p-value (the p-value roughly estimates the likelihood to obtain this correlation coefficient with uncorrelated datasets). This can be used to estimate how well a budget approximates the function to be optimized.

Parameters

runscontainer (RunsContainer) – contains all important information about the configurator runs

_get_table(runs)[source]
_plot(runs)[source]

Create table and plot that reacts to selection of cells by updating the plotted data to visualize correlation.

Parameters

runs (List[ConfiguratorRun]) – list with runs (budgets) to be compared

classmethod check_for_bokeh(d)

Check if there is bokeh-plots in the output of this analyzer by checking the result-dictionary for the bokeh keyword.

get_html(d=None, tooltip=None)[source]

General reports in html-format, to be easily integrated in html-code. WORKS ALSO FOR BOKEH-OUTPUT.

Parameters
  • d (Dictionary) – a dictionary that will be later turned into a website

  • tooltip (string) – tooltip to be displayed in report. optional, will overwrite the docstrings that are used by default.

Returns

script, div – header and body part of html-code

Return type

str, str

get_jupyter()[source]

Depending on analysis, this creates jupyter-notebook compatible output.

get_name()[source]
plot()[source]

Create table and plot that reacts to selection of cells by updating the plotted data to visualize correlation.

plot_bokeh()

This function should recreate the bokeh-plot from scratch with as little overhead as possible. This is needed to show the bokeh plot in jupyter AND save it to the webpage. The bokeh plot needs to be recreated to be displayed in different outputs for reasons beyond out control. So save all analysis results in the class and simply redo the plotting with this function. This function needs to be called if bokeh-plots are to be displayed in notebook AND saved to html-result.