Update README.md to include sampler and estimator #10584

jaygambetta · 2023-08-08T01:28:24Z

Summary

Details and comments

qiskit-bot · 2023-08-08T01:28:27Z

One or more of the the following people are requested to review this:

@Qiskit/terra-core

coveralls · 2023-08-08T02:34:15Z

Pull Request Test Coverage Report for Build 5880933220

0 of 0 changed or added relevant lines in 0 files are covered.
22 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.02%) to 87.244%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	4	91.14%
crates/qasm2/src/parse.rs	18	96.2%

Totals
Change from base Build 5876541463:	-0.02%
Covered Lines:	74289
Relevant Lines:	85151

💛 - Coveralls

1ucian0 · 2023-08-08T11:45:37Z

README.md

@@ -1,11 +1,11 @@
 # Qiskit Terra
 [![License](https://img.shields.io/github/license/Qiskit/qiskit-terra.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)<!--- long-description-skip-begin -->[![Release](https://img.shields.io/github/release/Qiskit/qiskit-terra.svg?style=popout-square)](https://github.com/Qiskit/qiskit-terra/releases)[![Downloads](https://img.shields.io/pypi/dm/qiskit-terra.svg?style=popout-square)](https://pypi.org/project/qiskit-terra/)[![Coverage Status](https://coveralls.io/repos/github/Qiskit/qiskit-terra/badge.svg?branch=main)](https://coveralls.io/github/Qiskit/qiskit-terra?branch=main)[![Minimum rustc 1.64.0](https://img.shields.io/badge/rustc-1.64.0+-blue.svg)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html)<!--- long-description-skip-end -->

-**Qiskit** is an open-source framework for working with noisy quantum computers at the level of pulses, circuits, and algorithms.
+**Qiskit**  is an open-source SDK for working with quantum computers at the level of extended quantum circuits, operators, and functions.


extended quantum circuits: I suspect this means dynamic quantum circuits (or just dynamic circuits). Otherwise, I'm unsure about its meaning. I quick search in the documentation did not help

operators: Maybe this can link to https://qiskit.org/documentation/stubs/qiskit.quantum_info.Operator.html ?

functions: Without context, this word is too generic. Suggestion: quantum primitives or just primitives? I prefer the first one as it is less generic.

We defined the extend quantum circuit in the openqasm and yes I agree we have lost this (I am not sure what version removed it) and we need to bring it back. It does includes dynamics etc. The good news is it is still in the description of qiskit.

Operators is the default way for working with quantum observables. They are an operator and we can call it quantum operators is you need (but there is too many quantums)

Functions are just the primitives and I want to keep it general you can put a quantum function there if need be.

See the definition of "extended quantum circuits" here: https://arxiv.org/abs/2104.14722 (second paragraph of the introduction).

Linking to the Operator docs in quantum_info would be fine, but the terms is unlikely to be confused with other meanings of "operator" in this context.

@jaygambetta's use of "functions" is perhaps novel. Can we just say "primitives" for now?

Im good with primitives but I do feel we need to own the visions of quantum functions as we go forward.

how do I edit it to primitives in the web version of GitHub. I see that I could just commit your other changes?

1ucian0 · 2023-08-08T11:49:36Z

Labeling as on hold as there is a chain of changes going on the README right now: mtreinish#19 is on top of #10530 .

README.md

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

README.md

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

README.md

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

1ucian0

Ready to merge. The rest of the open discussions can be followed in independent issues.

README.md

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

README.md

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

blakejohnson · 2023-08-19T11:40:27Z

We need a code owner to reapprove to merge.

abbycross · 2023-08-21T17:40:40Z

README.md


-This framework allows for building, transforming, and visualizing  quantum circuits. It also contains a compiler that supports
-different quantum computers and a common interface for running programs on different quantum computer architectures.
+This library is the core component of Qiskit, which contains the building blocks for creating and working with quantum circuits, quantum operators, and primitive functions (sampler and estimator).


Suggested change

This library is the core component of Qiskit, which contains the building blocks for creating and working with quantum circuits, quantum operators, and primitive functions (sampler and estimator).

This library is the core component of Qiskit, which contains the building blocks for creating and working with quantum circuits, quantum operators, and primitive functions (Sampler and Estimator).

abbycross · 2023-08-21T17:41:30Z

README.md

-This framework allows for building, transforming, and visualizing  quantum circuits. It also contains a compiler that supports
-different quantum computers and a common interface for running programs on different quantum computer architectures.
+This library is the core component of Qiskit, which contains the building blocks for creating and working with quantum circuits, quantum operators, and primitive functions (sampler and estimator).
+It also contains a transpiler that supports optimizing quantum circuits and a quantum information toolbox for creating advanced quantum operators. 


Any chance at least one of these "quantum"s in this sentence isn't necessary?

abbycross · 2023-08-21T17:43:15Z

README.md

+and see if you can achieve this outcome. (Spoiler alert: this is not possible!)
+
+Using the Qiskit-provided `qiskit.primitives.Sampler` and `qiskit.primitives.Estimator` will not take you very far. The power of quantum computing cannot be simulated 
+on classical computers and you need to use real quantum hardware to scale to larger quantum circuits. However, running a quantum 


Suggested change

on classical computers and you need to use real quantum hardware to scale to larger quantum circuits. However, running a quantum

on classical computers; you need real quantum hardware to scale to larger quantum circuits. However, running a quantum

abbycross · 2023-08-21T17:43:44Z

README.md

+
+Using the Qiskit-provided `qiskit.primitives.Sampler` and `qiskit.primitives.Estimator` will not take you very far. The power of quantum computing cannot be simulated 
+on classical computers and you need to use real quantum hardware to scale to larger quantum circuits. However, running a quantum 
+circuit on hardware requires rewriting them to the basis gates and connectivity of the quantum hardware.


Suggested change

circuit on hardware requires rewriting them to the basis gates and connectivity of the quantum hardware.

circuit on hardware requires rewriting to the basis gates and connectivity of the quantum hardware.

(the "them" was a little ambiguous but reads ok when just removing it)

abbycross · 2023-08-21T17:44:44Z

README.md


 ```python
-{'00': 513, '11': 511}
+from qiskit import transpile
+qc_transpiled = transpile(qc_example, basis_gates = ['cz', 'sx', 'rz'], coupling_map =[[0, 1], [1, 2]] , optimization_level=3)
 ```

 For further examples of using Qiskit you can look at the tutorials in the documentation here:


Suggested change

For further examples of using Qiskit you can look at the tutorials in the documentation here:

For further examples, visit the tutorials in the documentation here:

blakejohnson · 2023-08-21T18:22:38Z

@abbycross this is now merged, so perhaps open a new PR with your edits?

abbycross · 2023-08-21T18:23:52Z

@abbycross this is now merged, so perhaps open a new PR with your edits?

Will do -- I guess it wasn't kidding when it said it would auto-merge once all requirements are met 😆

* Update README.md to include sampler and estimator * Update README.md * Update README.md * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md * Update README.md * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: abbycross <across@us.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md * Update README.md * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> * Update README.md Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Apply suggestions from code review Co-authored-by: Matthew Treinish <mtreinish@kortar.org> * Apply suggestions from code review * new example * Update README.md Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> * Update README.md Co-authored-by: Matthew Treinish <mtreinish@kortar.org> --------- Co-authored-by: Blake Johnson <blakejohnson04@gmail.com> Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com> Co-authored-by: abbycross <across@us.ibm.com> Co-authored-by: Luciano Bello <bel@zurich.ibm.com> Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

Update README.md to include sampler and estimator

4107156

jaygambetta requested a review from a team as a code owner August 8, 2023 01:28

jaygambetta added 2 commits August 7, 2023 21:57

Update README.md

4a185e1

Update README.md

8a35507

1ucian0 reviewed Aug 8, 2023

View reviewed changes

1ucian0 added the on hold Can not fix yet label Aug 8, 2023

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

jaygambetta and others added 5 commits August 8, 2023 09:14

Update README.md

b0b9b54

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

Update README.md

f6a1e51

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

Update README.md

fb6e69b

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

Update README.md

e9f2e6e

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

Update README.md

bd39ef3

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

jaygambetta and others added 3 commits August 8, 2023 09:18

Update README.md

6b4ad11

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

Update README.md

37c45b1

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

Update README.md

40148a4

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

blakejohnson reviewed Aug 8, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

jaygambetta and others added 2 commits August 8, 2023 09:20

Update README.md

970cc63

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

Update README.md

2da714f

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

blakejohnson previously approved these changes Aug 14, 2023

View reviewed changes

Merge branch 'main' into jaygambetta-patch-1

de7ae3e

1ucian0 dismissed blakejohnson’s stale review via de7ae3e August 16, 2023 08:56

new example

bae8154

1ucian0 previously approved these changes Aug 16, 2023

View reviewed changes

1ucian0 enabled auto-merge August 16, 2023 11:00

1ucian0 added this pull request to the merge queue Aug 16, 2023

blakejohnson reviewed Aug 16, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 16, 2023

Update README.md

0d6bc53

Co-authored-by: Blake Johnson <blakejohnson04@gmail.com>

1ucian0 dismissed their stale review via 0d6bc53 August 16, 2023 13:54

1ucian0 enabled auto-merge August 16, 2023 13:54

mtreinish reviewed Aug 16, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

e42821f

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>

blakejohnson approved these changes Aug 19, 2023

View reviewed changes

1ucian0 approved these changes Aug 21, 2023

View reviewed changes

1ucian0 added this pull request to the merge queue Aug 21, 2023

abbycross reviewed Aug 21, 2023

View reviewed changes

Merged via the queue into main with commit 59223e3 Aug 21, 2023
16 checks passed

blakejohnson deleted the jaygambetta-patch-1 branch August 21, 2023 18:22

abbycross mentioned this pull request Aug 23, 2023

Minor updates to the readme language #10701

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README.md to include sampler and estimator #10584

Update README.md to include sampler and estimator #10584

jaygambetta commented Aug 8, 2023

qiskit-bot commented Aug 8, 2023

coveralls commented Aug 8, 2023 •

edited

1ucian0 Aug 8, 2023

jaygambetta Aug 8, 2023

blakejohnson Aug 8, 2023

jaygambetta Aug 8, 2023

jaygambetta Aug 8, 2023

jaygambetta Aug 8, 2023

1ucian0 commented Aug 8, 2023

1ucian0 left a comment

blakejohnson commented Aug 19, 2023

abbycross Aug 21, 2023

abbycross Aug 21, 2023

abbycross Aug 21, 2023

abbycross Aug 21, 2023

abbycross Aug 21, 2023

abbycross Aug 21, 2023

blakejohnson commented Aug 21, 2023

abbycross commented Aug 21, 2023

	This library is the core component of Qiskit, which contains the building blocks for creating and working with quantum circuits, quantum operators, and primitive functions (sampler and estimator).
	This library is the core component of Qiskit, which contains the building blocks for creating and working with quantum circuits, quantum operators, and primitive functions (Sampler and Estimator).

	on classical computers and you need to use real quantum hardware to scale to larger quantum circuits. However, running a quantum
	on classical computers; you need real quantum hardware to scale to larger quantum circuits. However, running a quantum

	circuit on hardware requires rewriting them to the basis gates and connectivity of the quantum hardware.
	circuit on hardware requires rewriting to the basis gates and connectivity of the quantum hardware.

	For further examples of using Qiskit you can look at the tutorials in the documentation here:
	For further examples, visit the tutorials in the documentation here:

Update README.md to include sampler and estimator #10584

Update README.md to include sampler and estimator #10584

Conversation

jaygambetta commented Aug 8, 2023

Summary

Details and comments

qiskit-bot commented Aug 8, 2023

coveralls commented Aug 8, 2023 • edited

Pull Request Test Coverage Report for Build 5880933220

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ucian0 commented Aug 8, 2023

1ucian0 left a comment

Choose a reason for hiding this comment

blakejohnson commented Aug 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blakejohnson commented Aug 21, 2023

abbycross commented Aug 21, 2023

coveralls commented Aug 8, 2023 •

edited