Skip to content

Commit

Permalink
Removed all cross-references in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jaeunkim committed Aug 23, 2023
1 parent 5e23f55 commit acb5ee9
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions qiskit/transpiler/passes/calibration/rx_builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ class RXCalibrationBuilder(CalibrationBuilder):
.. note::
Requirement: NormalizeRXAngles pass (one of the optimization passes).
References:
References
* [1]: Gokhale et al. (2020), Optimized Quantum Compilation for
Near-Term Algorithms with OpenPulse. https://arxiv.org/abs/2004.11205
Near-Term Algorithms with OpenPulse. https://arxiv.org/abs/2004.11205
"""

def __init__(
Expand Down
4 changes: 2 additions & 2 deletions qiskit/transpiler/passes/optimization/normalize_rx_angle.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def __init__(self, target=None, resolution_in_radian=0):
"""NormalizeRXAngle initializer.
Args:
target (Target): The :class:`~.Target` representing the target backend.
target (Target): The Target of the backend to run the circuit on.
If the target contains SX and X calibrations, this pass will replace the
corresponding RX gates with SX and X gates.
resolution_in_radian (float): Resolution for RX rotation angle quantization.
Expand Down Expand Up @@ -78,7 +78,7 @@ def quantize_angles(self, qubit, original_angle):
return quantized_angle

def run(self, dag):
"""Run the NormalizeRXAngle pass on `dag`. This pass consists of three parts:
"""Run the NormalizeRXAngle pass on dag. This pass consists of three parts:
normalize_rx_angles(), convert_to_hardware_sx_x(), quantize_rx_angles().
Args:
Expand Down
8 changes: 4 additions & 4 deletions releasenotes/notes/single-pulse-rx-cal-347aadcee7bfe60b.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@ features:
(2020), arXiv:2004.11205.
To reduce the amount of RX calibration data that needs to be generated,
:class:`qiskit.transpiler.passes.optimization.normalize_rx_angle.NormalizeRXAngle`
qiskit.transpiler.passes.optimization.normalize_rx_angle.NormalizeRXAngle
performs three optimizations: wrapping RX gate rotation angles to [0, pi],
replacing RX(pi/2) and RX(pi) with SX and X gates, and quantizing the rotation angles.
This pass is required to be run before
:class:`qiskit.transpiler.passes.calibration.rx_builder.RXCalibrationBuilder`,
qiskit.transpiler.passes.calibration.rx_builder.RXCalibrationBuilder,
which generates RX calibrations on the fly.
The details of the transpiler passes are as follows:
:class:`qiskit.transpiler.passes.optimization.normalize_rx_angle.NormalizeRXAngle` wraps
qiskit.transpiler.passes.optimization.normalize_rx_angle.NormalizeRXAngle wraps
RX gate rotation angles to [0, pi] by replacing an RX gate with negative rotation angle, RX(-theta),
with a sequence: RZ(pi)-RX(theta)-RZ(-pi). Moreover, the pass replaces RX(pi/2) with SX gate,
and RX(pi) with X gate. This will enable us to exploit the more accurate, hardware-calibrated
pulses. Lastly, the pass quantizes the rotation angles using a user-provided resolution.
If the resolution is set to 0, this pass will not perform any quantization.
:class:`qiskit.transpiler.passes.calibration.rx_builder.RXCalibrationBuilder`
qiskit.transpiler.passes.calibration.rx_builder.RXCalibrationBuilder
generates RX calibrations on the fly. The pulse calibrations are bootstrapped from
the SX gate calibration in the target.
The amplitude is linearly scaled to achieve the desired arbitrary rotation angle.
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ ddt>=1.2.0,!=1.4.0,!=1.4.3
# components of Terra use some of its optional dependencies in order to document
# themselves. These are the requirements that are _only_ required for the docs
# build, and are not used by Terra itself.
Sphinx>=6.0
Sphinx>=6.0,<7.2
qiskit-sphinx-theme~=1.14.0
sphinx-design>=0.2.0
nbsphinx~=0.9.2
Expand Down

0 comments on commit acb5ee9

Please sign in to comment.