Add Migration Guide for `QuantumInstance` #9554

ElePT · 2023-02-08T15:30:07Z

Summary

Closes #9517.

Details and comments

Blocked by #9549

qiskit-bot · 2023-02-08T15:30:16Z

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

@Cryoris
@Qiskit/terra-core
@manoelmarques
@woodsp-ibm

coveralls · 2023-02-08T16:03:43Z

Pull Request Test Coverage Report for Build 4691111819

0 of 0 changed or added relevant lines in 0 files are covered.
478 unchanged lines in 40 files lost coverage.
Overall coverage increased (+0.3%) to 85.738%

Files with Coverage Reduction	New Missed Lines	%
qiskit/primitives/backend_sampler.py	1	98.81%
qiskit/synthesis/evolution/matrix_synthesis.py	1	93.75%
qiskit/transpiler/passes/layout/full_ancilla_allocation.py	1	97.73%
qiskit/transpiler/passes/optimization/template_matching/template_substitution.py	1	93.2%
qiskit/transpiler/passes/utils/check_map.py	1	97.83%
qiskit/algorithms/amplitude_estimators/estimation_problem.py	2	93.67%
qiskit/primitives/sampler.py	2	97.1%
qiskit/qasm/init.py	2	71.43%
qiskit/transpiler/passes/layout/csp_layout.py	2	96.67%
qiskit/transpiler/passes/layout/trivial_layout.py	2	91.3%

Totals
Change from base Build 4627350272:	0.3%
Covered Lines:	70162
Relevant Lines:	81833

💛 - Coveralls

docs/migration_guides/qi_migration.rst

…terra into qi-migration-guide

docs/migration_guides/qi_migration.rst

woodsp-ibm · 2023-03-23T19:01:31Z

docs/migration_guides/qi_migration.rst

+
+The functionality of :class:`~qiskit.utils.QuantumInstance.execute` has
+now been delegated to the different implementations of the :mod:`~qiskit.primitives` base classes,
+while the explicit transpilation has been left to the :mod:`~qiskit.transpiler` module (see table below).


This is more a comment, but since its talking about transpilation its done by default now by the primitives, so algorithms no longer need to manage that aspect along with binding parameters. Transpilation can be turned off - but since operator and circuit size need to match for Estimator, doing your own transpilation needs to meet that constraint - if say it adds swaps, which increase overall circuit width, then it will fail as there is no mechanism to say identify the active qubits it should consider.

I have added that algorithms no longer need to take care of transpilation, as it has been moved to the primitive level. I will see where I can mention the transpilation + Estimator challenges.

woodsp-ibm · 2023-03-23T19:06:35Z

docs/migration_guides/qi_migration.rst

+   * - QuantumInstance method
+     - Alternative
+   * - ``QuantumInstance.execute``
+     - ``Sampler.run`` or ``Estimator.run``


This might also be an alternative https://qiskit.org/documentation/apidoc/execute.html - though the QI one had the mitigation, job splitting/combining and reliability which you may now want/need to do yourself if using this.

We're probably going to deprecate execute, so that would not need to be listed as alternative 🙂 See also #7892

docs/migration_guides/qi_migration.rst

woodsp-ibm · 2023-03-23T21:45:41Z

docs/migration_guides/qi_migration.rst

+        circuit.x(1)
+        circuit.measure_all()
+
+        sampler = Sampler(run_options = {"method":"statevector", "shots":200})


Similar comment. I will note while this is ok for Sampler presently, as far as I am aware, the Aer Estimator will override any method you pass it as it sets it internally based on approximation and if noise model is used.

woodsp-ibm · 2023-03-23T21:47:01Z

docs/migration_guides/qi_migration.rst

