Workbench Algorithms Documentation Map¶
Workbench Algorithms documentation includes several types of learning materials, focused on different learning scenarios.
Tutorials¶
Tutorials are lessons that provide a basic introduction to a certain topic. They focus on introducing the basics of using a group of Workbench Algorithms Qubricks and the main features and subroutines it provides.
Workbench Algorithms tutorials are organized into several sections by topic, such as data loading, state preparation, quantum phase estimation, and so on. There is no recommended order of reading these sections; feel free to choose whichever section looks most useful for your goals!
Experimental tutorials¶
Experimental tutorials cover experimental Qubricks - Qubricks that are still in the process of development, validation, and/or optimization. These Qubricks are located under a different namespace (workbench_algorithms.experimental instead of workbench_algorithms). You can use them same as you would use non-experimental Qubricks, with the expectation that experimental code can be modified, restructured, or deleted without notice.
Once Qubrick development and validation is complete, it is moved out of the
experimentalspace into Workbench Algorithms proper.
Qubricks index¶
The Qubricks index page serves as a reference for all Qubricks, experimental or not, implemented in Workbench Algorithms. It lists every Qubrick alongside a short description of its purpose, a link to its API reference and links to any tutorial notebooks that mention it.
API reference¶
Workbench Algorithms Python API reference offers the detailed API reference for the Qubricks and utilities provided by Workbench Algorithms.
Other learning materials¶
- End-to-end tutorials in Construct documentation ⧉ show you how to use Workbench as part of the complete workflow of developing a quantum program, from a high-level circuit to code complete with tests and resource estimates.
- Workbench documentation ⧉ offers an introduction to Workbench.