Added how-to guides by Guillermo-Mijares-Vilarino · Pull Request #8624 · Qiskit/qiskit

Guillermo-Mijares-Vilarino · 2022-08-26T17:29:19Z

Summary

Expanded the how-to guide section created in #9716.

Details and comments

This PR adds 4 guides written in .rst format:

Create a quantum circuit
Combine quantum circuits
Visualize a quantum circuit
Create a parameterized circuit

Note: This PR was originally meant to add the how-to section to qiskit-terra. However, several months later I added two guides about the primitives to this PR and later it was decided to move the primitive guides to their own PR (#9716) and give them higher priority. Therefore now this PR is more like an expansion of #9716.

…qiskit-terra into add-how-tos

qiskit-bot · 2022-08-26T17:29:22Z

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:

@Qiskit/terra-core

coveralls · 2022-08-26T18:03:51Z

Pull Request Test Coverage Report for Build 5518892140

0 of 0 changed or added relevant lines in 0 files are covered.
12 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.009%) to 85.988%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	6	91.39%
crates/qasm2/src/parse.rs	6	97.58%

Totals
Change from base Build 5515523732:	-0.009%
Covered Lines:	71643
Relevant Lines:	83317

💛 - Coveralls

…larino/qiskit-terra into add-how-tos

…cal register

Guillermo-Mijares-Vilarino · 2022-08-29T12:32:12Z

Had to remove QuantumCircuit.draw('latex') from the how to visualize circuits guide because it requires a full $\LaTeX$ distribution.

I explicitly set the cregbundle argument from QuantumCircuit.draw() to false when appending circuits in the how to combine circuits guide to avoid a warning that broke doc building.

mtreinish

I just quickly skimmed things and left two small inline comments but they apply to all the docs being added here

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

HuangJunye

Review for compose_quantum_circuits.rst

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

javabster

This looks great! I left a bunch of comments that are mostly just english corrections. I'm not a professional linguist so i don't really know how to explain my suggestions other than "it just sounds more fluent" as a native english speaker 😅 but if anything is confusing please lmk and I can try to explain

javabster · 2023-05-18T19:36:18Z

+                              0  1 
+
+The main difference from the previous case is that now you need to include the parameter values
+for which you want to evaluate the expectation value as a ``list`` of ``list``\ s of ``float``\ s.


is this paragraph correct? Shouldn't be talking about sampling probabilities not expectation values?

Good catch! Fixed in ec0c28c

Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>

…larino/qiskit-terra into add-how-tos

HuangJunye

Address review comments.

HuangJunye · 2023-07-10T15:35:46Z

+                              0  1 
+
+The main difference from the previous case is that now you need to include the parameter values
+for which you want to evaluate the expectation value as a ``list`` of ``list``\ s of ``float``\ s.


Good catch! Fixed in ec0c28c

HuangJunye · 2023-07-10T15:41:42Z

+.. note::
+    In Qiskit Terra :math:`\leq 0.7`, the default behavior for the :func:`~.circuit_drawer` function is to use the ``'latex'`` output backend, and in :math:`0.6.x` that includes a fallback to ``'mpl'`` if ``'latex'`` fails for any reason. Starting with release :math:`> 0.7`, the default changes to the ``'text'`` output.


I think this information is not needed and extra information makes the page longer and distracting. Remove in be801cf

javabster

Looking really good! Just a few last minor comments :)

javabster · 2023-07-11T19:01:37Z

+
+In order to join two circuits with :meth:`~.QuantumCircuit.compose`, you only have to specify the circuit you want to insert. That way the qubits and bits of the smaller circuit will be included into the first qubits and bits of the bigger one in the original order they had. 
+
+By default, :meth:`~.QuantumCircuit.compose` does not modify the original circuit to which it is applied but returns a new joint circuit object. This can be changed by setting the ``inplace`` argument to ``True``.


I think it would be good to put this sentence in a note box or a in brackets, as the following code example doesn't actually show how to use the inplace argument

alternatively it might be nice to add a short code snippet showing the use of the inplace arg

javabster · 2023-07-11T19:03:10Z

+
+In order to join two circuits with :meth:`~.QuantumCircuit.append`, you need to specify the circuit you want to add, as well as the qubits and classical bits (if there are any) onto which you want the circuit to be applied.
+
+Different from :meth:`~.QuantumCircuit.compose`, this method modifies the circuit it is applied to, instead of returning a new circuit.


Suggested change

Different from :meth:`~.QuantumCircuit.compose`, this method modifies the circuit it is applied to, instead of returning a new circuit.

