-
Notifications
You must be signed in to change notification settings - Fork 114
Add new FAQ about metapackage and include install snippets to intro #2516
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c803aa5
Add new FAQ about metapackage and install snippets
kaelynj ca237f9
Apply suggestions from code review
kaelynj 9e28571
Apply suggestions from code review
kaelynj 3c4a286
Address review comments
kaelynj ce9630e
Merge branch 'main' of github.com:Qiskit/documentation into kjf/insta…
kaelynj b7d254c
Apply suggestions from code review
kaelynj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,14 @@ Some of the most useful features of the Qiskit SDK include: | |
|
||
- **Primitives** ([`qiskit.primitives`](/api/qiskit/primitives)) - The module that contains the base definitions and reference implementations of the Sampler and Estimator primitives, from which different quantum hardware providers can derive their own implementations. See more information about the Qiskit Runtime primitives [in the documentation](./primitives). | ||
|
||
### Installation | ||
|
||
For a more detailed introduction to installing the Qiskit SDK, check out the [installation page](./install-qiskit). If you're ready to install it now, simply run: | ||
|
||
```bash | ||
pip install qiskit | ||
``` | ||
|
||
### Benchmarking and the Benchpress package | ||
|
||
Benchmarking is important for comparing the relative performance of quantum software across different stages of a development workflow. Benchmarking tests for quantum software might, for example, look at the speed and quality of building, manipulating, and transpiling circuits. IBM Quantum is committed to delivering the most performant SDK possible, and to that end, the Qiskit SDK is benchmarked using over 1,000 tests developed by leading universities, national labs, and researchers at IBM. The benchmarking suite used for these tests, named Benchpress, is now available as [an open-source package](https://github.com/qiskit/benchpress). You can now use the Benchpress package to perform your own analysis of quantum SDK performance. | ||
|
@@ -44,6 +52,13 @@ Qiskit Runtime is designed to use additional classical and quantum compute resou | |
|
||
Qiskit Runtime also includes three types of execution modes for running your quantum program on IBM hardware: _Job_, _Session_, and _Batch_, each of which have different use cases and implications for the quantum job queue. A Job is a single query to a primitive that can be run over a specified number of shots. [Sessions](./sessions) allow you to efficiently run multiple jobs in iterative workloads on quantum computers. [Batch mode](./run-jobs-batch) allows you to submit all your jobs at once for parallel processing. | ||
|
||
To quickly install Qiskit Runtime, run the following command | ||
```bash | ||
pip install qiskit-ibm-runtime | ||
``` | ||
|
||
More details on setting up a development environment for building quantum programs can be found in the [installation page](./install-qiskit). | ||
|
||
### Is Qiskit Runtime open-source? | ||
The short answer is, _not all of it_. The Qiskit Runtime service software that handles the technicalities of running your quantum program on an IBM Quantum device (including any error mitigation and suppression) is **not** open-source. However, the Qiskit Runtime client (the interface for users to access the Qiskit Runtime service), the Qiskit SDK running on the server side, and some of the software used for error mitigation, **are** open-source. To get involved with the Qiskit open-source efforts, visit our GitHub organization at [github.com/Qiskit](https://github.com/Qiskit) and [github.com/Qiskit-Extensions](https://github.com/Qiskit-Extensions/). | ||
|
||
|
@@ -55,6 +70,11 @@ Creating utility-scale quantum applications generally requires a variety of comp | |
- Persist long-running workloads in the cloud, even if your laptop is turned off | ||
- Deploy reusable programs in the cloud | ||
|
||
To start using Qiskit Serverless right away, install it with pip: | ||
```bash | ||
pip install qiskit_serverless | ||
``` | ||
|
||
|
||
## Qiskit Functions | ||
|
||
|
@@ -65,13 +85,45 @@ Qiskit Functions (`qiskit-ibm-catalog.QiskitFunctionsCatalog`) are abstracted se | |
|
||
Premium Plan members can access IBM-provided functions right away, or purchase licenses for the partner-provided functions directly from those partners. | ||
|
||
The catalog can be installed with pip: | ||
```bash | ||
pip install qiskit-ibm-catalog | ||
``` | ||
|
||
## Qiskit Transpiler as a Service | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. shouldn't we also include some pip install commands for the transpiler service and addons? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just added install commands for them |
||
The Qiskit Transpiler Service ([package name `qiskit-ibm-transpiler`](https://pypi.org/project/qiskit-ibm-transpiler/)) is a new experimental service that provides remote transpilation capabilities on the cloud to IBM Quantum Premium Plan users. In addition to the local Qiskit SDK transpiler capabilities, your transpilation tasks can benefit from both IBM Quantum cloud resources and AI-powered transpiler passes using this service. To learn more about how to integrate cloud-based transpilation into your Qiskit workflow you can [check out the documentation](./qiskit-transpiler-service). | ||
|
||
The transpiler service can be installed with pip: | ||
```bash | ||
pip install qiskit-ibm-transpiler | ||
``` | ||
|
||
## Qiskit addons | ||
|
||
Qiskit addons are a collection of research capabilities for utility-scale algorithm discovery. These capabilities build upon Qiskit’s performant foundation of tools for creating and running quantum algorithms. Addons are modular software components that plug into a workflow to scale or design new quantum algorithms. To learn more about the set of available Qiskit addons and how to get started using them, visit the [documentation](/guides/addons). | ||
|
||
There are a number of addons depending on what research capability you are interested in. Each of them can be installed with pip. | ||
|
||
[Sample-based quantum diagonalization (SQD)](/guides/qiskit-addons-sqd): | ||
```bash | ||
pip install qiskit-addon-sqd | ||
``` | ||
|
||
[Approximate quantum compilation (AQC)](/guides/qiskit-addons-aqc): | ||
```bash | ||
pip install qiskit-addon-aqc-tensor[quimb-jax] | ||
``` | ||
|
||
[Operator backpropagation (OBP)](/guides/qiskit-addons-obp): | ||
```bash | ||
pip install qiskit-addon-obp | ||
``` | ||
|
||
[Multi-product formulas (MPF)](/guides/qiskit-addons-mpf): | ||
```bash | ||
pip install qiskit-addon-mpf | ||
``` | ||
|
||
## The Qiskit ecosystem | ||
|
||
Beyond Qiskit there are many open-source projects that use the "Qiskit" name but are not part of Qiskit itself; rather, they interface with Qiskit and can provide valuable additional functionality to supplement the core Qiskit workflow. Some of these projects are maintained by IBM Quantum teams, whereas others are supported by the broader open-source community. The Qiskit SDK is designed in a modular, extensible way to make it easy for developers to create projects like these that extend its capabilities. | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should be more explicit here and warn people that since March 2024 (or whatever date we released the metapackage change) the command
pip install qiskit
will only install the Qiskit SDK (and link to the github repo), not the other packages.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added another couple sentences at the beginning of this section. Let me know if it seems sufficient!