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
Copy file name to clipboardExpand all lines: docs/guides/cloud-setup.mdx
+6-3Lines changed: 6 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -49,21 +49,24 @@ Your user account is associated with one or more [instances](./instances) that g
49
49
50
50
1. Find your access credentials.
51
51
1. Find your API key. From the [dashboard](https://quantum.cloud.ibm.com/), create your API key, then copy it to a secure location so you can use it for authentication.
52
-
2. Find your CRN from the Instances section of the dashboard. Click the icon to copy your CRN for the instance you want to use, then save it in a secure location so you can use it for authentication.
52
+
2.Optional: Find your CRN from the Instances section of the dashboard. Click the icon to copy your CRN for the instance you want to use, then save it in a secure location so you can use it to identify the instance.
53
53
54
54
1. <spanid="cloud-save"></span>**If you are working in a trusted Python environment (such as on a personal laptop or workstation),** use the `save_account()` method to save your credentials locally. ([Skip to the next step](#cloud-untrusted) if you are not using a trusted environment, such as a shared or public computer, to authenticate to IBM Cloud.) To use `save_account()`, activate a Python virtual environment. Then, run Python in your virtual environment and enter the following:
55
55
56
56
57
57
```python
58
58
token ="<your-API-token>"
59
59
```
60
+
<Admonitiontype="Note">
61
+
When an instance CRN or name is passed in, only backends and jobs from that instance are available. If an instance is not specified, all backends and jobs across all instances in your account are available. In this case, when a backend is specified, an instance that can access that backend is found and used.
62
+
</Admonition>
60
63
61
64
```python
62
65
from qiskit_ibm_runtime import QiskitRuntimeService
63
66
service = QiskitRuntimeService.save_account(
64
67
token=token, # Your token is confidential.
65
68
# Do not share your key in public code.
66
-
instance="<IBM Cloud CRN>",
69
+
instance="<IBM Cloud CRN or instance name>",# Optionally specify the CRN to use.
67
70
name="<account-name>", # Optionally name this set of account credentials.
68
71
set_as_default=True, # Optionally set these as your default credentials.
69
72
)
@@ -101,7 +104,7 @@ Your user account is associated with one or more [instances](./instances) that g
101
104
service = QiskitRuntimeService(
102
105
# Delete your key on the API keys page after entering this code:
Copy file name to clipboardExpand all lines: docs/guides/instances.mdx
+8-3Lines changed: 8 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ The instances that you can access are listed at the bottom of your [Account page
34
34
<CloudContent>
35
35
Access to IBM Quantum Platform services is controlled by the **instances** to which you are assigned. Users can belong to more than one instance at any given time.
36
36
37
-
An instance is a deployment of Qiskit Runtime. You need a different instance for every service plan (such as Open or Standard) you use in every region that you want to use. The account manager and anyone with enough permission can create an instance and define its configuration, such as its allocations, usage limits, quantum computers, and user permissions. Each instance is identified by a unique Cloud Resource Name (CRN). This CRN is used when sending workloads from your Qiskit programs.
37
+
An instance is a deployment of Qiskit Runtime. You need a different instance for every service plan (such as Open or Standard) you use in every region that you want to use. The account manager and anyone with enough permission can create an instance and define its configuration, such as its allocations, usage limits, quantum computers, and user permissions. Each instance is identified by a unique Cloud Resource Name (CRN). This CRN can be used when sending workloads from your Qiskit programs.
38
38
39
39
The IBM Quantum Platform [dashboard](https://quantum.cloud.ibm.com/) displays the instances to which you have access. You can view full details, edit, and delete instances on the [Instances page.](https://quantum.cloud.ibm.com/instances)
40
40
@@ -130,10 +130,15 @@ If you do not specify an instance, the code will select one in the following ord
130
130
131
131
</LegacyContent>
132
132
<CloudContent>
133
-
You must use the CRN to specify an instance to use; either when initializing the service or when sending the workload to a QPU. The instance's CRN is listed on the [Platform dashboard](https://quantum.cloud.ibm.com/). Before running the below code, follow the steps to [save an account.](/docs/guides/cloud-setup#cloud-save)
133
+
You can use the CRN or instance name to specify an instance to use; either when initializing the service or when sending the workload to a QPU. When an instance is passed in, only backends and jobs from that instance are available.
134
+
135
+
If an instance is not included, all backends and jobs across all instances in your account are available. In this case, when a backend is specified, an instance that can access the backend is found and used.
136
+
137
+
The instance's CRN is listed on the [Platform dashboard](https://quantum.cloud.ibm.com/). Before running the below code, follow the steps to [save an account.](/docs/guides/cloud-setup#cloud-save)
134
138
135
139
```python
136
-
# Specify an instance at service level. This becomes the default unless overwritten.
Copy file name to clipboardExpand all lines: docs/guides/retired-qpus.mdx
+7-2Lines changed: 7 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -104,11 +104,16 @@ jobs = service.jobs(backend_name=<backend_name>)
104
104
```
105
105
</LegacyContent>
106
106
<CloudContent>
107
+
108
+
<Admonitiontype="Note">
109
+
Passing in a Cloud Resource Name (CRN) or name in the following code is optional. When it is passed in, only backends and jobs from that instance are available. If an instance is not specified, all backends and jobs across all instances in your account are available. In this case, when a backend is specified, an instance that can access that backend is found and used.
110
+
</Admonition>
111
+
107
112
```python
108
113
from qiskit_ibm_runtime import QiskitRuntimeService
109
114
110
-
# Load your IBM Quantum account(s). Replace "<IBM Cloud CRN>" with your desired instance's CRN
111
-
service = QiskitRuntimeService(channel="ibm_cloud", instance="<IBM Cloud CRN>")
115
+
# Load your IBM Quantum account. Replace "<IBM Cloud CRN>" with your desired instance's CRN or name.
116
+
service = QiskitRuntimeService(channel="ibm_cloud", instance="<IBM Cloud CRN or Name>")
0 commit comments