Move PendingDeprecations to Deprecations in the circuit library #13604

1ucian0 · 2024-12-24T16:12:30Z

Summary

The circuit library modernization from #13046 introduced some pending deprecations that this PR is moving to deprecations.

~~reno is still missing.~~

Cryoris · 2025-02-07T15:24:05Z

We could just have a single reno for the deprecation of BlueprintCircuit and mention the deprecation of all subclasses therein. That would be a bit cleaner for the users than having multiple 🙂

Cryoris

Thanks for taking care of this, this LGTM but it seems to only miss the catches in the tests 🙂

…3241/1

1ucian0 · 2025-02-20T14:22:09Z

Most of the problems are coming from an internal call to a deprecated method:

qiskit/circuit/library/standard_gates/x.py", line 1148, in __init__
    num_ancilla_qubits = self.__class__.get_num_ancilla_qubits(num_ctrl_qubits)
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

There is also some issues with BlueprintCircuit subclasses. From @Cryoris :

There's currently 5 subclasses:
QFT and NLocal are already deprecated
all others should be taken care of by #13371

Still working on the rest.

…lledGate

…chain_dirty_ancilla_action_only

…3241/1

qiskit-bot · 2025-03-04T16:40:13Z

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

@Cryoris
@Qiskit/terra-core
@ajavadia
@levbishop
@mtreinish
@nkanazawa1989
@t-imamichi

coveralls · 2025-03-04T16:46:40Z

Pull Request Test Coverage Report for Build 13919787623

Details

99 of 111 (89.19%) changed or added relevant lines in 11 files are covered.
18 unchanged lines in 4 files lost coverage.
Overall coverage decreased (-0.01%) to 88.073%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
qiskit/circuit/quantumcircuit.py	36	41	87.8%
qiskit/circuit/library/standard_gates/x.py	28	35	80.0%

Files with Coverage Reduction	New Missed Lines	%
crates/accelerate/src/unitary_synthesis.rs	1	94.69%
qiskit/circuit/quantumcircuit.py	1	93.78%
crates/qasm2/src/lex.rs	4	92.48%
crates/qasm2/src/parse.rs	12	97.15%

Totals
Change from base Build 13905217637:	-0.01%
Covered Lines:	72650
Relevant Lines:	82488

💛 - Coveralls

alexanderivrii

Thanks for the massive effort. I am definitely looking forward to not see BlueprintCircuit and MCXGrayCode in Qiskit 3.0. I have left some questions and comments in-place.

alexanderivrii · 2025-03-18T12:42:58Z

qiskit/circuit/library/arithmetic/weighted_adder.py

+
+                        with warnings.catch_warnings(action="ignore", category=DeprecationWarning):
+                            circuit.mcx(
+                                [q_state, qr_sum[j], qr_carry[j - 1]],
+                                qr_carry[j],
+                                qr_control,
+                                mode="v-chain",
+                            )
+


Do I understand correctly that we need catch_warnings here because we are deprecating the argument mode in QuantumCircuit.mcx(...)? On the other hand, do we really need this -- as the whole class WeightedAdder is being deprecated? Note that these are only questions, I am not asking for any actual changes.

alexanderivrii · 2025-03-18T12:49:20Z

qiskit/circuit/library/arithmetic/weighted_adder.py

+        with warnings.catch_warnings(action="ignore", category=DeprecationWarning):
+            self.append(circuit.to_gate(), self.qubits)


Why do we need to catch_warnings here?

alexanderivrii · 2025-03-18T12:57:04Z

qiskit/circuit/library/basis_change/qft.py

+        since="1.4",
        additional_msg=(
            "Use qiskit.circuit.library.QFTGate or qiskit.synthesis.qft.synth_qft_full instead, "
            "for access to all previous arguments.",
        ),
