Merge branch 'main' into default_channel

Qiskit · Aug 20, 2023 · e4b3151 · e4b3151
2 parents 7a3c84a + 83091ee
commit e4b3151
Show file tree

Hide file tree

Showing 34 changed files with 248 additions and 189 deletions.
diff --git a/docs/compare.rst b/docs/compare.rst
@@ -13,8 +13,8 @@ characterizing quantum systems.
 In contrast, Qiskit Runtime is designed to streamline algorithm and application construction
 by removing the need for users to understand
 technical hardware and low-level software details. Advanced processing techniques
-for error suppression and mitigation are automtically applied, giving users
-high-fidelity results without the burdeen of haivng to code these routines
+for error suppression and mitigation are automatically applied, giving users
+high-fidelity results without the burden of having to code these routines
 themselves. The inclusion of sessions within Qiskit Runtime allows users
 to run iterative algorithm circuits back to back, or batch collections of circuits
 without having to re-queue each job. This results in more efficient quantum processor utilization

diff --git a/docs/errors.rst b/docs/errors.rst
diff --git a/docs/how_to/backends.rst b/docs/how_to/backends.rst
@@ -90,11 +90,10 @@ As mentioned previously, the ``IBMBackend`` class attributes provide information
   backend.simulator #returns True or False, depending on whether it is a simulator
   backend.num_qubits #returns the number of qubits the backend has
 
-.. vale IBMQuantum.Spelling = NO
+See the |IBMBackend_documentation|_ for the full list of backend attributes.
 
-See the `IBMBackend class documentation <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/stubs/qiskit_ibm_runtime.IBMBackend.html#qiskit_ibm_runtime.IBMBackend>`__ for the full list of backend attributes.
-
-.. vale IBMQuantum.Spelling = YES
+.. |IBMBackend_documentation| replace:: ``IBMBackend`` class documentation
+.. _IBMBackend_documentation: https://qiskit.org/documentation/partners/qiskit_ibm_runtime/stubs/qiskit_ibm_runtime.IBMBackend.html#qiskit_ibm_runtime.IBMBackend
 
 Find backend information from other channels
 --------------------------------------------------

diff --git a/docs/how_to/noisy_simulators.rst b/docs/how_to/noisy_simulators.rst
@@ -267,7 +267,7 @@ that the backend supports to have a more realistic noisy simulation.
     options.optimization_level = 0
     options.resilience_level = 0
 
-`set_backend <https://qiskit.org/ecosystem/ibm-runtime/stubs/qiskit_ibm_runtime.options.SimulatorOptions.html>`_ is the syntactic sugar for setting options.
+:meth:`~.options.SimulatorOptions.set_backend` is the syntactic sugar for setting options.
 The following code is equivalent.
 
 .. code-block:: python

diff --git a/docs/how_to/run_session.rst b/docs/how_to/run_session.rst
@@ -72,7 +72,7 @@ Specify the session length
 
 When a session is started, it is assigned a maximum session timeout value. After the session has been open the specified amount of time, the session expires and is forcefully closed. You can no longer submit jobs to that session.  See `What happens when a session ends <../sessions.html#ends>`__ for further details.
 
-You can configure the maximum session timeout value through the `max_time` parameter, which can be specified as seconds (int) or a string, like "2h 30m 40s".  This value has to be greater than the `max_execution_time` of the job and less than the system’s `max_time`. The default value is the system’s `max_time`. See `What is the maximum execution time for a Qiskit Runtime job? <../faqs/max_execution_time.html>`__ to determine the system limit.
+You can configure the maximum session timeout value through the ``max_time`` parameter, which can be specified as seconds (int) or a string, like "2h 30m 40s".  This value has to be greater than the ``max_execution_time`` of the job and less than the system’s ``max_time``. The default value is the system’s ``max_time``. See `What is the maximum execution time for a Qiskit Runtime job? <../faqs/max_execution_time.html>`__ to determine the system limit.
 
 When setting the session length, consider how long each job within the session might take. For example, if you run five jobs within a session and each job is estimated to be five minutes long, the maximum time for the session should at least 25 min.
 
