Add minimal working code examples in Experiment API docs (backport #1494) #1505
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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
### Summary
This change adds minimal working code examples to the API pages for
Experiments,
EFSpectroscopy,
EFRabi,
StarkRamseyXYAmpScan,
FineAmplitudeCal,
FineXAmplitudeCal,
FineSXAmplitudeCal,
FineDragCal,
FineXDragCal,
FineSXDragCal,
FineFrequencyCal,
FrequencyCal,
HalfAngleCal,
RoughAmplitudeCal,
RoughXSXAmplitudeCal,
EFRoughXSXAmplitudeCal,
RoughDragCal,
RoughFrequencyCal,
QuantumVolume,
InterleavedRB,
LayerFidelity,
StandardRB,
MitigatedProcessTomography,
MitigatedStateTomography,
ProcessTomography,
StateTomography and
TomographyExperiment.
### Details and comments
- This PR covers many remaining experiments in `issue#1238` and
`issue#1221`.
- In the API pages, the documentation for each experiment has been
updated with its code example. Users are required to specify a backend
in the code example. By default, backends used in the code examples, are
simulators such as, SingleTransmonTestBackend() and
AerSimulator(FakePerth()).
---------
Co-authored-by: 中澤 直仁 <nakazawanaohito@nakazawa-iMac.local>
(cherry picked from commit cc258d7)
wshanks
approved these changes
Dec 18, 2024
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.
Summary
This change adds minimal working code examples to the API pages for Experiments,
EFSpectroscopy,
EFRabi,
StarkRamseyXYAmpScan,
FineAmplitudeCal,
FineXAmplitudeCal,
FineSXAmplitudeCal,
FineDragCal,
FineXDragCal,
FineSXDragCal,
FineFrequencyCal,
FrequencyCal,
HalfAngleCal,
RoughAmplitudeCal,
RoughXSXAmplitudeCal,
EFRoughXSXAmplitudeCal,
RoughDragCal,
RoughFrequencyCal,
QuantumVolume,
InterleavedRB,
LayerFidelity,
StandardRB,
MitigatedProcessTomography,
MitigatedStateTomography,
ProcessTomography,
StateTomography and
TomographyExperiment.
Details and comments
issue#1238andissue#1221.This is an automatic backport of pull request #1494 done by [Mergify](https://mergify.com).