pygsti.report.section.datacomparison

Data comparison section

Module Contents

Classes

DataComparisonSection

Abstract base class for report sections.

class pygsti.report.section.datacomparison.DataComparisonSection(**kwargs)

Bases: pygsti.report.section.Section

Abstract base class for report sections.

Derived classes encapsulate the structure of data within the respective section of the report, and provide methods for rendering the section to various output formats.

Parameters

**kwargs

Computation of specific section elements can be configured at runtime by passing the name of a figure as a keyword argument set to False.

render(workspace, results=None, dataset_labels=None, embed_figures=True, comm=None, **kwargs)

Render this section’s figures.

Parameters

workspaceWorkspace

A Workspace used for caching figure computation.

brevityint, optional

Level of brevity used when generating this section. At higher brevity levels, certain non-critical figures will not be rendered. Defaults to 0 (most verbose).

**kwargs

All additional reportable quantities used when computing the figures of this section.

Returns

dict (str -> any)

Key-value map of report quantities used for this section.

dataset_comparison_summary(switchboard=None, dataset_labels=None, all_dscomps=None, **kwargs)

dataset_comparison_histogram(switchboard=None, ds_switchboard=None, comm=None, bgcolor='white', **kwargs)

dataset_comparison_box_plot(switchboard=None, ds_switchboard=None, comm=None, bgcolor='white', **kwargs)