Skip to content

Commit ae3ac82

Browse files
Update intersphinx links and others (backport #142) (#144)
Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
1 parent 07f14e3 commit ae3ac82

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# This code is part of a Qiskit project.
22
#
3-
# (C) Copyright IBM 2023.
3+
# (C) Copyright IBM 2023, 2024.
44
#
55
# This code is licensed under the Apache License, Version 2.0. You may
66
# obtain a copy of this license in the LICENSE.txt file in the root directory
@@ -120,7 +120,7 @@
120120
"python": ("https://docs.python.org/3", None),
121121
"numpy": ("https://numpy.org/doc/stable", None),
122122
"scipy": ("https://docs.scipy.org/doc/scipy", None),
123-
"qiskit": ("https://qiskit.org/documentation/", None),
123+
"qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None),
124124
}
125125

126126
# -- Options for HTML output -------------------------------------------------

docs/tutorials/01_algorithms_introduction.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"source": [
1616
"## How is the algorithm library structured?\n",
1717
"\n",
18-
"`qiskit_algorithms` provides a number of [algorithms](https://qiskit.org/ecosystem/algorithms/apidocs/algorithms.html) grouped by category, according to the task they can perform. For instance `Minimum Eigensolvers` to find the smallest eigen value of an operator, for example ground state energy of a chemistry Hamiltonian or a solution to an optimization problem when expressed as an Ising Hamiltonian. There are `Time Evolvers` for the time evolution of quantum systems and `Amplitude Estimators` for value estimation that can be used say in financial applications. The full set of categories can be seen in the documentation link above.\n",
18+
"`qiskit_algorithms` provides a number of [algorithms](https://qiskit-community.github.io/qiskit-algorithms/apidocs/algorithms.html) grouped by category, according to the task they can perform. For instance `Minimum Eigensolvers` to find the smallest eigen value of an operator, for example ground state energy of a chemistry Hamiltonian or a solution to an optimization problem when expressed as an Ising Hamiltonian. There are `Time Evolvers` for the time evolution of quantum systems and `Amplitude Estimators` for value estimation that can be used say in financial applications. The full set of categories can be seen in the documentation link above.\n",
1919
"\n",
2020
"Algorithms are configurable, and part of the configuration will often be in the form of smaller building blocks. For instance `VQE`, the Variational Quantum Eigensolver, it takes a trial wavefunction, in the form of a `QuantumCircuit` and a classical optimizer among other things.\n",
2121
"\n",
@@ -121,7 +121,7 @@
121121
"cell_type": "markdown",
122122
"metadata": {},
123123
"source": [
124-
"Now we can call the [compute_mininum_eigenvalue()](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.VQE.html#qiskit_algorithms.VQE.compute_minimum_eigenvalue) method. The latter is the interface of choice for the application modules, such as Nature and Optimization, in order that they can work interchangeably with any algorithm within the specific category."
124+
"Now we can call the [compute_mininum_eigenvalue()](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.VQE.html#qiskit_algorithms.VQE.compute_minimum_eigenvalue) method. The latter is the interface of choice for the application modules, such as Nature and Optimization, in order that they can work interchangeably with any algorithm within the specific category."
125125
]
126126
},
127127
{
@@ -337,4 +337,4 @@
337337
},
338338
"nbformat": 4,
339339
"nbformat_minor": 2
340-
}
340+
}

docs/tutorials/02_vqe_advanced_options.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# Advanced VQE Options\n",
88
"\n",
9-
"In the first algorithms tutorial, you learned how to set up a basic [VQE](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.VQE.html) algorithm. Now, you will see how to provide more advanced configuration parameters to explore the full range of the variational algorithms provided in this library: [VQE](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.VQE.html), [QAOA](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.QAOA.html) and [VQD](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.VQD.html) among others. In particular, this tutorial will cover how to set up a `callback` to monitor convergence and the use of custom `initial point`s and `gradient`s."
9+
"In the first algorithms tutorial, you learned how to set up a basic [VQE](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.VQE.html) algorithm. Now, you will see how to provide more advanced configuration parameters to explore the full range of the variational algorithms provided in this library: [VQE](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.VQE.html), [QAOA](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.QAOA.html) and [VQD](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.VQD.html) among others. In particular, this tutorial will cover how to set up a `callback` to monitor convergence and the use of custom `initial point`s and `gradient`s."
1010
]
1111
},
1212
{
@@ -33,7 +33,7 @@
3333
"cell_type": "markdown",
3434
"metadata": {},
3535
"source": [
36-
"First, you need a qubit operator for VQE. For this example, you can use the same operator as used in the algorithms introduction, which was originally computed by [Qiskit Nature](https://qiskit.org/ecosystem/nature/) for an H2 molecule."
36+
"First, you need a qubit operator for VQE. For this example, you can use the same operator as used in the algorithms introduction, which was originally computed by [Qiskit Nature](https://qiskit-community.github.io/qiskit-nature/) for an H2 molecule."
3737
]
3838
},
3939
{
@@ -177,7 +177,7 @@
177177
"cell_type": "markdown",
178178
"metadata": {},
179179
"source": [
180-
"Finally, since the above problem is still easily tractable classically, you can use [NumPyMinimumEigensolver](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.NumPyMinimumEigensolver.html) to compute a reference value for the solution."
180+
"Finally, since the above problem is still easily tractable classically, you can use [NumPyMinimumEigensolver](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.NumPyMinimumEigensolver.html) to compute a reference value for the solution."
181181
]
182182
},
183183
{
@@ -246,7 +246,7 @@
246246
"source": [
247247
"## Gradients\n",
248248
"\n",
249-
"In the variational algorithms, if the provided optimizer uses a gradient-based technique, the default gradient method will be finite differences. However, these classes include an option to pass custom gradients via the `gradient` parameter, which can be any of the provided methods within the [gradient](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.gradients.html) framework, which fully supports the use of primitives. This section shows how to use custom gradients in the VQE workflow.\n",
249+
"In the variational algorithms, if the provided optimizer uses a gradient-based technique, the default gradient method will be finite differences. However, these classes include an option to pass custom gradients via the `gradient` parameter, which can be any of the provided methods within the [gradient](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.gradients.html) framework, which fully supports the use of primitives. This section shows how to use custom gradients in the VQE workflow.\n",
250250
"\n",
251251
"The first step is to initialize both the corresponding primitive and primitive gradient:"
252252
]
@@ -267,7 +267,7 @@
267267
"cell_type": "markdown",
268268
"metadata": {},
269269
"source": [
270-
"Now, you can inspect an SLSQP run using the [FiniteDiffEstimatorGradient](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.gradients.FiniteDiffEstimatorGradient.html) from above:"
270+
"Now, you can inspect an SLSQP run using the [FiniteDiffEstimatorGradient](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.gradients.FiniteDiffEstimatorGradient.html) from above:"
271271
]
272272
},
273273
{
@@ -532,4 +532,4 @@
532532
},
533533
"nbformat": 4,
534534
"nbformat_minor": 2
535-
}
535+
}

