[NO MERGE] [WIP] Add wrapper estimator guide - #3202
Draft
TsafrirA wants to merge 4 commits into
Draft
Conversation
jyu00
reviewed
Aug 11, 2026
SamFerracin
reviewed
Aug 12, 2026
SamFerracin
left a comment
Collaborator
There was a problem hiding this comment.
Thanks, Tsafrir, looks great! I added some preliminary comments
| client machine**. This includes circuit preparation (twirling, gate folding, dynamical decoupling, | ||
| noise injection) and result post-processing (TREX readout-error mitigation, ZNE extrapolation, PEC | ||
| quasi-probability weighting). Running these steps locally provides faster debugging feedback and | ||
| greater user control, at the cost of local compute during the preparation phase. |
Collaborator
There was a problem hiding this comment.
I'd remove this, since this page needs to get the prospective user excited 😄
Suggested change
| greater user control, at the cost of local compute during the preparation phase. | |
| greater user control. |
Comment on lines
+34
to
+38
| The end-to-end processing pipeline is: | ||
|
|
||
| 1. :meth:`~.EstimatorV2.run` coerces PUBs, calls :meth:`~.EstimatorV2.finalize_options` to | ||
| resolve resilience-level defaults, and determines the shot count. | ||
| 2. The ``prepare()`` pipeline converts the PUBs into a |
Collaborator
There was a problem hiding this comment.
Some improvements:
Suggested change
| The end-to-end processing pipeline is: | |
| 1. :meth:`~.EstimatorV2.run` coerces PUBs, calls :meth:`~.EstimatorV2.finalize_options` to | |
| resolve resilience-level defaults, and determines the shot count. | |
| 2. The ``prepare()`` pipeline converts the PUBs into a | |
| When a user runs a job via :meth:`~.EstimatorV2.run`, the end-to-end processing pipeline is as follows: | |
| 1. First, some preliminary operations: The PUBs are coerced, the resilience-level defaults are resolved via :meth:`~.EstimatorV2.finalize_options`, and the shot count is determined. | |
| 2. Then, the ``prepare`` method converts the PUBs into a |
Comment on lines
+161
to
+174
| Constructor | ||
| ----------- | ||
|
|
||
| * **mode** (:class:`~qiskit.providers.BackendV2` | :class:`~qiskit_ibm_runtime.Session` | | ||
| :class:`~qiskit_ibm_runtime.Batch` | ``None``) — | ||
| The execution mode. Use a :class:`~qiskit.providers.BackendV2` for job mode, a | ||
| :class:`~qiskit_ibm_runtime.Session` for session mode, or a | ||
| :class:`~qiskit_ibm_runtime.Batch` for batch mode. Refer to the | ||
| `IBM Quantum Compute documentation <https://quantum.cloud.ibm.com/docs/guides/execution-modes>`_ | ||
| for guidance on choosing an execution mode. | ||
|
|
||
| * **options** (:class:`~.EstimatorOptions` | ``dict`` | ``None``) — | ||
| Estimator options. If ``None``, a default :class:`~.EstimatorOptions` instance with | ||
| ``resilience_level=1`` is used. A plain ``dict`` is coerced to :class:`~.EstimatorOptions`. |
Collaborator
There was a problem hiding this comment.
This part is already documented on the class itself, I'd avoid duplication
Suggested change
| Constructor | |
| ----------- | |
| * **mode** (:class:`~qiskit.providers.BackendV2` | :class:`~qiskit_ibm_runtime.Session` | | |
| :class:`~qiskit_ibm_runtime.Batch` | ``None``) — | |
| The execution mode. Use a :class:`~qiskit.providers.BackendV2` for job mode, a | |
| :class:`~qiskit_ibm_runtime.Session` for session mode, or a | |
| :class:`~qiskit_ibm_runtime.Batch` for batch mode. Refer to the | |
| `IBM Quantum Compute documentation <https://quantum.cloud.ibm.com/docs/guides/execution-modes>`_ | |
| for guidance on choosing an execution mode. | |
| * **options** (:class:`~.EstimatorOptions` | ``dict`` | ``None``) — | |
| Estimator options. If ``None``, a default :class:`~.EstimatorOptions` instance with | |
| ``resilience_level=1`` is used. A plain ``dict`` is coerced to :class:`~.EstimatorOptions`. |
| ``run()`` | ||
| --------- | ||
|
|
||
| Each call to :meth:`~.EstimatorV2.run` takes a list of PUBs (Primitive Unified Blocs). Each PUB |
Collaborator
There was a problem hiding this comment.
Same for this section. Everything here is already explained, except perhaps the part about broadcasting rules--but I would rather mention it, and link to the docs page, in the doctring of run rather than here
This file contains hidden or 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
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
Fixes #3193
AI/LLM disclosure