Move tutorials

Qiskit · Sep 27, 2023 · f301204 · f301204
1 parent 0ebea4e
commit f301204
Show file tree

Hide file tree

Showing 47 changed files with 49 additions and 34 deletions.
diff --git a/docs/cloud/quickstart.rst b/docs/cloud/quickstart.rst
@@ -99,6 +99,6 @@ Choose a primitive to run
 
 Qiskit Runtime uses primitives to interface with quantum computers and they are publicly available. Choose the appropriate link to continue learning how to run a primitive.
 
-`Getting started with Sampler <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/how-to-getting-started-with-sampler.html>`__
+`Getting started with Sampler <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/how-to-getting-started-with-sampler/index.html>`__
 
-`Getting started with Estimator <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/how-to-getting-started-with-estimator.html>`__
+`Getting started with Estimator <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/how-to-getting-started-with-estimator/index.html>`__
diff --git a/docs/conf.py b/docs/conf.py
@@ -61,7 +61,8 @@
     'reno.sphinxext',
     'nbsphinx',
     'sphinx_design',
-    "qiskit_sphinx_theme",
+    'sphinxext.rediraffe',
+    'qiskit_sphinx_theme',
 ]
 templates_path = ['_templates']
 
@@ -161,3 +162,16 @@
 html_sourcelink_suffix = ''
 
 autoclass_content = 'both'
+
+# -- Redirects ---------------------------------------------------------------
+
+rediraffe_redirects = {
+    "tutorials/chsh_with_estimator.ipynb": "tutorials/chsh-with-estimator/index.ipynb",
+    "tutorials/Error-Suppression-and-Error-Mitigation.ipynb": "tutorials/error-suppression-and-error-mitigation/index.ipynb",
+    "tutorials/grover_with_sampler.ipynb": "tutorials/grover-with-sampler/index.ipynb",
+    "tutorials/how-to-getting-started-with-estimator.ipynb": "tutorials/how-to-getting-started-with-estimator/index.ipynb",
+    "tutorials/how-to-getting-started-with-sampler.ipynb": "tutorials/how-to-getting-started-with-sampler/index.ipynb",
+    "tutorials/qaoa_with_primitives.ipynb": "tutorials/qaoa-with-primitives/index.ipynb",
+    "tutorials/user-transpiled-circuits.ipynb": "tutorials/user-transpiled-circuits/index.ipynb",
+    "tutorials/vqe_with_estimator.ipynb": "tutorials/vqe-with-estimator/index.ipynb"
+}
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -77,8 +77,8 @@ Getting started with primitives
 
 .. nbgallery::
 
-   tutorials/how-to-getting-started-with-sampler
-   tutorials/how-to-getting-started-with-estimator
+   tutorials/how-to-getting-started-with-sampler/index
+   tutorials/how-to-getting-started-with-estimator/index
 
 
 `See more tutorials <tutorials.html>`_
diff --git a/docs/how_to/noisy_simulators.rst b/docs/how_to/noisy_simulators.rst
@@ -108,7 +108,7 @@ distribution using the `Sampler primitive
 to do the same. To learn how to use the ``Sampler`` primitive and how to
 get started using Qiskit Runtime Sessions, you can check this tutorial:
 `Get started with the Sampler
-primitive <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/how-to-getting-started-with-sampler.html>`__.
+primitive <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/how-to-getting-started-with-sampler/index.html>`__.
 
 .. code-block:: python
 
@@ -151,7 +151,7 @@ Run the circuits on Estimator
 
 To learn how to start a session for Estimator, you may check this
 tutorial: `Get started with the Estimator
-primitive <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/how-to-getting-started-with-estimator.html>`__.
+primitive <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/how-to-getting-started-with-estimator/index.html>`__.
 
 The Estimator will bind single-qubit rotations to get Hamiltonians
 before it returns expectation values of quantum operators. Therefore,
@@ -420,7 +420,7 @@ explore additional options offered by them. If you want to learn more
 about activating features like *Digital-ZNE*, *PEC* in addition to *M3*
 and *T-REx* as shown in the previous examples, check out this tutorial:
 `Error suppression and error mitigation with Qiskit
