Add minimal working code examples in Experiment API docs #1494
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
local/main is updated
local/main is updated
local/main updated
local/main updated
local/main is updated
local/main is updated
local/main is updated
local/main is updated
local/main is updated
local/main is updated
loal/main is updated.
local/main is updated
…periments into main local/main is updated
…periments local/main updated
…periments lodal/main updated
…periments into main local/main updated (Qiskit-Extensions#1238)
…periments local/main updated (Qiskit-Extensions#1238)
local/main updated
local/main update
|
Hello, @wshanks. |
wshanks
reviewed
Dec 17, 2024
qiskit_experiments/library/randomized_benchmarking/interleaved_rb_experiment.py
Outdated
Show resolved
Hide resolved
releasenotes/notes/add-examples-to-experiments-api-docs-31f3e3c3369a6f3d.yaml
Show resolved
Hide resolved
|
The PR looks ready except one suggestion about the RB analysis names.
It feels a bit long to me, but we can can go with it for now. We will remove the pulse experiments soon from the main branch to prepare for pulse being removed in Qiskit 2.0 and that will bring the time down some. It would be nice if we could log the time of each jupyter-execute run to see where all the time is going. There might be some way to do that with sphinx and jupyter-sphinx but I don't know how. We have our |
|
Hi, @wshanks. |
wshanks
added
the
backport stable potential
wshanks
approved these changes
Dec 18, 2024
mergify bot
pushed a commit
that referenced
this pull request
Dec 18, 2024
### 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
pushed a commit
that referenced
this pull request
Dec 18, 2024
) (#1505) ### 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()). <hr>This is an automatic backport of pull request #1494 done by [Mergify](https://mergify.com). Co-authored-by: Naohito Nakazawa <117684192+Naohnakazawa@users.noreply.github.com>
|
The update versions are live now on the dev version of the docs: https://qiskit-community.github.io/qiskit-experiments/dev/apidocs/library.html I backported the PR to the stable 0.8 branch as well. I want to get #1502 merged into 0.8 and then we can release 0.8.1 and the docs changes should appear on the stable version of the docs as well. I might not be able to find anyone to review #1502 before January though. |
|
@Naohnakazawa I wrote the script to check the jupyter execute times. Maybe the QV and RB experiments could be made a little faster (and the QV manual needs to be looked at) but otherwise the non-pulse experiments have similar times (a few notebooks failed because they use |
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.