Unlike :meth:`~.QuantumCircuit.compose`, this method modifies the circuit it is applied to, instead of returning a new circuit.

javabster · 2023-07-11T19:17:05Z

+       └───────┘
+
+
+Another difference between :meth:`~.QuantumCircuit.bind_parameters` and :meth:`~.QuantumCircuit.assign_parameters` is that for the latter, you can make it change your original circuit instead of creating a new one by setting the ``inplace`` argument to ``True``.


This in place argument feels similar to the one in the previous how to guide, I think it would be good to use the same format for the explanation in both.

javabster · 2023-07-11T19:20:43Z

+
+.. testcode::
+
+    # Resulting quantum circuits are different if the quantum or classical registers have different relative order


nice comparison!

javabster · 2023-07-11T19:35:36Z

+Using the :func:`~.circuit_drawer` function
+-------------------------------------------
+
+If you prefer to use a self-contained function instead of a :class:`~.QuantumCircuit` method to draw your circuit, you can do it with :func:`~.circuit_drawer` from :mod:`qiskit.visualization`. It has the exact same behavior as the :meth:`~.QuantumCircuit.draw` method above, except that it requires the circuit to be included as an argument.


Is there a reason a user might want to use the circuit_drawer function at all? If there is a plausible scenario where this would be the preferred way maybe we should mention it?

javabster · 2023-07-11T19:36:41Z

+
+.. _create circuit with qubit numbers:
+
+Create by specifying the number of qubits and classical bits


this feels a bit weird grammatically. I'd suggest saying something like "Create a circuit by specifying..."

javabster · 2023-07-11T19:37:24Z

+
+    q_2: 
+
+Create from quantum and classical registers


same as above, just using "create" on it's own like this feels a bit odd grammatically. I think using something like "create a circuit from..." is a bit clearer

jakelishman · 2024-02-23T01:13:57Z

Since this type of content has moved over to github.com/Qiskit/documentation in the intervening yeras, I'll close this PR as staled now. Thanks for all the work that went into this - I'm sure it at a minimum informed the guides that got written in the separate documentation. If there's more to discuss, or components of this PR should be taken to the main documentation repository, please feel free to take the discussion there.

Guillermo-Mijares-Vilarino and others added 6 commits August 26, 2022 16:08

Added how-to section

2f1e42f

added how to compose circuits guide

d39833c

added how to visualize circuit guide

bb661fd

add how to create parameterized circuit guide

59e06f9

Merge branch 'main' of https://github.com/Guillermo-Mijares-Vilarino/…

9c87269

…qiskit-terra into add-how-tos

Merge branch 'Qiskit:main' into add-how-tos

109b049

qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Aug 26, 2022

Guillermo-Mijares-Vilarino added Intern PR PR submitted by IBM Quantum interns documentation Something is not clear or an error documentation and removed Community PR PRs from contributors that are not 'members' of the Qiskit repo labels Aug 26, 2022

Guillermo-Mijares-Vilarino added 2 commits August 26, 2022 20:15

add guides

63d6f81

Merge branch 'add-how-tos' of https://github.com/Guillermo-Mijares-Vi…

9cc7f76

…larino/qiskit-terra into add-how-tos

HuangJunye self-assigned this Aug 29, 2022

Guillermo-Mijares-Vilarino added 4 commits August 29, 2022 10:14

removed latex circuit visualization

d28748a

fixed title underlines

e7b2e47

Fix typo

352a7c4

explicitly set cregbundle to False when appending circuit with classi…

ba14c27

…cal register

Guillermo-Mijares-Vilarino and others added 3 commits August 30, 2022 13:34

Fix typo

4cf2634

Added explanation about needed latex distribution

ed2115c

added link to qiskit.visualization module

a7b38d8

mtreinish reviewed Aug 31, 2022

View reviewed changes

Comment thread docs/how_to/compose_quantum_circuits.rst Outdated

Comment thread docs/how_to/compose_quantum_circuits.rst Outdated

Guillermo-Mijares-Vilarino and others added 2 commits September 1, 2022 11:10

Simplified references

861baaa

Change 'we' to 'you'

9354aa0

Guillermo-Mijares-Vilarino mentioned this pull request Sep 23, 2022

Sphinx project for doc guidelines Qiskit/qiskit_sphinx_theme#78

Merged

3 tasks

Changed how_to.rst to how_to/index.rst

02298c6

HuangJunye mentioned this pull request Nov 22, 2022

Docs guidelines/add existing examples Qiskit/qiskit_sphinx_theme#135

Merged

Merge branch 'main' into add-how-tos

