Add some explanation and example to circuit library documentation #7354

1ucian0 · 2021-12-06T12:29:02Z

Summary

In Qiskit/qiskit.org#2009 there is a redesign of the qiskit.org main page where one of aspect to highlight from Qiskit is the Circuit Library:

The Learn more -> link in the Circuit Library box will point to https://qiskit.org/documentation/apidoc/circuit_library.html However, this page is a bit rough for the newcomer. This PR is an attempt to create a slightly more welcomed place, with a short explanation on what's the library and how to use it.

Comments on how to do that are very much welcomed.

Details and comments

In addition to add a paragraph (mostly copied from https://qiskit.org/overview#circuits) and an example, I also included:

added a section called Standard Instructions

…brary_docs

coveralls · 2021-12-09T13:22:58Z

Pull Request Test Coverage Report for Build 2190126833

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 83.97%

Totals
Change from base Build 2187018298:	0.0%
Covered Lines:	54241
Relevant Lines:	64596

💛 - Coveralls

…brary_docs

…it#5142?)

…brary_docs

jakelishman

I haven't actually built the documentation myself to check, but it would be good to do that and to ensure that all the inserted cross-references actually do link to the expected places.

qiskit/circuit/library/__init__.py

qiskit/circuit/library/standard_gates/__init__.py

qiskit/circuit/library/__init__.py

Co-authored-by: Jake Lishman <[email protected]>

Co-authored-by: Julien Gacon <[email protected]>

qiskit/circuit/library/__init__.py

Co-authored-by: Julien Gacon <[email protected]>

jakelishman · 2022-04-18T20:37:33Z

I pushed a change to fix the docs build here. I had to remove the documenting of qiskit.extensions.Initialize from qiskit.circuit.library because it's not importable from that location, so the docs would be misleading if we could do that but also autosummary won't find it since it starts with qiskit for some reason I'm not 100% sure.

qiskit/circuit/library/__init__.py

) * Add some explanation and example to circuit library * remove BooleanExpression * missing gates * standard and directives * title mod * generalized gates * boolean logic circuits * Basis Change Circuits and Arithmetic Circuits * section Amplitude Functions is duplicated. (maybe a bad merge in #5142?) * N-local and feature map * dup entry * Template circuits * ups * line too long * address #7354 (comment) * addressing #7354 (comment) * addressing #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * import to address #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * addressing #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Apply suggestions from code review Co-authored-by: Matthew Treinish <[email protected]> * directives * pretty colors * undo changes in standard_gates/__init__.py * operations * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Julien Gacon <[email protected]> * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * example * Update qiskit/circuit/library/__init__.py Co-authored-by: Julien Gacon <[email protected]> * Fix Sphinx errors * Fix duplicate definitions and indentation * Fix typo Co-authored-by: Jake Lishman <[email protected]> Co-authored-by: Matthew Treinish <[email protected]> Co-authored-by: Julien Gacon <[email protected]> Co-authored-by: Jake Lishman <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit aee0dc4)

) (#7955) * Add some explanation and example to circuit library * remove BooleanExpression * missing gates * standard and directives * title mod * generalized gates * boolean logic circuits * Basis Change Circuits and Arithmetic Circuits * section Amplitude Functions is duplicated. (maybe a bad merge in #5142?) * N-local and feature map * dup entry * Template circuits * ups * line too long * address #7354 (comment) * addressing #7354 (comment) * addressing #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * import to address #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Jake Lishman <[email protected]> * addressing #7354 (comment) * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Apply suggestions from code review Co-authored-by: Matthew Treinish <[email protected]> * directives * pretty colors * undo changes in standard_gates/__init__.py * operations * Update qiskit/circuit/library/__init__.py Co-authored-by: Matthew Treinish <[email protected]> * Update qiskit/circuit/library/__init__.py Co-authored-by: Julien Gacon <[email protected]> * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * Apply suggestions from code review Co-authored-by: Julien Gacon <[email protected]> * example * Update qiskit/circuit/library/__init__.py Co-authored-by: Julien Gacon <[email protected]> * Fix Sphinx errors * Fix duplicate definitions and indentation * Fix typo Co-authored-by: Jake Lishman <[email protected]> Co-authored-by: Matthew Treinish <[email protected]> Co-authored-by: Julien Gacon <[email protected]> Co-authored-by: Jake Lishman <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit aee0dc4) Co-authored-by: Luciano Bello <[email protected]>

Add some explanation and example to circuit library

6cba20b

1ucian0 added the documentation Something is not clear or an error documentation label Dec 6, 2021

1ucian0 changed the title ~~Add some explanation and example to circuit library~~ Add some explanation and example to circuit library documentation Dec 6, 2021

1ucian0 added 2 commits December 9, 2021 13:34

Merge branch 'main' of github.com:Qiskit/qiskit-terra into circuit_li…

b26898f

…brary_docs

remove BooleanExpression

da4d506

1ucian0 added 14 commits December 9, 2021 16:25

missing gates

4c54f09

merge

ae35544

standard and directives

46784f7

Merge branch 'main' of github.com:Qiskit/qiskit-terra into circuit_li…

22954b9

…brary_docs

title mod

dd2afad

generalized gates

db327e3

boolean logic circuits

a8e448e

Merge branch 'main' of github.com:Qiskit/qiskit-terra into circuit_li…

23963c9

…brary_docs

Basis Change Circuits and Arithmetic Circuits

6b27c98

section Amplitude Functions is duplicated. (maybe a bad merge in Qisk…

7766026

…it#5142?)

N-local and feature map

1a77edc

dup entry

846b3fc

Template circuits

c18e46d

Merge branch 'main' of github.com:Qiskit/qiskit-terra into circuit_li…

aba5c45

…brary_docs

1ucian0 marked this pull request as ready for review January 24, 2022 15:00

1ucian0 requested a review from a team as a code owner January 24, 2022 15:00

ups

5346bf4

jakelishman reviewed Jan 25, 2022

View reviewed changes

1ucian0 and others added 6 commits January 27, 2022 11:21

line too long

54e1b8a

conflict solving

2411cf9

address Qiskit#7354 (comment)

6c8ee83

addressing Qiskit#7354 (comment)

69ca4e9

addressing Qiskit#7354 (comment)

c45d0a3

Update qiskit/circuit/library/__init__.py

45b2bb1

Co-authored-by: Jake Lishman <[email protected]>

mtreinish added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Mar 31, 2022

mtreinish removed this from the 0.20 milestone Mar 31, 2022

1ucian0 and others added 4 commits March 31, 2022 18:28

Update qiskit/circuit/library/__init__.py

22b2fb6

Co-authored-by: Julien Gacon <[email protected]>

Apply suggestions from code review

f54d3be

Co-authored-by: Julien Gacon <[email protected]>

Apply suggestions from code review

704f6a7

Co-authored-by: Julien Gacon <[email protected]>

example

6e95c77

jakelishman added this to the 0.20.1 milestone Mar 31, 2022

Cryoris reviewed Apr 1, 2022

View reviewed changes

qiskit/circuit/library/__init__.py Outdated Show resolved Hide resolved

mtreinish and others added 2 commits April 11, 2022 16:24

Update qiskit/circuit/library/__init__.py

b19a524

Co-authored-by: Julien Gacon <[email protected]>

Merge branch 'main' into circuit_library_docs

1444edf

mtreinish removed this from the 0.20.1 milestone Apr 18, 2022

jakelishman added 2 commits April 18, 2022 15:59

Merge remote-tracking branch 'ibm/main' into circuit_library_docs

2ebc78d

Fix Sphinx errors

7fe2b17

jakelishman added 2 commits April 18, 2022 17:02

Fix duplicate definitions and indentation

0e18d5a

Merge remote-tracking branch 'ibm/main' into circuit_library_docs

024f810

1ucian0 requested a review from mtreinish April 19, 2022 11:03

1ucian0 added this to the 0.20.1 milestone Apr 19, 2022

mtreinish previously approved these changes Apr 19, 2022

View reviewed changes

qiskit/circuit/library/__init__.py Outdated Show resolved Hide resolved

mtreinish dismissed their stale review via 6d468e8 April 19, 2022 13:15

Fix typo

6d468e8

mtreinish added the automerge label Apr 19, 2022

mtreinish approved these changes Apr 19, 2022

View reviewed changes

Merge branch 'main' into circuit_library_docs

9ec4f03

mergify bot merged commit aee0dc4 into Qiskit:main Apr 19, 2022

mergify bot mentioned this pull request Apr 19, 2022

Add some explanation and example to circuit library documentation (backport #7354) #7955

Merged

1ucian0 mentioned this pull request Jun 21, 2023

Tutorial moving status Qiskit/qiskit-tutorials#1473

Closed

26 tasks

Eric-Arellano mentioned this pull request Aug 21, 2023

Tutorial improvement & deduplication ideas Qiskit/documentation#874

Closed

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add some explanation and example to circuit library documentation #7354

Add some explanation and example to circuit library documentation #7354

1ucian0 commented Dec 6, 2021 •

edited

Loading

coveralls commented Dec 9, 2021 •

edited

Loading

jakelishman left a comment

jakelishman commented Apr 18, 2022

Add some explanation and example to circuit library documentation #7354

Add some explanation and example to circuit library documentation #7354

Conversation

1ucian0 commented Dec 6, 2021 • edited Loading

Summary

Details and comments

coveralls commented Dec 9, 2021 • edited Loading

Pull Request Test Coverage Report for Build 2190126833

💛 - Coveralls

jakelishman left a comment

Choose a reason for hiding this comment

jakelishman commented Apr 18, 2022

1ucian0 commented Dec 6, 2021 •

edited

Loading

coveralls commented Dec 9, 2021 •

edited

Loading