qiskit/docs
Guillermo-Mijares-Vilarino 591116f584
Add how-to guides about primitives (#9716)
* Added how-to section

* added how to compose circuits guide

* added how to visualize circuit guide

* add how to create parameterized circuit guide

* add guides

* removed latex circuit visualization

* fixed title underlines

* Fix typo

* explicitly set cregbundle to False when appending circuit with classical register

* Fix typo

* Added explanation about needed latex distribution

* added link to qiskit.visualization module

* Simplified references

* Change 'we' to 'you'

* Changed how_to.rst to how_to/index.rst

* Removed jupyter-execute from create_a_quantum_circuit

* Removed jupyter-execute from create_a_parameterized_circuit

* Removed jupyter-execute from compose_quantum_circuits

* Removed jupyter-execute from visualize_a_quantum_circuit

* Add sphinx.ext.doctest to conf.py

* Change header symbol for index and visualization guide

* Added guides for sampler and estimator and simplified toctree

* Fixed underline

* Add links to how-to create circuit

* Added section about parameterized circuits to primitives how-tos

* Remove other how-tos

* Remove links

* Added reference to other implementations of primitives

* Update docs/how_to/use_estimator.rst

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>

* Improved titles

* set global doctest flags and disable automatic doctests

* Added part about changing options

* Add new aer docs page to intersphinx

* Added notes about circuit measurements

* Improved notes about circuit measurements

* Update docs/how_to/use_estimator.rst

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Added numpy to intersphinx and  note about doctest and plot directive

* Added note about quasi-probabilities

* rename how to to How-to Guides

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Remove generally

* Changed sampler initial note to mention BackendSampler

* Update docs/how_to/use_sampler.rst

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

* Added code example for backend primitives and link to providers page

* Update intersphinx mapping to ecosystem for aer and runtime

* Change rustworkx link

* Add "primitive" to estimator how-to title

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

* Change hypothetical import to avoid confusion

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

* Include "primitive" word in sampler how-to title

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

* Improve phrasing

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

* Include notice about doctest and plot directive incompatibility in sampler guide

* change->modify sampler options

* change qiskit_provider to <some_qiskit_provider>

* shots->amount of shots in estimator how-to

* Add quick explanation about using multiple circuits and observables and adjust plurals

* singular

* singular

---------

Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
Co-authored-by: Junye Huang <h.jun.ye@gmail.com>
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Co-authored-by: Luciano Bello <bel@zurich.ibm.com>
2023-05-19 12:14:28 +00:00
..
_templates/autosummary Remove unneeded Sphinx templates and static files (#9712) 2023-03-03 14:14:33 +00:00
apidocs Add Rust-based OpenQASM 2 converter (#9784) 2023-04-12 16:00:54 +00:00
how_to Add how-to guides about primitives (#9716) 2023-05-19 12:14:28 +00:00
migration_guides Add Migration Guide for `QuantumInstance` (#9554) 2023-04-13 16:37:46 +00:00
source_images Add supplementary information to transpiler module (#4134) 2020-05-04 21:12:35 +00:00
Makefile Move API docs for Terra into source (#3085) 2019-09-30 12:50:44 -04:00
conf.py Add how-to guides about primitives (#9716) 2023-05-19 12:14:28 +00:00
index.rst Add how-to guides about primitives (#9716) 2023-05-19 12:14:28 +00:00
release_notes.rst Move API docs for Terra into source (#3085) 2019-09-30 12:50:44 -04:00