+
+        estimator = Estimator(
+                   backend_options={
+                       "method": "density_matrix",


As mentioned above this will be overidden in any case - yes, you have what it chooses internally but there is no choice at this level.

docs/migration_guides/qi_migration.rst

woodsp-ibm · 2023-03-23T21:58:53Z

docs/migration_guides/qi_migration.rst

+    On the other hand, when using the primitives:
+
+    * You cannot explicitly access their transpilation routine.
+    * The mechanism to apply custom transpilation passes to the Aer, Runtime and Backend primitives is to pre-transpile


Care is needed here - as I mentioned in one of the earlier comments at the head of the file. In opflow the ansatz would always have the basis change and measurement gates added before transpilation so if the circuit ended up on more qubits it did not matter. Transpiling it first before giving it to the Estimator is a different flow.

added a warning

woodsp-ibm · 2023-03-23T22:03:47Z

docs/migration_guides/qi_migration.rst

+    Aer simulation following the statevector method. This would be the direct 1-1 replacement of the ``QuantumInstance``
+    example, as they are both accessing the same simulator. For this reason, the output metadata is
+    closer to the Quantum Instance's output. Please note that
+    the resulting quasi-probability distribution does not use bitstrings but **integers** to identify the states.


You could note the QuasiProb does have methods binary_probabilities and hex_probabilities if the integer keys are not to your liking.

Added note and example

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

declanmillar

LGTM! Again, just minor grammar tweaks.

docs/migration_guides/qi_migration.rst

Co-authored-by: Declan Millar <declan.millar@ibm.com>

Guillermo-Mijares-Vilarino

Hi Elena. The content looks great!

However I have some comments about the Sphinx links.

docs/migration_guides/qi_migration.rst

Guillermo-Mijares-Vilarino · 2023-04-05T11:13:06Z

docs/migration_guides/qi_migration.rst

+    The only alternative for local simulations using the quantum instance was using an Aer Simulator backend.
+    Please note that ``QuantumInstance.execute()`` returned the counts bitstrings in hexadecimal format.
+
+    .. testcode::


If you don't plan to run the tests (I see that you used the SKIP flag) you can use .. code-block:: python and .. code-block:: text for input and output respectively so you don't depend on the Sphinx doctest extension.

I didn't know about .. code-block:: text, thanks!

Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com>

…terra into qi-migration-guide

Cryoris

Some minor points and one comment on the unbound PMs, otherwise LGTM 👍🏻

docs/migration_guides/qi_migration.rst

Cryoris · 2023-04-13T08:08:03Z

docs/migration_guides/qi_migration.rst

+        Quasi dists: [{2: 0.0008492371522941081, 3: 0.9968874384378738, 0: -0.0003921227905920063,
+		 1: 0.002655447200424097}]
+
+.. dropdown:: Example 4: Circuit Sampling with Custom Bound and Unbound Pass Managers


The power of unbound and bound pass managers in the quantum instance is actually coming from the combination with the CircuitSampler 🙂 If you have an unbound and bound pass manager (for example, the unbound pass manager does the routing and high level optimization and the bound does pulse optimization), then you could do

qi = QuantumInstance(pass_manager=unbound, bound_pass_manager=bound, ....) sampler = CircuitSampler(qi) circuits = .... # circuit with *free* parameters sampler.convert(circuits, param_values=....) # sampler will first do the unbound, then bind, then the bound for you

This workflow is (afaik) not possible anymore with the primitives. Should we update this example?

Co-authored-by: Julien Gacon <gaconju@gmail.com>

docs/migration_guides/qi_migration.rst

Co-authored-by: Julien Gacon <gaconju@gmail.com>

Cryoris

LGTM thanks for all the detailed work on the migration guides!

* Add draft * Remove qiskit * Add qi migration file * Add content * Finish content * Update provider syntax * Finish content * Apply auto-suggestions * Add doctests * Change to dropdowns * Add EM results * Apply suggestions from code review Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Apply review comments * Apply suggestions from Declan's code review Co-authored-by: Declan Millar <declan.millar@ibm.com> * Apply suggestions from Guillermo's code review Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com> * Change from doctest to codeblocks * Review follow-up edits * Replace statevector with quantum info * Reorder index * Add assemble alternative * Apply suggestions from Julien's code review Co-authored-by: Julien Gacon <gaconju@gmail.com> * Change transpilation example * Apply suggestions from Juliencode review Co-authored-by: Julien Gacon <gaconju@gmail.com> --------- Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> Co-authored-by: Declan Millar <declan.millar@ibm.com> Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com> Co-authored-by: Julien Gacon <gaconju@gmail.com>

ElePT added 3 commits February 8, 2023 11:59

Add draft

dc0fae8

Remove qiskit

d728473

Add qi migration file

7a6f8c6

1ucian0 added the on hold Can not fix yet label Feb 8, 2023

HuangJunye mentioned this pull request Feb 8, 2023

Add migration guides from terra Qiskit/qiskit-metapackage#1664

Closed

ElePT added 2 commits February 16, 2023 19:14

Add content

61414ae

Finish content

9872996

ElePT marked this pull request as ready for review February 17, 2023 17:59

ElePT requested a review from a team as a code owner February 17, 2023 17:59

ElePT added 2 commits February 20, 2023 17:30

Update provider syntax

a8f7a45

Finish content

b28aebf

ElePT added this to the 0.24.0 milestone Feb 21, 2023

ElePT added documentation Something is not clear or an error documentation mod: opflow Related to the Opflow module labels Feb 21, 2023

ElePT commented Feb 21, 2023

View reviewed changes

Apply auto-suggestions

f727c1b

HuangJunye mentioned this pull request Feb 27, 2023

Add Migration Guide for Opflow #9549

Merged

7 tasks

ElePT and others added 5 commits March 3, 2023 10:36

Add doctests

f75dc12

Merge branch 'main' into qi-migration-guide

4152ac1

Change to dropdowns

610b368

Merge branch 'qi-migration-guide' of https://github.com/ElePT/qiskit-…

5ea9dd6

…terra into qi-migration-guide

Add EM results

2d12c04

woodsp-ibm reviewed Mar 23, 2023

View reviewed changes

Apply suggestions from code review

6531df8

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

HuangJunye self-assigned this Mar 24, 2023

Apply review comments

6227ee4

declanmillar previously approved these changes Mar 31, 2023

View reviewed changes

Apply suggestions from Declan's code review

23461ce

Co-authored-by: Declan Millar <declan.millar@ibm.com>

ElePT dismissed declanmillar’s stale review via 23461ce April 3, 2023 08:47

Guillermo-Mijares-Vilarino reviewed Apr 5, 2023

View reviewed changes

ElePT and others added 9 commits April 6, 2023 10:41

Apply suggestions from Guillermo's code review

d42997f

Co-authored-by: Guillermo-Mijares-Vilarino <106545082+Guillermo-Mijares-Vilarino@users.noreply.github.com>

Merge branch 'qi-migration-guide' of https://github.com/ElePT/qiskit-…

e0a4aeb

…terra into qi-migration-guide

Fix merge conflict

a7122d6

Change from doctest to codeblocks

5b1bb88

Review follow-up edits

c925adf

Replace statevector with quantum info

15b895d

Merge branch 'main' into qi-migration-guide

c352fa0

Reorder index

27ada7b

Add assemble alternative

dcfcc70

mtreinish added the priority: high label Apr 11, 2023

mtreinish assigned Cryoris Apr 11, 2023

Cryoris reviewed Apr 13, 2023

View reviewed changes

Apply suggestions from Julien's code review

3b50d9c

Co-authored-by: Julien Gacon <gaconju@gmail.com>

ElePT removed the on hold Can not fix yet label Apr 13, 2023

Change transpilation example

9dcd212

Cryoris reviewed Apr 13, 2023

View reviewed changes

docs/migration_guides/qi_migration.rst Outdated Show resolved Hide resolved

docs/migration_guides/qi_migration.rst Outdated Show resolved Hide resolved

Apply suggestions from Juliencode review

929ea99

Co-authored-by: Julien Gacon <gaconju@gmail.com>

Cryoris approved these changes Apr 13, 2023

View reviewed changes

Cryoris enabled auto-merge April 13, 2023 15:39

Cryoris added this pull request to the merge queue Apr 13, 2023

Merged via the queue into Qiskit:main with commit 9157b40 Apr 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Migration Guide for `QuantumInstance` #9554

Add Migration Guide for `QuantumInstance` #9554

ElePT commented Feb 8, 2023 •

edited

Loading

qiskit-bot commented Feb 8, 2023

coveralls commented Feb 8, 2023 •

edited

Loading

woodsp-ibm Mar 23, 2023

ElePT Mar 24, 2023

woodsp-ibm Mar 23, 2023

Cryoris Apr 6, 2023

woodsp-ibm Mar 23, 2023

woodsp-ibm Mar 23, 2023

woodsp-ibm Mar 23, 2023

ElePT Mar 24, 2023

woodsp-ibm Mar 23, 2023

ElePT Apr 6, 2023

declanmillar left a comment

Guillermo-Mijares-Vilarino left a comment

Guillermo-Mijares-Vilarino Apr 5, 2023 •

edited

Loading

ElePT Apr 6, 2023

Cryoris left a comment

Cryoris Apr 13, 2023

Cryoris left a comment

Add Migration Guide for QuantumInstance #9554

Add Migration Guide for QuantumInstance #9554

Conversation

ElePT commented Feb 8, 2023 • edited Loading

Summary

Details and comments

qiskit-bot commented Feb 8, 2023

coveralls commented Feb 8, 2023 • edited Loading

Pull Request Test Coverage Report for Build 4691111819

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

declanmillar left a comment

Choose a reason for hiding this comment

Guillermo-Mijares-Vilarino left a comment

Choose a reason for hiding this comment

Guillermo-Mijares-Vilarino Apr 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cryoris left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cryoris left a comment

Choose a reason for hiding this comment

Add Migration Guide for `QuantumInstance` #9554

Add Migration Guide for `QuantumInstance` #9554

ElePT commented Feb 8, 2023 •

edited

Loading

coveralls commented Feb 8, 2023 •

edited

Loading

Guillermo-Mijares-Vilarino Apr 5, 2023 •

edited

Loading