This repository was archived by the owner on Aug 21, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
This repository was archived by the owner on Aug 21, 2023. It is now read-only.
Tutorial moving status #1473
Copy link
Copy link
Closed
Labels
documentationSomething is not clear or error in descriptionSomething is not clear or error in description
Description
As part of Qiskit/RFCs#41, we are planning to migrate qiskit-tutorials content to qiskit-terra. This issue assess the current status of the tutorials content and recommend actions. This is a draft. This list will be reformatted and linked with existing issues.
Quantum circuits -> moved to Terra
- qiskit intro, circuit_basics, and getting_started_with_qiskit are all very similar: write a "get started with Qiskit" tutorial qiskit#10315
- plotting_data_in_qiskit is replaced by api reference examples: Add common usage explanations and code examples to qiskit.visualization module level API reference page. qiskit#8567
- summary_of_quantum_operations is replaced by api reference examples: Add some explanation and example to circuit library documentation qiskit#7354
Advanced circuits -> moved to Terra
- advanced_circuits, more like api reference code examples or how-to guide, should be converted to those content type move as it is
- operators_overview, more like api reference code examples or how-to guide, should be converted to those content type move as it is
- advanced_circuit_visualization, most of the content is covered by one of the how-to guide here: Added how-to guides qiskit#8624
- transpiler_passes_and_passmanager, should be converted to a how-to guide move as it is
- pulse_gates, should be converted to a how-to guide move as it is
- building_pulse_schedules, should be converted to a how-to guide move as it is
- pulse_scheduler, should be converted to a how-to guide move as it is
- gathering_system_information, should be converted to a how-to guide. The content is about BackendV1, should be updated to BackendV2 equivalent: write a how-to: Obtaining information about a backend qiskit#10317
Classical simulators -> moved to Aer
- Already moved to Aer Add Tutorials to Documentation Page qiskit-aer#1768
Algorithms -> moved to qiskit-algorithms
The content in this section is pretty good. I recommend making the introduction notebook a full fledge tutorial with more hand holding and background information and convert all the other tutorials into how-to guides.
- algorithms_introduction: currently it's written more like a how to guide, can be improved to make it a full tutorial with more background information about quantum algorithms, especially variational algorithms. move as it is
- vqe_advanced_options: should be converted to a how-to guide move as it is
- vqe_simulation_with_noise: can be moved to Aer. We can link to it from algorithms_introduction tutorial. move as it is to Aer
- vqd: the content is good though I am not sure we want to highlight VQD specifically. should be converted to a how-to guide move as it is
- qaoa: should be converted to a how-to guide move as it is
- grover: written more like a tutorial. I would make it into a how-to guide and link to qiskit textbook / ibm quantum learning platform for the background information about grover's algorithm (as pre-requisites) move as it is
- grover_examples move as it is
- IQPE: written like a tutorial. This is more a textbook / learning platform material because IQPE is not a class in Qiskit. I would move it to textbook / learning platform if similar content doesn't exist yet. move as it is
- pvqd: should be converted to a how-to guide move as it is
- VarQTE
- gradients_framework
Operators -> moved to Terra, will be removed
As stated in Qiskit/qiskit#10666
- operator_flow: remove since optflow is deprecated.
- gradients_framework: remove since optflow is deprecated.
Sample algorithms in Qiskit
- IQPE: duplicate of IQPE in algorithms section, remove: Remove the "Sample algorithms in Qiskit" section, as it is duplicated #1479
Metadata
Metadata
Assignees
Labels
documentationSomething is not clear or error in descriptionSomething is not clear or error in description