-Runtime <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/Error-Suppression-and-Error-Mitigation.html>`__.
+Runtime <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/error-suppression-and-error-mitigation/index.html>`__.
 
 .. code-block:: python
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -63,14 +63,14 @@ Next steps
    :hidden:
    :caption: Tutorials
 
-    Get started with Estimator <tutorials/how-to-getting-started-with-estimator>
-    Get started with Sampler <tutorials/how-to-getting-started-with-sampler>
-    Get started with error suppression and error mitigation <tutorials/Error-Suppression-and-Error-Mitigation>
-    CHSH with Estimator <tutorials/chsh_with_estimator>
-    VQE with Estimator <tutorials/vqe_with_estimator>
-    Grover with Sampler <tutorials/grover_with_sampler>
-    QAOA with Primitives <tutorials/qaoa_with_primitives>
-    Submit user-transpiled circuits using primitives <tutorials/user-transpiled-circuits>
+    Get started with Estimator <tutorials/how-to-getting-started-with-estimator/index>
+    Get started with Sampler <tutorials/how-to-getting-started-with-sampler/index>
+    Get started with error suppression and error mitigation <tutorials/error-suppression-and-error-mitigation/index>
+    CHSH with Estimator <tutorials/chsh-with-estimator/index>
+    VQE with Estimator <tutorials/vqe-with-estimator/index>
+    Grover with Sampler <tutorials/grover-with-sampler/index>
+    QAOA with Primitives <tutorials/qaoa-with-primitives/index>
+    Submit user-transpiled circuits using primitives <tutorials/user-transpiled-circuits/index>
     All tutorials <tutorials>
 
 .. toctree::

diff --git a/docs/migrate/migrate-estimator.rst b/docs/migrate/migrate-estimator.rst
@@ -265,7 +265,7 @@ Note that the Estimator returns a list of values, as it can perform batched eval
 The ``Estimator`` Runtime primitive offers a series of features and tuning options that do not have a legacy alternative
 to migrate from, but can help improve your performance and results. For more information, refer to the following:
 
-- `Error mitigation tutorial <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/Error-Suppression-and-Error-Mitigation.html>`_
+- `Error mitigation tutorial <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/error-suppression-and-error-mitigation/index.html>`_
 - `Setting execution options topic <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/how_to/options.html>`_
 - `Primitive execution options API reference <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/stubs/qiskit_ibm_runtime.options.Options.html#qiskit_ibm_runtime.options.Options>`_
 - `How to run a session topic <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/how_to/run_session.html>`_

diff --git a/docs/migrate/migrate-guide.rst b/docs/migrate/migrate-guide.rst
@@ -200,6 +200,6 @@ often occurs in optimization problems or chemistry applications.  For example, w
 Related links
 -------------
 
-* `Get started with Estimator <../tutorials/how-to-getting-started-with-estimator.ipynb>`__
-* `Get started with Sampler <../tutorials/how-to-getting-started-with-sampler.ipynb>`__
+* `Get started with Estimator <../tutorials/how-to-getting-started-with-estimator/index.ipynb>`__
+* `Get started with Sampler <../tutorials/how-to-getting-started-with-sampler/index.ipynb>`__
 * `Tutorial: Migrate from qiskit-ibmq-provider to qiskit-ibm-provider <https://qiskit.org/documentation/partners/qiskit_ibm_provider/tutorials/Migration_Guide_from_qiskit-ibmq-provider.html>`__
diff --git a/docs/migrate/migrate-sampler.rst b/docs/migrate/migrate-sampler.rst
@@ -286,7 +286,7 @@ notice that the workflow is now simplified, as the quasi-probability distributio
 The ``Sampler`` Runtime primitive offers several features and tuning options that do not have a legacy alternative
 to migrate from, but can help improve your performance and results. For more information, refer to the following:
 