@@ -132,4 +132,4 @@ In this example, we start a session, run an Estimator job, and output the result
   display(circuit.draw("mpl"))
   print(f" > Observable: {observable.paulis}")
   print(f" > Expectation value: {result.values[0]}")
-  print(f" > Metadata: {result.metadata[0]}")
+  print(f" > Metadata: {result.metadata[0]}")
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,7 +5,7 @@ Qiskit Runtime 0.11.3 documentation
 Overview
 ==============
 
-Qiskit Runtime is a cloud-based quantum computing service developed by IBM. It offers computational *primitives* to perform foundational quantum computing tasks that utilize built-in error suppression and mitigation techniques. Primitives can be executed inside of *sessions*, allowing collections of circuits to be jointly run on a quantum computer without being interrupted by other users’ jobs. The combination of primitives, error suppression / mitigation, and sessions paves the way to efficiently build and execute scalable quantum applications.
+Qiskit Runtime is a cloud-based quantum computing service developed by IBM. It offers computational *primitives* to perform foundational quantum computing tasks that use built-in error suppression and mitigation techniques. Primitives can be executed inside of *sessions*, allowing collections of circuits to be jointly run on a quantum computer without being interrupted by other users’ jobs. The combination of primitives, error suppression / mitigation, and sessions paves the way to efficiently build and execute scalable quantum applications.
 
 The following figure illustrates how one can use Qiskit Runtime sessions and primitives. The first session request (job) waits through the regular `fair-share queue <https://quantum-computing.ibm.com/admin/docs/admin/manage/systems/queue>`__. When it starts to run, the session is started. After the first session job is finished processing, the next job in the session is run. This process continues until the session is paused (due to a lack of queued session jobs) or closed.
 
@@ -17,7 +17,7 @@ Key concepts
 
 **Primitives**
 
-Primitives are base level operations that serve as building blocks for many quantum algorithms and applications. Through these primitives, users can obtain high-fidelity results, without needing detailed hardware knowledge.  This abstraction allows you to write code, using Qiskit algorithms or otherwise, that can run on different quantum hardware or simulators without having to explicitly manage aspects such as compilation, optimization, and error suppression / mitigation. The primitives offered by `qiskit_ibm_runtime <https://qiskit.org/ecosystem/ibm-runtime/apidocs/ibm-runtime.html>`__ add additional options specific to IBM services. See `Introduction to primitives <primitives.html>`__ for further details.
+Primitives are base level operations that serve as building blocks for many quantum algorithms and applications. Through these primitives, users can obtain high-fidelity results, without needing detailed hardware knowledge.  This abstraction allows you to write code, using Qiskit algorithms or otherwise, that can run on different quantum hardware or simulators without having to explicitly manage aspects such as compilation, optimization, and error suppression / mitigation. The primitives offered by :mod:`qiskit_ibm_runtime` add additional options specific to IBM services. See `Introduction to primitives <primitives.html>`__ for further details.
 
 There are currently two primitives defined in Qiskit: Estimator and Sampler.
 
@@ -32,7 +32,7 @@ This primitive takes circuits as input and returns a quasi-probability distribut
 
 **Error suppression / mitigation**
 
-While building a fault-tolerant quantum computation is the ultimate goal, at present, calculations performed on near-term quantum computers are susceptible to noise.  Qiskit Runtime offers a number of methods for preventing errors before they occur (error suppression techniques) and dealing with those that do occur (error mitigation techniques).  
+While building a fault-tolerant quantum computation is the ultimate goal, at present, calculations performed on near-term quantum computers are susceptible to noise.  Qiskit Runtime offers several methods for preventing errors before they occur (error suppression techniques) and dealing with those that do occur (error mitigation techniques).  
 
 **Session**
 

