You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* update readme
* remove "other"
* address comments
* Use "the new IQP" when possible
* use ibm_quantum_platform
---------
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
| :warning: The ibm_quantum channel option is deprecated and will be sunset on 1 July. For help migrating to the ibm_cloud channel, read the [migration guide.](https://quantum.cloud.ibm.com/docs/migration-guides/classic-iqp-to-cloud-iqp)
34
34
|:---------------------------|
35
35
36
+
### Qiskit Runtime service on IBM Quantum Platform Classic (deprecated)
37
+
36
38
You will need your IBM Quantum API token to authenticate with the runtime service:
37
39
38
40
1. Create an IBM Quantum account or log in to your existing account by visiting the [IBM Quantum login page].
39
41
40
42
2. Copy (and optionally regenerate) your API token from your
41
43
[IBM Quantum account page].
42
44
43
-
### Qiskit Runtime service on IBM Cloud
45
+
46
+
### Qiskit Runtime service on the new IBM Quantum Platform (IBM Cloud)
47
+
48
+
You will need your IBM Quantum Platform API token to authenticate with the runtime service:
49
+
50
+
1. Create an IBM Quantum Platform account or log in to your existing account by visiting the [IBM Quantum Platform login page].
51
+
52
+
2. Copy (and optionally regenerate) your API token from your
53
+
[IBM Cloud account page].
44
54
45
55
The runtime service is now part of the IBM Quantum Services on IBM Cloud. To use this service, you'll
46
56
need to create an IBM Cloud account and a quantum service instance.
@@ -277,35 +287,41 @@ This code returns `Job result is [4.] at theta = 1.575674623307102` using only n
277
287
278
288
## Instances
279
289
280
-
Access to IBM Quantum Platform channel is controlled by the instances (previously called providers) to which you are assigned. An instance is defined by a hierarchical organization of hub, group, and project. A hub is the top level of a given hierarchy (organization) and contains within it one or more groups. These groups are in turn populated with projects. The combination of hub/group/project is called an instance. Users can belong to more than one instance at any time.
290
+
For the now deprecated `ibm_quantum` channel, access is controlled by the instances (previously called providers) to which you are assigned. An instance is defined by a hierarchical organization of hub, group, and project. A hub is the top level of a given hierarchy (organization) and contains within it one or more groups. These groups are in turn populated with projects. The combination of hub/group/project is called an instance. Users can belong to more than one instance at any time.
291
+
292
+
> **_NOTE:_** the new IBM Quantum Platform (IBM Cloud) instances are different from IBM Quantum classic instances. IBM Cloud does not use the hub/group/project structure for user management.
281
293
282
-
> **_NOTE:_**IBM Cloud instances are different from IBM Quantum Platform classic instances. IBM Cloud does not use the hub/group/project structure for user management. To view and create IBM Cloud instances, visit the [IBM Cloud Quantum Instances page](https://cloud.ibm.com/quantum/instances).
294
+
On the new IBM Quantum platform, instances are virtual servers that manage your workload execution, including executing quantum programs and classical compute tasks (such as processing error mitigation). Instances are specified by their Cloud Resource Name (CRN).
283
295
284
-
To view a list of your instances, visit your [account settings page](https://www.quantum.ibm.com/account) or use the `instances()` method.
296
+
You can see the instances you have access to on the [dashboard](https://quantum.cloud.ibm.com/) or by clicking the [Instances tab](https://quantum.cloud.ibm.com/instances) from the dashboard. Each instance is listed with its CRN identifier. You can include this identifier or the name of the instance when initializing the `QiskitRuntimeService` or saving your account. When an instance is passed in, only backends and jobs from that instance are available. Alternatively, if an instance is not included, then all backends and jobs across all instances in your account are available. In this case, when a backend is specified, an instance with the backend available will be used.
297
+
298
+
To view a list of your instances, you can also use the `instances()` method.
285
299
286
300
You can specify an instance when initializing the service or provider, or when picking a backend:
287
301
288
302
```python
289
303
# Optional: List all the instances you can access.
290
-
service = QiskitRuntimeService(channel='ibm_cloud')
304
+
service = QiskitRuntimeService(channel='ibm_quantum_platform')
291
305
print(service.instances())
292
306
293
307
# Optional: Specify the instance at service level. This becomes the default unless overwritten.
294
-
service = QiskitRuntimeService(channel='ibm_cloud', instance="IBM_CLOUD_INSTANCE")
308
+
service = QiskitRuntimeService(channel='ibm_quantum_platform', instance="IBM_CLOUD_INSTANCE_1")
295
309
backend1 = service.backend("ibmq_manila")
296
310
297
311
# Optional: Specify the instance at the backend level, which overwrites the service-level specification when this backend is used.
If you do not specify an instance, then the code will select one in the following order:
305
319
306
320
1. If your account only has access to one instance, it is selected by default.
307
321
2. If your account has access to multiple instances, but only one can access the requested backend, the instance with access is selected.
308
-
3. In all other cases, the code selects the first instance other than ibm-q/open/main that has access to the backend.
322
+
3. In all other cases, the code selects the first instance that has access to the backend.
323
+
324
+
Priority of instance order can also be set with the ``region`` and ``plans_preference`` parameters. The official [release notes](https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/release-notes#0400-2025-05-28) have examples on how these values can be used.
309
325
310
326
## Access your IBM Quantum backends
311
327
@@ -353,9 +369,11 @@ If you use Qiskit, please cite as per the included [BibTeX file](https://github.
0 commit comments