The parameter `idle_wires` default flipped to False in all circuit drawers #13865

1ucian0 · 2025-02-17T22:16:32Z

Summary

Closes #12361

Details and comments

As QPUs are getting bigger, also the circuits are growing in terms of qubits.

…drawers

qiskit-bot · 2025-02-17T22:16:37Z

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

@enavarro51
@Qiskit/terra-core

coveralls · 2025-02-18T01:51:14Z

Pull Request Test Coverage Report for Build 13696173867

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

7 of 8 (87.5%) changed or added relevant lines in 2 files are covered.
1892 unchanged lines in 80 files lost coverage.
Overall coverage increased (+1.3%) to 88.501%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
qiskit/visualization/circuit/circuit_visualization.py	4	5	80.0%

Files with Coverage Reduction	New Missed Lines	%
crates/circuit/src/operations.rs	1	90.37%
qiskit/circuit/_classical_resource_map.py	1	76.62%
qiskit/circuit/commutation_checker.py	1	94.12%
qiskit/circuit/controlflow/_builder_utils.py	1	96.97%
qiskit/circuit/parameter.py	1	96.72%
qiskit/compiler/transpiler.py	1	98.78%
qiskit/primitives/utils.py	1	92.86%
qiskit/result/distributions/quasi.py	1	95.92%
qiskit/synthesis/evolution/product_formula.py	1	89.8%
qiskit/transpiler/passes/layout/apply_layout.py	1	96.67%

Totals
Change from base Build 13635545005:	1.3%
Covered Lines:	71838
Relevant Lines:	81172

💛 - Coveralls

jakelishman

I was going to say that this is a better default, but then I thought: actually I use the drawers quite a lot for small-scale drawing, and I think suppressing idle wires there by default is quite possibly surprising behaviour.

I wonder if it's worth having idle_wires take a number to use as a cut-off size: if there are n or more idle wires (possibly only count qubit ones), hide them, and if there's fewer, show them? So idle_wires=0 is the same as the current idle_wires=False. We'd have to catch idle_wires=True and turn it into idle_wires=math.inf, potentially.

Alternatively, we ignore the int stuff, and add a third option to idle_wires: "layout". I think this might be the happiest middle-ground: if the circuit has been transpiled to a layout (so the left margin will indicate qubit mapping), then we set idle_wires=False, and if it hasn't, we set idle_wires=True. (Could also call the option "auto" or something.)

I'm not 100% convinced of that, I'm just slightly concerned about breaking usability of drawing small-scale circuits - I would think there's a pretty sizeable number of people who almost invariably draw those, and it'd be confusing if wires are sometimes hidden on them.

jakelishman · 2025-02-26T10:57:29Z

releasenotes/notes/closes_12361-d3ea2c442a4a74a7.yaml

+upgrade_visualization:
+  - |
+    The default for the parameter ``idle_wires`` changed to ``False`` in all the circuit drawers. If you still want to see wires without instructions, set ``idle_wires=True`` explicitly. 


It might help to either explain a bit more, or put in a couple of text-mode drawings just to illustrate the difference? I'm not sure users necessarily know what the option is.

good point. done in 4f83dc7

1ucian0 · 2025-03-03T18:00:18Z

test/visual/mpl/circuit/test_circuit_matplotlib_drawer.py

@@ -1117,7 +1117,9 @@ def test_idle_wires_barrier(self):
        circuit.barrier()

        fname = "idle_wires_barrier.png"