diff --git a/docs/migrate/migrate-estimator.rst b/docs/migrate/migrate-estimator.rst
@@ -344,7 +344,7 @@ the simulation method has been updated to match the result from 3.a.
     >>> print("expectation: ", expectation_value)
     expectation:  [-1.06365335]
 
-For more information on using the Aer primitives, see the
+For more information about 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 this

diff --git a/docs/migrate/migrate-guide.rst b/docs/migrate/migrate-guide.rst
@@ -86,7 +86,7 @@ Why use Qiskit Runtime?
     - :octicon:`check`
     - :octicon:`check`
 
-  * - Elasic compute integration
+  * - Elastic compute integration
     - :octicon:`check`
     - :octicon:`check`
 

diff --git a/docs/migrate/migrate-qiskit-alg.rst b/docs/migrate/migrate-qiskit-alg.rst
@@ -12,7 +12,7 @@ Work with updated Qiskit algorithms
 .. |qiskit.quantum_info| replace:: ``qiskit.quantum_info``
 .. _qiskit.quantum_info: https://qiskit.org/documentation/apidoc/quantum_info.html
 
-The |qiskit.algorithms|_ module has been updated to leverage the primitives in all of its classes.
+The |qiskit.algorithms|_ module has been updated to use the primitives in all of its classes.
 In practice, this means that:
 
 1. All algorithms now take in a primitive instead of a ``Backend`` or |QuantumInstance|_

diff --git a/docs/migrate/migrate-setup.rst b/docs/migrate/migrate-setup.rst
@@ -80,7 +80,7 @@ Use the updated code to work with accounts.
     IBMQ.save_account("<IQX_TOKEN>", overwrite=True)
 
 **Updated - Save accounts**
-The new syntax accepts credentials for Qiskit Runtime on IBM Cloud or IBM Quantum Platform. For more information on retrieving account credentials, see the `getting started guide <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/getting_started.html>`_.
+The new syntax accepts credentials for Qiskit Runtime on IBM Cloud or IBM Quantum Platform. For more information about retrieving account credentials, see the `getting started guide <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/getting_started.html>`_.
 
 .. code-block:: python
 

diff --git a/docs/migrate/migrate-tuning.rst b/docs/migrate/migrate-tuning.rst
@@ -112,7 +112,7 @@ The ``skip_transpilation`` option is an advanced transpilation option, set as fo
 3. Error mitigation
 ~~~~~~~~~~~~~~~~~~~
 
-You might want to leverage different error mitigation methods and see how these affect the performance of your
+You might want to use 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 <https://qiskit.org/documentation/partners/qiskit_ibm_runtime/how_to/error-mitigation.html>`_.

diff --git a/docs/migrate/migrate-update-parm.rst b/docs/migrate/migrate-update-parm.rst
@@ -45,7 +45,7 @@ We want to assign the following parameter values to the circuit:
 
 Legacy
 ---------
-Previously, the parameter values had to be bound to their respective circuit parameters prior to calling `backend.run()`.
+Previously, the parameter values had to be bound to their respective circuit parameters before calling `backend.run()`.
 
 .. code-block:: python
 

