Explanation and examples added for various QuantumCircuit methods Fixes #3400 by sumitpuri · Pull Request #3683 · Qiskit/qiskit

sumitpuri · 2020-01-05T16:41:15Z

Summary

Fixes #3400 by adding explanations for various QuantumCircuit methods.

Details and comments

The gates (ccx, ch, crz, cswap, cu1, cu3, cx, cy, cz, h, iden, rx, ry, rz, s, sdg, swap, t, tdg, u1, u2, u3, x, y, z) now have an example and explanation of what the respective gate does.

Co-Author: Sumit Puri <er.sumitpuri@gmail.com>

…omplex number.

…3640branch

Examples have been provided for the following methods- ccx, ch, crz, cswap, cu1, cu3, cx, cy, cz, h, iden, rx, ry, rz, s, sdg, swap, t, tdg, u1, u2, u3, x, y, z

This reverts commit 36b7881.

Examples have been provided for the following methods- ccx, ch, crz, cswap, cu1, cu3, cx, cy, cz, h, iden, rx, ry, rz, s, sdg, swap, t, tdg, u1, u2, u3, x, y, z

nonhermitian · 2020-01-05T16:51:31Z

The examples should be in jupyter-execute blocks so as they are run at docs build time. This way errors in the docs are caught.

sumitpuri · 2020-01-05T17:06:32Z

@nonhermitian So are you suggesting to split the explanation and the example circuit? Are the one line explanations okay in these files? Can you please share a sample screenshot of where the examples need to be added?

sumitpuri · 2020-01-05T23:15:47Z

I was doing a PR for another bug #3684 but seems like it got tied to this PR instead.

kdk · 2020-01-07T14:57:27Z

The explanations and examples can stay together in the same docstrings, but the example should be prefaced with .. jupyter-execute:: so that they will be run and displayed in the auto-generated documentation. For example, https://github.com/Qiskit/qiskit-terra/blob/7718e3576d0c9d77991c8c4b813ac05b7b1aa940/qiskit/circuit/quantumcircuit.py#L76
builds to the Examples section on https://qiskit.org/documentation/api/qiskit.circuit.QuantumCircuit.html#quantumcircuit .

kdk · 2020-01-07T14:59:33Z

I was doing a PR for another bug #3684 but seems like it got tied to this PR instead.

You can revert that commit from this PR by checking out the fixissue3640branch branch and running git revert b8b010e.

This reverts commit b8b010e.

…orrecting by performing 'make style'.

sumitpuri · 2020-01-07T21:13:02Z

Thank you @kdk Can you help me fix the two checks that are failing.

kdk

It looks like a missing import statement. This should fix it.

kdk · 2020-02-03T14:33:24Z

@kdk I have incorporated the comments, the tests are still failing though.

#3631 moved the definitions of some of the controlled gate classes into the files of their base gates (e.g. cx and ccx are now defined in x.py). Normally changes on master are automatically merged in to PR branches, but that change will have to be resolved manually.

sumitpuri · 2020-02-03T15:26:24Z

ok @kdk so what is the suggested action item for me?

…kit-terra into sumitpuri-fixissue3640branch

kdk

ok @kdk so what is the suggested action item for me?

I resolved the conflicts so no action needed from you :). One comment below on the matrix definition of cswap.

