Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
8 changes: 4 additions & 4 deletions docs/api/migration-guides/qiskit-runtime-examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ to the following:
- [Primitive execution options API
reference](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options)
- [How to run a session
topic](../run/run-sessions)
topic](../run/run-jobs-in-session)

#### 3. Other execution alternatives (non-Runtime)

Expand Down Expand Up @@ -304,7 +304,7 @@ expectation: [-1.06365335]

For more information on using the Aer primitives, see the [VQE tutorial](https://qiskit.org/documentation/tutorials/algorithms/03_vqe_simulation_with_noise.html).

For more information about running noisy simulations with the **Runtime primitives**, see the [Noisy simulators in Qiskit Runtime](../verify/noise) topic.
For more information about running noisy simulations with the **Runtime primitives**, see the [Noisy simulators in Qiskit Runtime](../verify/noisy-simulators) topic.

<span id="sampler-algorithm"></span>
## Use Sampler to design an algorithm
Expand Down Expand Up @@ -538,7 +538,7 @@ to the following:

- [Error mitigation tutorial](https://learning.quantum-computing.ibm.com/tutorial/error-suppression-and-error-mitigation-with-qiskit-runtime)
- [Setting execution options topic](../run/advanced-runtime-options)
- [How to run a session topic](../run/run-sessions)
- [How to run a session topic](../run/run-jobs-in-session)

### 3. Other execution alternatives (non-Runtime)

Expand Down Expand Up @@ -674,4 +674,4 @@ quasi_dists: [{1: 0.2802734375, 2: 0.2412109375, 0: 0.2392578125, 3: 0.23925781
binary_quasi_dist: {'0001': 0.2802734375, '0010': 0.2412109375, '0000': 0.2392578125, '0011': 0.2392578125}
```

For more information, see [Noisy simulators in Qiskit Runtime](../verify/noise).
For more information, see [Noisy simulators in Qiskit Runtime](../verify/noisy-simulators).
2 changes: 1 addition & 1 deletion docs/api/migration-guides/qiskit-runtime.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ an algorithm, you might want to tune certain primitive options. For details, see
- [Get started with Estimator.](../run/primitives-get-started#start-estimator)
- [Get started with Sampler.](../run/primitives-get-started#start-sampler)
- Explore [sessions.](../run/sessions)
- [Run a primitive in a session.](../run/run-sessions)
- [Run a primitive in a session.](../run/run-jobs-in-session)
- Experiment with the [migration tutorial.](https://qiskit.org/documentation/partners/qiskit_ibm_provider/tutorials/Migration_Guide_from_qiskit-ibmq-provider.html)
- Experiment with the [Run custom transpiled circuits with primitives tutorial.](https://learning.quantum-computing.ibm.com/tutorial/submitting-user-transpiled-circuits-using-primitives)

Expand Down
2 changes: 1 addition & 1 deletion docs/build/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"children": [
{
"title": "OpenQASM 3 feature table",
"url": "/build/feature-table"
"url": "/build/qasm-feature-table"
},
{
"title": "OpenQASM 3.x Live Specification",
Expand Down
File renamed without changes.
16 changes: 8 additions & 8 deletions docs/run/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@
},
{
"title": "Configure runtime error mitigation",
"url": "/run/error-mitigation"
"url": "/run/configure-error-mitigation"
},
{
"title": "Configure runtime error suppression",
"url": "/run/error-suppression"
"url": "/run/configure-error-suppression"
}
]
},
Expand All @@ -48,7 +48,7 @@
},
{
"title": "Run jobs in a session",
"url": "/run/run-sessions"
"url": "/run/run-jobs-in-session"
}
]
},
Expand All @@ -57,11 +57,11 @@
"children": [
{
"title": "Monitor a job",
"url": "/run/monitor"
"url": "/run/monitor-job"
},
{
"title": "Estimate job run time",
"url": "/run/estimate-job"
"url": "/run/estimate-job-run-time"
},
{
"title": "Maximum execution time",
Expand All @@ -78,7 +78,7 @@
},
{
"title": "System information",
"url": "/run/hardware"
"url": "/run/system-information"
},
{
"title": "Get backend information",
Expand All @@ -99,11 +99,11 @@
},
{
"title": "Fair-share queue",
"url": "/run/queue"
"url": "/run/fair-share-queue"
},
{
"title": "Manage cost",
"url": "/run/cost"
"url": "/run/manage-cost"
},
{
"title": "Reserve system time",
Expand Down
8 changes: 4 additions & 4 deletions docs/run/advanced-runtime-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ By default, the Qiskit Runtime primitives perform circuit transpilation. There a
levels you can choose from. These levels affect the transpilation strategy and might include additional error
suppression mechanisms. Level 0 only involves basic transpilation.
See the Optimization level table in the
[Error suppression topic](error-suppression#setting-the-optimization-level) for further details.
[Error suppression topic](configure-error-suppression#setting-the-optimization-level) for further details.

The optimization level option is a "first level option", and can be set as follows:

Expand Down Expand Up @@ -134,7 +134,7 @@ estimator = Estimator(session=session, options=options)
```

For more information, and a complete list of advanced transpilation options, see the Advanced transpilation options table in the
[Error suppression topic](../run/error-suppression#transpilation-table).
[Error suppression topic](../run/configure-error-suppression#transpilation-table).

Finally, you might want to specify settings that are not available through the primitives interface,
or use custom transpiler passes. In these cases, you can set `skip_transpilation=True` to submit
Expand All @@ -158,7 +158,7 @@ estimator = Estimator(session=session, options=options)
You might want to leverage different error mitigation methods and see how these affect the performance of your
algorithm. These can also be set through the `resilience_level` option. The method selected for each level is
different for `Sampler` and `Estimator`. You can find more information in the
[Configure error mitigation topic](error-mitigation).
[Configure error mitigation topic](configure-error-mitigation).

The configuration is similar to the other options:

Expand All @@ -181,5 +181,5 @@ estimator = Estimator(session=session, options=options)
- Find more details about the `Estimator` methods in the [Estimator API reference](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator#estimator).
- Find more details about the `Sampler` methods in the [Sampler API reference](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler#sampler).
- Find all available options in the [Options API reference](../api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options).
- Find details about [error suppression](../run/error-suppression) and [error mitigation](../run/error-mitigation).
- Find details about [error suppression](../run/configure-error-suppression) and [error mitigation](../run/configure-error-mitigation).
</Admonition>
2 changes: 1 addition & 1 deletion docs/run/backends.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ To find your available systems and simulators on **IBM Quantum Platform**, view

## Specify a backend when running a job

If you are using a runtime session, add the `backend` option when starting your session. For details about working with sessions, see [Run jobs in a session](run-sessions).
If you are using a runtime session, add the `backend` option when starting your session. For details about working with sessions, see [Run jobs in a session](run-jobs-in-session).

```python
from qiskit.circuit.random import random_circuit
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/run/cost.mdx → docs/run/manage-cost.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ These are the columns relevant to cost:

## Estimate the cost

You can estimate how long a job will run, and therefore its cost, by estimating the job run time. For details, see the [Estimate job run time](estimate-job) topic.
You can estimate how long a job will run, and therefore its cost, by estimating the job run time. For details, see the [Estimate job run time](estimate-job-run-time) topic.

## Set up spending notifications

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/run/reserve-system-time.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Reserve time on a system as an IBM Quantum Network member
This feature is available only to organizations that belong to the [IBM Quantum Network](https://www.ibm.com/quantum/network). Educators and researchers can also make reservations and access other benefits by signing up for one of the special programs we offer. Go to the [Educators program sign-up form](https://quantum-computing.ibm.com/programs/educators) or the [Researchers program sign-up form](https://quantum-computing.ibm.com/programs/researchers) for more information.
</Admonition>

Under standard operating conditions, IBM Quantum systems accept jobs according to the dynamic priority assigned by the [fair-share queuing system](queue).
Under standard operating conditions, IBM Quantum systems accept jobs according to the dynamic priority assigned by the [fair-share queuing system](fair-share-queue).

![Normal device queuing operation.](/images/migration/normal_queue_with_providers1.jpg)

Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/run/sessions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A session allows a collection of jobs to be grouped and jointly scheduled by the
<figcaption>Figure 1: Qiskit Runtime session flow diagram</figcaption>
</figure>

Compared with jobs that use the [fair-share scheduler](../run/queue),
Compared with jobs that use the [fair-share scheduler](../run/fair-share-queue),
sessions become particularly beneficial when running programs that
require iterative calls between classical and quantum resources, where a
large number of jobs are submitted sequentially. This is the case, for
Expand Down Expand Up @@ -104,7 +104,7 @@ starts each time a session job finishes.
When a session is started, it is assigned a *maximum session timeout*
value. You can set this value by using the `max_time` parameter, which
can be greater than the program's `max_execution_time`. For
instructions, see [Run a primitive in a session](run-sessions).
instructions, see [Run a primitive in a session](run-jobs-in-session).

If you do not specify a timeout value, it is the smaller of these
values:
Expand Down Expand Up @@ -137,7 +137,7 @@ is deactivated or closed, at which point normal job selection resumes.

A session ends by reaching its maximum timeout value or when it is
manually closed by the user. Do not close a session until all jobs
**complete**. See [Close a session](run-sessions#close) for details. After a session is closed, the following occurs:
**complete**. See [Close a session](run-jobs-in-session#close) for details. After a session is closed, the following occurs:

- Any jobs that are already running continue to run.
- Any queued jobs remaining in the session are put into a failed state.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/verify/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
},
{
"title": "Simulate with noise",
"url": "/verify/noise"
"url": "/verify/noisy-simulators"
},
{
"title": "Building noise models",
Expand Down
2 changes: 1 addition & 1 deletion docs/verify/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ description: Introduction to the Verify phase
In the verify phase, you test your quantum programs by running them on simulated devices and exploring their performance under realistic device [noise models](https://qiskit.org/ecosystem/aer/apidocs/aer_noise.html). This allows you to validate them before sending them to a physical system. This phase consists of the following steps:

1. Run your program on a quantum simulator, using [Qiskit reference primitives](simulate-with-primitives) or [IBM Quantum cloud-based simulators](simulators).
1. [Add noise to your simulation](noise).
1. [Add noise to your simulation](noisy-simulators).
2. Optionally [create your own noise model](building_noise_models).

2 changes: 1 addition & 1 deletion docs/verify/noise.mdx → docs/verify/noisy-simulators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ options_with_em.resilience_level = 1 # M3 for Sampler and T-REx for Estimator
```

When you set the ``resilience_level`` to 1, M3 is activated in Sampler.
All available resilience level configurations are described on the [Configure error mitigation](../run/error-mitigation) page.
All available resilience level configurations are described on the [Configure error mitigation](../run/configure-error-mitigation) page.

``` python
with Session(service=service, backend=backend):
Expand Down