Update the circuit library docs #13520

Cryoris · 2024-12-03T10:19:40Z

e.g. why we use different gate types and what's the advantages

Summary

With #13046 the designated workflow with the circuit library changed. This PR adds a section to the docs explaining this new structure. While not fully done, I'm already opening this draft PR for people to have a look at the text.

Details and comments

This includes some other minor changes:

add a TOC for the different sections
consistently sort the standard gates (before this was partially sorted, partially chaotic)
move the documentation of get_standard_gate_name_mapping under Standard gates
always mention the circuit functions and gates before the old circuits

To do

Add some more examples to the sections
Move the template circuits to a separate page
Can we find a better name/structure for "particular quantum circuits"?

e.g. why we use different gate types and what's the advantages

coveralls · 2024-12-03T10:45:48Z

Pull Request Test Coverage Report for Build 14103023447

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
574 unchanged lines in 11 files lost coverage.
Overall coverage decreased (-0.003%) to 88.073%

Files with Coverage Reduction	New Missed Lines	%
crates/accelerate/src/unitary_synthesis.rs	1	94.79%
qiskit/circuit/library/standard_gates/r.py	1	97.56%
crates/accelerate/src/basis/basis_translator/mod.rs	2	88.97%
qiskit/synthesis/multi_controlled/mcx_synthesis.py	4	98.53%
qiskit/circuit/library/standard_gates/x.py	5	98.33%
qiskit/transpiler/preset_passmanagers/generate_preset_pass_manager.py	6	95.8%
crates/qasm2/src/lex.rs	9	91.23%
crates/qasm2/src/parse.rs	12	97.15%
qiskit/transpiler/target.py	16	94.22%
crates/accelerate/src/target_transpiler/mod.rs	64	82.03%

Totals
Change from base Build 14034596400:	-0.003%
Covered Lines:	72745
Relevant Lines:	82596

💛 - Coveralls

ShellyGarion · 2025-01-29T08:48:04Z

Currently all the standard gates are ordered alphabetically. Does it make sense to order them according to the number of qubits (0,1,2,3,many) and then maybe according to the number of parameters (0,1,2,3)?

ShellyGarion · 2025-02-10T09:35:18Z

copy here a comment about organizing the oracles (grover, phase, bitflip) in their own section:

#13769 (comment)

mtreinish · 2025-03-05T14:43:21Z

Since this is just documentation it can merge after 2.0.0rc1 is tagged before the final release. I've pre-emptively tagged it as stable backport potential because we'll need to backport it to stable/2.0 once that's created when we tag 2.0.0rc1.

ShellyGarion

It's a great start! need to rebase with main branch. I also have some comments.

qiskit/circuit/library/__init__.py

qiskit-bot · 2025-03-24T15:54:26Z

One or more of the following people are relevant to this code:

@Cryoris
@Qiskit/terra-core
@ajavadia

ShellyGarion

Nicely written! I only have a few comments.

qiskit/circuit/library/__init__.py

ElePT · 2025-03-26T09:46:45Z

qiskit/circuit/library/__init__.py

+Elements in the circuit library are provided as :class:`.QuantumCircuit`\ s or
+:class:`~.circuit.Instruction`\ s, allowing them to be easily investigated or plugged into other
+circuits. This enables fast prototyping and circuit design circuit at higher levels of abstraction.


Suggested change

Elements in the circuit library are provided as :class:`.QuantumCircuit`\ s or

:class:`~.circuit.Instruction`\ s, allowing them to be easily investigated or plugged into other

circuits. This enables fast prototyping and circuit design circuit at higher levels of abstraction.

The components in the circuit library are either :class:`.QuantumCircuit`\ s or

:class:`~.circuit.Instruction`\ s, allowing them to be easily manipulated and plugged into other

circuits. This enables fast prototyping and circuit design at higher levels of abstraction.

qiskit/circuit/library/__init__.py

Thank you Elena! Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

ElePT

LGTM too. Just to be sure, did you also want to address the missing TO-DOs? (this can anyways be done in a follow-up)

Cryoris · 2025-03-28T06:46:29Z

Todo's are for a follow up, thanks! 🙂

* Explain circlib design e.g. why we use different gate types and what's the advantages * separate old circuits and new gates * alt text & broken links * Apply suggestions from code review Thank you Elena! Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> * more review comments --------- Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> (cherry picked from commit 4675335)

* Explain circlib design e.g. why we use different gate types and what's the advantages * separate old circuits and new gates * alt text & broken links * Apply suggestions from code review Thank you Elena! Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> * more review comments --------- Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> (cherry picked from commit 4675335) Co-authored-by: Julien Gacon <jules.gacon@googlemail.com>

Cryoris added 3 commits December 3, 2024 10:41

Explain circlib design

f51ee46

e.g. why we use different gate types and what's the advantages

separate old circuits and new gates

8d67df1

Merge branch 'main' into clib-docs

f4a4429

Cryoris added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels Dec 3, 2024

Cryoris added this to the 2.0.0 milestone Dec 3, 2024

1ucian0 assigned Cryoris Feb 6, 2025

ShellyGarion mentioned this pull request Feb 9, 2025

Remove dependance of BooleanExpression on tweedledum #13769

Merged

ShellyGarion self-assigned this Feb 10, 2025

ShellyGarion mentioned this pull request Feb 12, 2025

Single-register arithmetic gates #13371

Merged

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

mtreinish added the on hold Can not fix yet label Mar 5, 2025

ShellyGarion reviewed Mar 13, 2025

View reviewed changes

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

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

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

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

Merge branch 'main' into clib-docs

e128c21

Cryoris marked this pull request as ready for review March 24, 2025 15:54

Cryoris requested a review from a team as a code owner March 24, 2025 15:54

Merge branch 'main' into clib-docs

267f6db

Cryoris removed the on hold Can not fix yet label Mar 24, 2025

alt text & broken links

345880e

ShellyGarion reviewed Mar 25, 2025

View reviewed changes

ElePT reviewed Mar 26, 2025

View reviewed changes

Cryoris and others added 2 commits March 27, 2025 09:58

Apply suggestions from code review

6dd1b5b

Thank you Elena! Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

more review comments

9c3f793

ShellyGarion self-requested a review March 27, 2025 10:40

ShellyGarion approved these changes Mar 27, 2025

View reviewed changes

ElePT approved these changes Mar 27, 2025

View reviewed changes

Cryoris added this pull request to the merge queue Mar 28, 2025

Merged via the queue into Qiskit:main with commit 4675335 Mar 28, 2025
20 checks passed

mergify bot mentioned this pull request Mar 28, 2025

Update the circuit library docs (backport #13520) #14117

Merged

3 tasks

Update the circuit library docs #13520

Update the circuit library docs #13520

Uh oh!

Conversation

Cryoris commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details and comments

To do

Uh oh!

coveralls commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 14103023447

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

ShellyGarion commented Jan 29, 2025

Uh oh!

ShellyGarion commented Feb 10, 2025

Uh oh!

mtreinish commented Mar 5, 2025

Uh oh!

ShellyGarion left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qiskit-bot commented Mar 24, 2025

Uh oh!

ShellyGarion 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!

ElePT Mar 26, 2025

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!

ElePT left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Cryoris commented Mar 28, 2025

Uh oh!

Uh oh!

Uh oh!

Cryoris commented Dec 3, 2024 •

edited

Loading

coveralls commented Dec 3, 2024 •

edited

Loading

ElePT left a comment •

edited

Loading