Generate qiskit-ibm-provider 0.11 docs (#1191)

Qiskit · Apr 18, 2024 · 6dcc44c · 6dcc44c
1 parent 124e143
commit 6dcc44c
Show file tree

Hide file tree

Showing 103 changed files with 5,213 additions and 282 deletions.
diff --git a/docs/api/qiskit-ibm-provider/0.10/_package.json b/docs/api/qiskit-ibm-provider/0.10/_package.json
@@ -0,0 +1,4 @@
+{
+  "name": "qiskit-ibm-provider",
+  "version": "0.10.0"
+}
diff --git a/docs/api/qiskit-ibm-provider/0.10/_toc.json b/docs/api/qiskit-ibm-provider/0.10/_toc.json
@@ -0,0 +1,214 @@
+{
+  "title": "Qiskit IBM Provider",
+  "children": [
+    {
+      "title": "qiskit_ibm_provider",
+      "children": [
+        {
+          "title": "Overview",
+          "url": "/api/qiskit-ibm-provider/0.10/ibm_provider"
+        },
+        {
+          "title": "IBMBackend",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend"
+        },
+        {
+          "title": "IBMBackendApiError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError"
+        },
+        {
+          "title": "IBMBackendApiProtocolError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError"
+        },
+        {
+          "title": "IBMBackendError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError"
+        },
+        {
+          "title": "IBMBackendService",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService"
+        },
+        {
+          "title": "IBMBackendValueError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError"
+        },
+        {
+          "title": "IBMError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError"
+        },
+        {
+          "title": "IBMProvider",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider"
+        },
+        {
+          "title": "IBMProviderError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError"
+        },
+        {
+          "title": "IBMProviderValueError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError"
+        },
+        {
+          "title": "least_busy",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.least_busy"
+        },
+        {
+          "title": "Session",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session"
+        }
+      ]
+    },
+    {
+      "title": "qiskit_ibm_provider.job",
+      "children": [
+        {
+          "title": "Overview",
+          "url": "/api/qiskit-ibm-provider/0.10/ibm_job"
+        },
+        {
+          "title": "IBMCircuitJob",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob"
+        },
+        {
+          "title": "IBMCompositeJob",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob"
+        },
+        {
+          "title": "IBMJobApiError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError"
+        },
+        {
+          "title": "IBMJobError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError"
+        },
+        {
+          "title": "IBMJobFailureError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError"
+        },
+        {
+          "title": "IBMJobInvalidStateError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError"
+        },
+        {
+          "title": "IBMJobTimeoutError",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError"
+        },
+        {
+          "title": "job_monitor",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.job_monitor"
+        },
+        {
+          "title": "QueueInfo",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo"
+        }
+      ]
+    },
+    {
+      "title": "qiskit_ibm_provider.jupyter",
+      "url": "/api/qiskit-ibm-provider/0.10/ibm_jupyter"
+    },
+    {
+      "title": "qiskit_ibm_provider.transpiler",
+      "children": [
+        {
+          "title": "Overview",
+          "url": "/api/qiskit-ibm-provider/0.10/ibm_transpiler"
+        },
+        {
+          "title": "qiskit_ibm_provider.transpiler.passes",
+          "children": [
+            {
+              "title": "Overview",
+              "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes"
+            },
+            {
+              "title": "qiskit_ibm_provider.transpiler.passes.basis",
+              "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.basis"
+            },
+            {
+              "title": "qiskit_ibm_provider.transpiler.passes.scheduling",
+              "children": [
+                {
+                  "title": "Overview",
+                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling"
+                },
+                {
+                  "title": "ALAPScheduleAnalysis",
+                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
+                },
+                {
+                  "title": "ASAPScheduleAnalysis",
+                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
+                },
+                {
+                  "title": "BlockBasePadder",
+                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
+                },
+                {
+                  "title": "DynamicCircuitInstructionDurations",
+                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
+                },
+                {
+                  "title": "PadDelay",
+                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
+                },
+                {
+                  "title": "PadDynamicalDecoupling",
+                  "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "title": "qiskit_ibm_provider.utils",
+      "children": [
+        {
+          "title": "Overview",
+          "url": "/api/qiskit-ibm-provider/0.10/ibm_utils"
+        },
+        {
+          "title": "seconds_to_duration",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.seconds_to_duration"
+        },
+        {
+          "title": "to_python_identifier",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.to_python_identifier"
+        },
+        {
+          "title": "utc_to_local",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.utc_to_local"
+        },
+        {
+          "title": "validate_job_tags",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.validate_job_tags"
+        }
+      ]
+    },
+    {
+      "title": "qiskit_ibm_provider.visualization",
+      "children": [
+        {
+          "title": "Overview",
+          "url": "/api/qiskit-ibm-provider/0.10/ibm_visualization"
+        },
+        {
+          "title": "iplot_error_map",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_error_map"
+        },
+        {
+          "title": "iplot_gate_map",
+          "url": "/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_gate_map"
+        }
+      ]
+    },
+    {
+      "title": "Release notes",
+      "url": "/api/qiskit-ibm-provider/release-notes"
+    }
+  ],
+  "collapsed": true
+}
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/ibm_job.mdx b/docs/api/qiskit-ibm-provider/0.10/ibm_job.mdx
@@ -0,0 +1,46 @@
+---
+title: job
+description: API reference for qiskit_ibm_provider.job
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider.job
+---
+
+<span id="job-qiskit-ibm-provider-job" />
+
+<span id="module-qiskit_ibm_provider.job" />
+
+<span id="qiskit-ibm-provider-job" />
+
+# Job
+
+<span id="module-qiskit_ibm_provider.job" />
+
+`qiskit_ibm_provider.job`
+
+Modules representing IBM Quantum jobs.
+
+## Classes
+
+|                                                                                                                                         |                                                                         |
+| --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| [`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.IBMCircuitJob")(backend, api\_client, job\_id\[, ...]) | Representation of a job that executes on an IBM Quantum backend.        |
+| [`IBMCompositeJob`](qiskit_ibm_provider.job.IBMCompositeJob "qiskit_ibm_provider.job.IBMCompositeJob")(backend, api\_client\[, ...])    | Representation of a set of jobs that execute on an IBM Quantum backend. |
+| [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo")(\[position\_in\_queue, status, ...])               | Queue information for a job.                                            |
+
+## Functions
+
+|                                                                                                                      |                                             |
+| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
+| [`job_monitor`](qiskit_ibm_provider.job.job_monitor "qiskit_ibm_provider.job.job_monitor")(job\[, interval, output]) | Monitor the status of an `IBMJob` instance. |
+
+## Exception
+
+|                                                                                                                                           |                                                                     |
+| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| [`IBMJobError`](qiskit_ibm_provider.job.IBMJobError "qiskit_ibm_provider.job.IBMJobError")(\*message)                                     | Base class for errors raised by the job modules.                    |
+| [`IBMJobApiError`](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError")(\*message)                            | Errors that occur unexpectedly when querying the server.            |
+| [`IBMJobFailureError`](qiskit_ibm_provider.job.IBMJobFailureError "qiskit_ibm_provider.job.IBMJobFailureError")(\*message)                | Errors raised when a job failed.                                    |
+| [`IBMJobInvalidStateError`](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError")(\*message) | Errors raised when a job is not in a valid state for the operation. |
+| [`IBMJobTimeoutError`](qiskit_ibm_provider.job.IBMJobTimeoutError "qiskit_ibm_provider.job.IBMJobTimeoutError")(\*message)                | Errors raised when a job operation times out.                       |
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/ibm_jupyter.mdx b/docs/api/qiskit-ibm-provider/0.10/ibm_jupyter.mdx
@@ -0,0 +1,57 @@
+---
+title: jupyter
+description: API reference for qiskit_ibm_provider.jupyter
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider.jupyter
+---
+
+<span id="jupyter-tools-qiskit-ibm-provider-jupyter" />
+
+<span id="module-qiskit_ibm_provider.jupyter" />
+
+<span id="qiskit-ibm-provider-jupyter" />
+
+# Jupyter Tools
+
+<span id="module-qiskit_ibm_provider.jupyter" />
+
+`qiskit_ibm_provider.jupyter`
+
+A Collection of Jupyter magic functions and tools that extend the functionality of Qiskit for the IBM Quantum devices.
+
+<Admonition title="Note" type="note">
+  To use these tools locally, you’ll need to install the additional dependencies for the visualization functions:
+
+  ```python
+  pip install qiskit_ibm_provider[visualization]
+  ```
+</Admonition>
+
+## Detailed information on a single backend
+
+```python
+from qiskit_ibm_provider import IBMProvider
+import qiskit_ibm_provider.jupyter
+
+provider = IBMProvider(hub='ibm-q')
+backend = provider.get_backend('ibmq_vigo')
+```
+
+```python
+backend
+```
+
+```python
+<Fake1Q('fake_1q')>
+```
+
+## IBM Quantum dashboard
+
+```python
+from qiskit_ibm_provider import IBMProvider
+import qiskit_ibm_provider.jupyter
+
+%ibm_quantum_dashboard
+```
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/ibm_provider.mdx b/docs/api/qiskit-ibm-provider/0.10/ibm_provider.mdx
@@ -0,0 +1,66 @@
+---
+title: qiskit_ibm_provider
+description: API reference for qiskit_ibm_provider
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider
+---
+
+<span id="ibm-quantum-provider-qiskit-ibm-provider" />
+
+<span id="module-qiskit_ibm_provider" />
+
+<span id="qiskit-ibm-provider" />
+
+# IBM Quantum Provider
+
+<span id="module-qiskit_ibm_provider" />
+
+`qiskit_ibm_provider`
+
+Modules representing the Qiskit IBM Quantum Provider.
+
+## Logging
+
+The qiskit-ibm-provider uses the `qiskit_ibm_provider` logger.
+
+Two environment variables can be used to control the logging:
+
+> *   `QISKIT_IBM_PROVIDER_LOG_LEVEL`: Specifies the log level to use, for the Qiskit IBM provider modules. If an invalid level is set, the log level defaults to `WARNING`. The valid log levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL` (case-insensitive). If the environment variable is not set, then the parent logger’s level is used, which also defaults to `WARNING`.
+> *   `QISKIT_IBM_PROVIDER_LOG_FILE`: Specifies the name of the log file to use. If specified, messages will be logged to the file only. Otherwise messages will be logged to the standard error (usually the screen).
+
+For more advanced use, you can modify the logger itself. For example, to manually set the level to `WARNING`:
+
+```python
+import logging
+logging.getLogger('qiskit_ibm_provider').setLevel(logging.WARNING)
+```
+
+## Functions
+
+|                                                                                           |                                            |
+| ----------------------------------------------------------------------------------------- | ------------------------------------------ |
+| [`least_busy`](qiskit_ibm_provider.least_busy "qiskit_ibm_provider.least_busy")(backends) | Return the least busy backend from a list. |
+
+## Classes
+
+|                                                                                                                        |                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider")(\[token, url, name, instance, ...]) | Provides access to the IBM Quantum services available to an account. |
+| [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend")(configuration, provider, api\_client)  | Backend class interfacing with an IBM Quantum device.                |
+| [`IBMBackendService`](qiskit_ibm_provider.IBMBackendService "qiskit_ibm_provider.IBMBackendService")(provider, hgp)    | Backend namespace for an IBM Quantum account.                        |
+| [`Session`](qiskit_ibm_provider.Session "qiskit_ibm_provider.Session")(\[max\_time, session\_id])                      | Class for creating a flexible Qiskit Runtime session.                |
+
+## Exceptions
+
+|                                                                                                                                            |                                                                     |
+| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- |
+| [`IBMError`](qiskit_ibm_provider.IBMError "qiskit_ibm_provider.IBMError")(\*message)                                                       | Base class for errors raised by the provider modules.               |
+| [`IBMProviderError`](qiskit_ibm_provider.IBMProviderError "qiskit_ibm_provider.IBMProviderError")(\*message)                               | Base class for errors raise by IBMProvider.                         |
+| [`IBMProviderValueError`](qiskit_ibm_provider.IBMProviderValueError "qiskit_ibm_provider.IBMProviderValueError")(\*message)                | Value errors raised by IBMProvider.                                 |
+| [`IBMBackendError`](qiskit_ibm_provider.IBMBackendError "qiskit_ibm_provider.IBMBackendError")(\*message)                                  | Base class for errors raised by the backend modules.                |
+| [`IBMBackendApiError`](qiskit_ibm_provider.IBMBackendApiError "qiskit_ibm_provider.IBMBackendApiError")(\*message)                         | Errors that occur unexpectedly when querying the server.            |
+| [`IBMBackendApiProtocolError`](qiskit_ibm_provider.IBMBackendApiProtocolError "qiskit_ibm_provider.IBMBackendApiProtocolError")(\*message) | Errors raised when an unexpected value is received from the server. |
+| [`IBMBackendValueError`](qiskit_ibm_provider.IBMBackendValueError "qiskit_ibm_provider.IBMBackendValueError")(\*message)                   | Value errors raised by the backend modules.                         |
+| [`IBMProviderError`](qiskit_ibm_provider.IBMProviderError "qiskit_ibm_provider.IBMProviderError")(\*message)                               | Base class for errors raise by IBMProvider.                         |
+