deepcave.plugins.objective.configuration_cube¶

# ConfigurationCube

This module provides utilities for visualizing and creating a configuration cube.

The configuration cube displays configurations and their score on the objective.

## Classes

ConfigurationCube: A plugin for visualizing a configuration cube.

Classes

ConfigurationCube()

A plugin for visualizing a configuration cube.

class deepcave.plugins.objective.configuration_cube.ConfigurationCube[source]¶

Bases: DynamicPlugin

A plugin for visualizing a configuration cube.

static get_filter_layout(register)[source]¶

Get the layout for the filter block.

Parameters:: register (Callable) – Method to register (user) variables. The register_input function is located in the Plugin superclass.
Returns:: Layouts for the filter block.
Return type:: List[html.Div]

static get_input_layout(register)[source]¶

Get the layout for the input block.

Parameters:: register (Callable) – Method to register (user) variables. The register_input function is located in the Plugin superclass.
Returns:: Layouts for the input block.
Return type:: List[dbc.Row]

static get_output_layout(register)[source]¶

Get the layout for the output block.

Parameters:: register (Callable) – Method to register output. The register_output function is located in the Plugin superclass.
Returns:: Layout for the output block.
Return type:: Tuple[dcc.Graph,]

load_dependency_inputs(run, _, inputs)[source]¶

Work like ‘load_inputs’ but called after inputs have changed.

It is restricted to three Hyperparameters.

Note

Only the changes have to be returned. The returned dictionary will be merged with the inputs.

Parameters:

run – The selected run.
inputs – Current content of the inputs.

Returns:

The dictionary with the changes.

Return type:

Dict[str, Any]

load_inputs()[source]¶

Load the content for the defined inputs in ‘get_input_layout’ and ‘get_filter_layout’.

This method is necessary to pre-load contents for the inputs. So, if the plugin is called for the first time or there are no results in the cache, the plugin gets its content from this method.

Returns:: The content to be filled.
Return type:: Dict[str, Any]

static load_outputs(run, inputs, outputs)[source]¶

Read in the raw data and prepares them for the layout.

Note

The passed inputs are cleaned and therefore differs compared to ‘load_inputs’ or ‘load_dependency_inputs’. Please see ‘_clean_inputs’ for more information.

Parameters:

run – The selected run.
inputs – Input and filter values from the user.
outputs – Raw output from the run.

Returns:

The output figure.

Return type:

go.Figure

static process(run, inputs)[source]¶

Return raw data based on the run and input data.

Warning

The returned data must be JSON serializable.

Note

The passed inputs are cleaned and therefore differs compared to ‘load_inputs’ or ‘load_dependency_inputs’. Please see ‘_clean_inputs’ for more information.

Parameters:

run (AbstractRun) – The selected run.
inputs (Dict[str, Any]) – The input data.

Returns:

The serialized dictionary.

Return type:

Dict[str, str]

deepcave.plugins.objective

deepcave.plugins.objective.parallel_coordinates

DeepCAVE Documentation

deepcave.plugins.objective.configuration_cube¶