From 988d723ce5447847d5e608321e03be84565a8d9e Mon Sep 17 00:00:00 2001 From: Purva Thakre Date: Sat, 10 Aug 2024 03:06:47 -0500 Subject: [PATCH] add tags configuration + techniques/interface tags --- docs/source/_tags/bqskit.md | 10 ++++++ docs/source/_tags/braket.md | 12 +++++++ docs/source/_tags/calibration.md | 10 ++++++ docs/source/_tags/cdr.md | 11 ++++++ docs/source/_tags/cirq.md | 26 ++++++++++++++ docs/source/_tags/ddd.md | 12 +++++++ docs/source/_tags/ionq.md | 10 ++++++ docs/source/_tags/pec.md | 11 ++++++ docs/source/_tags/pennylane.md | 12 +++++++ docs/source/_tags/qibo.md | 10 ++++++ docs/source/_tags/qiskit.md | 21 ++++++++++++ docs/source/_tags/qrack.md | 10 ++++++ docs/source/_tags/rem.md | 10 ++++++ docs/source/_tags/shadows.md | 11 ++++++ docs/source/_tags/stim.md | 10 ++++++ docs/source/_tags/tagsindex.md | 26 ++++++++++++++ docs/source/_tags/zne.md | 34 +++++++++++++++++++ docs/source/conf.py | 12 +++++++ docs/source/examples/bqskit.md | 3 ++ docs/source/examples/braket_mirror_circuit.md | 3 ++ docs/source/examples/calibration-tutorial.md | 3 ++ docs/source/examples/cdr_qrack.md | 3 ++ docs/source/examples/cirq-ibmq-backends.md | 3 ++ docs/source/examples/combine_ddd_zne.md | 2 ++ docs/source/examples/combine_rem_zne.md | 2 ++ docs/source/examples/ddd_on_ibmq_ghz.md | 2 ++ docs/source/examples/ddd_tutorial.md | 2 ++ docs/source/examples/examples.md | 9 +++++ .../examples/ggi_summer_school_solved.md | 2 ++ .../examples/ggi_summer_school_unsolved.md | 3 ++ docs/source/examples/hamiltonians.md | 3 ++ docs/source/examples/ibmq-backends.md | 3 ++ docs/source/examples/layerwise-folding.md | 3 ++ .../examples/learning-depolarizing-noise.md | 3 ++ docs/source/examples/maxcut-demo.md | 3 ++ docs/source/examples/molecular_hydrogen.md | 3 ++ .../examples/molecular_hydrogen_pennylane.md | 2 ++ docs/source/examples/pec_tutorial.md | 2 ++ .../examples/pennylane-ibmq-backends.md | 3 ++ docs/source/examples/qibo-noisy-simulation.md | 3 ++ .../examples/quantum_simulation_1d_ising.md | 3 ++ .../examples/quantum_simulation_scars_ibmq.md | 3 ++ docs/source/examples/rshadows_tutorial.md | 3 ++ docs/source/examples/scaling.md | 2 ++ docs/source/examples/shadows_tutorial.md | 3 ++ .../examples/simple-landscape-braket.md | 3 ++ docs/source/examples/simple-landscape-cirq.md | 3 ++ .../examples/simple-landscape-pennylane.md | 3 ++ .../examples/simple-landscape-qiskit.md | 3 ++ docs/source/examples/zne-braket-ionq.md | 3 ++ .../examples/zne_logical_rb_cirq_stim.md | 3 ++ requirements/requirements-dev.txt | 1 + 52 files changed, 356 insertions(+) create mode 100644 docs/source/_tags/bqskit.md create mode 100644 docs/source/_tags/braket.md create mode 100644 docs/source/_tags/calibration.md create mode 100644 docs/source/_tags/cdr.md create mode 100644 docs/source/_tags/cirq.md create mode 100644 docs/source/_tags/ddd.md create mode 100644 docs/source/_tags/ionq.md create mode 100644 docs/source/_tags/pec.md create mode 100644 docs/source/_tags/pennylane.md create mode 100644 docs/source/_tags/qibo.md create mode 100644 docs/source/_tags/qiskit.md create mode 100644 docs/source/_tags/qrack.md create mode 100644 docs/source/_tags/rem.md create mode 100644 docs/source/_tags/shadows.md create mode 100644 docs/source/_tags/stim.md create mode 100644 docs/source/_tags/tagsindex.md create mode 100644 docs/source/_tags/zne.md diff --git a/docs/source/_tags/bqskit.md b/docs/source/_tags/bqskit.md new file mode 100644 index 0000000000..d47cb4897f --- /dev/null +++ b/docs/source/_tags/bqskit.md @@ -0,0 +1,10 @@ +(sphx_tag_bqskit)= +# Tags: bqskit + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/bqskit.md +``` diff --git a/docs/source/_tags/braket.md b/docs/source/_tags/braket.md new file mode 100644 index 0000000000..f6cc4d283c --- /dev/null +++ b/docs/source/_tags/braket.md @@ -0,0 +1,12 @@ +(sphx_tag_braket)= +# Tags: braket + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/braket_mirror_circuit.md +../examples/simple-landscape-braket.md +../examples/zne-braket-ionq.md +``` diff --git a/docs/source/_tags/calibration.md b/docs/source/_tags/calibration.md new file mode 100644 index 0000000000..51d34591be --- /dev/null +++ b/docs/source/_tags/calibration.md @@ -0,0 +1,10 @@ +(sphx_tag_calibration)= +# Tags: calibration + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/calibration-tutorial.md +``` diff --git a/docs/source/_tags/cdr.md b/docs/source/_tags/cdr.md new file mode 100644 index 0000000000..c19a095fd0 --- /dev/null +++ b/docs/source/_tags/cdr.md @@ -0,0 +1,11 @@ +(sphx_tag_cdr)= +# Tags: cdr + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/cdr_qrack.md +../examples/quantum_simulation_1d_ising.md +``` diff --git a/docs/source/_tags/cirq.md b/docs/source/_tags/cirq.md new file mode 100644 index 0000000000..f5eb6d780b --- /dev/null +++ b/docs/source/_tags/cirq.md @@ -0,0 +1,26 @@ +(sphx_tag_cirq)= +# Tags: cirq + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/cdr_qrack.md +../examples/cirq-ibmq-backends.md +../examples/combine_ddd_zne.md +../examples/combine_rem_zne.md +../examples/ddd_tutorial.md +../examples/hamiltonians.md +../examples/learning-depolarizing-noise.md +../examples/maxcut-demo.md +../examples/molecular_hydrogen.md +../examples/molecular_hydrogen_pennylane.md +../examples/pec_tutorial.md +../examples/quantum_simulation_1d_ising.md +../examples/rshadows_tutorial.md +../examples/scaling.md +../examples/shadows_tutorial.md +../examples/simple-landscape-cirq.md +../examples/zne_logical_rb_cirq_stim.md +``` diff --git a/docs/source/_tags/ddd.md b/docs/source/_tags/ddd.md new file mode 100644 index 0000000000..726b01ea18 --- /dev/null +++ b/docs/source/_tags/ddd.md @@ -0,0 +1,12 @@ +(sphx_tag_ddd)= +# Tags: ddd + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/combine_ddd_zne.md +../examples/ddd_on_ibmq_ghz.md +../examples/ddd_tutorial.md +``` diff --git a/docs/source/_tags/ionq.md b/docs/source/_tags/ionq.md new file mode 100644 index 0000000000..59896e833a --- /dev/null +++ b/docs/source/_tags/ionq.md @@ -0,0 +1,10 @@ +(sphx_tag_ionq)= +# Tags: ionq + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/zne-braket-ionq.md +``` diff --git a/docs/source/_tags/pec.md b/docs/source/_tags/pec.md new file mode 100644 index 0000000000..bc9845aec7 --- /dev/null +++ b/docs/source/_tags/pec.md @@ -0,0 +1,11 @@ +(sphx_tag_pec)= +# Tags: pec + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/learning-depolarizing-noise.md +../examples/pec_tutorial.md +``` diff --git a/docs/source/_tags/pennylane.md b/docs/source/_tags/pennylane.md new file mode 100644 index 0000000000..913ebab8fe --- /dev/null +++ b/docs/source/_tags/pennylane.md @@ -0,0 +1,12 @@ +(sphx_tag_pennylane)= +# Tags: pennylane + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/molecular_hydrogen_pennylane.md +../examples/pennylane-ibmq-backends.md +../examples/simple-landscape-pennylane.md +``` diff --git a/docs/source/_tags/qibo.md b/docs/source/_tags/qibo.md new file mode 100644 index 0000000000..4291b80bfa --- /dev/null +++ b/docs/source/_tags/qibo.md @@ -0,0 +1,10 @@ +(sphx_tag_qibo)= +# Tags: qibo + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/qibo-noisy-simulation.md +``` diff --git a/docs/source/_tags/qiskit.md b/docs/source/_tags/qiskit.md new file mode 100644 index 0000000000..6182476ae5 --- /dev/null +++ b/docs/source/_tags/qiskit.md @@ -0,0 +1,21 @@ +(sphx_tag_qiskit)= +# Tags: qiskit + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/calibration-tutorial.md +../examples/cdr_qrack.md +../examples/cirq-ibmq-backends.md +../examples/ddd_on_ibmq_ghz.md +../examples/ggi_summer_school_solved.md +../examples/ggi_summer_school_unsolved.md +../examples/ibmq-backends.md +../examples/layerwise-folding.md +../examples/pec_tutorial.md +../examples/pennylane-ibmq-backends.md +../examples/quantum_simulation_scars_ibmq.md +../examples/simple-landscape-qiskit.md +``` diff --git a/docs/source/_tags/qrack.md b/docs/source/_tags/qrack.md new file mode 100644 index 0000000000..6ae3fad368 --- /dev/null +++ b/docs/source/_tags/qrack.md @@ -0,0 +1,10 @@ +(sphx_tag_qrack)= +# Tags: qrack + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/cdr_qrack.md +``` diff --git a/docs/source/_tags/rem.md b/docs/source/_tags/rem.md new file mode 100644 index 0000000000..83c0e70972 --- /dev/null +++ b/docs/source/_tags/rem.md @@ -0,0 +1,10 @@ +(sphx_tag_rem)= +# Tags: rem + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/combine_rem_zne.md +``` diff --git a/docs/source/_tags/shadows.md b/docs/source/_tags/shadows.md new file mode 100644 index 0000000000..05092a6f9b --- /dev/null +++ b/docs/source/_tags/shadows.md @@ -0,0 +1,11 @@ +(sphx_tag_shadows)= +# Tags: shadows + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/rshadows_tutorial.md +../examples/shadows_tutorial.md +``` diff --git a/docs/source/_tags/stim.md b/docs/source/_tags/stim.md new file mode 100644 index 0000000000..312324d095 --- /dev/null +++ b/docs/source/_tags/stim.md @@ -0,0 +1,10 @@ +(sphx_tag_stim)= +# Tags: stim + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/zne_logical_rb_cirq_stim.md +``` diff --git a/docs/source/_tags/tagsindex.md b/docs/source/_tags/tagsindex.md new file mode 100644 index 0000000000..72de8ede22 --- /dev/null +++ b/docs/source/_tags/tagsindex.md @@ -0,0 +1,26 @@ +(tagoverview)= + +# All tags + +```{toctree} +--- +caption: Tags in the documentation tutorials: +maxdepth: 1 +--- +bqskit (1) +braket (3) +calibration (1) +cdr (2) +cirq (17) +ddd (3) +ionq (1) +pec (2) +pennylane (3) +qibo (1) +qiskit (12) +qrack (1) +rem (1) +shadows (2) +stim (1) +zne (25) +``` diff --git a/docs/source/_tags/zne.md b/docs/source/_tags/zne.md new file mode 100644 index 0000000000..0711aec4c4 --- /dev/null +++ b/docs/source/_tags/zne.md @@ -0,0 +1,34 @@ +(sphx_tag_zne)= +# Tags: zne + +```{toctree} +--- +maxdepth: 1 +caption: Pages with this tag: +--- +../examples/bqskit.md +../examples/braket_mirror_circuit.md +../examples/calibration-tutorial.md +../examples/cirq-ibmq-backends.md +../examples/combine_ddd_zne.md +../examples/combine_rem_zne.md +../examples/ggi_summer_school_solved.md +../examples/ggi_summer_school_unsolved.md +../examples/hamiltonians.md +../examples/ibmq-backends.md +../examples/layerwise-folding.md +../examples/maxcut-demo.md +../examples/molecular_hydrogen.md +../examples/molecular_hydrogen_pennylane.md +../examples/pennylane-ibmq-backends.md +../examples/qibo-noisy-simulation.md +../examples/quantum_simulation_1d_ising.md +../examples/quantum_simulation_scars_ibmq.md +../examples/scaling.md +../examples/simple-landscape-braket.md +../examples/simple-landscape-cirq.md +../examples/simple-landscape-pennylane.md +../examples/simple-landscape-qiskit.md +../examples/zne-braket-ionq.md +../examples/zne_logical_rb_cirq_stim.md +``` diff --git a/docs/source/conf.py b/docs/source/conf.py index 98f47b4b91..b412346d65 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -98,8 +98,20 @@ def setup(app): "sphinx_copybutton", "nbsphinx", "sphinx_gallery.load_style", + "sphinx_design", + "sphinx_tags", ] +# to add tags to the documentation tutorials +tags_create_tags = True +tags_overview_title = "All tags" +tags_create_badges = True +tags_intro_text = "Tags on this page: " +tags_page_title = "Tags" +tags_page_header = "Pages with this tag: " +tags_index_head = "Tags in the documentation tutorials: " +tags_extension = ["md"] + # hide primary sidebar from the following pages html_sidebars = {"apidoc": [], "changelog": [], "bibliography": []} diff --git a/docs/source/examples/bqskit.md b/docs/source/examples/bqskit.md index 04b4d71812..12f842720e 100644 --- a/docs/source/examples/bqskit.md +++ b/docs/source/examples/bqskit.md @@ -10,6 +10,9 @@ kernelspec: name: python3 --- +```{tags} bqskit, zne +``` + # Improving the accuracy of BQSKit compiled circuits with error mitigation In this tutorial we describe how to use error mitigation capabilities from [Mitiq](https://mitiq.readthedocs.io/en/stable/) together with the compilation capabilities of [BQSKit](https://bqskit.lbl.gov/) {cite}`Patel_2022_ACM`, a compiler for quantum circuits. BQSKit stands for Berkeley Quantum Synthesis Toolkit and it allows one "to compile quantum programs to efficient physical circuits for any QPU". diff --git a/docs/source/examples/braket_mirror_circuit.md b/docs/source/examples/braket_mirror_circuit.md index ee122dfd7e..150d32d2e5 100644 --- a/docs/source/examples/braket_mirror_circuit.md +++ b/docs/source/examples/braket_mirror_circuit.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} braket, zne +``` + # Mitiq with Braket This notebook shows improved performance on a mirror circuit benchmark with zero-noise extrapolation on Rigetti Aspen-9 via Amazon Braket. diff --git a/docs/source/examples/calibration-tutorial.md b/docs/source/examples/calibration-tutorial.md index 83f401d298..f9f29111a6 100644 --- a/docs/source/examples/calibration-tutorial.md +++ b/docs/source/examples/calibration-tutorial.md @@ -12,6 +12,9 @@ kernelspec: name: python3 --- +```{tags} calibration, zne, qiskit +``` + # Breaking into error mitigation with Mitiq's calibration module diff --git a/docs/source/examples/cdr_qrack.md b/docs/source/examples/cdr_qrack.md index cdcbe87884..ab0ade35ea 100644 --- a/docs/source/examples/cdr_qrack.md +++ b/docs/source/examples/cdr_qrack.md @@ -12,6 +12,9 @@ kernelspec: name: python3 --- +```{tags} qiskit, cdr, qrack, cirq +``` + # CDR with Qrack as Near-Clifford Simulator In this tutorial, [Clifford Data Regression](../guide/cdr.md) (CDR) is used with [Qrack](https://qrack.readthedocs.io/en/latest/) and a Qiskit fake backend. diff --git a/docs/source/examples/cirq-ibmq-backends.md b/docs/source/examples/cirq-ibmq-backends.md index 90fb133e89..f1a6a7ef2c 100644 --- a/docs/source/examples/cirq-ibmq-backends.md +++ b/docs/source/examples/cirq-ibmq-backends.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cirq, zne, qiskit +``` + # Error mitigation with Cirq on IBMQ backends diff --git a/docs/source/examples/combine_ddd_zne.md b/docs/source/examples/combine_ddd_zne.md index c907ee2907..73d6510ec6 100644 --- a/docs/source/examples/combine_ddd_zne.md +++ b/docs/source/examples/combine_ddd_zne.md @@ -11,6 +11,8 @@ kernelspec: language: python name: python3 --- +```{tags} ddd, zne, cirq +``` # Composing techniques: Digital Dynamical Decoupling and Zero Noise Extrapolation diff --git a/docs/source/examples/combine_rem_zne.md b/docs/source/examples/combine_rem_zne.md index 6676418d49..fbd9a6bb2e 100644 --- a/docs/source/examples/combine_rem_zne.md +++ b/docs/source/examples/combine_rem_zne.md @@ -11,6 +11,8 @@ kernelspec: language: python name: python3 --- +```{tags} rem, zne, cirq +``` # Composing techniques: Readout Error Mitigation and Zero Noise Extrapolation diff --git a/docs/source/examples/ddd_on_ibmq_ghz.md b/docs/source/examples/ddd_on_ibmq_ghz.md index fa3c29a5db..fd96cdce97 100644 --- a/docs/source/examples/ddd_on_ibmq_ghz.md +++ b/docs/source/examples/ddd_on_ibmq_ghz.md @@ -11,6 +11,8 @@ kernelspec: language: python name: python3 --- +```{tags} ddd, qiskit +``` # Digital dynamical decoupling (DDD) with Qiskit on GHZ Circuits diff --git a/docs/source/examples/ddd_tutorial.md b/docs/source/examples/ddd_tutorial.md index 96ef6344ab..939c137182 100644 --- a/docs/source/examples/ddd_tutorial.md +++ b/docs/source/examples/ddd_tutorial.md @@ -10,6 +10,8 @@ kernelspec: language: python name: python3 --- +```{tags} ddd, cirq +``` # Digital dynamical decoupling (DDD) with Mirror Circuits diff --git a/docs/source/examples/examples.md b/docs/source/examples/examples.md index 860d4f99ff..c66c0d6b62 100644 --- a/docs/source/examples/examples.md +++ b/docs/source/examples/examples.md @@ -38,3 +38,12 @@ Composing techniques: REM + ZNE Composing techniques: DDD + ZNE The Mitiq paper code ``` + +You can also search for a specific example by clicking on one of the tags below: + +```{toctree} +--- +maxdepth: 2 +--- +../../_tags/tagsindex.md +``` \ No newline at end of file diff --git a/docs/source/examples/ggi_summer_school_solved.md b/docs/source/examples/ggi_summer_school_solved.md index 8dabbcb3c1..696983663a 100644 --- a/docs/source/examples/ggi_summer_school_solved.md +++ b/docs/source/examples/ggi_summer_school_solved.md @@ -11,6 +11,8 @@ kernelspec: name: python3 orphan: true --- +```{tags} qiskit, zne +``` # Solution to hands-on lab on error mitigation with Mitiq. diff --git a/docs/source/examples/ggi_summer_school_unsolved.md b/docs/source/examples/ggi_summer_school_unsolved.md index 85e67a7c8b..2e22f3d2c1 100644 --- a/docs/source/examples/ggi_summer_school_unsolved.md +++ b/docs/source/examples/ggi_summer_school_unsolved.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} qiskit, zne +``` + # Hands-on lab on error mitigation with Mitiq. +++ diff --git a/docs/source/examples/hamiltonians.md b/docs/source/examples/hamiltonians.md index 6987d7ccbe..08301db0df 100644 --- a/docs/source/examples/hamiltonians.md +++ b/docs/source/examples/hamiltonians.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cirq, zne +``` + # Defining Hamiltonians as Linear Combinations of Pauli Strings This tutorial shows an example of using Hamiltonians defined as {class}`~cirq.PauliSum` objects or similar objects in other diff --git a/docs/source/examples/ibmq-backends.md b/docs/source/examples/ibmq-backends.md index 75fdaac3f4..83d3be9dba 100644 --- a/docs/source/examples/ibmq-backends.md +++ b/docs/source/examples/ibmq-backends.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} qiskit, zne +``` + # Error mitigation on IBMQ backends with Qiskit diff --git a/docs/source/examples/layerwise-folding.md b/docs/source/examples/layerwise-folding.md index b2b081ddb9..e25a099b27 100644 --- a/docs/source/examples/layerwise-folding.md +++ b/docs/source/examples/layerwise-folding.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} qiskit, zne +``` + # ZNE with Qiskit: Layerwise folding diff --git a/docs/source/examples/learning-depolarizing-noise.md b/docs/source/examples/learning-depolarizing-noise.md index 2419e1c3be..9a74f34c64 100644 --- a/docs/source/examples/learning-depolarizing-noise.md +++ b/docs/source/examples/learning-depolarizing-noise.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cirq, pec +``` + # Learning quasiprobability representations with a depolarizing noise model In this example, we demonstrate the workflow of learning quasiprobability representations of a `CNOT` gate with a depolarizing noise model, diff --git a/docs/source/examples/maxcut-demo.md b/docs/source/examples/maxcut-demo.md index 9450e3fc84..ac1e4e873a 100644 --- a/docs/source/examples/maxcut-demo.md +++ b/docs/source/examples/maxcut-demo.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cirq, zne +``` + # Solving MaxCut with Mitiq-improved QAOA +++ diff --git a/docs/source/examples/molecular_hydrogen.md b/docs/source/examples/molecular_hydrogen.md index 95f45e2a52..341409e3a4 100644 --- a/docs/source/examples/molecular_hydrogen.md +++ b/docs/source/examples/molecular_hydrogen.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cirq, zne +``` + # Estimating the potential energy surface of molecular Hydrogen with ZNE and OpenFermion In this example we apply zero-noise extrapolation (ZNE) to the estimation of the potential energy surface of molecular Hydrogen ($\rm H_2$). diff --git a/docs/source/examples/molecular_hydrogen_pennylane.md b/docs/source/examples/molecular_hydrogen_pennylane.md index 720ab88502..e71d6a1530 100644 --- a/docs/source/examples/molecular_hydrogen_pennylane.md +++ b/docs/source/examples/molecular_hydrogen_pennylane.md @@ -10,6 +10,8 @@ kernelspec: language: python name: python3 --- +```{tags} cirq, pennylane, zne +``` # Estimating the potential energy surface of molecular Hydrogen with ZNE and PennyLane + Cirq diff --git a/docs/source/examples/pec_tutorial.md b/docs/source/examples/pec_tutorial.md index 299d9329b9..5d9bd34e80 100644 --- a/docs/source/examples/pec_tutorial.md +++ b/docs/source/examples/pec_tutorial.md @@ -11,6 +11,8 @@ kernelspec: name: python3 --- +```{tags} pec, cirq, qiskit +``` # Probabilistic error cancellation (PEC) with Mirror Circuits This notebook shows probabilistic error cancellation (PEC) *Temme et al. PRL (2017)* {cite}`Temme_2017_PRL`, *Sun et al. PRLAppl (2021)* {cite}`Sun_2021_PRAppl`, *Zhang et al. NatComm (2020)* {cite}`Zhang_2020_NatComm`, improving performance of a mirror circuit benchmark on the `braket_dm` noisy simulator. diff --git a/docs/source/examples/pennylane-ibmq-backends.md b/docs/source/examples/pennylane-ibmq-backends.md index d68f447935..c5bdce13fa 100644 --- a/docs/source/examples/pennylane-ibmq-backends.md +++ b/docs/source/examples/pennylane-ibmq-backends.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} qiskit, zne, pennylane +``` + # Error mitigation with Pennylane on IBMQ backends In this tutorial we will cover how to use Mitiq in conjunction with [PennyLane](https://pennylane.ai/), and further how to run error-mitigated circuits on IBMQ backends. diff --git a/docs/source/examples/qibo-noisy-simulation.md b/docs/source/examples/qibo-noisy-simulation.md index 7cf805cb77..e5f798aef5 100644 --- a/docs/source/examples/qibo-noisy-simulation.md +++ b/docs/source/examples/qibo-noisy-simulation.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} qibo, zne +``` + # Error mitigation with Qibo using noisy simulation In this tutorial we will cover how to use Mitiq to apply [Zero-Noise Extrapolation](../guide/zne.md) (ZNE) to a quantum program written using [Qibo](https://qibo.science/). diff --git a/docs/source/examples/quantum_simulation_1d_ising.md b/docs/source/examples/quantum_simulation_1d_ising.md index 093c9f60cc..18642ed4be 100644 --- a/docs/source/examples/quantum_simulation_1d_ising.md +++ b/docs/source/examples/quantum_simulation_1d_ising.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cdr, zne, cirq +``` + # Using ZNE and learning-based methods to mitigate the 1D transverse-longitudinal Ising model In this tutorial, we employ ZNE, CDR, and VNCDR mitigation techniques to address errors in the simulation of the 1-D Transverse-Longitudinal Ising model using Mitiq. It is important to note that the results presented here are not original, but rather an attempt to reproduce some of the findings outlined in the paper available at {cite}`Sopena_2023_Quantum`. diff --git a/docs/source/examples/quantum_simulation_scars_ibmq.md b/docs/source/examples/quantum_simulation_scars_ibmq.md index 74409518da..bb9c52dd56 100644 --- a/docs/source/examples/quantum_simulation_scars_ibmq.md +++ b/docs/source/examples/quantum_simulation_scars_ibmq.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} qiskit, zne +``` + ```{code-cell} ipython3 import qiskit from qiskit import QuantumCircuit diff --git a/docs/source/examples/rshadows_tutorial.md b/docs/source/examples/rshadows_tutorial.md index b8c8ec6309..dffec8ea01 100644 --- a/docs/source/examples/rshadows_tutorial.md +++ b/docs/source/examples/rshadows_tutorial.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} shadows, cirq +``` + # Robust Shadow Estimation with Mitiq **Corresponding to:** Min Li (minl2@illinois.edu) diff --git a/docs/source/examples/scaling.md b/docs/source/examples/scaling.md index b58e381714..0beb3143c3 100644 --- a/docs/source/examples/scaling.md +++ b/docs/source/examples/scaling.md @@ -11,6 +11,8 @@ kernelspec: name: python3 --- +```{tags} cirq, zne +``` # Noise Scaling Methods In this tutorial we will compare two noise scaling methods available for use in [Zero-Noise Extrapolation](https://mitiq.readthedocs.io/en/stable/guide/zne.html) (ZNE): identity insertion and unitary folding. diff --git a/docs/source/examples/shadows_tutorial.md b/docs/source/examples/shadows_tutorial.md index f6798371df..835fa18db9 100644 --- a/docs/source/examples/shadows_tutorial.md +++ b/docs/source/examples/shadows_tutorial.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cirq, shadows +``` + # Classical Shadows Protocol with Cirq **Corresponding to:** Min Li (minl2@illinois.edu) diff --git a/docs/source/examples/simple-landscape-braket.md b/docs/source/examples/simple-landscape-braket.md index b0f7713526..c4d64eeb2c 100644 --- a/docs/source/examples/simple-landscape-braket.md +++ b/docs/source/examples/simple-landscape-braket.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} braket, zne +``` + # Using ZNE to compute the energy landscape of a variational circuit with Braket This tutorial shows an example in which the energy landscape for a two-qubit variational circuit is explored with and without error mitigation, using Amazon's [Braket](https://amazon-braket-sdk-python.readthedocs.io/en/latest/) as our frontend. diff --git a/docs/source/examples/simple-landscape-cirq.md b/docs/source/examples/simple-landscape-cirq.md index 724832e527..3410d2376d 100644 --- a/docs/source/examples/simple-landscape-cirq.md +++ b/docs/source/examples/simple-landscape-cirq.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cirq, zne +``` + # Mitigating the energy landscape of a variational circuit with Mitiq +++ diff --git a/docs/source/examples/simple-landscape-pennylane.md b/docs/source/examples/simple-landscape-pennylane.md index f131527993..ad60ac1c7a 100644 --- a/docs/source/examples/simple-landscape-pennylane.md +++ b/docs/source/examples/simple-landscape-pennylane.md @@ -12,6 +12,9 @@ kernelspec: name: python3 --- +```{tags} pennylane, zne +``` + # Mitigating the energy landscape of a variational circuit with Mitiq and PennyLane This tutorial shows an example in which the energy landscape for a two-qubit variational circuit is explored diff --git a/docs/source/examples/simple-landscape-qiskit.md b/docs/source/examples/simple-landscape-qiskit.md index 740edcaa3a..6c1f97592b 100644 --- a/docs/source/examples/simple-landscape-qiskit.md +++ b/docs/source/examples/simple-landscape-qiskit.md @@ -12,6 +12,9 @@ kernelspec: name: python3 --- +```{tags} qiskit, zne +``` + # Using ZNE to compute the energy landscape of a variational circuit with Qiskit This tutorial shows an example in which the energy landscape for a two-qubit variational circuit is explored with and without error mitigation, using Qiskit as our frontend. diff --git a/docs/source/examples/zne-braket-ionq.md b/docs/source/examples/zne-braket-ionq.md index 9c9fdd4ece..f1d42cae79 100644 --- a/docs/source/examples/zne-braket-ionq.md +++ b/docs/source/examples/zne-braket-ionq.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} braket, zne, ionq +``` + (label-zne-braket-ionq)= # Zero-noise extrapolation with Braket on the IonQ backend diff --git a/docs/source/examples/zne_logical_rb_cirq_stim.md b/docs/source/examples/zne_logical_rb_cirq_stim.md index 4d760dd0f5..c35f03a5a1 100644 --- a/docs/source/examples/zne_logical_rb_cirq_stim.md +++ b/docs/source/examples/zne_logical_rb_cirq_stim.md @@ -11,6 +11,9 @@ kernelspec: name: python3 --- +```{tags} cirq, stim, zne +``` + # ZNE on Stim backend with Cirq: Logical randomized benchmarking circuits +++ diff --git a/requirements/requirements-dev.txt b/requirements/requirements-dev.txt index 209d61db50..2712650acc 100644 --- a/requirements/requirements-dev.txt +++ b/requirements/requirements-dev.txt @@ -11,6 +11,7 @@ Sphinx==8.0.2 sphinxcontrib-bibtex==2.6.2 sphinx-copybutton==0.5.2 sphinx-autodoc-typehints==2.0.0 +sphix-tags==0.4 myst-nb==1.1.1 myst-parser==4.0.0 pydata-sphinx-theme==0.15.4