pygsti.report.section
Internal model of a section of a generated report
Submodules
Package Contents
Classes
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
|
Abstract base class for report sections. |
- class pygsti.report.section.Section(**kwargs)
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
.
- static figure_factory(brevity_limit=None)
Decorator to designate a method as a figure factory.
Parameters
- brevity_limitint or None, optional
Mark that this figure should only be rendered for reports with brevity strictly less than this limit. Defaults to
None
, indicating that the figure should always be rendered.
- render(workspace, brevity=0, **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.
- class pygsti.report.section.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)
- class pygsti.report.section.DriftSection(**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
.
- drift_summary_table(results=None, dskey=None, **kwargs)
- drift_details_table(results=None, **kwargs)
- global_power_spectra_plot(results=None, dskey=None, **kwargs)
- germ_fiducial_power_spectra_plot(results=None, switchboard=None, dskey=None, **kwargs)
- germ_fiducial_prob_trajectories_plot(results=None, switchboard=None, dskey=None, **kwargs)
- drift_detector_colorbox_plot(stabilityanalyzer=None, circuit_list=None, **kwargs)
- drift_size_colorbox_plot(stabilityanalyzer=None, circuit_list=None, **kwargs)
- class pygsti.report.section.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.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.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.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.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.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.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)
- class pygsti.report.section.GoodnessSection(**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_fit_colorscatter_plot(switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
- final_model_fit_progress_table(switchboard=None, max_lengths=None, comm=None, **kwargs)
- final_model_fit_progress_bar_plot(switchboard=None, max_lengths=None, comm=None, **kwargs)
- class pygsti.report.section.GoodnessColorBoxPlotSection(**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_fit_colorbox_plot(switchboard=None, linlog_percentile=5, brevity=0, comm=None, bgcolor='white', **kwargs)
- final_model_tvd_colorbox_plot(switchboard=None, brevity=0, comm=None, bgcolor='white', **kwargs)
- maxlength_switchboard1(switchboard=None, switchbd_maxlengths=None, **kwargs)
- class pygsti.report.section.GoodnessScalingSection(**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_fit_colorscatter_plot_scl(switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
- final_model_fit_colorbox_plot_scl(switchboard=None, linlog_percentile=5, brevity=0, comm=None, bgcolor='white', **kwargs)
- final_model_fit_histogram_scl(switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
- final_model_fit_progress_table_scl(switchboard=None, max_lengths=None, comm=None, **kwargs)
- final_model_fit_progress_bar_plot_scl(switchboard=None, max_lengths=None, comm=None, **kwargs)
- data_scaling_colorbox_plot(switchboard=None, comm=None, bgcolor='white', **kwargs)
- class pygsti.report.section.GoodnessUnmodeledSection(**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
.
- unmodeled_error_budget_table(switchboard=None, **kwargs)
- unmodeled_error_ddist_bar_plot(switchboard=None, **kwargs)
- final_model_fit_progress_bar_plot_ume(switchboard=None, max_lengths=None, comm=None, **kwargs)
- final_model_fit_progress_table_ume(switchboard=None, max_lengths=None, comm=None, **kwargs)
- final_model_fit_histogram_ume(switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
- final_model_fit_colorbox_plot_ume(switchboard=None, linlog_percentile=5, brevity=0, comm=None, bgcolor='white', **kwargs)
- final_model_fit_colorscatter_plot_ume(switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
- class pygsti.report.section.IdleTomographySection(**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
.
- idt_intrinsic_errors_table(switchboard=None, **kwargs)
- idt_observed_rates_table(switchboard=None, **kwargs)
- class pygsti.report.section.InputSection(**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
.
- fiducial_list_table(switchboard=None, **kwargs)
- germ_list_2col_table(switchboard=None, **kwargs)
- dataset_overview_table(switchboard=None, **kwargs)
- target_gates_box_table(switchboard=None, **kwargs)
- target_spam_brief_table(switchboard=None, **kwargs)
- class pygsti.report.section.MetaSection(**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
.
- metadata_table(switchboard=None, **kwargs)
- stdout_block(switchboard=None, **kwargs)
- profiler_table(switchboard=None, **kwargs)
- software_environment_table(**kwargs)
- class pygsti.report.section.SummarySection(**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_fit_progress_bar_plot_sum(switchboard=None, max_lengths=None, comm=None, **kwargs)
- final_model_fit_histogram(switchboard=None, linlog_percentile=5, comm=None, bgcolor='white', **kwargs)
- final_gates_vs_target_table_insummary(switchboard=None, confidence_level=None, ci_brevity=1, show_unmodeled_error=False, **kwargs)
- final_fits_comparison_plot(switchboard=None, est_labels=None, dataset_labels=None, comm=None, **kwargs)