Skip to content

Commit 605448b

Browse files
kt474ElePT
andauthored
Update readme (#2286)
* 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>
1 parent c216883 commit 605448b

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,28 @@ pip install qiskit-ibm-runtime
3333
| :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)
3434
|:---------------------------|
3535

36+
### Qiskit Runtime service on IBM Quantum Platform Classic (deprecated)
37+
3638
You will need your IBM Quantum API token to authenticate with the runtime service:
3739

3840
1. Create an IBM Quantum account or log in to your existing account by visiting the [IBM Quantum login page].
3941

4042
2. Copy (and optionally regenerate) your API token from your
4143
[IBM Quantum account page].
4244

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].
4454

4555
The runtime service is now part of the IBM Quantum Services on IBM Cloud. To use this service, you'll
4656
need to create an IBM Cloud account and a quantum service instance.
47-
[This guide](https://cloud.ibm.com/docs/quantum-computing?topic=quantum-computing-get-started)
57+
[This guide](https://quantum.cloud.ibm.com/docs/migration-guides/classic-iqp-to-cloud-iqp)
4858
contains step-by-step instructions, including how to find your
4959
IBM Cloud API key and Cloud Resource Name (CRN), which you will need for authentication.
5060

@@ -81,7 +91,7 @@ Alternatively, the service can discover credentials from environment variables:
8191
```bash
8292
export QISKIT_IBM_TOKEN="MY_IBM_CLOUD_API_KEY"
8393
export QISKIT_IBM_INSTANCE="MY_IBM_CLOUD_CRN"
84-
export QISKIT_IBM_CHANNEL="ibm_cloud"
94+
export QISKIT_IBM_CHANNEL="ibm_quantum_platform"
8595
```
8696

8797
Then instantiate the service without any arguments:
@@ -99,7 +109,7 @@ service with your credentials.
99109
from qiskit_ibm_runtime import QiskitRuntimeService
100110

101111
# For an IBM Cloud account.
102-
ibm_cloud_service = QiskitRuntimeService(channel="ibm_cloud", token="MY_IBM_CLOUD_API_KEY", instance="MY_IBM_CLOUD_CRN")
112+
ibm_cloud_service = QiskitRuntimeService(channel="ibm_quantum_platform", token="MY_IBM_CLOUD_API_KEY", instance="MY_IBM_CLOUD_CRN")
103113
```
104114

105115
## Primitives
@@ -277,35 +287,41 @@ This code returns `Job result is [4.] at theta = 1.575674623307102` using only n
277287

278288
## Instances
279289

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.
281293
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).
283295

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.
285299

286300
You can specify an instance when initializing the service or provider, or when picking a backend:
287301

288302
```python
289303
# Optional: List all the instances you can access.
290-
service = QiskitRuntimeService(channel='ibm_cloud')
304+
service = QiskitRuntimeService(channel='ibm_quantum_platform')
291305
print(service.instances())
292306

293307
# 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")
295309
backend1 = service.backend("ibmq_manila")
296310

297311
# Optional: Specify the instance at the backend level, which overwrites the service-level specification when this backend is used.
298-
backend2 = service.backend("ibmq_manila", instance="IBM_CLOUD_INSTANCE")
312+
backend2 = service.backend("ibmq_manila", instance="IBM_CLOUD_INSTANCE_2")
299313

300-
sampler1 = Sampler(mode=backend1) # this will use hub1/group1/project1
301-
sampler2 = Sampler(mode=backend2) # this will use hub2/group2/project2
314+
sampler1 = Sampler(mode=backend1) # IBM_CLOUD_INSTANCE_1
315+
sampler2 = Sampler(mode=backend2) # IBM_CLOUD_INSTANCE_2
302316
```
303317

304318
If you do not specify an instance, then the code will select one in the following order:
305319

306320
1. If your account only has access to one instance, it is selected by default.
307321
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.
309325

310326
## Access your IBM Quantum backends
311327

@@ -353,9 +369,11 @@ If you use Qiskit, please cite as per the included [BibTeX file](https://github.
353369
[Apache License 2.0].
354370

355371

356-
[IBM Quantum]: https://www.ibm.com/quantum/
357372
[IBM Quantum login page]: https://quantum.ibm.com/login
358373
[IBM Quantum account page]: https://quantum.ibm.com/account
374+
[IBM Quantum classic]: https://www.ibm.com/quantum/
375+
[New IBM Quantum Platform login page]: https://quantum.cloud.ibm.com/
376+
[IBM Cloud account page]: https://cloud.ibm.com/iam/apikeys
359377
[contribution guidelines]: https://github.com/Qiskit/qiskit-ibm-runtime/blob/main/CONTRIBUTING.md
360378
[code of conduct]: https://github.com/Qiskit/qiskit-ibm-runtime/blob/main/CODE_OF_CONDUCT.md
361379
[GitHub issues]: https://github.com/Qiskit/qiskit-ibm-runtime/issues

0 commit comments

Comments
 (0)