deepcave.plugins.summary.overview

# Overview

This module provides utilities for visualizing an overview of the selected runs.

It holds the most important information, e.g. meta data, objectives and statistics.

The module includes a dynamic plugin for the overview.

## Classes

  • Overview: Visualize an overall overview of the selected run.

Classes

Overview()

Visualize an overall overview of the selected run.
class deepcave.plugins.summary.overview.Overview[source]

Bases: DynamicPlugin

Visualize an overall overview of the selected run.

static get_output_layout(register)[source]

Get the layout for the output block.

Parameters:

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

Returns:

The layouts for the output block.

Return type:

List[Any]

static load_outputs(run, *_)[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.

Returns:

A list of the created tables of the overview.

Return type:

List[Any]

previous

deepcave.plugins.summary.footprint

next

deepcave.layouts