Wildcard Support for Instruments #527
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds partial support for wildcard models. At the moment this only patches in support for 1D diamond distance wildcard models.
sserita
approved these changes
Jan 20, 2025
Comment on lines
+2297
to
+2331
| using the model introduced in https://doi.org/10.1038/s41534-023-00764-y. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| model : Model | ||
| The model to add a wildcard budget to. | ||
| estimate : Estimate | ||
| The estimate object containing the model and data to be used. | ||
|
|
||
| ds : DataSet | ||
| The data the model predictions are being compared with. | ||
| objfn_cache : ObjectiveFunctionCache | ||
| A cache for objective function evaluations. | ||
|
|
||
| circuits_to_use : list | ||
| The circuits whose data are compared. | ||
| mdc_objfn : ModelDatasetCircuitsStore | ||
| An object that stores the model, dataset, and circuits to be used in the computation. | ||
|
|
||
| parameters : dict | ||
| Various parameters of the estimate at hand. | ||
|
|
||
| badfit_options : GSTBadFitOptions, optional | ||
| Options specifying what post-processing actions should be performed when | ||
| a fit is unsatisfactory. Contains detailed parameters for wildcard budget | ||
| a fit is unsatisfactory. Contains detailed parameters for wildcard budget | ||
| creation. | ||
|
|
||
| comm : mpi4py.MPI.Comm, optional | ||
| An MPI communicator used to run this computation in parallel. | ||
|
|
||
| mem_limit : int, optional | ||
| A rough per-processor memory limit in bytes. | ||
|
|
||
| verbosity : int, optional | ||
| Level of detail printed to stdout. | ||
|
|
||
| gaugeopt_suite : GSTGaugeOptSuite, optional (default None) | ||
| The 1-D wildcard models can be based on gauge-variant functions such as the diamond distance. When gauge optimization is applied this will ensure the gauge optimized models used are consistent in the wildcard model and the parent estimates. | ||
| The 1-D wildcard models can be based on gauge-variant functions such as the diamond distance. | ||
| When gauge optimization is applied, this will ensure the gauge optimized models used are consistent | ||
| in the wildcard model and the parent estimates. | ||
|
|
||
| Returns | ||
| ------- | ||
| PrimitiveOpsWildcardBudget | ||
| PrimitiveOpsWildcardBudget or dict | ||
| The computed wildcard budget. If gauge optimization is applied, a dictionary of | ||
| budgets keyed by gauge optimization labels is returned. | ||
|
|
There was a problem hiding this comment.
As always, these docstring updates are very appreciated!
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds partial support for adding wildcard models to estimates containing quantum instruments. At the moment this only patches in support for 1D diamond distance wildcard models. This addresses issue #463.
An additional change is that a slightly different version of the instrument fidelity and instrument diamond distance functions in reportables have been copied over to optools for better discoverability. For a separate thread on eventually reconciling those two files see #526.