diff --git a/docs/retired.rst b/docs/retired.rst
@@ -10,65 +10,65 @@ To retrieve job results from retired backends, use `QiskitRuntimeService.jobs <h
 +-------------------------------+----------------------+
 | System name                   | Qubit count          |
 +===============================+======================+
-| ibm_washington                | 127                  |
+| ``ibm_washington``            | 127                  |
 +-------------------------------+----------------------+
-| ibmq_oslo                     | 7                    |
+| ``ibmq_oslo``                 | 7                    |
 +-------------------------------+----------------------+
-| ibmq_geneva                   | 27                   |
+| ``ibmq_geneva``               | 27                   |
 +-------------------------------+----------------------+
-| ibmq_toronto                  | 27                   |
+| ``ibmq_toronto``              | 27                   |
 +-------------------------------+----------------------+
-| ibmq_montreal                 | 27                   |
+| ``ibmq_montreal``             | 27                   |
 +-------------------------------+----------------------+
-| ibmq_armonk                   | 1                    |
+| ``ibmq_armonk``               | 1                    |
 +-------------------------------+----------------------+
-| ibmq_brooklyn                 | 65                   |
+| ``ibmq_brooklyn``             | 65                   |
 +-------------------------------+----------------------+
-| ibmq_bogota                   | 5                    |
+| ``ibmq_bogota``               | 5                    |
 +-------------------------------+----------------------+
-| ibmq_santiago                 | 5                    |
+| ``ibmq_santiago``             | 5                    |
 +-------------------------------+----------------------+
-| ibmq_casablanca               | 7                    |
+| ``ibmq_casablanca``           | 7                    |
 +-------------------------------+----------------------+
-| ibmq_sydney                   | 27                   |
+| ``ibmq_sydney``               | 27                   |
 +-------------------------------+----------------------+
-| ibmq_dublin                   | 27                   |
+| ``ibmq_dublin``               | 27                   |
 +-------------------------------+----------------------+
-| ibmq_manhattan                | 65                   |
+| ``ibmq_manhattan``            | 65                   |
 +-------------------------------+----------------------+
-| ibmq_5_yorktown               | 5                    |
+| ``ibmq_5_yorktown``           | 5                    |
 +-------------------------------+----------------------+
-| ibmq_16_melbourne             | 15                   |
+| ``ibmq_16_melbourne``         | 15                   |
 +-------------------------------+----------------------+
-| ibmq_paris                    | 27                   |
+| ``ibmq_paris``                | 27                   |
 +-------------------------------+----------------------+
-| ibmq_rome                     | 5                    |
+| ``ibmq_rome``                 | 5                    |
 +-------------------------------+----------------------+
-| ibmq_athens                   | 5                    |
+| ``ibmq_athens``               | 5                    |
 +-------------------------------+----------------------+
-| ibmq_berlin                   | 27                   |
+| ``ibmq_berlin``               | 27                   |
 +-------------------------------+----------------------+
-| ibmq_boeblingen               | 20                   |
+| ``ibmq_boeblingen``           | 20                   |
 +-------------------------------+----------------------+
-| ibmq_ourense                  | 5                    |
+| ``ibmq_ourense``              | 5                    |
 +-------------------------------+----------------------+
-| ibmq_vigo                     | 5                    |
+| ``ibmq_vigo``                 | 5                    |
 +-------------------------------+----------------------+
-| ibmq_valencia                 | 5                    |
+| ``ibmq_valencia``             | 5                    |
 +-------------------------------+----------------------+
-| ibmq_almaden                  | 20                   |
+| ``ibmq_almaden``              | 20                   |
 +-------------------------------+----------------------+
-| ibmq_singapore                | 20                   |
+| ``ibmq_singapore``            | 20                   |
 +-------------------------------+----------------------+
-| ibmq_johannesburg             | 20                   |
+| ``ibmq_johannesburg``         | 20                   |
 +-------------------------------+----------------------+
-| ibmq_essex                    | 5                    |
+| ``ibmq_essex``                | 5                    |
 +-------------------------------+----------------------+
-| ibmq_burlington               | 5                    |
+| ``ibmq_burlington``           | 5                    |
 +-------------------------------+----------------------+
-| ibmq_london                   | 5                    |
+| ``ibmq_london``               | 5                    |
 +-------------------------------+----------------------+
-| ibmq_rochester                | 53                   |
+| ``ibmq_rochester``            | 53                   |
 +-------------------------------+----------------------+
-| ibmq_cambridge                | 28                   |
+| ``ibmq_cambridge``            | 28                   |
 +-------------------------------+----------------------+