From 9ad094dc1261f383aa4185812d9b220baa56fff1 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Tue, 17 Oct 2023 14:12:16 -0400 Subject: [PATCH 1/3] Improve URLs to be more specific --- .../migration-guides/qiskit-runtime-examples.mdx | 8 ++++---- docs/api/migration-guides/qiskit-runtime.mdx | 2 +- docs/build/_toc.json | 2 +- ...{feature-table.mdx => qasm-feature-table.mdx} | 0 docs/run/_toc.json | 16 ++++++++-------- docs/run/advanced-runtime-options.mdx | 4 ++-- ...gation.mdx => configure-error-mitigation.mdx} | 0 ...ssion.mdx => configure-error-suppression.mdx} | 0 ...stimate-job.mdx => estimate-job-run-time.mdx} | 0 docs/run/{queue.mdx => fair-share-queue.mdx} | 0 docs/run/{cost.mdx => manage-cost.mdx} | 0 docs/run/{monitor.mdx => monitor-job.mdx} | 0 ...{run-sessions.mdx => run-jobs-in-session.mdx} | 0 docs/run/sessions.mdx | 2 +- .../run/{hardware.mdx => system-information.mdx} | 0 docs/verify/_toc.json | 2 +- docs/verify/{noise.mdx => noisy-simulators.mdx} | 2 +- 17 files changed, 19 insertions(+), 19 deletions(-) rename docs/build/{feature-table.mdx => qasm-feature-table.mdx} (100%) rename docs/run/{error-mitigation.mdx => configure-error-mitigation.mdx} (100%) rename docs/run/{error-suppression.mdx => configure-error-suppression.mdx} (100%) rename docs/run/{estimate-job.mdx => estimate-job-run-time.mdx} (100%) rename docs/run/{queue.mdx => fair-share-queue.mdx} (100%) rename docs/run/{cost.mdx => manage-cost.mdx} (100%) rename docs/run/{monitor.mdx => monitor-job.mdx} (100%) rename docs/run/{run-sessions.mdx => run-jobs-in-session.mdx} (100%) rename docs/run/{hardware.mdx => system-information.mdx} (100%) rename docs/verify/{noise.mdx => noisy-simulators.mdx} (99%) diff --git a/docs/api/migration-guides/qiskit-runtime-examples.mdx b/docs/api/migration-guides/qiskit-runtime-examples.mdx index d2c6a2e51f4..1a25c420a76 100644 --- a/docs/api/migration-guides/qiskit-runtime-examples.mdx +++ b/docs/api/migration-guides/qiskit-runtime-examples.mdx @@ -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) @@ -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. ## Use Sampler to design an algorithm @@ -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) @@ -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). diff --git a/docs/api/migration-guides/qiskit-runtime.mdx b/docs/api/migration-guides/qiskit-runtime.mdx index 0b0912c5b73..4788069ecbc 100644 --- a/docs/api/migration-guides/qiskit-runtime.mdx +++ b/docs/api/migration-guides/qiskit-runtime.mdx @@ -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) diff --git a/docs/build/_toc.json b/docs/build/_toc.json index d07175833e5..8ff5b510910 100644 --- a/docs/build/_toc.json +++ b/docs/build/_toc.json @@ -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", diff --git a/docs/build/feature-table.mdx b/docs/build/qasm-feature-table.mdx similarity index 100% rename from docs/build/feature-table.mdx rename to docs/build/qasm-feature-table.mdx diff --git a/docs/run/_toc.json b/docs/run/_toc.json index f735e0f3943..dbe30b0ada8 100644 --- a/docs/run/_toc.json +++ b/docs/run/_toc.json @@ -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" } ] }, @@ -48,7 +48,7 @@ }, { "title": "Run jobs in a session", - "url": "/run/run-sessions" + "url": "/run/run-jobs-in-session" } ] }, @@ -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", @@ -78,7 +78,7 @@ }, { "title": "System information", - "url": "/run/hardware" + "url": "/run/system-information" }, { "title": "Get backend information", @@ -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", diff --git a/docs/run/advanced-runtime-options.mdx b/docs/run/advanced-runtime-options.mdx index 558ef6b88b0..60ee22502ee 100644 --- a/docs/run/advanced-runtime-options.mdx +++ b/docs/run/advanced-runtime-options.mdx @@ -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 @@ -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). \ No newline at end of file diff --git a/docs/run/error-mitigation.mdx b/docs/run/configure-error-mitigation.mdx similarity index 100% rename from docs/run/error-mitigation.mdx rename to docs/run/configure-error-mitigation.mdx diff --git a/docs/run/error-suppression.mdx b/docs/run/configure-error-suppression.mdx similarity index 100% rename from docs/run/error-suppression.mdx rename to docs/run/configure-error-suppression.mdx diff --git a/docs/run/estimate-job.mdx b/docs/run/estimate-job-run-time.mdx similarity index 100% rename from docs/run/estimate-job.mdx rename to docs/run/estimate-job-run-time.mdx diff --git a/docs/run/queue.mdx b/docs/run/fair-share-queue.mdx similarity index 100% rename from docs/run/queue.mdx rename to docs/run/fair-share-queue.mdx diff --git a/docs/run/cost.mdx b/docs/run/manage-cost.mdx similarity index 100% rename from docs/run/cost.mdx rename to docs/run/manage-cost.mdx diff --git a/docs/run/monitor.mdx b/docs/run/monitor-job.mdx similarity index 100% rename from docs/run/monitor.mdx rename to docs/run/monitor-job.mdx diff --git a/docs/run/run-sessions.mdx b/docs/run/run-jobs-in-session.mdx similarity index 100% rename from docs/run/run-sessions.mdx rename to docs/run/run-jobs-in-session.mdx diff --git a/docs/run/sessions.mdx b/docs/run/sessions.mdx index 3307af0fe38..df6706af05d 100644 --- a/docs/run/sessions.mdx +++ b/docs/run/sessions.mdx @@ -13,7 +13,7 @@ A session allows a collection of jobs to be grouped and jointly scheduled by the
Figure 1: Qiskit Runtime session flow diagram
-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 diff --git a/docs/run/hardware.mdx b/docs/run/system-information.mdx similarity index 100% rename from docs/run/hardware.mdx rename to docs/run/system-information.mdx diff --git a/docs/verify/_toc.json b/docs/verify/_toc.json index 5d7d1881035..84e45506528 100644 --- a/docs/verify/_toc.json +++ b/docs/verify/_toc.json @@ -15,7 +15,7 @@ }, { "title": "Simulate with noise", - "url": "/verify/noise" + "url": "/verify/noisy-simulators" }, { "title": "Building noise models", diff --git a/docs/verify/noise.mdx b/docs/verify/noisy-simulators.mdx similarity index 99% rename from docs/verify/noise.mdx rename to docs/verify/noisy-simulators.mdx index e6d7f62047a..8a388466952 100644 --- a/docs/verify/noise.mdx +++ b/docs/verify/noisy-simulators.mdx @@ -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): From a712dc1290bda57759b5b22007eb7ad5ade77d3b Mon Sep 17 00:00:00 2001 From: ABBY CROSS Date: Tue, 17 Oct 2023 14:27:38 -0400 Subject: [PATCH 2/3] check for paths not including the slash --- docs/run/backends.mdx | 2 +- docs/run/sessions.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/run/backends.mdx b/docs/run/backends.mdx index f14ced21321..39f5d277119 100644 --- a/docs/run/backends.mdx +++ b/docs/run/backends.mdx @@ -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 diff --git a/docs/run/sessions.mdx b/docs/run/sessions.mdx index df6706af05d..f865443bafd 100644 --- a/docs/run/sessions.mdx +++ b/docs/run/sessions.mdx @@ -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: @@ -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. From 3d7ac3a892d70eacd1a6dd2742da3ba3249b8772 Mon Sep 17 00:00:00 2001 From: ABBY CROSS Date: Tue, 17 Oct 2023 14:33:23 -0400 Subject: [PATCH 3/3] a few more --- docs/run/advanced-runtime-options.mdx | 4 ++-- docs/run/manage-cost.mdx | 2 +- docs/run/reserve-system-time.mdx | 2 +- docs/verify/index.mdx | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/run/advanced-runtime-options.mdx b/docs/run/advanced-runtime-options.mdx index 60ee22502ee..e5aee7e1c7a 100644 --- a/docs/run/advanced-runtime-options.mdx +++ b/docs/run/advanced-runtime-options.mdx @@ -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: @@ -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: diff --git a/docs/run/manage-cost.mdx b/docs/run/manage-cost.mdx index cc97e50d3b8..b1f34037ce9 100644 --- a/docs/run/manage-cost.mdx +++ b/docs/run/manage-cost.mdx @@ -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 diff --git a/docs/run/reserve-system-time.mdx b/docs/run/reserve-system-time.mdx index 7011ddf6075..673c158db52 100644 --- a/docs/run/reserve-system-time.mdx +++ b/docs/run/reserve-system-time.mdx @@ -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. -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) diff --git a/docs/verify/index.mdx b/docs/verify/index.mdx index 587e845683f..f987c179e84 100644 --- a/docs/verify/index.mdx +++ b/docs/verify/index.mdx @@ -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).