Skip to content

Commit

Permalink
Fix bad Sphinx API doc Provider naming (#1360) (#1362)
Browse files Browse the repository at this point in the history
This resulted in the imports being called `qiskit_ibm_provider` rather than `qiskit_ibm_runtime`.

Co-authored-by: Frank Harkins <frankharkins@users.noreply.github.com>
  • Loading branch information
Eric-Arellano and frankharkins committed Jan 31, 2024
1 parent 9997652 commit d829566
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion qiskit_ibm_runtime/transpiler/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

"""
====================================================================
IBM Backend Transpiler Tools (:mod:`qiskit_ibm_provider.transpiler`)
IBM Backend Transpiler Tools (:mod:`qiskit_ibm_runtime.transpiler`)
====================================================================
A collection of transpiler tools for working with IBM Quantum's
Expand Down
4 changes: 2 additions & 2 deletions qiskit_ibm_runtime/transpiler/passes/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@

"""
================================================================
Transpiler Passes (:mod:`qiskit_ibm_provider.transpiler.passes`)
Transpiler Passes (:mod:`qiskit_ibm_runtime.transpiler.passes`)
================================================================
.. currentmodule:: qiskit_ibm_provider.transpiler.passes
.. currentmodule:: qiskit_ibm_runtime.transpiler.passes
A collection of transpiler passes for IBM backends.
Expand Down
4 changes: 2 additions & 2 deletions qiskit_ibm_runtime/transpiler/passes/basis/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@

"""
==========================================================
Basis (:mod:`qiskit_ibm_provider.transpiler.passes.basis`)
Basis (:mod:`qiskit_ibm_runtime.transpiler.passes.basis`)
==========================================================
.. currentmodule:: qiskit_ibm_provider.transpiler.passes.basis
.. currentmodule:: qiskit_ibm_runtime.transpiler.passes.basis
Passes to layout circuits to IBM backend's instruction sets.
"""
Expand Down
38 changes: 19 additions & 19 deletions qiskit_ibm_runtime/transpiler/passes/scheduling/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@

"""
====================================================================
Scheduling (:mod:`qiskit_ibm_provider.transpiler.passes.scheduling`)
Scheduling (:mod:`qiskit_ibm_runtime.transpiler.passes.scheduling`)
====================================================================
.. currentmodule:: qiskit_ibm_provider.transpiler.passes.scheduling
.. currentmodule:: qiskit_ibm_runtime.transpiler.passes.scheduling
A collection of scheduling passes for working with IBM Quantum's next-generation
backends that support advanced "dynamic circuit" capabilities. Ie.,
Expand Down Expand Up @@ -80,7 +80,7 @@
# Transpile.
scheduled_teleport = pm.run(teleport)
scheduled_teleport.draw(output="mpl")
scheduled_teleport.draw(output="mpl", style="iqp")
Instead of padding with delays we may also insert a dynamical decoupling sequence
Expand All @@ -105,7 +105,7 @@
dd_teleport = pm.run(teleport)
dd_teleport.draw(output="mpl")
dd_teleport.draw(output="mpl", style="iqp")
When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the
transformations in a single transpilation. This has been done above by extending Qiskit's preset
Expand All @@ -123,7 +123,7 @@
qc_c_if = QuantumCircuit(1, 1)
qc_c_if.x(0).c_if(0, 1)
qc_c_if.draw(output="mpl")
qc_c_if.draw(output="mpl", style="iqp")
The :class:`.IBMBackend` configures a translation plugin
:class:`.IBMTranslationPlugin` to automatically
Expand All @@ -146,7 +146,7 @@
)
qc_if_dd = pm.run(qc_c_if, backend)
qc_if_dd.draw(output="mpl")
qc_if_dd.draw(output="mpl", style="iqp")
If you are not using the transpiler plugin stages to
Expand All @@ -168,7 +168,7 @@
)
qc_if_dd = pm.run(qc_c_if)
qc_if_dd.draw(output="mpl")
qc_if_dd.draw(output="mpl", style="iqp")
Exploiting IBM backend's local parallel "fast-path"
Expand All @@ -194,7 +194,7 @@
with qc.if_test((1, 1)):
qc.x(1)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
The circuit below will not use the fast-path as the conditional gate is
Expand All @@ -207,7 +207,7 @@
with qc.if_test((0, 1)):
qc.x(1)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
Similarly, the circuit below contains gates on multiple qubits
and will not be performed using the fast-path.
Expand All @@ -220,7 +220,7 @@
qc.x(0)
qc.x(1)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
A fast-path block may contain multiple gates as long as they are on the fast-path qubit.
If there are multiple fast-path blocks being performed in parallel each block will be
Expand All @@ -238,7 +238,7 @@
with qc.if_test((1, 1)):
qc.delay(1600, 1)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
This behavior is also applied to the else condition of a fast-path eligible branch.
Expand All @@ -253,7 +253,7 @@
with else_:
qc.delay(1600, 0)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
If a single measurement result is used with several conditional blocks, if there is a fast-path
Expand All @@ -272,7 +272,7 @@
# Does not use fast-path
qc.x(1)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
If you wish to prevent the usage of the fast-path you may insert a barrier between the measurement and
the conditional branch.
Expand All @@ -286,7 +286,7 @@
with qc.if_test((0, 1)):
qc.x(0)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
Conditional measurements are not eligible for the fast-path.
Expand All @@ -298,7 +298,7 @@
# Does not use the fast-path
qc.measure(0, 1)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
Similarly nested control-flow is not eligible.
Expand All @@ -312,7 +312,7 @@
with qc.if_test((0, 1)):
qc.x(0)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
The scheduler is aware of the fast-path behavior and will not insert delays on idle qubits
Expand Down Expand Up @@ -345,11 +345,11 @@
qc.delay(1000, 0)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
qc_dd = pm.run(qc)
qc_dd.draw(output="mpl")
qc_dd.draw(output="mpl", style="iqp")
.. note::
If there are qubits that are *not* involved in a fast-path decision it is not
Expand All @@ -374,7 +374,7 @@
# since the condition is compile time evaluated.
qc.x(2)
qc.draw(output="mpl")
qc.draw(output="mpl", style="iqp")
Scheduling & Dynamical Decoupling
Expand Down

0 comments on commit d829566

Please sign in to comment.