Add twirling stratgey options diagram (#2056)

* Add twirling stratgey options diagram * Update alt text * fix lint * Update qiskit_ibm_runtime/options/twirling_options.py Co-authored-by: Eric Arellano <[email protected]> * Update qiskit_ibm_runtime/options/twirling_options.py Co-authored-by: Rebecca Dimock <[email protected]> * Update qiskit_ibm_runtime/options/twirling_options.py Co-authored-by: Rebecca Dimock <[email protected]> --------- Co-authored-by: Eric Arellano <[email protected]> Co-authored-by: Rebecca Dimock <[email protected]> Co-authored-by: ptristan3 <[email protected]>
Qiskit · Dec 2, 2024 · ae49bde · ae49bde
1 parent a5c6ce6
commit ae49bde
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/source_images/twirling_strategy_options.png b/docs/source_images/twirling_strategy_options.png
diff --git a/qiskit_ibm_runtime/options/twirling_options.py b/qiskit_ibm_runtime/options/twirling_options.py
@@ -94,6 +94,13 @@ class TwirlingOptions:
         twirled layer.
 
       Default: "active-accum".
+
+    .. image:: /source_images/twirling_strategy_options.png
+      :alt: Image illustrating the differences among twirling strategies. If "active", only
+            instruction qubits in each layer will be twirled. If "active-circuit", 
+            all instruction qubits in the circuit will be twirled. If "active-accum", the union 
+            all instruction qubits in the circuit up to the current twirled layer will be twirled. 
+            Finally, if "all", all qubits in the input circuit will be twirled in each twirled layer.
     """
 
     _ge1 = make_constraint_validator("num_randomizations", "shots_per_randomization", ge=1)