Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use absolute links in API docs (backport #27) #28

Merged
merged 1 commit into from
Oct 24, 2024
Merged

Use absolute links in API docs (backport #27) #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion qiskit_addon_obp/backpropagation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://qiskit.github.io/qiskit-addon-obp/how_tos/truncate_operator_terms.html>`__ 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`
Expand Down
8 changes: 4 additions & 4 deletions qiskit_addon_obp/utils/truncating.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://qiskit.github.io/qiskit-addon-obp/how_tos/truncate_operator_terms.html>`__ for a detailed discussion
on truncating operator terms during backpropagation and bounding the incurred error.
"""

Expand All @@ -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 <https://qiskit.github.io/qiskit-addon-obp/how_tos/bound_error_using_p_norm.html>`__ for a detailed
conversation on bounding truncation error using higher Lp-norms.
"""

Expand All @@ -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
<https://qiskit.github.io/qiskit-addon-obp/how_tos/truncate_operator_terms.html>`__ for a detailed discussion on truncating terms from
the output operator and bounding the incurred error.

The construction logic is as follows:
Expand Down Expand Up @@ -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 <https://qiskit.github.io/qiskit-addon-obp/how_tos/bound_error_using_p_norm.html>`__ for a detailed conversation
on bounding truncation error using higher Lp-norms.

Returns:
Expand Down