Fixed (#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net>

sumitpuri · 2020-02-03T20:20:16Z

Thanks @kdk However, it is failing here:
But I don't see anything wrong in the code.

kdk

A few more import locations need updating.

Fixed (#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net>

sumitpuri · 2020-02-04T16:17:10Z

Thanks @kdk all tests have passed this time.

kdk

This looks just about ready to go. to_matrix was re-introduced on RZGate (maybe in one of the merge conflicts) and should be removed.

sumitpuri · 2020-02-06T04:11:41Z

Hi @kdk

In rz.py, there's just a to_matrix definition, not the .. jupyter-execute::

Are you suggesting to remove def to_matrix(self) code?

kdk · 2020-02-06T15:00:05Z

Are you suggesting to remove def to_matrix(self) code?

Yes, it had caused a test failure earlier due to a phase difference between Rz and U1 (not sure why the test currently passes) #3683 (comment)

There are some additional merge conflicts, I'll take care of removing it there.

kdk

This looks good to go, thanks @sumitpuri !

@nonhermitian

Qiskit#3400 (Qiskit#3683) * Fixed issue 3640 by adding logic for complex imaginary numbers Co-Author: Sumit Puri <er.sumitpuri@gmail.com> * Added test for display of 'pi'. * Added test for displaying 'pi' for both real and imaginary parts of complex number. * Release notes added for Fixes Qiskit#3640 * release notes * Fixes Qiskit#3400 Examples have been provided for the following methods- ccx, ch, crz, cswap, cu1, cu3, cx, cy, cz, h, iden, rx, ry, rz, s, sdg, swap, t, tdg, u1, u2, u3, x, y, z * Revert "Fixes Qiskit#3400" This reverts commit 36b7881. * Fixes Qiskit#3400 Examples have been provided for the following methods- ccx, ch, crz, cswap, cu1, cu3, cx, cy, cz, h, iden, rx, ry, rz, s, sdg, swap, t, tdg, u1, u2, u3, x, y, z * Added release notes for Fixes Qiskit#3400 * Fixes Qiskit#3684 Text drawer displays cU1 correctly. * Revert "Fixes Qiskit#3684 Text drawer displays cU1 correctly." This reverts commit b8b010e. * Fixes Qiskit#3400 by adding jupyter-execute statement in the examples. * Fixes Qiskit#3400 by adding jupyter-execute statement in the examples and correcting by performing 'make style'. * Update qiskit/extensions/standard/crz.py Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Revert "Update qiskit/extensions/standard/crz.py" This reverts commit 2abc824. * Fixes Qiskit#3400 Added import numpy * Qiskit#3400 added import numpy statements * Fixes Qiskit#3400 incorporated comments from @nonhermitian * Fixes Qiskit#3400 added more text. * Update qiskit/extensions/standard/rx.py Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Added params for matrix generation. * Removed Matrix representation from rz.py * Update qiskit/extensions/standard/z.py Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Update qiskit/extensions/standard/y.py Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Update qiskit/extensions/standard/y.py Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Update qiskit/extensions/standard/u2.py Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Update qiskit/extensions/standard/cx.py Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Update qiskit/extensions/standard/u3.py Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Fixes Qiskit#3400 incorporated suggestions * Fixes Qiskit#3400 H gate description. * Added matrix for cswap * Consistency with removing hyphen. * Fixes Qiskit#3400 consistency * Fixing style * Rearranged the import order * Fixes matrix representation * Incorporating suggestions * Incorporated comments (Qiskit#3400) * Update qiskit/extensions/standard/swap.py Fixed (Qiskit#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Update qiskit/extensions/standard/h.py Fixed (Qiskit#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Update qiskit/extensions/standard/swap.py Fixed (Qiskit#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Update qiskit/extensions/standard/x.py Fixed (Qiskit#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net> * Fix lint failures following merge resolution. Co-authored-by: Luciano Bello <luciano.bello@ibm.com> Co-authored-by: Kevin Krsulich <kevin@krsulich.net>

1ucian0 and others added 12 commits January 3, 2020 15:22

Fixed issue 3640 by adding logic for complex imaginary numbers

4ecb49c

Co-Author: Sumit Puri <er.sumitpuri@gmail.com>

Merge branch 'master' into fixissue3640branch

9a25537

Added test for display of 'pi'.

834ba0c

Added test for displaying 'pi' for both real and imaginary parts of c…

be364d8

…omplex number.

Merge branch 'master' into fixissue3640branch

d505325

Release notes added for Fixes #3640

ca4a326

release notes

19ce29b

Merge branch 'master' of github.com:Qiskit/qiskit-terra into fixissue…

88cad51

…3640branch

Fixes #3400

36b7881

Examples have been provided for the following methods- ccx, ch, crz, cswap, cu1, cu3, cx, cy, cz, h, iden, rx, ry, rz, s, sdg, swap, t, tdg, u1, u2, u3, x, y, z

Revert "Fixes #3400"

7325b45

This reverts commit 36b7881.

Fixes #3400

883e07f

Examples have been provided for the following methods- ccx, ch, crz, cswap, cu1, cu3, cx, cy, cz, h, iden, rx, ry, rz, s, sdg, swap, t, tdg, u1, u2, u3, x, y, z

Added release notes for Fixes #3400

569168b

sumitpuri requested review from 1ucian0, ajavadia, ewinston, kdk, mtreinish and nonhermitian as code owners January 5, 2020 16:41

Fixes #3684 Text drawer displays cU1 correctly.

b8b010e

sumitpuri added 3 commits January 7, 2020 11:19

Revert "Fixes #3684 Text drawer displays cU1 correctly."

d7f175f

This reverts commit b8b010e.

Fixes #3400 by adding jupyter-execute statement in the examples.

6b40eb6

Fixes #3400 by adding jupyter-execute statement in the examples and c…

461e518

…orrecting by performing 'make style'.

kdk reviewed Jan 8, 2020

View reviewed changes

Comment thread qiskit/extensions/standard/crz.py Outdated

kdk assigned sumitpuri Jan 8, 2020

Merge branch 'fixissue3640branch' of https://github.com/sumitpuri/qis…

c8391c3

…kit-terra into sumitpuri-fixissue3640branch

sumitpuri requested review from chriseclectic, dcmckayibm, diego-plan9, eggerdj, itoko, jyu00, lcapelluto, nkanazawa1989 and taalexander as code owners February 3, 2020 17:21

Merge branch 'master' into fixissue3640branch

df39bf7

kdk reviewed Feb 3, 2020

View reviewed changes

Comment thread qiskit/extensions/standard/swap.py Outdated

Update qiskit/extensions/standard/swap.py

41b89cc

Fixed (#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net>

kdk reviewed Feb 4, 2020

View reviewed changes

Comment thread qiskit/extensions/standard/h.py Outdated

Comment thread qiskit/extensions/standard/x.py

Comment thread qiskit/extensions/standard/z.py

Comment thread qiskit/extensions/standard/swap.py Outdated

Comment thread qiskit/extensions/standard/x.py Outdated

kdk added this to the 0.12 milestone Feb 4, 2020

sumitpuri and others added 3 commits February 4, 2020 09:23

Update qiskit/extensions/standard/h.py

0c7debc

Fixed (#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net>

Update qiskit/extensions/standard/swap.py

59a917b

Fixed (#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net>

Update qiskit/extensions/standard/x.py

4cb5190

Fixed (#3400) Co-Authored-By: Kevin Krsulich <kevin@krsulich.net>

kdk reviewed Feb 5, 2020

View reviewed changes

kdk added 2 commits February 6, 2020 10:29

Merge branch 'master' into fixissue3640branch

4abf422

Fix lint failures following merge resolution.

b48a6be

kdk approved these changes Feb 6, 2020

View reviewed changes

kdk merged commit 1de26bb into Qiskit:master Feb 6, 2020

Conversation

sumitpuri commented Jan 5, 2020

Summary

Details and comments

Uh oh!

nonhermitian commented Jan 5, 2020

Uh oh!

sumitpuri commented Jan 5, 2020

Uh oh!

sumitpuri commented Jan 5, 2020

Uh oh!

kdk commented Jan 7, 2020

Uh oh!

kdk commented Jan 7, 2020

Uh oh!

sumitpuri commented Jan 7, 2020

Uh oh!

kdk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kdk commented Feb 3, 2020

Uh oh!

sumitpuri commented Feb 3, 2020

Uh oh!

kdk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sumitpuri commented Feb 3, 2020

Uh oh!

kdk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sumitpuri commented Feb 4, 2020

Uh oh!

kdk left a comment

Choose a reason for hiding this comment

Uh oh!

sumitpuri commented Feb 6, 2020

Uh oh!

kdk commented Feb 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kdk left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kdk commented Feb 6, 2020 •

edited

Loading