-- `Error mitigation tutorial <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/Error-Suppression-and-Error-Mitigation.html>`_
+- `Error mitigation tutorial <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/error-suppression-and-error-mitigation/index.html>`-
 - `Setting execution options topic <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/how_to/options.html>`_
 - `How to run a session topic <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/how_to/run_session.html>`_
 

diff --git a/docs/migrate/migrate-tuning.rst b/docs/migrate/migrate-tuning.rst
@@ -95,7 +95,7 @@ For more information, and a complete list of advanced transpilation options, see
 Finally, you might want to specify settings that are not available through the primitives interface,
 or use custom transpiler passes. In these cases, you can set ``skip_transpilation=True`` to submit
 user-transpiled circuits. To learn how this is done, refer to the 
-`Submitting user-transpiled circuits using primitives tutorial <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/user-transpiled-circuits.html>`_.
+`Submitting user-transpiled circuits using primitives tutorial <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/tutorials/user-transpiled-circuits/index.html>`_.
 
 The ``skip_transpilation`` option is an advanced transpilation option, set as follows:
 

diff --git a/docs/primitives.rst b/docs/primitives.rst
@@ -62,6 +62,6 @@ How to use primitives
 
 Primitive interfaces vary based on the type of task that you want to run on the quantum computer and the corresponding data that you want returned as a result. After identifying the appropriate primitive for your program, you can use Qiskit to prepare inputs, such as circuits, observables (for Estimator), and customizable options to optimize your job. For more information, see the appropriate topic:
 
-* `Getting started with Estimator <./tutorials/how-to-getting-started-with-estimator.ipynb>`__
-* `Getting started with Sampler <./tutorials/how-to-getting-started-with-sampler.ipynb>`__
+* `Getting started with Estimator <./tutorials/how-to-getting-started-with-estimator/index.ipynb>`__
+* `Getting started with Sampler <./tutorials/how-to-getting-started-with-sampler/index.ipynb>`__
 * :ref:`Migrate from qiskit-ibmq-provider to qiskit-ibm-runtime <migrate to primitives>`
diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -9,20 +9,20 @@ Estimator
 
 .. nbgallery::
 
-   tutorials/how-to-getting-started-with-estimator
-   tutorials/Error-Suppression-and-Error-Mitigation
-   tutorials/chsh_with_estimator
-   tutorials/vqe_with_estimator
+   tutorials/how-to-getting-started-with-estimator/index
+   tutorials/error-suppression-and-error-mitigation/index
+   tutorials/chsh-with-estimator/index
+   tutorials/vqe-with-estimator/index
 
 Sampler
 =================================
 
 .. nbgallery::
 
-   tutorials/how-to-getting-started-with-sampler
-   tutorials/grover_with_sampler
-   tutorials/user-transpiled-circuits
-   tutorials/qaoa_with_primitives
+   tutorials/how-to-getting-started-with-sampler/index
+   tutorials/grover-with-sampler/index
+   tutorials/user-transpiled-circuits/index
+   tutorials/qaoa-with-primitives/index
 
 
 .. Hiding - Indices and tables