-        self.circuit_drawer(circuit, output="mpl", cregbundle=False, filename=fname)
+        self.circuit_drawer(
+            circuit, output="mpl", cregbundle=False, filename=fname, idle_wires=False


I accidentally found that a test with the description "Test that idle_wires False works with barrier" was not doing idle_wires=False

1ucian0 · 2025-03-03T18:00:30Z

test/visual/mpl/circuit/references/idle_wires_barrier.png

see https://github.com/Qiskit/qiskit/pull/13865/files#r1977946484

jakelishman

Thanks Luciano, this does feel like a good default now.

jakelishman · 2025-03-03T18:06:47Z

qiskit/visualization/circuit/_utils.py

 def _get_layered_instructions(
-    circuit, reverse_bits=False, justify=None, idle_wires=True, wire_order=None, wire_map=None
+    circuit, reverse_bits=False, justify=None, idle_wires="auto", wire_order=None, wire_map=None
 ):


Can we leave this as idle_wires: bool, and resolve the "auto" at the top level of the drawers?

jakelishman · 2025-03-03T18:07:56Z

qiskit/visualization/circuit/circuit_visualization.py

-    default_idle_wires = config.get("circuit_idle_wires", False)
+    default_idle_wires = config.get("circuit_idle_wires", "auto")


Can we now resolve "auto" into either True or False immediately after line 227, so the rest of the visualisers don't need to change?

jakelishman · 2025-03-03T18:08:34Z

qiskit/circuit/quantumcircuit.py

+            idle_wires: Include (or not) idle wires (wires with no circuit elements)
+                in output visualization. The string ``"auto"`` is also possible, in which
+                case idle wires are show except that the circuit has a layout attached.
+                Default is ``"auto"`` unless the
                user config file (usually ``~/.qiskit/settings.conf``) has an
-                alternative value set. For example, ``circuit_idle_wires = True``.
+                alternative value set. For example, ``circuit_idle_wires = False``.


Do we need to update the configuration-file logic to make it possible to specify "auto" in there too?

there's some bloch sphere plot failure which likely shouldn't be related to this, let's see if it persists

handle "auto" at the circuit_drawer level and subsequently use on booleans in internal logic

qiskit/visualization/circuit/circuit_visualization.py

Co-authored-by: Jake Lishman <jake@binhbar.com>

jakelishman

I tried this locally and it seems to do what I expect - thanks for the changes to the default, Luciano, and for getting it over the line, Julien.

The parameter idle_wires default flipped to False in all circuit …

79577b3

…drawers

1ucian0 requested review from nonhermitian and a team as code owners February 17, 2025 22:16

1ucian0 added 4 commits February 17, 2025 23:19

reno

bea2712

readjust tests

8d22dff

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

ac75150

test.python.visualization.test_circuit_text_drawer

768de18

1ucian0 added 3 commits February 19, 2025 19:39

adjust visual tests

4a4fc4f

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

2aad944

bug in the tests

9d44df3

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

1ucian0 added 4 commits February 25, 2025 00:22

Merge branch 'main' into fixes/12361/1

d1ee1b0

adjust test

7e01302

black

5a54cfc

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

951d3b3

jakelishman reviewed Feb 26, 2025

View reviewed changes

1ucian0 added 4 commits March 3, 2025 17:19

testing

04eb324

adjust tests

727b337

conflict

1cead5c

revert test changes

28d854b

1ucian0 commented Mar 3, 2025

View reviewed changes

jakelishman reviewed Mar 3, 2025

View reviewed changes

1ucian0 and others added 3 commits March 4, 2025 17:32

new reno

4f83dc7

fix layout-related plots

5237c08

there's some bloch sphere plot failure which likely shouldn't be related to this, let's see if it persists

top-level handling of "auto"

aa6e542

handle "auto" at the circuit_drawer level and subsequently use on booleans in internal logic

jakelishman reviewed Mar 6, 2025

View reviewed changes

qiskit/visualization/circuit/circuit_visualization.py Outdated Show resolved Hide resolved

jakelishman self-assigned this Mar 6, 2025

jakelishman assigned Cryoris and 1ucian0 Mar 6, 2025

Fix idle_wires None case

1c4f862

Co-authored-by: Jake Lishman <jake@binhbar.com>

jakelishman approved these changes Mar 6, 2025

View reviewed changes

jakelishman enabled auto-merge March 6, 2025 11:07

jakelishman added Changelog: New Feature Include in the "Added" section of the changelog Changelog: API Change Include in the "Changed" section of the changelog mod: visualization qiskit.visualization labels Mar 6, 2025

jakelishman added this pull request to the merge queue Mar 6, 2025

Merged via the queue into Qiskit:main with commit 2ec8f8f Mar 6, 2025
21 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The parameter `idle_wires` default flipped to False in all circuit drawers #13865

The parameter `idle_wires` default flipped to False in all circuit drawers #13865

1ucian0 commented Feb 17, 2025

qiskit-bot commented Feb 17, 2025

coveralls commented Feb 18, 2025 •

edited

Loading

jakelishman left a comment •

edited

Loading

jakelishman Feb 26, 2025

1ucian0 Mar 4, 2025

1ucian0 Mar 3, 2025

1ucian0 Mar 3, 2025

jakelishman left a comment

jakelishman Mar 3, 2025

jakelishman Mar 3, 2025

jakelishman Mar 3, 2025

jakelishman left a comment

		default_idle_wires = config.get("circuit_idle_wires", False)
		default_idle_wires = config.get("circuit_idle_wires", "auto")

The parameter idle_wires default flipped to False in all circuit drawers #13865

The parameter idle_wires default flipped to False in all circuit drawers #13865

Conversation

1ucian0 commented Feb 17, 2025

Summary

Details and comments

qiskit-bot commented Feb 17, 2025

coveralls commented Feb 18, 2025 • edited Loading

Pull Request Test Coverage Report for Build 13696173867

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

jakelishman left a comment • edited Loading

Choose a reason for hiding this comment

jakelishman Feb 26, 2025

Choose a reason for hiding this comment

1ucian0 Mar 4, 2025

Choose a reason for hiding this comment

1ucian0 Mar 3, 2025

Choose a reason for hiding this comment

1ucian0 Mar 3, 2025

Choose a reason for hiding this comment

jakelishman left a comment

Choose a reason for hiding this comment

jakelishman Mar 3, 2025

Choose a reason for hiding this comment

jakelishman Mar 3, 2025

Choose a reason for hiding this comment

jakelishman Mar 3, 2025

Choose a reason for hiding this comment

jakelishman left a comment

Choose a reason for hiding this comment

The parameter `idle_wires` default flipped to False in all circuit drawers #13865

The parameter `idle_wires` default flipped to False in all circuit drawers #13865

coveralls commented Feb 18, 2025 •

edited

Loading

jakelishman left a comment •

edited

Loading