Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add options table for V2 primitives #1124

Closed
jyu00 opened this issue Apr 3, 2024 · 4 comments · Fixed by #1188
Closed

Add options table for V2 primitives #1124

jyu00 opened this issue Apr 3, 2024 · 4 comments · Fixed by #1188
Assignees
Labels
content request request for new content to be added new ✨

Comments

@jyu00
Copy link
Collaborator

jyu00 commented Apr 3, 2024

URL, if applicable

https://docs.quantum.ibm.com/run/advanced-runtime-options

Describe the new content you are requesting.

Feedback from user mentioned that it was difficult to find the primitive options, since there are many options classes buried i the API reference. It'd be helpful to have a table that mentions the different categories and links to the respective class. For example:

Category Description Example
resilience Advanced options for configuring error mitigation. Estimator only. estimator.options.resilience.measure_mitigation = True
dynamical_decoupling Options for dynamical decoupling. estimator.options.dynamical_decoupling.enable = True

If this new content request is accepted, do you want to write the content?

I can help the team by providing enough information to write the material

@jyu00 jyu00 added new ✨ content request request for new content to be added labels Apr 3, 2024
@abbycross
Copy link
Collaborator

@LenaPer has created a table based on questions coming in to the support team. Tagging her here to contribute her ideas

@abbycross
Copy link
Collaborator

Here is the draft @LenaPer shared:

  1. Noiseless simulation = exact simulation without sampling noise
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler using sampler.run(…, shots=None) (old samplerV1 interface)
  2. Shotnoise simulation = shot-based ideal simulation, only noise is the sampling
    StatevectorSampler https://docs.quantum.ibm.com/api/qiskit/qiskit.primitives.StatevectorSampler
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler (old samplerV1 interface)
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + ideal aer simulator https://docs.quantum.ibm.com/api/migration-guides/local-simulators#aersimulator
  3. Simulated device noise
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler (old samplerV1 interface)
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + fake backend or aer simulator with noise
  4. Running on actual hardware
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + real backend from QiskitRuntimeService

Not in this list :

Questions :

  • Are the aer primitives going to be updated to v2? Support for PrimitivesV2 qiskit-aer#2078
  • For case 2 : which one for what?
  • For case 3 : which one for what?
  • For case 2 and 3 : several ways to do the same thing, is there a plan to have only one in the future?

@jyu00
Copy link
Collaborator Author

jyu00 commented Apr 16, 2024

I don't quite understand what the different simulation/real environments have to do with the options Qiskit Runtime supports.

@beckykd
Copy link
Collaborator

beckykd commented Apr 16, 2024

Here is the draft @LenaPer shared:

  1. Noiseless simulation = exact simulation without sampling noise
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler using sampler.run(…, shots=None) (old samplerV1 interface)
  2. Shotnoise simulation = shot-based ideal simulation, only noise is the sampling
    StatevectorSampler https://docs.quantum.ibm.com/api/qiskit/qiskit.primitives.StatevectorSampler
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler (old samplerV1 interface)
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + ideal aer simulator https://docs.quantum.ibm.com/api/migration-guides/local-simulators#aersimulator
  3. Simulated device noise
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler (old samplerV1 interface)
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + fake backend or aer simulator with noise
  4. Running on actual hardware
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + real backend from QiskitRuntimeService

Not in this list :

Questions :

  • Are the aer primitives going to be updated to v2? Support for PrimitivesV2 qiskit-aer#2078
  • For case 2 : which one for what?
  • For case 3 : which one for what?
  • For case 2 and 3 : several ways to do the same thing, is there a plan to have only one in the future?

Here is the draft @LenaPer shared:

  1. Noiseless simulation = exact simulation without sampling noise
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler using sampler.run(…, shots=None) (old samplerV1 interface)
  2. Shotnoise simulation = shot-based ideal simulation, only noise is the sampling
    StatevectorSampler https://docs.quantum.ibm.com/api/qiskit/qiskit.primitives.StatevectorSampler
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler (old samplerV1 interface)
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + ideal aer simulator https://docs.quantum.ibm.com/api/migration-guides/local-simulators#aersimulator
  3. Simulated device noise
    https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html#qiskit_aer.primitives.Sampler (old samplerV1 interface)
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + fake backend or aer simulator with noise
  4. Running on actual hardware
    https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2 + real backend from QiskitRuntimeService

Not in this list :

Questions :

  • Are the aer primitives going to be updated to v2? Support for PrimitivesV2 qiskit-aer#2078
  • For case 2 : which one for what?
  • For case 3 : which one for what?
  • For case 2 and 3 : several ways to do the same thing, is there a plan to have only one in the future?

Moved these to issue #1186

github-merge-queue bot pushed a commit that referenced this issue Apr 29, 2024
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content request request for new content to be added new ✨
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants