Update API dev docs (#2238)

An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Eric Arellano <[email protected]>
Qiskit · Nov 4, 2024 · 82aea7d · 82aea7d
1 parent c12e2ac
commit 82aea7d
Show file tree

Hide file tree

Showing 325 changed files with 4,472 additions and 1,329 deletions.
diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json
@@ -109,6 +109,10 @@
         {
           "title": "SliceSpan",
           "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.SliceSpan"
+        },
+        {
+          "title": "TwirledSliceSpan",
+          "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.TwirledSliceSpan"
         }
       ]
     },

diff --git a/docs/api/qiskit-ibm-runtime/dev/execution_span.mdx b/docs/api/qiskit-ibm-runtime/dev/execution_span.mdx
@@ -20,11 +20,12 @@ An [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_i
 
 ## Classes
 
-|                                                                                                                                                       |                                                                                                                                                                |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [`DoubleSliceSpan`](qiskit_ibm_runtime.execution_span.DoubleSliceSpan "qiskit_ibm_runtime.execution_span.DoubleSliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |
-| [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")(start, stop)                     | Abstract parent for classes that store an execution time span for a subset of job data.                                                                        |
-| [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")(spans)                        | A collection of timings for pub results.                                                                                                                       |
-| [`ShapeType`](qiskit_ibm_runtime.execution_span.ShapeType "qiskit_ibm_runtime.execution_span.ShapeType")                                              | alias of `Tuple`\[`int`, ...]                                                                                                                                  |
-| [`SliceSpan`](qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")(start, stop, data\_slices)                   | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |
+|                                                                                                                                                          |                                                                                                                                                                              |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [`DoubleSliceSpan`](qiskit_ibm_runtime.execution_span.DoubleSliceSpan "qiskit_ibm_runtime.execution_span.DoubleSliceSpan")(start, stop, data\_slices)    | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format.               |
+| [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")(start, stop)                        | Abstract parent for classes that store an execution time span for a subset of job data.                                                                                      |
+| [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")(spans)                           | A collection of timings for pub results.                                                                                                                                     |
+| [`ShapeType`](qiskit_ibm_runtime.execution_span.ShapeType "qiskit_ibm_runtime.execution_span.ShapeType")                                                 | alias of `Tuple`\[`int`, ...]                                                                                                                                                |
+| [`SliceSpan`](qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")(start, stop, data\_slices)                      | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format.               |
+| [`TwirledSliceSpan`](qiskit_ibm_runtime.execution_span.TwirledSliceSpan "qiskit_ibm_runtime.execution_span.TwirledSliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format when twirling. |
 
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
 # IBMBackend
 
-<Class id="qiskit_ibm_runtime.IBMBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L75-L937" signature="IBMBackend(configuration, service, api_client, instance=None)" modifiers="class">
+<Class id="qiskit_ibm_runtime.IBMBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L75-L931" signature="IBMBackend(configuration, service, api_client, instance=None)" modifiers="class">
   Backend class interfacing with an IBM Quantum backend.
 
   <Admonition title="Note" type="note">
@@ -343,7 +343,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### \_\_call\_\_
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.__call__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L541-L543" signature="__call__()">
+  <Function id="qiskit_ibm_runtime.IBMBackend.__call__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L535-L537" signature="__call__()">
     Call self as a function.
 
     **Return type**
@@ -353,7 +353,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### acquire\_channel
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L515-L521" signature="acquire_channel(qubit)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.acquire_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L509-L515" signature="acquire_channel(qubit)">
     Return the acquisition channel for the given qubit.
 
     **Returns**
@@ -367,7 +367,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### cancel\_session
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.cancel_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L902-L916" signature="cancel_session()">
+  <Function id="qiskit_ibm_runtime.IBMBackend.cancel_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L896-L910" signature="cancel_session()">
     Cancel session. All pending jobs will be cancelled.
 
     **Return type**
@@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### check\_faulty
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L565-L597" signature="check_faulty(circuit)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.check_faulty" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L559-L591" signature="check_faulty(circuit)">
     Check if the input circuit uses faulty qubits or edges.
 
     **Parameters**
@@ -395,7 +395,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### close\_session
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.close_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L918-L933" signature="close_session()">
+  <Function id="qiskit_ibm_runtime.IBMBackend.close_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L912-L927" signature="close_session()">
     Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs.
 
     **Return type**
@@ -405,7 +405,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### configuration
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L473-L497" signature="configuration()">
+  <Function id="qiskit_ibm_runtime.IBMBackend.configuration" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L467-L491" signature="configuration()">
     Return the backend configuration.
 
     Backend configuration contains fixed information about the backend, such as its name, number of qubits, basis gates, coupling map, quantum volume, etc.
@@ -435,7 +435,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### control\_channel
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L523-L536" signature="control_channel(qubits)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.control_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L517-L530" signature="control_channel(qubits)">
     Return the secondary drive channel for the given qubit
 
     This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -455,7 +455,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### defaults
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L450-L471" signature="defaults(refresh=False)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.defaults" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L444-L465" signature="defaults(refresh=False)">
     Return the pulse defaults for the backend.
 
     The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas/default\_pulse\_configuration](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json).
@@ -475,7 +475,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### drive\_channel
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L499-L505" signature="drive_channel(qubit)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.drive_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L493-L499" signature="drive_channel(qubit)">
     Return the drive channel for the given qubit.
 
     **Returns**
@@ -489,7 +489,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### get\_translation\_stage\_plugin
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.get_translation_stage_plugin" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L935-L937" signature="get_translation_stage_plugin()">
+  <Function id="qiskit_ibm_runtime.IBMBackend.get_translation_stage_plugin" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L929-L931" signature="get_translation_stage_plugin()">
     Return the default translation stage plugin name for IBM backends.
 
     **Return type**
@@ -499,7 +499,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### measure\_channel
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L507-L513" signature="measure_channel(qubit)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.measure_channel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L501-L507" signature="measure_channel(qubit)">
     Return the measure stimulus channel for the given qubit.
 
     **Returns**
@@ -513,7 +513,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### open\_session
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.open_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L872-L888" signature="open_session(max_time=None)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.open_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L866-L882" signature="open_session(max_time=None)">
     Open session
 
     **Return type**
@@ -523,7 +523,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### properties
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L374-L424" signature="properties(refresh=False, datetime=None)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.properties" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L368-L418" signature="properties(refresh=False, datetime=None)">
     Return the backend properties, subject to optional filtering.
 
     This data describes qubits properties (such as T1 and T2), gates properties (such as gate length and error), and other general properties of the backend.
@@ -575,7 +575,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### refresh
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L363-L372" signature="refresh()">
+  <Function id="qiskit_ibm_runtime.IBMBackend.refresh" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L357-L366" signature="refresh()">
     Retrieve the newest backend configuration and refresh the current backend target.
 
     **Return type**
@@ -585,7 +585,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### run
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L617-L788" signature="run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L611-L782" signature="run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)">
     Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run.
 
     **Parameters**
@@ -674,7 +674,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### status
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L426-L448" signature="status()">
+  <Function id="qiskit_ibm_runtime.IBMBackend.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L420-L442" signature="status()">
     Return the backend status.
 
     <Admonition title="Note" type="note">
@@ -696,7 +696,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
 
   ### target\_history
 
-  <Function id="qiskit_ibm_runtime.IBMBackend.target_history" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L352-L361" signature="target_history(datetime=None)">
+  <Function id="qiskit_ibm_runtime.IBMBackend.target_history" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L337-L355" signature="target_history(datetime=None)">
     A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
 
     **Return type**

diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder
 
 # RuntimeDecoder
 
-<Class id="qiskit_ibm_runtime.RuntimeDecoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L382-L489" signature="RuntimeDecoder(*args, **kwargs)" modifiers="class">
+<Class id="qiskit_ibm_runtime.RuntimeDecoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L393-L507" signature="RuntimeDecoder(*args, **kwargs)" modifiers="class">
   JSON Decoder used by runtime service.
 
   `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting).
@@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder
 
   ### object\_hook
 
-  <Function id="qiskit_ibm_runtime.RuntimeDecoder.object_hook" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L390-L489" signature="object_hook(obj)">
+  <Function id="qiskit_ibm_runtime.RuntimeDecoder.object_hook" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L401-L507" signature="object_hook(obj)">
     Called to decode object.
 
     **Return type**

diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder
 
 # RuntimeEncoder
 
-<Class id="qiskit_ibm_runtime.RuntimeEncoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L234-L379" signature="RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)" modifiers="class">
+<Class id="qiskit_ibm_runtime.RuntimeEncoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L235-L390" signature="RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)" modifiers="class">
   JSON Encoder used by runtime service.
 
   Constructor for JSONEncoder, with sensible defaults.
@@ -43,7 +43,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder
 
   ### default
 
-  <Function id="qiskit_ibm_runtime.RuntimeEncoder.default" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L237-L379" signature="default(obj)">
+  <Function id="qiskit_ibm_runtime.RuntimeEncoder.default" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L238-L390" signature="default(obj)">
     Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`).
 
     For example, to support arbitrary iterators, you could implement default like this: