Skip to content

Commit 490fc27

Browse files
Cryorisjakelishman
andauthored
Add criteria for library circuits (#15533)
* Add criteria for library circuits * Reword "widely used" bit Co-authored-by: Jake Lishman <jake.lishman@ibm.com> --------- Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
1 parent 7170ebe commit 490fc27

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

qiskit/circuit/library/__init__.py

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,25 @@
1818
1919
.. currentmodule:: qiskit.circuit.library
2020
21-
The circuit library is a collection of valuable circuits and building blocks. We call these valuable
22-
for different reasons. For instance, they can be used as building blocks for algorithms, serve as
23-
benchmarks, or they are circuits conjectured to be difficult to simulate classically.
21+
The circuit library is a collection of quantum circuits that serve as algorithmic building blocks,
22+
benchmarking tools, and examples that are conjectured to be hard to simulate classically.
23+
The goal is to provide circuits that are well-defined, widely applicable, and easy to reuse across
24+
different workflows.
25+
26+
The criteria for a circuit in the library are:
27+
28+
Well-defined
29+
The circuit has a clear structure or a mathematical action, supported by a paper or
30+
reference.
31+
32+
Widely used and relevant
33+
The circuit is a canonical or best-known choice for a well-defined task, is a standard reference
34+
or common baseline, or is historically foundational to a substantial subfield of quantum
35+
computing.
36+
37+
Standalone
38+
The circuit is self-contained, meaning it can be generated efficiently without new
39+
external dependencies.
2440
2541
Elements in the circuit library are either :class:`.QuantumCircuit`\ s or
2642
:class:`~.circuit.Instruction`\ s, allowing them to be easily investigated or plugged into other
@@ -126,7 +142,6 @@
126142
ansatz = real_amplitudes(5, entanglement="pairwise")
127143
ansatz.draw("mpl")
128144
129-
130145
.. _standard-gates:
131146
132147
Standard gates

0 commit comments

Comments
 (0)