cave.analyzer.feature_analysis.box_violin module¶

class cave.analyzer.feature_analysis.box_violin.BoxViolin(runscontainer)[source]¶

Bases: cave.analyzer.base_analyzer.BaseAnalyzer

Box and Violin Plots show the distribution of each feature value across the instances. Box plots show the quantiles of the distribution and violin plots show the approximated probability density of the feature values. Such plots are useful to inspect the instances and to detect characteristics of the instances. For example, if the distributions have two or more modes, it could indicate that the instance set is heterogeneous which could cause problems in combination with racing strategies configurators typically use. NaN values are removed from the data.

runscontainer: RunsContainer contains all important information about the configurator runs

box_violin(output_dir, scenario, feat_names, feat_importance)[source]¶

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) → Tuple[str, str]¶

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()¶: Depending on analysis, this creates jupyter-notebook compatible output.

get_name()[source]¶

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.