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.

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

Add how-to guides about primitives #9716

Merged
merged 96 commits into from
May 19, 2023

Conversation

Guillermo-Mijares-Vilarino
Copy link
Contributor

@Guillermo-Mijares-Vilarino Guillermo-Mijares-Vilarino commented Mar 3, 2023

Summary

Added a new how-to guide section to qiskit-terra.

Close #7965

Details and comments

This new section includes 2 guides written in .rst format:

  • Compute circuit output probabilities with Sampler
  • Compute an expectation value with Estimator

@Guillermo-Mijares-Vilarino
Copy link
Contributor Author

I added a sentence about using multiple circuits and observables when you run Sampler and Estimator and fixed the use of singular and plural when talking about defining observables and circuits.

With that all your comments should be addressed @1ucian0.

@1ucian0 1ucian0 enabled auto-merge May 19, 2023 11:22
@1ucian0 1ucian0 added this pull request to the merge queue May 19, 2023
Merged via the queue into Qiskit:main with commit 591116f May 19, 2023
king-p3nguin pushed a commit to king-p3nguin/qiskit-terra that referenced this pull request May 22, 2023
* Add draft

* Remove qiskit

* Apply review

* Apply comments boxnote

* Small edit

* Apply review

* Update up to primitive ops

* Dump changes from sphinx repo

* Add twisties

* Update information, add examples

* Formatting changes

* Simplify intro

* Add links

* Add sampler example

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Steve Wood <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Apply suggestions from code review

Co-authored-by: Julien Gacon <[email protected]>

* Update CircuitOp

Co-authored-by: Julien Gacon <[email protected]>

* Applied suggestions locally

* Change format, links

* Add grouping, algorithms link

* Fix indentation

* Final review, add links

* Add gradients

* Apply heading suggestions

Co-authored-by: Junye Huang <[email protected]>

* Add tags

* Apply suggestions code review

* Correct code examples, add outputs

* Run code examples by doctest

* Remove underscores

* Apply suggestions second round of review

Co-authored-by: Junye Huang <[email protected]>

* Add globals link

* Change links to refs

* Add dropdowns

* Change doctest syntax, apply reviews

* Try CI config

* Add internal links

* Fix lint, add doctest import

* Fix cyclic import

* Fix cyclic import

* Apply suggestions from Declan's code review

Co-authored-by: Declan Millar <[email protected]>

* Update qiskit/quantum_info/__init__.py

* Fix import

* Copy docs config from Qiskit#9716

* Make black

* Remove duplicate

* Reorder

---------

Co-authored-by: Steve Wood <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Declan Millar <[email protected]>
king-p3nguin pushed a commit to king-p3nguin/qiskit-terra that referenced this pull request May 22, 2023
* 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 <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Remove generally

* Changed sampler initial note to mention BackendSampler

* Update docs/how_to/use_sampler.rst

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>

* Change hypothetical import to avoid confusion

Co-authored-by: Luciano Bello <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Luciano Bello <[email protected]>

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

Co-authored-by: Luciano Bello <[email protected]>

* Improve phrasing

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Elena Peña Tapia <[email protected]>
Co-authored-by: Luciano Bello <[email protected]>
@Eric-Arellano
Copy link
Collaborator

Should this be cherry-picked to Terra 0.24? We can't add it to the docs in qiskit-metapackage until then (Qiskit/qiskit-metapackage#1746) because the metapackage builds docs off of the released version, not main. Cc @jlapeyre @1ucian0 @HuangJunye

@1ucian0 1ucian0 added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Jun 12, 2023
mergify bot pushed a commit that referenced this pull request Jun 12, 2023
* 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 <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Remove generally

* Changed sampler initial note to mention BackendSampler

* Update docs/how_to/use_sampler.rst

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>

* Change hypothetical import to avoid confusion

Co-authored-by: Luciano Bello <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Luciano Bello <[email protected]>

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

Co-authored-by: Luciano Bello <[email protected]>

* Improve phrasing

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Elena Peña Tapia <[email protected]>
Co-authored-by: Luciano Bello <[email protected]>
(cherry picked from commit 591116f)
Eric-Arellano pushed a commit to Qiskit/documentation that referenced this pull request Oct 6, 2023
* Add draft

* Remove qiskit

* Apply review

* Apply comments boxnote

* Small edit

* Apply review

* Update up to primitive ops

* Dump changes from sphinx repo

* Add twisties

* Update information, add examples

* Formatting changes

* Simplify intro

* Add links

* Add sampler example

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Steve Wood <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Apply suggestions from code review

Co-authored-by: Julien Gacon <[email protected]>

* Update CircuitOp

Co-authored-by: Julien Gacon <[email protected]>

* Applied suggestions locally

* Change format, links

* Add grouping, algorithms link

* Fix indentation

* Final review, add links

* Add gradients

* Apply heading suggestions

Co-authored-by: Junye Huang <[email protected]>

* Add tags

* Apply suggestions code review

* Correct code examples, add outputs

* Run code examples by doctest

* Remove underscores

* Apply suggestions second round of review

Co-authored-by: Junye Huang <[email protected]>

* Add globals link

* Change links to refs

* Add dropdowns

* Change doctest syntax, apply reviews

