pygsti.report.Results.create_presentation_pdf

Results.create_presentation_pdf(confidenceLevel=None, filename='auto', title='auto', datasetLabel='auto', suffix='', debugAidsAppendix=False, pixelPlotAppendix=False, whackamoleAppendix=False, m=0, M=10, verbosity=0, comm=None)

Create a GST presentation (i.e. slides) using the beamer latex package.

The slides can contain most (but not all) of the tables and figures from the “full” report but contain only minimal descriptive text. This output if useful for those familiar with the GST full report who need to present the results in a projector-friendly format.

Parameters:
  • confidenceLevel (float, optional) – If not None, then the confidence level (between 0 and 100) used in the computation of confidence regions/intervals. If None, no confidence regions or intervals are computed.
  • filename (string, optional) – The output filename where the presentation file(s) will be saved. Specifying “auto” will use the default directory and base name (specified in set_additional_info) if given, otherwise the file “GSTSlides.pdf” will be output to the current directoy.
  • title (string, optional) – The title of the presentation. “auto” uses a default title which specifyies the label of the dataset as well.
  • datasetLabel (string, optional) – A label given to the dataset. If set to “auto”, then the label will be the base name of the dataset filename without extension (if given) or “$mathcal{D}$” (if not).
  • suffix (string, optional) – A suffix to add to the end of the presentation filename. Useful when filename is “auto” and you generate different presentations using the same dataset.
  • debugAidsAppendix (bool, optional) – Whether to include the “debugging aids” appendix. This appendix contains comparisons of GST and Direct-GST and small- eigenvalue error rates among other quantities potentially useful for figuring out why the GST estimate did not fit the data as well as expected.
  • pixelPlotAppendix (bool, optional) – Whether to include the “pixel plots” appendix, which shows the goodness of fit, in the form of color box plots, for the intermediate iterations of the GST algortihm.
  • whackamoleAppendix (bool, optional) – Whether to include the “whack-a-mole” appendix, which contains colr box plots showing the effect of reducing (“whacking”) one particular part of the overall goodness of fit box plot.
  • M (m,) – Minimum and Maximum values of the color scale used in the presentation’s color box plots.
  • verbosity (int, optional) – How much detail to send to stdout.
  • comm (mpi4py.MPI.Comm, optional) – When not None, an MPI communicator for distributing the computation across multiple processors.
Returns:

Return type:

None