deepcave.plugins.summary.configurations

# Configurations

This module provides utilities to visualize the characteristics of a configuration within a run.

The module provides a corresponding dynamic plugin.

## Classes

  • Configurations: Visualize the characteristics of a configuration.

Classes

Configurations()

Visualize the characteristics of a configuration.
class deepcave.plugins.summary.configurations.Configurations[source]

Bases: DynamicPlugin

Visualize the characteristics of a configuration.

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:

The layouts for the input block.

Return type:

List[html.Div]

Create a link to a specific configuration.

Parameters:

  • run (AbstractRun) – The selected run.

  • config_id (int) – Configuration which should be visited.

Returns:

Link to the configuration.

Return type:

str

static get_output_layout(register)[source]

Get the layout for the output block.

Parameters:

register (Callable) – Method used to register outputs. The register_input function is located in the Plugin superclass.

Returns:

The layouts for the outputs.

Return type:

List[Any]

load_dependency_inputs(run, previous_inputs, inputs)[source]

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

Note

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

Parameters:

  • run – The selected run.

  • previous_inputs (Dict[str, Any]) – Previous content of the inputs. Not used in this specific function

  • inputs (Dict[str, Any]) – The current content of the inputs.

Returns:

A 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 prepare 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:

A list of the created tables containing output information.

Return type:

List[Any]

static process(run, inputs)[source]

Return raw data based on a 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 – The selected run.

  • inputs – The input data.

Returns:

A serialized dictionary.

Return type:

Dict[str, Any]

previous

deepcave.plugins.summary

next

deepcave.plugins.summary.footprint