Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api/qiskit-ibm-runtime/0.40/qiskit-runtime-service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService

**Parameters**

* **channel** (*Optional\[ChannelType]*) – Channel type. `ibm_quantum`, `ibm_cloud`, `ibm_quantum_platform` or `local`. The `ibm_quantum` channel is deprecated and will be removed no earlier than July 1st 2025, `ibm_quantum_platform`, which points to the new Quantum Platform cloud API ([https://quantum.cloud.ibm.com](https://quantum.cloud.ibm.com)) should be used instead. For help migrating to the alternative channels, review the [migration guide.](/docs/migration-guides/classic-iqp-to-cloud-iqp) If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/docs/guides/local-testing-mode) documentation.
* **channel** (*Optional\[ChannelType]*) – Channel type. `ibm_quantum`, `ibm_cloud`, `ibm_quantum_platform` or `local`. The `ibm_quantum` channel is deprecated and will be removed no earlier than July 1st 2025, `ibm_quantum_platform`, which points to the new Quantum Platform cloud API ([/](/)) should be used instead. For help migrating to the alternative channels, review the [migration guide.](/docs/migration-guides/classic-iqp-to-cloud-iqp) If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/docs/guides/local-testing-mode) documentation.
* **token** (*Optional\[str]*) – IBM Cloud API key or IBM Quantum API token.
* **url** (*Optional\[str]*) – The API URL. Defaults to [https://quantum-computing.cloud.ibm.com](https://quantum-computing.cloud.ibm.com) (`ibm_cloud`), [https://quantum.cloud.ibm.com](https://quantum.cloud.ibm.com) (`ibm_quantum_platform`) or [https://auth.quantum.ibm.com/api](https://auth.quantum.ibm.com/api) (`ibm_quantum`).
* **url** (*Optional\[str]*) – The API URL. Defaults to [https://quantum-computing.cloud.ibm.com](https://quantum-computing.cloud.ibm.com) (`ibm_cloud`), [/](/) (`ibm_quantum_platform`) or [https://auth.quantum.ibm.com/api](https://auth.quantum.ibm.com/api) (`ibm_quantum`).
* **filename** (*Optional\[str]*) – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE
* **name** (*Optional\[str]*) – Name of the account to load.
* **instance** (*Optional\[str]*) – The service instance to use. For `ibm_cloud` and `ibm_quantum_platform`, this is the Cloud Resource Name (CRN) or the service name. If set, it will define a default instance for service instantiation, if not set, the service will fetch all instances accessible within the account. For `ibm_quantum`, this is the hub/group/project specification.
Expand Down Expand Up @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService

* **token** (*str | None*) – IBM Cloud API key or IBM Quantum API token.

* **url** (*str | None*) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (`ibm_cloud`), [https://quantum.cloud.ibm.com](https://quantum.cloud.ibm.com) (`ibm_quantum_platform`) or [https://auth.quantum.ibm.com/api](https://auth.quantum.ibm.com/api) (`ibm_quantum`).
* **url** (*str | None*) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (`ibm_cloud`), [/](/) (`ibm_quantum_platform`) or [https://auth.quantum.ibm.com/api](https://auth.quantum.ibm.com/api) (`ibm_quantum`).

* **instance** (*str | None*) – This is an optional parameter to specify the CRN or service name for `ibm_cloud` and `ibm_quantum_platform`, and the hub/group/project for `ibm_quantum`. If set, it will define a default instance for service instantiation, if not set, the service will fetch all instances accessible within the account.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService

* **channel** (*Optional\[ChannelType]*) – Channel type. `ibm_cloud`, `ibm_quantum_platform` or `local`. If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/docs/guides/local-testing-mode) documentation.
* **token** (*Optional\[str]*) – IBM Cloud API key.
* **url** (*Optional\[str]*) – The API URL. Defaults to [https://quantum-computing.cloud.ibm.com](https://quantum-computing.cloud.ibm.com) (`ibm_cloud`), [https://quantum.cloud.ibm.com](https://quantum.cloud.ibm.com) (`ibm_quantum_platform`) or
* **url** (*Optional\[str]*) – The API URL. Defaults to [https://quantum-computing.cloud.ibm.com](https://quantum-computing.cloud.ibm.com) (`ibm_cloud`), [/](/) (`ibm_quantum_platform`) or
* **filename** (*Optional\[str]*) – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE
* **name** (*Optional\[str]*) – Name of the account to load.
* **instance** (*Optional\[str]*) – The service instance to use. For `ibm_cloud` and `ibm_quantum_platform`, this is the Cloud Resource Name (CRN) or the service name. If set, it will define a default instance for service instantiation, if not set, the service will fetch all instances accessible within the account.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/dev/qiskit-runtime-service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService

* **channel** (*Optional\[ChannelType]*) – String that identifies the service platform. This is set to `ibm_quantum_platform` by default, but can additionally take `local` and `ibm_cloud` as values. If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/docs/guides/local-testing-mode) documentation. For non-local modes, the channel is used to resolve the default API URL value. `ibm_cloud` was the identifier for the legacy IBM Cloud platform, and its url will be redirected to the new `ibm_quantum_platform` url.
* **token** (*Optional\[str]*) – IBM Cloud API key. Providing an API key is required for IQP authentication. If not provided explicitly, the default saved account will be queried for this API key.
* **url** (*Optional\[str]*) – The API URL. Defaults to different values depending on the selected channel: [https://quantum.cloud.ibm.com](https://quantum.cloud.ibm.com) (`ibm_quantum_platform`), or [https://quantum-computing.cloud.ibm.com](https://quantum-computing.cloud.ibm.com) (`ibm_cloud`).
* **url** (*Optional\[str]*) – The API URL. Defaults to different values depending on the selected channel: [/](/) (`ibm_quantum_platform`), or [https://quantum-computing.cloud.ibm.com](https://quantum-computing.cloud.ibm.com) (`ibm_cloud`).
* **filename** (*Optional\[str]*) – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE.
* **name** (*Optional\[str]*) – Name of the account to load from file.
* **instance** (*Optional\[str]*) – The service instance to use. For `ibm_cloud` and `ibm_quantum_platform`, this is the Cloud Resource Name (CRN) or the service name. If set, it will define an instance for service instantiation, if not set, the service will fetch all instances accessible within the account following the specified filtering criteria.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-runtime/qiskit-runtime-service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService

* **channel** (*Optional\[ChannelType]*) – String that identifies the service platform. This is set to `ibm_quantum_platform` by default, but can additionally take `local` and `ibm_cloud` as values. If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/docs/guides/local-testing-mode) documentation. For non-local modes, the channel is used to resolve the default API URL value. `ibm_cloud` was the identifier for the legacy IBM Cloud platform, and its url will be redirected to the new `ibm_quantum_platform` url.
* **token** (*Optional\[str]*) – IBM Cloud API key. Providing an API key is required for IQP authentication. If not provided explicitly, the default saved account will be queried for this API key.
* **url** (*Optional\[str]*) – The API URL. Defaults to different values depending on the selected channel: [https://quantum.cloud.ibm.com](https://quantum.cloud.ibm.com) (`ibm_quantum_platform`), or [https://quantum-computing.cloud.ibm.com](https://quantum-computing.cloud.ibm.com) (`ibm_cloud`).
* **url** (*Optional\[str]*) – The API URL. Defaults to different values depending on the selected channel: [/](/) (`ibm_quantum_platform`), or [https://quantum-computing.cloud.ibm.com](https://quantum-computing.cloud.ibm.com) (`ibm_cloud`).
* **filename** (*Optional\[str]*) – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE.
* **name** (*Optional\[str]*) – Name of the account to load from file.
* **instance** (*Optional\[str]*) – The service instance to use. For `ibm_cloud` and `ibm_quantum_platform`, this is the Cloud Resource Name (CRN) or the service name. If set, it will define an instance for service instantiation, if not set, the service will fetch all instances accessible within the account following the specified filtering criteria.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/access-groups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ Create a fourth policy for the same instance.
- **Roles and actions** - For Platform access, select **Administrator**. Click **Next**.
At the bottom, click **Add**, then click **Assign**.

Finally, add users to the access group. You can do this from the access group's **Users** page, or by using the IBM Quantum Platform [Access management](https://quantum.cloud.ibm.com/access-groups) page.
Finally, add users to the access group. You can do this from the access group's **Users** page, or by using the IBM Quantum Platform [Access management](/access-groups) page.

<Admonition type="note">
You can only invite users who are already members of the account. If you don't see a user on the Add users page, follow the steps in [Invite and manage users](/docs/guides/invite-and-manage-users#invite) to add them to the account first. After they accept the invitation, you can add them to the access group.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/algorithmiq-tem.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
"source": [
"## Get started\n",
"\n",
"Authenticate using your [IBM Quantum Platform API key](http://quantum.cloud.ibm.com/), and select the TEM function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)"
"Authenticate using your [IBM Quantum Platform API key](/), and select the TEM function as follows. (This snippet assumes you've already [saved your account](/docs/guides/functions#install-qiskit-functions-catalog-client) to your local environment.)"
]
},
{
Expand Down Expand Up @@ -365,7 +365,7 @@
"\n",
"<Admonition type=\"tip\" title=\"Recommendations\">\n",
"\n",
"- [Request access to Algorithmiq Tensor-network error mitigation](https://quantum.cloud.ibm.com/functions?id=algorithmiq-tem)\n",
"- [Request access to Algorithmiq Tensor-network error mitigation](/functions?id=algorithmiq-tem)\n",
"\n",
"</Admonition>"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/allocation-limits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ An account might have allotted time on the Premium or Flex plan. Because each ac

The time that you allocate to instances is used by the fair-share algorithm to determine the priority in the queue, based on usage of all QPUs over a rolling time window of 28 days (for Premium Plan users) or over the subscription period (for Flex Plan users).

The allocation is set when creating the instance. However, you can view and change allocated time on the [instances page.](https://quantum.cloud.ibm.com/instances)
The allocation is set when creating the instance. However, you can view and change allocated time on the [instances page.](/instances)


## What happens when the limit is reached
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/cloud-setup-invited.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can run workloads on IBM&reg; quantum processing units (QPUs) by setting up
Your user account is associated with one or more [instances](./instances), identified by _Cloud Resource Names_ (CRNs) that give access to IBM Quantum services. Additionally, a unique API token (also called a key) is assigned to each account, allowing for IBM Quantum access from Qiskit. For instructions to choose a specific instance, see [Connect to an instance](./instances#connect-instance).

<Admonition type="note">
The [IBM Quantum Platform dashboard](https://quantum.cloud.ibm.com) and the [Instances page](https://quantum.cloud.ibm.com/instances) list the instances that you can access.
The [IBM Quantum Platform dashboard](/) and the [Instances page](/instances) list the instances that you can access.
</Admonition>

<span id="cloud"></span>
Expand All @@ -26,7 +26,7 @@ Your user account is associated with one or more [instances](./instances), ident

1. Accept the email invitation.
1. Log in with an IBMid or Google account. Note that the profile that you use to log in to IBM Cloud or IBM Quantum Platform in this step is not your IBM Cloud account. After logging in, confirm your information and accept the invitation to join the account.
1. Navigate back to [IBM Quantum Platform.](https://quantum.cloud.ibm.com)
1. Navigate back to [IBM Quantum Platform.](/)
1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image.
* Choose the account that was invited in the email.
* The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to.
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/cloud-setup-rest-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ You can access quantum processors with REST APIs, enabling you to work with QPUs

### 1. Get access

1. If you do not already have a user account, get one at the [IBM Quantum login page.](https://quantum.cloud.ibm.com/login)
1. Create an API key (also called a token) on the [dashboard.](https://quantum.cloud.ibm.com) Note that the same API key can be used for either region.
1. If you do not already have a user account, get one at the [IBM Quantum login page.](/login)
1. Create an API key (also called a token) on the [dashboard.](/) Note that the same API key can be used for either region.
1. Generate an IBM Cloud Identity and Access Management (IAM) bearer token. This is a short-lived token used to authenticate requests to the REST API. To generate one, call the [IAM Identity Services API](https://cloud.ibm.com/apidocs/iam-identity-token-api#create-api-key) as shown in the following sample request:
<Tabs>

Expand Down Expand Up @@ -81,7 +81,7 @@ Choose the appropriate authentication method, depending on your working environm
1. Authenticate requests to the Qiskit Runtime REST API by including the CRN and bearer token to the request's headers.
```bash
curl -X 'GET' \
'https://quantum.cloud.ibm.com/api/v1/usage' \
'/api/v1/usage' \
'-H accept: application/json' \
'-H authorization: Bearer <BEARER_TOKEN>' \
'-H Service-CRN: <INSTANCE_CRN>'
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/cloud-setup-untrusted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Follow these instructions if you are working with IBM Cloud or the IBM Qiskit Ru
<span id="access-credentials"></span>
## Find your access credentials

1. Find your API key (also referred to as an _API token_). 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. The token will not be visible again. Note that you can use a single API key to connect to any region.
2. Optional: Find the instance you want to use from the [Instances](https://quantum.cloud.ibm.com/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance.
1. Find your API key (also referred to as an _API token_). From the [dashboard](/), create your API key, then copy it to a secure location so you can use it for authentication. The token will not be visible again. Note that you can use a single API key to connect to any region.
2. Optional: Find the instance you want to use from the [Instances](/instances) page. Hover over its CRN, click the icon to copy it, then save it in a secure location so you can use it to identify the instance.

## Authenticate to IBM Cloud in an untrusted environment

Expand Down Expand Up @@ -57,7 +57,7 @@ Follow these steps to use your API key directly to authenticate to the Qiskit Ru

```bash
curl -X 'GET' \
'https://quantum.cloud.ibm.com/api/v1/usage' \
'/api/v1/usage' \
'-H accept: application/json' \
'-H authorization: Bearer <BEARER_TOKEN>' \
'-H Service-CRN: <INSTANCE_CRN>'
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/cloud-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Your user account is associated with one or more [instances,](./instances) ident

### Before you begin

1. If you do not already have one, set up an [IBM Cloud account.](https://quantum.cloud.ibm.com/registration)
1. If you do not already have one, set up an [IBM Cloud account.](/registration)
<Admonition type="note">
You can be part of multiple IBM Cloud accounts. You can access any of your IBM Cloud accounts at any time from the account switcher in the header of the [IBM Quantum Platform](https://quantum.cloud.ibm.com) interface.
You can be part of multiple IBM Cloud accounts. You can access any of your IBM Cloud accounts at any time from the account switcher in the header of the [IBM Quantum Platform](/) interface.
</Admonition>
1. Log in to [IBM Quantum Platform](https://quantum.cloud.ibm.com) with an IBMid or Google account. If you don't have one, you are guided through creating one. (These login credentials are not your IBM Cloud account credentials.)
1. Log in to [IBM Quantum Platform](/) with an IBMid or Google account. If you don't have one, you are guided through creating one. (These login credentials are not your IBM Cloud account credentials.)
1. Make sure that the correct account and region are selected in the account switcher in the header, as shown in the following image.

The region controls where your jobs are run and where the job data is kept. You can access either region by using the same API key, but you can only see and access the instances that were created in the region that you're logged in to.
Expand All @@ -33,7 +33,7 @@ Your user account is associated with one or more [instances,](./instances) ident

### 1. Create an instance

You can create an instance from the IBM Quantum Platform [Instances](https://quantum.cloud.ibm.com/instances) page. See [Create an instance](/docs/guides/instances#add-instance) for detailed instructions.
You can create an instance from the IBM Quantum Platform [Instances](/instances) page. See [Create an instance](/docs/guides/instances#add-instance) for detailed instructions.

### 2. Optional: Save your access credentials

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/common-parameters.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@
"id": "d2034dd5-23e5-4473-89b8-aaf4233775c7",
"metadata": {},
"source": [
"You can use the [`plot_error_map`](/docs/api/qiskit/qiskit.visualization.plot_error_map) function to generate a diagram of the device graph with error information and with the physical qubits labeled. You can also view similar diagrams on the [Compute resources](https://quantum.cloud.ibm.com/computers) page."
"You can use the [`plot_error_map`](/docs/api/qiskit/qiskit.visualization.plot_error_map) function to generate a diagram of the device graph with error information and with the physical qubits labeled. You can also view similar diagrams on the [Compute resources](/computers) page."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/composer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: IBM Quantum Composer is a graphical programming tool. Drag and drop

## What is it?

[IBM Quantum&reg; Composer](https://quantum.cloud.ibm.com/composer) is a graphical quantum programming tool that lets you drag and drop operations to build quantum circuits and run them on quantum hardware.
[IBM Quantum&reg; Composer](/composer) is a graphical quantum programming tool that lets you drag and drop operations to build quantum circuits and run them on quantum hardware.

## What can it do?

Expand Down
Loading