docs/tutorials/04_vqd.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# Variational Quantum Deflation (VQD) Algorithm\n",
88
"\n",
9-
"This notebook demonstrates how to use our implementation of the [Variational Quantum Deflation (VQD)](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.VQD.html) algorithm for computing higher energy states of a Hamiltonian, as introduced in this [reference paper](https://arxiv.org/abs/1805.08138)."
9+
"This notebook demonstrates how to use our implementation of the [Variational Quantum Deflation (VQD)](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.VQD.html) algorithm for computing higher energy states of a Hamiltonian, as introduced in this [reference paper](https://arxiv.org/abs/1805.08138)."
1010
]
1111
},
1212
{
@@ -365,4 +365,4 @@
365365
},
366366
"nbformat": 4,
367367
"nbformat_minor": 4
368-
}
368+
}

docs/tutorials/05_qaoa.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# Quantum Approximate Optimization Algorithm\n",
88
"\n",
9-
"This notebook demonstrates the implementation of the Quantum Approximate Optimization Algorithm ([QAOA](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.QAOA.html)) for a graph partitioning problem (finding the maximum cut), and compares it to a solution using the brute-force approach."
9+
"This notebook demonstrates the implementation of the Quantum Approximate Optimization Algorithm ([QAOA](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.QAOA.html)) for a graph partitioning problem (finding the maximum cut), and compares it to a solution using the brute-force approach."
1010
]
1111
},
1212
{
@@ -389,4 +389,4 @@
389389
},
390390
"nbformat": 4,
391391
"nbformat_minor": 2
392-
}
392+
}

docs/tutorials/07_grover_examples.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# Grover's algorithm examples\n",
88
"\n",
9-
"This notebook has examples demonstrating how to use the Qiskit Algorithms [Grover](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.Grover.html) search algorithm, with different oracles."
9+
"This notebook has examples demonstrating how to use the Qiskit Algorithms [Grover](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.Grover.html) search algorithm, with different oracles."
1010
]
1111
},
1212
{
@@ -269,4 +269,4 @@
269269
},
270270
"nbformat": 4,
271271
"nbformat_minor": 2
272-
}
272+
}

docs/tutorials/10_pvqd.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"\n",
1717
"where $e^{-i\\Delta_t H}$ is calculated with a Trotter expansion (using e.g. the [PauliEvolutionGate](https://qiskit.org/documentation/stubs/qiskit.circuit.library.PauliEvolutionGate.html) in Qiskit!).\n",
1818
"\n",
19-
"The following tutorial explores the p-VQD algorithm, which is available as the [PVQD](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.PVQD.html) class. For details on the algorithm, see the original paper: [Barison et al. Quantum 5, 512 (2021)](https://quantum-journal.org/papers/q-2021-07-28-512/#)."
19+
"The following tutorial explores the p-VQD algorithm, which is available as the [PVQD](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.PVQD.html) class. For details on the algorithm, see the original paper: [Barison et al. Quantum 5, 512 (2021)](https://quantum-journal.org/papers/q-2021-07-28-512/#)."
2020
]
2121
},
2222
{

docs/tutorials/11_VarQTE.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
"id": "WG-18slyLnVM"
6767
},
6868
"source": [
69-
"In this tutorial, we will use two classes that extend `VarQTE`, `VarQITE` ([Variational Quantum Imaginary Time Evolution](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.VarQITE.html#qiskit_algorithms.VarQITE)) and `VarQRTE` ([Variational Quantum Real Time Evolution](https://qiskit.org/ecosystem/algorithms/stubs/qiskit_algorithms.VarQRTE.html)) for time evolution.\n",
69+
"In this tutorial, we will use two classes that extend `VarQTE`, `VarQITE` ([Variational Quantum Imaginary Time Evolution](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.VarQITE.html#qiskit_algorithms.VarQITE)) and `VarQRTE` ([Variational Quantum Real Time Evolution](https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.VarQRTE.html)) for time evolution.\n",
7070
"We can use a simple Ising model on a spin chain to illustrate this. Let us consider the following Hamiltonian:\n",
7171
"\n",
7272
"$$H = -J\\sum_{i=0}^{L-2}Z_{i}Z_{i+1} - h\\sum_{i=0}^{L-1}X_i$$\n",
@@ -955,4 +955,4 @@
955955
},
956956
"nbformat": 4,
957957
"nbformat_minor": 1
958-
}
958+
}

0 commit comments

Comments
 (0)