0dbd593

Guillermo-Mijares-Vilarino and others added 3 commits May 12, 2023 18:35

Apply suggestions from code review

20fd583

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

Apply suggestions from code review

795b35c

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

rephrase visualization how-to intro

8f8ec24

HuangJunye requested changes May 12, 2023

View reviewed changes

Guillermo-Mijares-Vilarino and others added 2 commits May 12, 2023 19:16

Apply suggestions from code review

9677372

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

fix underline

c33605e

javabster reviewed May 18, 2023

View reviewed changes

HuangJunye mentioned this pull request Jun 13, 2023

Tutorial moving status Qiskit/qiskit-tutorials#1473

Closed

26 tasks

HuangJunye and others added 10 commits July 10, 2023 15:58

Apply suggestions from code review

95537d3

Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>

reverting to use verb instead of ing form

0570733

Merge branch 'main' into add-how-tos

5e51112

Merge branch 'add-how-tos' of https://github.com/Guillermo-Mijares-Vi…

434c25e

…larino/qiskit-terra into add-how-tos

add back notes for including and excluding measurements

aa5d2d4

revert necessary code changes in use_estimator

b0a1f6f

revert unnecessary code changes in use_sampler

ec0c28c

change expectation values to sampling probabilities

194302c

remove note

65935f3

remove note

be801cf

HuangJunye reviewed Jul 10, 2023

View reviewed changes

HuangJunye added 2 commits July 10, 2023 17:48

add a sentence explaining joining by specifying qubits

802b53d

fix indentation

9f8cd3a

HuangJunye assigned javabster and unassigned HuangJunye Jul 11, 2023

HuangJunye requested a review from javabster July 11, 2023 10:36

Merge branch 'main' into add-how-tos

b304ad8

HuangJunye approved these changes Jul 11, 2023

View reviewed changes

javabster reviewed Jul 11, 2023

View reviewed changes

Eric-Arellano mentioned this pull request Aug 21, 2023

Tutorial improvement & deduplication ideas Qiskit/documentation#874

Closed

13 tasks

jakelishman closed this Feb 23, 2024

		.. note::
		In Qiskit Terra :math:`\leq 0.7`, the default behavior for the :func:`~.circuit_drawer` function is to use the ``'latex'`` output backend, and in :math:`0.6.x` that includes a fallback to ``'mpl'`` if ``'latex'`` fails for any reason. Starting with release :math:`> 0.7`, the default changes to the ``'text'`` output.


		In order to join two circuits with :meth:`~.QuantumCircuit.compose`, you only have to specify the circuit you want to insert. That way the qubits and bits of the smaller circuit will be included into the first qubits and bits of the bigger one in the original order they had.

		By default, :meth:`~.QuantumCircuit.compose` does not modify the original circuit to which it is applied but returns a new joint circuit object. This can be changed by setting the ``inplace`` argument to ``True``.


		In order to join two circuits with :meth:`~.QuantumCircuit.append`, you need to specify the circuit you want to add, as well as the qubits and classical bits (if there are any) onto which you want the circuit to be applied.

		Different from :meth:`~.QuantumCircuit.compose`, this method modifies the circuit it is applied to, instead of returning a new circuit.

	Different from :meth:`~.QuantumCircuit.compose`, this method modifies the circuit it is applied to, instead of returning a new circuit.
	Unlike :meth:`~.QuantumCircuit.compose`, this method modifies the circuit it is applied to, instead of returning a new circuit.

		└───────┘


		Another difference between :meth:`~.QuantumCircuit.bind_parameters` and :meth:`~.QuantumCircuit.assign_parameters` is that for the latter, you can make it change your original circuit instead of creating a new one by setting the ``inplace`` argument to ``True``.


		.. testcode::

		# Resulting quantum circuits are different if the quantum or classical registers have different relative order


		.. _create circuit with qubit numbers:

		Create by specifying the number of qubits and classical bits

Conversation

Guillermo-Mijares-Vilarino commented Aug 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details and comments

Uh oh!

qiskit-bot commented Aug 26, 2022

Uh oh!

coveralls commented Aug 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 5518892140

💛 - Coveralls

Uh oh!

Guillermo-Mijares-Vilarino commented Aug 29, 2022

Uh oh!

mtreinish left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

HuangJunye left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

javabster left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

HuangJunye left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

javabster left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jakelishman commented Feb 23, 2024

Uh oh!

Reviewers

Guillermo-Mijares-Vilarino commented Aug 26, 2022 •

edited

Loading

coveralls commented Aug 26, 2022 •

edited

Loading