Update API dev docs (#2249)

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>
Qiskit · Nov 6, 2024 · a4deec7 · a4deec7
1 parent 551868e
commit a4deec7
Show file tree

Hide file tree

Showing 75 changed files with 484 additions and 105 deletions.
diff --git a/...api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx b/...api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans
 
 # ExecutionSpans
 
-<Class id="qiskit_ibm_runtime.execution_span.ExecutionSpans" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L26-L143" signature="ExecutionSpans(spans)" modifiers="class">
+<Class id="qiskit_ibm_runtime.execution_span.ExecutionSpans" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L26-L144" signature="ExecutionSpans(spans)" modifiers="class">
   A collection of timings for pub results.
 
   This class is a list-like containing [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")s, where each execution span represents a time window of data collection, and contains a reference to exactly which of the data were collected during the window.
@@ -77,7 +77,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans
 
   ### draw
 
-  <Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.draw" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L120-L143" signature="draw(name=None, normalize_y=False, line_width=4)">
+  <Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.draw" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L120-L144" signature="draw(name=None, normalize_y=False, line_width=4)">
     Draw these execution spans.
 
     <Admonition title="Note" type="note">

diff --git a/...it-ibm-runtime/dev/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx b/...it-ibm-runtime/dev/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.LayerError
 
 # LayerError
 
-<Class id="qiskit_ibm_runtime.utils.noise_learner_result.LayerError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/noise_learner_result.py#L136-L309" signature="LayerError(circuit, qubits, error=None)" modifiers="class">
+<Class id="qiskit_ibm_runtime.utils.noise_learner_result.LayerError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/noise_learner_result.py#L136-L375" signature="LayerError(circuit, qubits, error=None)" modifiers="class">
   The error channel (in Pauli-Lindblad format) of a single layer of instructions.
 
   **Parameters**
@@ -132,5 +132,36 @@ python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.LayerError
 
     `Figure`
   </Function>
+
+  ### draw\_swarm
+
+  <Function id="qiskit_ibm_runtime.utils.noise_learner_result.LayerError.draw_swarm" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/noise_learner_result.py#L303-L367" signature="draw_swarm(num_bodies=None, max_rate=None, min_rate=None, connected=None, colors=None, num_bins=None, opacities=0.4, names=None, x_coo=None, marker_size=None, height=500, width=800)">
+    Draw a swarm plot of the rates in this layer error.
+
+    This function plots the rates along a vertical axes, offsetting the rates along the `x` axis so that they do not overlap with each other.
+
+    <Admonition title="Note" type="note">
+      To draw multiple layer errors at once, consider calling `draw_layer_errors_swarm()` directly.
+    </Admonition>
+
+    **Parameters**
+
+    *   **num\_bodies** (`Optional`\[`int`]) – The weight of the generators to include in the plot, or `None` if all the generators should be included.
+    *   **max\_rate** (`Optional`\[`float`]) – The largest rate to include in the plot, or `None` if no upper limit should be set.
+    *   **min\_rate** (`Optional`\[`float`]) – The smallest rate to include in the plot, or `None` if no lower limit should be set.
+    *   **connected** (`Union`\[`list`\[[`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `list`\[`str`], `None`]) – A list of generators whose markers are to be connected by lines.
+    *   **colors** (`Optional`\[`list`\[`str`]]) – A list of colors for the markers in the plot, or `None` if these colors are to be chosen automatically.
+    *   **num\_bins** (`Optional`\[`int`]) – The number of bins to place the rates into when calculating the `x`-axis offsets.
+    *   **opacities** (`Union`\[`float`, `list`\[`float`]]) – A list of opacities for the markers.
+    *   **names** (`Optional`\[`list`\[`str`]]) – The names of the various layers as displayed in the legend. If `None`, default names are assigned based on the layers’ position inside the `layer_errors` list.
+    *   **x\_coo** (`Optional`\[`list`\[`float`]]) – The `x`-axis coordinates of the vertical axes that the markers are drawn around, or `None` if these axes should be placed at regular intervals.
+    *   **marker\_size** (`Optional`\[`float`]) – The size of the marker in the plot.
+    *   **height** (`int`) – The height of the returned figure.
+    *   **width** (`int`) – The width of the returned figure.
+
+    **Return type**
+
+    `Figure`
+  </Function>
 </Class>
 
diff --git a/...iskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_execution_spans.mdx b/...iskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_execution_spans.mdx
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.visualization.draw_execution_spans
 
 # draw\_execution\_spans
 
-<Function id="qiskit_ibm_runtime.visualization.draw_execution_spans" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/visualization/draw_execution_spans.py#L50-L154" signature="draw_execution_spans(*spans, names=None, common_start=False, normalize_y=False, line_width=4, show_legend=None)">
+<Function id="qiskit_ibm_runtime.visualization.draw_execution_spans" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/visualization/draw_execution_spans.py#L51-L155" signature="draw_execution_spans(*spans, names=None, common_start=False, normalize_y=False, line_width=4, show_legend=None)">
   Draw one or more [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") on a bar plot.
 
   **Parameters**

diff --git a/...iskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx b/...iskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx
@@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.visualization.draw_layer_error_map
 
 # draw\_layer\_error\_map
 
-<Function id="qiskit_ibm_runtime.visualization.draw_layer_error_map" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/visualization/draw_layer_error_map.py#L29-L264" signature="draw_layer_error_map(layer_error, embedding, colorscale='Bluered', color_no_data='lightgray', color_out_of_scale='lightgreen', num_edge_segments=16, edge_width=4, height=500, highest_rate=None, background_color='white', radius=0.25, width=800)">
+<Function id="qiskit_ibm_runtime.visualization.draw_layer_error_map" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/visualization/draw_layer_error.py#L30-L264" signature="draw_layer_error_map(layer_error, embedding, colorscale='Bluered', color_no_data='lightgray', color_out_of_scale='lightgreen', num_edge_segments=16, edge_width=4, height=500, highest_rate=None, background_color='white', radius=0.25, width=800)">
   Draw a map view of a [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError").
 
   **Parameters**
@@ -32,7 +32,6 @@ python_api_name: qiskit_ibm_runtime.visualization.draw_layer_error_map
 
   *   **ValueError** – If the given coordinates are incompatible with the specified backend.
   *   **ValueError** – If `backend` has no coupling map.
-  *   **ModuleNotFoundError** – If the required `plotly` dependencies cannot be imported.
 
   **Return type**