Skip to content

Commit

Permalink
Prepare release 0.1.0 (#162)
Browse files Browse the repository at this point in the history
* Prepare release 0.1

* Add prelude for 0.1.0 release

* Add release note for renaming get_backend to backend

* Fix broken links

* Add release note for BackendV2

* Update tutorials

* Fix execution count

* Add release note for new RuntimeOptions class

* Add release note explaining new ability to authenticate using IBM Cloud

* Add release note to explain new features in account management

* Add release note about automatic hgp selection
  • Loading branch information
rathishcholarajan authored Feb 25, 2022
1 parent 312f971 commit 4706575
Show file tree
Hide file tree
Showing 27 changed files with 174 additions and 74 deletions.
103 changes: 48 additions & 55 deletions docs/tutorials/01_introduction_cloud_runtime.ipynb

Large diffs are not rendered by default.

5 changes: 1 addition & 4 deletions qiskit_ibm_runtime/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@
# Set the "sampler" program parameters
params = service.program(program_id="sampler").parameters()
params.circuits = qc
params.use_measurement_mitigation = True
# Configure backend options
options = {'backend_name': backend}
Expand All @@ -100,9 +99,7 @@
# Get runtime job result.
result = job.result()
The example above invokes the ``sampler`` program,
which compiles, executes, and optionally applies measurement error mitigation to
the circuit result.
The example above invokes the ``sampler`` program.
Runtime Jobs
------------
Expand Down
1 change: 0 additions & 1 deletion qiskit_ibm_runtime/ibm_runtime_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ class IBMRuntimeService:
# Set the "sampler" program parameters
params = service.program(program_id="sampler").parameters()
params.circuits = qc
params.use_measurement_mitigation = True
# Configure backend options
options = {'backend_name': backend}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
upgrade:
- |
`qiskit-ibm-runtime` package no longer uses the `$HOME/.qiskit/qiskitrc` file used by
`qiskit-ibmq-provider` to save credentials. Credentials are now stored in a
JSON format in `$HOME/.qiskit/qiskit-ibm.json` file when you use
:meth:`qiskit_ibm_runtime.IBMRuntimeService.save_account` method.
You can now save multiple credentials and give an optional `name` for each credential.
15 changes: 15 additions & 0 deletions releasenotes/notes/0.1/authentication-79b90822d430688f.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
upgrade:
- |
Qiskit Runtime service is accessible using an IBM Quantum (`legacy`) account
or an IBM Cloud (`cloud`) account.
`qiskit-ibm-runtime` enables you to connect to either of these accounts::
# Legacy
from qiskit_ibm_runtime import IBMRuntimeService
service = IBMRuntimeService(auth="legacy", token="abc")
# Cloud
from qiskit_ibm_runtime import IBMRuntimeService
service = IBMRuntimeService(auth="cloud", token="abc", instance="IBM Cloud CRN or Service instance name")
18 changes: 18 additions & 0 deletions releasenotes/notes/0.1/backend-v2-15bbe03ff572b6da.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
upgrade:
- |
:class:`qiskit_ibm_runtime.IBMBackend` class now implements the
:class:`qiskit.providers.BackendV2` interface and provides flatter access to the configuration
of a backend, for example::
# BackendV1:
backend.configuration().n_qubits
# BackendV2:
backend.num_qubits
Only breaking change when compared to `BackendV1` is backend.name is now an attribute
instead of a method.
Refer to the :class:`qiskit_ibm_runtime.IBMBackend` class doc string for a list of all
available attributes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
upgrade:
- |
If you used `qiskit.providers.ibmq.AccountProvider.get_backend` method (for example,
``provider.get_backend("ibmq_qasm_simulator")``) in the `qiskit-ibmq-provider` package, it's
equivalent method in this new package is :meth:`qiskit_ibm_runtime.IBMRuntimeService.backend`::
service = IBMRuntimeService()
backend = service.backend("ibmq_qasm_simulator")
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
fixes:
- |
:class:`qiskit_ibm_runtime.utils.json.RuntimeEncoder` and
:class:`qiskit_ibm_runtime.utils.json.RuntimeDecoder` have been updated to handle
instances of the `Instruction` class.
5 changes: 5 additions & 0 deletions releasenotes/notes/0.1/least-busy-4a7040c00f605635.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
features:
- |
:meth:`qiskit_ibm_runtime.IBMRuntimeService.least_busy` will now allow you find
the least busy backend.
14 changes: 14 additions & 0 deletions releasenotes/notes/0.1/legacy-optional-hgp-299a0fd8ee029734.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
upgrade:
- |
It is now optional to specify a hub/group/project upfront when connecting to the `legacy` IBM
Quantum account. The hub/group/project is selected in the following order.
- hub/group/project if passed via ``instance`` parameter when initializing
:class:`qiskit_ibm_runtime.IBMRuntimeService`
- the specific hub/group/project required by the backend specified when
calling :meth:`qiskit_ibm_runtime.IBMRuntimeService.run`
- the default set previously via :meth:`qiskit_ibm_runtime.IBMRuntimeService.save_account`
- a premium hub/group/project in your account
- open access hub/group/project
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
fixes:
- |
Fixed an issue where numpy ndarrays with object types could not be
serialized. :class:`qiskit_ibm_runtime.utils.json.RuntimeEncoder` and
:class:`qiskit_ibm_runtime.utils.json.RuntimeDecoder` have been updated
to handle these ndarrays.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
upgrade:
- |
It is now optional to specify `backend_name` in `options` when executing
:meth:`qiskit_ibm_runtime.IBMRuntimeService.run` method when using `cloud` runtime
(IBM Cloud only). The server will automatically pick a backend and return the name.
13 changes: 13 additions & 0 deletions releasenotes/notes/0.1/prelude-96ed7aae53f9932a.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
prelude: >
`qiskit-ibm-runtime` is a new Python API client for accessing the quantum programs,
systems and simulators at IBM Quantum via the Qiskit Runtime Service.
This new package is built upon the work already done in `qiskit.providers.ibmq.runtime`
module in the `qiskit-ibmq-provider` package and replaces it going forward. The `runtime`
module in `qiskit-ibmq-provider` package is now deprecated.
`qiskit-ibm-runtime` is not included as part of `Qiskit` meta package and thereby you have to
install it separately using ``pip install qiskit-ibm-runtime``.
5 changes: 5 additions & 0 deletions releasenotes/notes/0.1/remove-logout-207163e4d4a6adf8.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
upgrade:
- |
`qiskit.providers.ibmq.runtime.IBMRuntimeService.logout` method in `qiskit-ibmq-provider`
which was used to clear authorization cache on the server has been removed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
upgrade:
- |
Python 3.6 has reached end of life and will no longer be supported in the new
`qiskit-ibm-runtime` package.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
upgrade:
- |
`qiskit.providers.ibmq.runtime.IBMRuntimeService.run_circuits` method in `qiskit-ibmq-provider`
has been removed and will be replaced by the ``Sampler`` primitive program.
7 changes: 7 additions & 0 deletions releasenotes/notes/0.1/runtime-options-175692ee0417ff30.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
upgrade:
- |
:meth:`qiskit_ibm_runtime.IBMRuntimeService.run` method now accepts runtime
execution options as :class:`qiskit_ibm_runtime.RuntimeOptions` class in addition to
already supported Dict. `backend_name`, `image` and `log_level` are the
currently available options.
6 changes: 0 additions & 6 deletions releasenotes/notes/encoder-instructions-f99e128a02a10714.yaml

This file was deleted.

This file was deleted.

0 comments on commit 4706575

Please sign in to comment.