-        pending=True,
    )
    def __init__(


Do I understand correctly that technically we do not need this deprecation message -- as we are deprecating the base BlueprintCircuit class?

alexanderivrii · 2025-03-18T12:59:47Z

qiskit/circuit/library/arithmetic/adders/adder.py

-        since="1.3",
+        since="1.4",
        additional_msg=(
            "Use the adder gates provided in qiskit.circuit.library.arithmetic instead. "
            "The gate type depends on the adder kind: fixed, half, full are represented by "
            "ModularAdderGate, HalfAdderGate, FullAdderGate, respectively. For different adder "
            "implementations, see https://docs.quantum.ibm.com/api/qiskit/synthesis.",
        ),
-        pending=True,


Some other similar deprecation messages include the argument

removal_timeline="in Qiskit 3.0",

Would it be more consistent to add a similar argument here and other similar messages?

alexanderivrii · 2025-03-18T13:09:35Z

qiskit/circuit/library/boolean_logic/quantum_or.py

-            num_variable_qubits: The qubits of which the AND is computed. The result will be written
+            num_variable_qubits: The qubits of which the OR is computed. The result will be written


nice catch (better late than never) 😄

alexanderivrii · 2025-03-18T14:39:51Z

qiskit/circuit/quantumcircuit.py

+            else:
+                self.compose(synth_mcx_n_clean_m15(len(control_qubits)), inplace=True)


same concern about correctness here

alexanderivrii · 2025-03-18T14:41:28Z

qiskit/circuit/quantumcircuit.py

+    @deprecate_arg(
+        name="mode",
+        since="2.0",
+        additional_msg=(
+            "Instead, add a generic MCXGate to the circuit and specify the synthesis method "
+            "via the ``hls_config`` in the transpilation. Alternatively, specific decompositions "
+            "are available at https://qisk.it/mcx."
+        ),
+    )


Shouldn't we also deprecate the argument ancilla_qubits?

alexanderivrii · 2025-03-18T14:44:31Z

releasenotes/notes/deprecate-library-circuits-4f8b234500f90d50.yaml

+      * :class:`.QuantumVolume` ``-->`` :func:`.quantum_volume`
+      * :class:`.EvolvedOperatorAnsatz` ``-->`` :func:`.evolved_operator_ansatz`


Should we also mention the deprecation of MCX variants in the release notes, as well as arguments to QuantumCircuit.mcx(...)?

alexanderivrii · 2025-03-18T15:01:22Z

test/python/circuit/test_controlled_gate.py

-            MCXVChain(num_ctrl_qubits, True),
+        for synth_circuit in [
+            synth_mcx_n_dirty_i15(num_ctrl_qubits),
+            synth_mcx_n_clean_m15(num_ctrl_qubits),
+            synth_mcx_1_clean_b95(num_ctrl_qubits),
+            synth_mcx_gray_code(num_ctrl_qubits),
+            synth_mcx_noaux_v24(num_ctrl_qubits),


Do we need this test? Previously we checked that adding custom MCX variants worked correctly, but now we are checking correctness of synthesis methods, and this does not seem the right place to do that, do you agree?

alexanderivrii · 2025-03-18T15:07:01Z

test/python/circuit/test_controlled_gate.py

                    corrected = np.zeros(2 ** (num_ctrl_qubits + 1), dtype=complex)
                    for i, statevector_amplitude in enumerate(statevector):
-                        i = int(bin(i)[2:].zfill(circuit.num_qubits)[gate.num_ancilla_qubits :], 2)
+                        i = int(bin(i)[2:].zfill(circuit.num_qubits)[num_ancillas:], 2)
                        corrected[i] += statevector_amplitude
                    statevector = corrected
                np.testing.assert_array_almost_equal(statevector.real, reference)

    @data(5, 10, 15)
    def test_mcxvchain_dirty_ancilla_cx_count(self, num_ctrl_qubits):


More tests that can be removed (I think) especially given #13961. Or actually shouldn't we keep the original test with the MCXVChain gate, that was deprecated but not yet removed? (The same comment applies to other changes in this file).

1ucian0 mentioned this pull request Dec 25, 2024

Deprecate in 1.4 the pending deprecations from the 1.* cycle #13589

Closed

40 tasks

1ucian0 linked an issue Feb 4, 2025 that may be closed by this pull request

Deprecate in 1.4 the pending deprecations from the 1.* cycle #13589

Closed

40 tasks

Cryoris reviewed Feb 7, 2025

View reviewed changes

a76ebc7

1ucian0 force-pushed the followup/13241/1 branch from 4eee40c to a76ebc7 Compare February 10, 2025 13:18

1ucian0 changed the base branch from stable/1.4 to main February 10, 2025 13:19

Cryoris and others added 18 commits February 10, 2025 17:43

blueprint deprecation + reno

5c1420b

Merge branch 'main' into followup/13241/1

6db06ef

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

4d30309

…3241/1

unittest test.python.transpiler.test_star_prerouting

8418359

test.python.transpiler.test_solovay_kitaev

a614735

test.python.transpiler.test_linear_functions_passes

fd394dd

unittest test.python.synthesis.test_qft_synthesis

b848848

test.python.synthesis.test_cz_synthesis

4257e03

test.python.transpiler.test_parameterizedgate_translator

c5e7000

test.python.quantum_info.operators.test_operator

3f1e59a

test.python.primitives.test_statevector_sampler

cfac75b

test.python.primitives.test_sampler

6a11a16

test.python.primitives.test_statevector_estimator

f2f65d4

test.python.primitives.test_estimator

9bdad15

test.python.primitives.test_backend_sampler_v2

e80b209

test.python.primitives.test_backend_sampler

d094e95

test.python.primitives.test_backend_estimator_v2

677a6db

test.python.primitives.test_backend_estimator

6267f71

1ucian0 linked an issue Feb 15, 2025 that may be closed by this pull request

Deprecate BlueprintCircuit in 2.0 #13760

Open

1ucian0 self-assigned this Feb 20, 2025

1ucian0 added this to the 2.0.0 milestone Feb 20, 2025

1ucian0 added the on hold Can not fix yet label Feb 20, 2025

1ucian0 added 5 commits February 26, 2025 16:59

capture the deprecations for internal usage

420c5e5

test.python.visualization.test_circuit_text_drawer.TestTextOpenContro…

294270e

…lledGate

test.python.circuit.library.test_boolean_logic

739ad10

test.python.transpiler.test_swap_strategy_router

6f4e855

test.python.transpiler.test_high_level_synthesis

2d35ac1

1ucian0 assigned Cryoris Feb 27, 2025

1ucian0 added 5 commits February 27, 2025 12:30

test.python.circuit.library.test_qft.TestQFT

dba0f10

test.python.circuit.test_controlled_gate.TestControlledGate

2d6f2be

test.python.circuit.test_controlled_gate.TestControlledGate.test_mcxv…

1a52567

…chain_dirty_ancilla_action_only

test.python.circuit.test_controlled_gate.TestControlledGate

a14b0c7

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

755ce47

…3241/1

1ucian0 mentioned this pull request Feb 28, 2025

Deprecate BlueprintCircuit in 2.0 #13760

Open

1ucian0 and others added 7 commits February 28, 2025 13:41

test.python.transpiler.test_high_level_synthesis

aa41bb8

test.python.qasm2.test_export

8a6d33e

EvolvedOperatorAnsatz

81800ae

fix tests in circuit library

9230db0

more controlled gate fixes

ad8f200

I can see light at the end of the tunnel

3540d3f

Merge branch 'main' into followup/13241/1

98223bd

1ucian0 marked this pull request as ready for review March 4, 2025 16:40

1ucian0 requested review from a team as code owners March 4, 2025 16:40

1ucian0 modified the milestones: 2.0.0, 2.1.0 Mar 4, 2025

1ucian0 mentioned this pull request Mar 4, 2025

Consider testing for PendingDeprecationWarnings Qiskit/documentation#2716

Open

Cryoris mentioned this pull request Mar 17, 2025

Add explicit tests for MCX synthesis algorithms #13961

Merged

Merge branch 'main' into followup/13241/1

6e504de

alexanderivrii reviewed Mar 18, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move PendingDeprecations to Deprecations in the circuit library #13604

Move PendingDeprecations to Deprecations in the circuit library #13604

1ucian0 commented Dec 24, 2024 •

edited

Loading

Cryoris commented Feb 7, 2025

Cryoris left a comment

1ucian0 commented Feb 20, 2025

qiskit-bot commented Mar 4, 2025

coveralls commented Mar 4, 2025 •

edited

Loading

alexanderivrii left a comment

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

alexanderivrii Mar 18, 2025

		with warnings.catch_warnings(action="ignore", category=DeprecationWarning):
		self.append(circuit.to_gate(), self.qubits)

		num_variable_qubits: The qubits of which the AND is computed. The result will be written
		num_variable_qubits: The qubits of which the OR is computed. The result will be written

		else:
		self.compose(synth_mcx_n_clean_m15(len(control_qubits)), inplace=True)

		* :class:`.QuantumVolume` ``-->`` :func:`.quantum_volume`
		* :class:`.EvolvedOperatorAnsatz` ``-->`` :func:`.evolved_operator_ansatz`

Move PendingDeprecations to Deprecations in the circuit library #13604

Are you sure you want to change the base?

Move PendingDeprecations to Deprecations in the circuit library #13604

Conversation

1ucian0 commented Dec 24, 2024 • edited Loading

Summary

Cryoris commented Feb 7, 2025

Cryoris left a comment

Choose a reason for hiding this comment

1ucian0 commented Feb 20, 2025

qiskit-bot commented Mar 4, 2025

coveralls commented Mar 4, 2025 • edited Loading

Pull Request Test Coverage Report for Build 13919787623

Details

💛 - Coveralls

alexanderivrii left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ucian0 commented Dec 24, 2024 •

edited

Loading

coveralls commented Mar 4, 2025 •

edited

Loading