pygsti.report.section.gauge

Gauge-invariant and -dependent sections

Module Contents

Classes

GaugeInvariantsGatesSection	Abstract base class for report sections.
GaugeInvariantsGermsSection	Abstract base class for report sections.
GaugeVariantSection	Abstract base class for report sections.
GaugeVariantsDecompSection	Abstract base class for report sections.
GaugeVariantsErrorGenSection	Abstract base class for report sections.
GaugeVariantsErrorGenNQubitSection	Abstract base class for report sections.
GaugeVariantsRawSection	Abstract base class for report sections.

class pygsti.report.section.gauge.GaugeInvariantsGatesSection(**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, est_labels=None, embed_figures=True, **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.

final_model_spam_parameters_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

final_model_eigenvalue_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

final_model_vs_target_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

final_gates_vs_target_table_gauge_inv(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

final_gauge_inv_model_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

single_metric_table_gauge_inv(switchboard=None, dataset_labels=None, est_labels=None, gi_switchboard=None, **kwargs)

final_gauge_inv_metric_table(switchboard=None, confidence_level=None, ci_brevity=1, gr_switchboard=None, **kwargs)

gram_bar_plot(switchboard=None, **kwargs)

class pygsti.report.section.gauge.GaugeInvariantsGermsSection(**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.

final_gates_vs_target_table_gauge_invgerms(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

germs_eigenvalue_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

class pygsti.report.section.gauge.GaugeVariantSection(**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, est_labels=None, embed_figures=True, **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.

final_model_spam_vs_target_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

final_gates_vs_target_table_gauge_var(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

final_gates_vs_target_table_gauge_vargerms(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

single_metric_table_gauge_var(switchboard=None, dataset_labels=None, est_labels=None, gv_switchboard=None, **kwargs)

class pygsti.report.section.gauge.GaugeVariantsDecompSection(**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.

final_model_choi_eigenvalue_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

final_model_decomposition_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

class pygsti.report.section.gauge.GaugeVariantsErrorGenSection(**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.

final_model_errorgen_box_table(switchboard=None, confidence_level=None, ci_brevity=1, errgen_type='logGTi', **kwargs)

errorgen_type(errgen_type='logGTi', **kwargs)

class pygsti.report.section.gauge.GaugeVariantsErrorGenNQubitSection(**kwargs)

Bases: GaugeVariantsErrorGenSection

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.

final_model_errorgen_box_table(switchboard=None, confidence_level=None, ci_brevity=1, errgen_type='logGTi', **kwargs)

class pygsti.report.section.gauge.GaugeVariantsRawSection(**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.

final_gates_box_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)

final_model_brief_spam_table(switchboard=None, confidence_level=None, ci_brevity=1, **kwargs)