diff --git a/docs/tutorials/chsh_with_estimator.ipynb → ...tutorials/chsh-with-estimator/index.ipynb b/docs/tutorials/chsh_with_estimator.ipynb → ...tutorials/chsh-with-estimator/index.ipynb
diff --git a/docs/tutorials/images/100x100.png → ...n-and-error-mitigation/images/100x100.png b/docs/tutorials/images/100x100.png → ...n-and-error-mitigation/images/100x100.png
diff --git a/docs/tutorials/images/analog_vs_digital.png → ...r-mitigation/images/analog_vs_digital.png b/docs/tutorials/images/analog_vs_digital.png → ...r-mitigation/images/analog_vs_digital.png
diff --git a/...orials/images/bias_variance_trade_off.png → ...gation/images/bias_variance_trade_off.png b/...orials/images/bias_variance_trade_off.png → ...gation/images/bias_variance_trade_off.png
diff --git a/docs/tutorials/images/global_vs_local.png → ...ror-mitigation/images/global_vs_local.png b/docs/tutorials/images/global_vs_local.png → ...ror-mitigation/images/global_vs_local.png
diff --git a/...ials/images/path_to_quantum_advantage.png → ...tion/images/path_to_quantum_advantage.png b/...ials/images/path_to_quantum_advantage.png → ...tion/images/path_to_quantum_advantage.png
diff --git a/docs/tutorials/images/pec_curve_fitting.png → ...r-mitigation/images/pec_curve_fitting.png b/docs/tutorials/images/pec_curve_fitting.png → ...r-mitigation/images/pec_curve_fitting.png
diff --git a/docs/tutorials/images/pec_layers.png → ...nd-error-mitigation/images/pec_layers.png b/docs/tutorials/images/pec_layers.png → ...nd-error-mitigation/images/pec_layers.png
diff --git a/docs/tutorials/images/pec_learn_layer.png → ...ror-mitigation/images/pec_learn_layer.png b/docs/tutorials/images/pec_learn_layer.png → ...ror-mitigation/images/pec_learn_layer.png
diff --git a/docs/tutorials/images/pec_pauli_twirling.png → ...-mitigation/images/pec_pauli_twirling.png b/docs/tutorials/images/pec_pauli_twirling.png → ...-mitigation/images/pec_pauli_twirling.png
diff --git a/...tutorials/images/trex_data_collection.png → ...itigation/images/trex_data_collection.png b/...tutorials/images/trex_data_collection.png → ...itigation/images/trex_data_collection.png
diff --git a/...torials/images/unuseful_extrapolation.png → ...igation/images/unuseful_extrapolation.png b/...torials/images/unuseful_extrapolation.png → ...igation/images/unuseful_extrapolation.png
diff --git a/...tutorials/images/useful_extrapolation.png → ...itigation/images/useful_extrapolation.png b/...tutorials/images/useful_extrapolation.png → ...itigation/images/useful_extrapolation.png
diff --git a/docs/tutorials/images/zne_stages.png → ...nd-error-mitigation/images/zne_stages.png b/docs/tutorials/images/zne_stages.png → ...nd-error-mitigation/images/zne_stages.png
diff --git a/...or-Suppression-and-Error-Mitigation.ipynb → ...pression-and-error-mitigation/index.ipynb b/...or-Suppression-and-Error-Mitigation.ipynb → ...pression-and-error-mitigation/index.ipynb
diff --git a/docs/tutorials/grover_with_sampler.ipynb → ...tutorials/grover-with-sampler/index.ipynb b/docs/tutorials/grover_with_sampler.ipynb → ...tutorials/grover-with-sampler/index.ipynb
diff --git a/docs/tutorials/images/options.png → ...started-with-estimator/images/options.png b/docs/tutorials/images/options.png → ...started-with-estimator/images/options.png
diff --git a/...w-to-getting-started-with-estimator.ipynb → ...etting-started-with-estimator/index.ipynb b/...w-to-getting-started-with-estimator.ipynb → ...etting-started-with-estimator/index.ipynb
@@ -64,7 +64,7 @@
     }
    },
    "source": [
-    "In this tutorial we will focus on the `Estimator` primitive. There is a separate tutorial on [Getting started with the Sampler primitive](how-to-getting-started-with-sampler.ipynb)."
+    "In this tutorial we will focus on the `Estimator` primitive. There is a separate tutorial on [Getting started with the Sampler primitive](../how-to-getting-started-with-sampler/index.ipynb)."
    ]
   },
   {

diff --git a/docs/tutorials/how-to-getting-started-with-sampler/images/options.png b/docs/tutorials/how-to-getting-started-with-sampler/images/options.png
diff --git a/...how-to-getting-started-with-sampler.ipynb → ...-getting-started-with-sampler/index.ipynb b/...how-to-getting-started-with-sampler.ipynb → ...-getting-started-with-sampler/index.ipynb
@@ -64,7 +64,7 @@
     }
    },
    "source": [
-    "In this tutorial we will focus on the `Sampler` primitive. There is a separate tutorial on [Getting started with the Estimator primitive](how-to-getting-started-with-estimator.ipynb)."
+    "In this tutorial we will focus on the `Sampler` primitive. There is a separate tutorial on [Getting started with the Estimator primitive](../how-to-getting-started-with-estimator/index.ipynb)."
    ]
   },
   {

diff --git a/docs/tutorials/images/bias_variance_trade_off-checkpoint.png b/docs/tutorials/images/bias_variance_trade_off-checkpoint.png
diff --git a/docs/tutorials/images/chip.png b/docs/tutorials/images/chip.png
diff --git a/docs/tutorials/images/estimator.png b/docs/tutorials/images/estimator.png
diff --git a/docs/tutorials/images/pec_multiple_axes.png b/docs/tutorials/images/pec_multiple_axes.png
diff --git a/docs/tutorials/images/plot_combined.png b/docs/tutorials/images/plot_combined.png
diff --git a/docs/tutorials/images/plot_dd.png b/docs/tutorials/images/plot_dd.png
diff --git a/docs/tutorials/images/plot_pec.png b/docs/tutorials/images/plot_pec.png
diff --git a/docs/tutorials/images/plot_trex.png b/docs/tutorials/images/plot_trex.png
diff --git a/docs/tutorials/images/plot_zne.png b/docs/tutorials/images/plot_zne.png
diff --git a/docs/tutorials/images/sampling_overhead_scalability_chart.png b/docs/tutorials/images/sampling_overhead_scalability_chart.png
diff --git a/docs/tutorials/images/subgraphs.png b/docs/tutorials/images/subgraphs.png
diff --git a/docs/tutorials/images/surface_code_resources.png b/docs/tutorials/images/surface_code_resources.png
diff --git a/docs/tutorials/qaoa_with_primitives.ipynb → ...utorials/qaoa-with-primitives/index.ipynb b/docs/tutorials/qaoa_with_primitives.ipynb → ...utorials/qaoa-with-primitives/index.ipynb
@@ -205,7 +205,7 @@
    "id": "fe36b13c",
    "metadata": {},
    "source": [
-    "As with an iterative optimization procedure, we now need to define our cost function over which to minimize.  We proceed in an identical manner to the [VQE tutorial](vqe_with_estimator.ipynb), computing the expectation value of our Hamiltonian with respect to the parameterized ansatz circuit using the Qiskit Runtime `Estimator` primitive:"
+    "As with an iterative optimization procedure, we now need to define our cost function over which to minimize.  We proceed in an identical manner to the [VQE tutorial](../vqe-with-estimator/index.ipynb), computing the expectation value of our Hamiltonian with respect to the parameterized ansatz circuit using the Qiskit Runtime `Estimator` primitive:"
    ]
   },
   {

diff --git a/.../tutorials/user-transpiled-circuits.ipynb → ...ials/user-transpiled-circuits/index.ipynb b/.../tutorials/user-transpiled-circuits.ipynb → ...ials/user-transpiled-circuits/index.ipynb
diff --git a/docs/tutorials/vqe_with_estimator.ipynb → .../tutorials/vqe-with-estimator/index.ipynb b/docs/tutorials/vqe_with_estimator.ipynb → .../tutorials/vqe-with-estimator/index.ipynb
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -24,6 +24,7 @@ sphinx-automodapi
 sphinx-autodoc-typehints<=1.19.2
 sphinx-design>=0.4.0
 sphinx-intl
+sphinxext-rediraffe
 jupyter-sphinx
 reno>=2.11.0
 qiskit-sphinx-theme~=1.12.0
-Original file line number
+Diff line change
@@ Expand Up / @@ -64,7 +64,7 @@ @@
         }
        },
        "source": [
-        "In this tutorial we will focus on the `Estimator` primitive. There is a separate tutorial on [Getting started with the Sampler primitive](how-to-getting-started-with-sampler.ipynb)."
+        "In this tutorial we will focus on the `Estimator` primitive. There is a separate tutorial on [Getting started with the Sampler primitive](../how-to-getting-started-with-sampler/index.ipynb)."
        ]
       },
       {
@@ Expand Down @@