* Try CI config

* Add internal links

* Fix lint, add doctest import

* Fix cyclic import

* Fix cyclic import

* Apply suggestions from Declan's code review

Co-authored-by: Declan Millar <[email protected]>

* Update qiskit/quantum_info/__init__.py

* Fix import

* Copy docs config from Qiskit/qiskit#9716

* Make black

* Remove duplicate

* Reorder

---------

Co-authored-by: Steve Wood <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Declan Millar <[email protected]>
Eric-Arellano pushed a commit to Qiskit/documentation that referenced this pull request Oct 6, 2023
* 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 <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Remove generally

* Changed sampler initial note to mention BackendSampler

* Update docs/how_to/use_sampler.rst

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>

* Change hypothetical import to avoid confusion

Co-authored-by: Luciano Bello <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Luciano Bello <[email protected]>

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

Co-authored-by: Luciano Bello <[email protected]>

* Improve phrasing

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Elena Peña Tapia <[email protected]>
Co-authored-by: Luciano Bello <[email protected]>
Eric-Arellano pushed a commit to Qiskit/documentation that referenced this pull request Oct 9, 2023
* Add draft

* Remove qiskit

* Apply review

* Apply comments boxnote

* Small edit

* Apply review

* Update up to primitive ops

* Dump changes from sphinx repo

* Add twisties

* Update information, add examples

* Formatting changes

* Simplify intro

* Add links

* Add sampler example

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Steve Wood <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Update docs/migration_guides/opflow_migration.rst

Co-authored-by: Julien Gacon <[email protected]>

* Apply suggestions from code review

Co-authored-by: Julien Gacon <[email protected]>

* Update CircuitOp

Co-authored-by: Julien Gacon <[email protected]>

* Applied suggestions locally

* Change format, links

* Add grouping, algorithms link

* Fix indentation

* Final review, add links

* Add gradients

* Apply heading suggestions

Co-authored-by: Junye Huang <[email protected]>

* Add tags

* Apply suggestions code review

* Correct code examples, add outputs

* Run code examples by doctest

* Remove underscores

* Apply suggestions second round of review

Co-authored-by: Junye Huang <[email protected]>

* Add globals link

* Change links to refs

* Add dropdowns

* Change doctest syntax, apply reviews

* Try CI config

* Add internal links

* Fix lint, add doctest import

* Fix cyclic import

* Fix cyclic import

* Apply suggestions from Declan's code review

Co-authored-by: Declan Millar <[email protected]>

* Update qiskit/quantum_info/__init__.py

* Fix import

* Copy docs config from Qiskit/qiskit#9716

* Make black

* Remove duplicate

* Reorder

---------

Co-authored-by: Steve Wood <[email protected]>
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Declan Millar <[email protected]>
Eric-Arellano pushed a commit to Qiskit/documentation that referenced this pull request Oct 9, 2023
* 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 <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Remove generally

* Changed sampler initial note to mention BackendSampler

* Update docs/how_to/use_sampler.rst

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>

* Change hypothetical import to avoid confusion

Co-authored-by: Luciano Bello <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Luciano Bello <[email protected]>

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

Co-authored-by: Luciano Bello <[email protected]>

* Improve phrasing

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Elena Peña Tapia <[email protected]>
Co-authored-by: Luciano Bello <[email protected]>
Eric-Arellano pushed a commit to Qiskit/documentation that referenced this pull request Oct 9, 2023
* 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 <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Junye Huang <[email protected]>

* 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 <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Update docs/how_to/use_sampler.rst

Co-authored-by: Elena Peña Tapia <[email protected]>

* Remove generally

* Changed sampler initial note to mention BackendSampler

* Update docs/how_to/use_sampler.rst

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>

* Change hypothetical import to avoid confusion

Co-authored-by: Luciano Bello <[email protected]>

* Update docs/how_to/use_estimator.rst

Co-authored-by: Luciano Bello <[email protected]>

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

Co-authored-by: Luciano Bello <[email protected]>

* Improve phrasing

Co-authored-by: Luciano Bello <[email protected]>

* 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 <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Elena Peña Tapia <[email protected]>
Co-authored-by: Luciano Bello <[email protected]>
Eric-Arellano added a commit to Qiskit/documentation that referenced this pull request Oct 9, 2023
For some reason, this wasn't brought in via
#118. This uses `git
cherry-pick` to bring in the relevant commit.

Co-authored-by: Guillermo-Mijares-Vilarino <[email protected]>
Co-authored-by: Steve Wood <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Elena Peña Tapia <[email protected]>
Co-authored-by: Luciano Bello <[email protected]>
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
…skit#128)

For some reason, this wasn't brought in via
Qiskit#118. This uses `git
cherry-pick` to bring in the relevant commit.

Co-authored-by: Guillermo-Mijares-Vilarino <[email protected]>
Co-authored-by: Steve Wood <[email protected]>
Co-authored-by: Junye Huang <[email protected]>
Co-authored-by: Elena Peña Tapia <[email protected]>
Co-authored-by: Luciano Bello <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or an error documentation Intern PR PR submitted by IBM Quantum interns mod: primitives Related to the Primitives module stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a how-to guide example on terra
8 participants