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

Document primitive option precedence rules #1247

Open
ihincks opened this issue Apr 26, 2024 · 3 comments
Open

Document primitive option precedence rules #1247

ihincks opened this issue Apr 26, 2024 · 3 comments
Assignees
Labels
content request request for new content to be added new ✨

Comments

@ihincks
Copy link
Contributor

ihincks commented Apr 26, 2024

URL, if applicable

No response

Describe the new content you are requesting.

When a user sets options like this,

from qiskit_ibm_runtime import EstimatorV2, QiskitRuntimeService
from qiskit import QuantumCircuit

service = QiskitRuntimeService()
backend = service.backend("ibm_auckland")

estimator = EstimatorV2(backend)

estimator.options.default_shots = 100
estimator.options.resilience_level = 0
estimator.options.resilience.zne_mitigation = True

it might not be clear how the resilience level might interact with the other options, because the resilience level itself can modify the mitigation strategy. In this example, does setting the resilience level to 0 have the effect of turning off the attempt to add zne_mitigation? (spoiler: no)

What needs to be documented is that that the resilience level is FIRST used to set a base configuration on any options it thinks are relevant, and THEN any other user-specified options are updated on top of that. So it would be possible, for example, though pointless, to completely undo the effect of setting the resilience level by reversing all of its intentions manually.

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

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

Which page do you envision this living on, @ihincks? The primitives examples page, the V2 migration guide, etc.

@jyu00
Copy link
Collaborator

jyu00 commented Apr 26, 2024

how about this page: https://docs.quantum.ibm.com/run/configure-error-mitigation#custom-error-settings-v2-primitives

@abbycross
Copy link
Collaborator

Thanks @ihincks! What is the timeline for this content? Are you ready to open a PR for it, and how can we support you with it? If it might be more than a few weeks before this is ready, I'll add it to our backlog.

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
None yet
Development

No branches or pull requests

5 participants