Add "Get started" tutorial #10328
Add "Get started" tutorial #10328
Conversation
Pull Request Test Coverage Report for Build 5869258713
💛 - Coveralls |
There was a problem hiding this comment.
Thanks for the speedy work on this @frankharkins!
The main general comment I have is that I think there could be a smidge more detail. Atm this feels more like a how to guide than a tutorial (not sure if anyone's showed you this yet but we have a docs guide here that breaks down the difference). I know we don't want to go too much down the rabbit hole of teaching quantum computing with these tutorials but I think we could give a bit more detail than whats currently here. One example of a tutorial that I think strikes the right balance is this one on QPE from the runtime docs. I think something similar here, giving some context on what the bell state actually is, would be good. Also would be good to add a pre-requisites section that links people to the installation page (see tutorial guidelines [here])(https://qiskit.github.io/qiskit_sphinx_theme/tutorials/tutorials_guidelines.html))
|
one additional point, the existing getting started tutorial gives a helpful tip about how the qubit ordering is reversed, I think it would be good to do something similar here, or possibly just mention it briefly and then share a link to the more detailed explanation (not deployed yet, also there is an open PR/discussion on this that you might like to take over or weigh in on) |
javabster
added
the
documentation
* Mention Qiskit and IBM Qiskit Runtime * Improve flow * Mention little-endianess Co-authored-by: Abby Mitchell <[email protected]>
Co-authored-by: Abby Mitchell <[email protected]>
|
One or more of the the following people are requested to review this:
|
…-get-started-tutorial
Co-authored-by: abbycross <[email protected]> Co-authored-by: Abby Mitchell <[email protected]>
…kins/qiskit-terra into fh-get-started-tutorial
…kins/qiskit-terra into fh-get-started-tutorial
…-get-started-tutorial
Eric-Arellano
added
stable backport potential
There was a problem hiding this comment.
This looks fine to me, I'm not super keen on using a notebook for this, it makes it a lot harder to review and interact with but that's not a strong objection. I left a few comments inline about the content but nothing major.
The other question is about the "Quantum computing in a nutshell" guide, that is being removed here, but this new document isn't a replacement for that information; it only replaces the intro tutorial (and moves to using the sampler). Is there a plan to replace that guide with some of the higher level background info about quantum computing?
docs/get_started_with_qiskit.ipynb
Outdated
| "tags": [] | ||
| }, | ||
| "source": [ | ||
| "You can use the :func:`~.visualization.plot_histogram` function to plot your `Sampler` results. This function returns a MatPlotLib `Figure`, which displays nicely in Jupyter notebooks. For more ways to display results, see `Qiskit visualizations <https://qiskit.org/documentation/tutorials/circuits/2_plotting_data_in_qiskit.html>`__." |
There was a problem hiding this comment.
If we're in rst space can we use references instead of external links? If we can that'll be a bit more robust for different builds of the documentation.
There was a problem hiding this comment.
I don't think this is possible until #10710 is merged
|
@mtreinish thank you!
I also don't have a strong opinion; I did ask which format to use before writing and the answers were pretty evenly divided.
I believe the plan is not to replace this, instead pointing people to the learning platform (source). |
Summary
Adds a new "Get started with Qiskit" tutorial to replace the three existing introduction tutorials.
Details and comments
Topics breakdown
Here's the topics I could see covered in the existing tutorials. Strikethough means I chose not to include it in the new tutorial.
General Qiskit workflow
Compile for deviceAnalyze results(although I do showplot_histogram)QuantumCircuit
hcxmeasuredrawSimulating
quantum_info.StatevectorAerSimulatorstate vector vs qasm vs other simulators.result.get_counts/.get_memoryOther important classes / functions
plot_histogramshotsparametertranspileBasicAerSettingsChange default circuit drawerGeneral quantum computingDefault state of qubitsQubit orderingWhat a circuit isThis notebook contains raw reST cells, which don't display in GitHub's built-in notebook viewer. For example this cell is hidden. This could be a downside of using notebooks with ReST cells.
Closes #10315, closes #10613