From f11b1ea1a9dea0c1006ffae196d6631a3807258b Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu, 24 Oct 2024 10:53:01 -0400 Subject: [PATCH] Use absolute links in API docs (#27) (cherry picked from commit 676fb59797bbde09c9fc919658725c180acdc7b5) --- qiskit_addon_obp/backpropagation.py | 2 +- qiskit_addon_obp/utils/truncating.py | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/qiskit_addon_obp/backpropagation.py b/qiskit_addon_obp/backpropagation.py index 4ba6dab..2841aee 100644 --- a/qiskit_addon_obp/backpropagation.py +++ b/qiskit_addon_obp/backpropagation.py @@ -80,7 +80,7 @@ def backpropagate( tools provided in :external:mod:`qiskit_addon_utils.slicing` to slice a single :external:class:`~qiskit.circuit.QuantumCircuit`. truncation_error_budget: The error budget used for truncating Pauli terms. Refer to the - `how-to guide <../how_tos/truncate_operator_terms.html>`__ for a detailed discussion on + `how-to guide `__ for a detailed discussion on truncating terms from the output operator and bounding the incurred error. operator_budget: Constraints on how large the operator may grow during backpropagation. If ``None``, a default instance of :class:`~qiskit_addon_obp.utils.simplify.OperatorBudget` diff --git a/qiskit_addon_obp/utils/truncating.py b/qiskit_addon_obp/utils/truncating.py index 792380f..baf6d36 100644 --- a/qiskit_addon_obp/utils/truncating.py +++ b/qiskit_addon_obp/utils/truncating.py @@ -37,7 +37,7 @@ class TruncationErrorBudget: """A class for storing the constants that determine the truncation error budget. - Refer to the `how-to guide <../how_tos/truncate_operator_terms.html>`__ for a detailed discussion + Refer to the `how-to guide `__ for a detailed discussion on truncating operator terms during backpropagation and bounding the incurred error. """ @@ -55,7 +55,7 @@ class TruncationErrorBudget: """ Indicates which Lp-norm is used for calculating truncation errors. - Refer to the `how-to guide <../how_tos/bound_error_using_p_norm.html>`__ for a detailed + Refer to the `how-to guide `__ for a detailed conversation on bounding truncation error using higher Lp-norms. """ @@ -76,7 +76,7 @@ def setup_budget( This method makes the construction of a :class:`.TruncationErrorBudget` easier for an end-user. This error budget can be provided to the :meth:`~qiskit_addon_obp.backpropagate` method to enable the truncation of low-weight Pauli terms. Refer to the `how-to guide - <../how_tos/truncate_operator_terms.html>`__ for a detailed discussion on truncating terms from + `__ for a detailed discussion on truncating terms from the output operator and bounding the incurred error. The construction logic is as follows: @@ -107,7 +107,7 @@ def setup_budget( num_slices: The number of slices over which to distribute the budget. See above for more details. p_norm: The Lp norm of the error. This affects the gradual distribution of ``max_error_total`` in the case of ``num_slices`` also being set (see above). Refer to the - `how-to guide <../how_tos/bound_error_using_p_norm.html>`__ for a detailed conversation + `how-to guide `__ for a detailed conversation on bounding truncation error using higher Lp-norms. Returns: