Regen runtime docs to add debug_tools module (#2161)

Qiskit · Oct 22, 2024 · 073f1ce · 073f1ce
1 parent a8c8834
commit 073f1ce
Show file tree

Hide file tree

Showing 74 changed files with 1,452 additions and 172 deletions.
diff --git a/docs/api/qiskit-ibm-runtime/_toc.json b/docs/api/qiskit-ibm-runtime/_toc.json
@@ -62,6 +62,27 @@
         }
       ]
     },
+    {
+      "title": "qiskit_ibm_runtime.debug_tools",
+      "children": [
+        {
+          "title": "Module overview",
+          "url": "/api/qiskit-ibm-runtime/debug_tools"
+        },
+        {
+          "title": "Neat",
+          "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat"
+        },
+        {
+          "title": "NeatPubResult",
+          "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult"
+        },
+        {
+          "title": "NeatResult",
+          "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult"
+        }
+      ]
+    },
     {
       "title": "qiskit_ibm_runtime.execution_span",
       "children": [

diff --git a/docs/api/qiskit-ibm-runtime/debug_tools.mdx b/docs/api/qiskit-ibm-runtime/debug_tools.mdx
@@ -0,0 +1,26 @@
+---
+title: debug_tools
+description: API reference for qiskit_ibm_runtime.debug_tools
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_runtime.debug_tools
+---
+
+<span id="debugging-tools-qiskit-ibm-runtime-debug-tools" />
+
+<span id="module-qiskit_ibm_runtime.debug_tools" />
+
+# Debugging tools
+
+`qiskit_ibm_runtime.debug_tools`
+
+The tools for debugging and analyzing qiskit-ibm-runtime jobs.
+
+## Classes
+
+|                                                                                                                      |                                                                                                                                                  |
+| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [`Neat`](qiskit_ibm_runtime.debug_tools.Neat "qiskit_ibm_runtime.debug_tools.Neat")(backend\[, noise\_model])        | A class to help understand the expected performance of estimator jobs.                                                                           |
+| [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.NeatResult")(pub\_results)  | A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. |
+| [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult")(vals) | A class to store the PUB results of `Neat`.                                                                                                      |
+
diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json
@@ -62,6 +62,27 @@
         }
       ]
     },
+    {
+      "title": "qiskit_ibm_runtime.debug_tools",
+      "children": [
+        {
+          "title": "Module overview",
+          "url": "/api/qiskit-ibm-runtime/dev/debug_tools"
+        },
+        {
+          "title": "Neat",
+          "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.Neat"
+        },
+        {
+          "title": "NeatPubResult",
+          "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatPubResult"
+        },
+        {
+          "title": "NeatResult",
+          "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatResult"
+        }
+      ]
+    },
     {
       "title": "qiskit_ibm_runtime.execution_span",
       "children": [

diff --git a/docs/api/qiskit-ibm-runtime/dev/debug_tools.mdx b/docs/api/qiskit-ibm-runtime/dev/debug_tools.mdx
@@ -0,0 +1,26 @@
+---
+title: debug_tools
+description: API reference for qiskit_ibm_runtime.debug_tools
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_runtime.debug_tools
+---
+
+<span id="debugging-tools-qiskit-ibm-runtime-debug-tools" />
+
+<span id="module-qiskit_ibm_runtime.debug_tools" />
+
+# Debugging tools
+
+`qiskit_ibm_runtime.debug_tools`
+
+The tools for debugging and analyzing qiskit-ibm-runtime jobs.
+
+## Classes
+
+|                                                                                                                      |                                                                                                                                                  |
+| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [`Neat`](qiskit_ibm_runtime.debug_tools.Neat "qiskit_ibm_runtime.debug_tools.Neat")(backend\[, noise\_model])        | A class to help understand the expected performance of estimator jobs.                                                                           |
+| [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.NeatResult")(pub\_results)  | A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. |
+| [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult")(vals) | A class to store the PUB results of `Neat`.                                                                                                      |
+
diff --git a/docs/api/qiskit-ibm-runtime/dev/index.mdx b/docs/api/qiskit-ibm-runtime/dev/index.mdx
@@ -13,5 +13,6 @@ description: API documentation for the qiskit-ibm-runtime client
 *   [Transpiler scheduling passes (`qiskit_ibm_runtime.transpiler.passes.scheduling`)](qiskit_ibm_runtime.transpiler.passes.scheduling)
 *   [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider)
 *   [Execution Spans (`qiskit_ibm_runtime.execution_span`)](execution_span)
+*   [Debugging tools (`qiskit_ibm_runtime.debug_tools`)](debug_tools)
 *   [Visualization (`qiskit_ibm_runtime.visualization`)](visualization)
 
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator
 
 # Estimator
 
-<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L46-L197">
+<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L45-L190">
   alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2")
 </Attribute>
 
diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
 
 # EstimatorV2
 
-<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L46-L197" signature="EstimatorV2(mode=None, options=None)" modifiers="class">
+<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L45-L190" signature="EstimatorV2(mode=None, options=None)" modifiers="class">
   Class for interacting with Qiskit Runtime Estimator primitive service.
 
   Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables.
@@ -65,10 +65,6 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
 
   *   **options** (`Union`\[`Dict`, [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – Estimator options, see `EstimatorOptions` for detailed description.
 
-  **Raises**
-
-  **NotImplementedError** – If “q-ctrl” channel strategy is used.
-
   ## Attributes
 
   ### mode
@@ -103,7 +99,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
 
   ### run
 
-  <Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L137-L160" signature="run(pubs, *, precision=None)">
+  <Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L134-L157" signature="run(pubs, *, precision=None)">
     Submit a request to the estimator primitive.
 
     **Parameters**