From d401fdd68f7b7203cd7fcc8892edb0a501688f1c Mon Sep 17 00:00:00 2001
From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Date: Wed, 17 Apr 2024 16:08:52 -0400
Subject: [PATCH 1/3] Generate qiskit-ibm-provider 0.11 docs
---
.../qiskit-ibm-provider/0.10/_package.json | 4 +
docs/api/qiskit-ibm-provider/0.10/_toc.json | 214 ++++++
docs/api/qiskit-ibm-provider/0.10/ibm_job.mdx | 46 ++
.../qiskit-ibm-provider/0.10/ibm_jupyter.mdx | 57 ++
.../qiskit-ibm-provider/0.10/ibm_provider.mdx | 66 ++
.../0.10/ibm_transpiler.mdx | 28 +
.../qiskit-ibm-provider/0.10/ibm_utils.mdx | 102 +++
.../0.10/ibm_visualization.mdx | 35 +
docs/api/qiskit-ibm-provider/0.10/index.mdx | 14 +
.../0.10/qiskit_ibm_provider.IBMBackend.mdx | 626 ++++++++++++++++
...qiskit_ibm_provider.IBMBackendApiError.mdx | 16 +
...bm_provider.IBMBackendApiProtocolError.mdx | 16 +
.../qiskit_ibm_provider.IBMBackendError.mdx | 16 +
.../qiskit_ibm_provider.IBMBackendService.mdx | 160 ++++
...skit_ibm_provider.IBMBackendValueError.mdx | 16 +
.../0.10/qiskit_ibm_provider.IBMError.mdx | 16 +
.../0.10/qiskit_ibm_provider.IBMProvider.mdx | 340 +++++++++
.../qiskit_ibm_provider.IBMProviderError.mdx | 16 +
...kit_ibm_provider.IBMProviderValueError.mdx | 16 +
.../0.10/qiskit_ibm_provider.Session.mdx | 88 +++
.../qiskit_ibm_provider.job.IBMCircuitJob.mdx | 557 ++++++++++++++
...iskit_ibm_provider.job.IBMCompositeJob.mdx | 685 ++++++++++++++++++
...qiskit_ibm_provider.job.IBMJobApiError.mdx | 16 +
.../qiskit_ibm_provider.job.IBMJobError.mdx | 16 +
...it_ibm_provider.job.IBMJobFailureError.mdx | 16 +
...m_provider.job.IBMJobInvalidStateError.mdx | 16 +
...it_ibm_provider.job.IBMJobTimeoutError.mdx | 16 +
.../qiskit_ibm_provider.job.QueueInfo.mdx | 66 ++
.../qiskit_ibm_provider.job.job_monitor.mdx | 26 +
.../0.10/qiskit_ibm_provider.least_busy.mdx | 34 +
...t_ibm_provider.transpiler.passes.basis.mdx | 22 +
.../qiskit_ibm_provider.transpiler.passes.mdx | 27 +
...passes.scheduling.ALAPScheduleAnalysis.mdx | 141 ++++
...passes.scheduling.ASAPScheduleAnalysis.mdx | 141 ++++
...iler.passes.scheduling.BlockBasePadder.mdx | 135 ++++
...ing.DynamicCircuitInstructionDurations.mdx | 128 ++++
....transpiler.passes.scheduling.PadDelay.mdx | 147 ++++
...sses.scheduling.PadDynamicalDecoupling.mdx | 282 +++++++
..._provider.transpiler.passes.scheduling.mdx | 384 ++++++++++
...ibm_provider.utils.seconds_to_duration.mdx | 28 +
...bm_provider.utils.to_python_identifier.mdx | 28 +
...qiskit_ibm_provider.utils.utc_to_local.mdx | 32 +
...t_ibm_provider.utils.validate_job_tags.mdx | 29 +
...provider.visualization.iplot_error_map.mdx | 52 ++
..._provider.visualization.iplot_gate_map.mdx | 53 ++
docs/api/qiskit-ibm-provider/_package.json | 2 +-
docs/api/qiskit-ibm-provider/ibm_jupyter.mdx | 9 +-
docs/api/qiskit-ibm-provider/ibm_utils.mdx | 12 +-
.../qiskit_ibm_provider.IBMBackend.mdx | 34 +-
...qiskit_ibm_provider.IBMBackendApiError.mdx | 2 +-
...bm_provider.IBMBackendApiProtocolError.mdx | 2 +-
.../qiskit_ibm_provider.IBMBackendError.mdx | 2 +-
.../qiskit_ibm_provider.IBMBackendService.mdx | 12 +-
...skit_ibm_provider.IBMBackendValueError.mdx | 2 +-
.../qiskit_ibm_provider.IBMError.mdx | 2 +-
.../qiskit_ibm_provider.IBMProvider.mdx | 24 +-
.../qiskit_ibm_provider.IBMProviderError.mdx | 2 +-
...kit_ibm_provider.IBMProviderValueError.mdx | 2 +-
.../qiskit_ibm_provider.Session.mdx | 4 +-
.../qiskit_ibm_provider.job.IBMCircuitJob.mdx | 44 +-
...iskit_ibm_provider.job.IBMCompositeJob.mdx | 54 +-
...qiskit_ibm_provider.job.IBMJobApiError.mdx | 2 +-
.../qiskit_ibm_provider.job.IBMJobError.mdx | 2 +-
...it_ibm_provider.job.IBMJobFailureError.mdx | 2 +-
...m_provider.job.IBMJobInvalidStateError.mdx | 2 +-
...it_ibm_provider.job.IBMJobTimeoutError.mdx | 2 +-
.../qiskit_ibm_provider.job.QueueInfo.mdx | 4 +-
.../qiskit_ibm_provider.job.job_monitor.mdx | 2 +-
.../qiskit_ibm_provider.least_busy.mdx | 2 +-
...passes.scheduling.ALAPScheduleAnalysis.mdx | 4 +-
...passes.scheduling.ASAPScheduleAnalysis.mdx | 4 +-
...iler.passes.scheduling.BlockBasePadder.mdx | 4 +-
...ing.DynamicCircuitInstructionDurations.mdx | 8 +-
....transpiler.passes.scheduling.PadDelay.mdx | 4 +-
...sses.scheduling.PadDynamicalDecoupling.mdx | 65 +-
..._provider.transpiler.passes.scheduling.mdx | 37 +-
...ibm_provider.utils.seconds_to_duration.mdx | 2 +-
...bm_provider.utils.to_python_identifier.mdx | 2 +-
...qiskit_ibm_provider.utils.utc_to_local.mdx | 2 +-
...t_ibm_provider.utils.validate_job_tags.mdx | 2 +-
...provider.visualization.iplot_error_map.mdx | 10 +-
..._provider.visualization.iplot_gate_map.mdx | 10 +-
.../api/qiskit-ibm-provider/release-notes.mdx | 138 ++--
.../api/qiskit-ibm-provider/0.10/objects.inv | Bin 0 -> 3365 bytes
...ider.transpiler.passes.scheduling_10_0.png | Bin 0 -> 9282 bytes
...ider.transpiler.passes.scheduling_11_0.png | Bin 0 -> 9687 bytes
...ider.transpiler.passes.scheduling_12_0.png | Bin 0 -> 7004 bytes
...ider.transpiler.passes.scheduling_13_0.png | Bin 0 -> 6991 bytes
...ider.transpiler.passes.scheduling_14_0.png | Bin 0 -> 7246 bytes
...ider.transpiler.passes.scheduling_15_0.png | Bin 0 -> 18297 bytes
...ider.transpiler.passes.scheduling_16_0.png | Bin 0 -> 11921 bytes
...vider.transpiler.passes.scheduling_1_0.png | Bin 0 -> 57985 bytes
...vider.transpiler.passes.scheduling_2_0.png | Bin 0 -> 62527 bytes
...vider.transpiler.passes.scheduling_3_0.png | Bin 0 -> 3565 bytes
...vider.transpiler.passes.scheduling_4_0.png | Bin 0 -> 21200 bytes
...vider.transpiler.passes.scheduling_5_0.png | Bin 0 -> 21200 bytes
...vider.transpiler.passes.scheduling_6_0.png | Bin 0 -> 11208 bytes
...vider.transpiler.passes.scheduling_7_0.png | Bin 0 -> 7598 bytes
...vider.transpiler.passes.scheduling_8_0.png | Bin 0 -> 8263 bytes
...vider.transpiler.passes.scheduling_9_0.png | Bin 0 -> 12759 bytes
scripts/api-html-artifacts.json | 1 +
101 files changed, 5208 insertions(+), 281 deletions(-)
create mode 100644 docs/api/qiskit-ibm-provider/0.10/_package.json
create mode 100644 docs/api/qiskit-ibm-provider/0.10/_toc.json
create mode 100644 docs/api/qiskit-ibm-provider/0.10/ibm_job.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/ibm_jupyter.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/ibm_provider.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/ibm_transpiler.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/ibm_visualization.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/index.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.job_monitor.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.least_busy.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.basis.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.seconds_to_duration.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.to_python_identifier.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.utc_to_local.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.validate_job_tags.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_error_map.mdx
create mode 100644 docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_gate_map.mdx
create mode 100644 public/api/qiskit-ibm-provider/0.10/objects.inv
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_10_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_11_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_12_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_13_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_14_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_15_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_16_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_1_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_2_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_3_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_4_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_5_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_6_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_7_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_8_0.png
create mode 100644 public/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_9_0.png
diff --git a/docs/api/qiskit-ibm-provider/0.10/_package.json b/docs/api/qiskit-ibm-provider/0.10/_package.json
new file mode 100644
index 00000000000..9c7a52a5269
--- /dev/null
+++ 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
new file mode 100644
index 00000000000..dd975d3b313
--- /dev/null
+++ 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
new file mode 100644
index 00000000000..613ac57f0b3
--- /dev/null
+++ 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
+---
+
+
+
+
+
+
+
+# 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
new file mode 100644
index 00000000000..1a4965ba4cc
--- /dev/null
+++ 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
+---
+
+
+
+
+
+
+
+# Jupyter Tools
+
+
+
+`qiskit_ibm_provider.jupyter`
+
+A Collection of Jupyter magic functions and tools that extend the functionality of Qiskit for the IBM Quantum devices.
+
+
+ To use these tools locally, you’ll need to install the additional dependencies for the visualization functions:
+
+ ```python
+ pip install qiskit_ibm_provider[visualization]
+ ```
+
+
+## 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
+
+```
+
+## 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
new file mode 100644
index 00000000000..e82a4b52286
--- /dev/null
+++ 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
+---
+
+
+
+
+
+
+
+# IBM Quantum 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. |
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/ibm_transpiler.mdx b/docs/api/qiskit-ibm-provider/0.10/ibm_transpiler.mdx
new file mode 100644
index 00000000000..60c019ce32a
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/ibm_transpiler.mdx
@@ -0,0 +1,28 @@
+---
+title: transpiler
+description: API reference for qiskit_ibm_provider.transpiler
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider.transpiler
+---
+
+
+
+
+
+
+
+# IBM Backend Transpiler Tools
+
+
+
+`qiskit_ibm_provider.transpiler`
+
+A collection of transpiler tools for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical compute and control-flow/feedback based off of measurement results.
+
+## Transpiler Passes
+
+| | |
+| -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
+| [`passes`](qiskit_ibm_provider.transpiler.passes#module-qiskit_ibm_provider.transpiler.passes "qiskit_ibm_provider.transpiler.passes") | Transpiler Passes (qiskit\_ibm\_provider.transpiler.passes) |
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx b/docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx
new file mode 100644
index 00000000000..98295f4919e
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/ibm_utils.mdx
@@ -0,0 +1,102 @@
+---
+title: utils
+description: API reference for qiskit_ibm_provider.utils
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider.utils
+---
+
+
+
+
+
+
+
+# Utilities
+
+
+
+`qiskit_ibm_provider.utils`
+
+Utility functions related to the IBM Quantum Provider.
+
+## Conversion
+
+| | |
+| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| [`seconds_to_duration`](qiskit_ibm_provider.utils.seconds_to_duration "qiskit_ibm_provider.utils.seconds_to_duration")(seconds) | Converts seconds in a datetime delta to a duration. |
+| [`utc_to_local`](qiskit_ibm_provider.utils.utc_to_local "qiskit_ibm_provider.utils.utc_to_local")(utc\_dt) | Convert a UTC `datetime` object or string to a local timezone `datetime`. |
+
+## Misc Functions
+
+| | |
+| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| [`to_python_identifier`](qiskit_ibm_provider.utils.to_python_identifier "qiskit_ibm_provider.utils.to_python_identifier")(name) | Convert a name to a valid Python identifier. |
+| [`validate_job_tags`](qiskit_ibm_provider.utils.validate_job_tags "qiskit_ibm_provider.utils.validate_job_tags")(job\_tags, exception) | Validates input job tags. |
+
+
+
+
+
+## Publisher/subscriber model
+
+Message broker for the Publisher / Subscriber mechanism
+
+
+ Represents a “publisher”.
+
+ Every component (class) can become a [`Publisher`](#qiskit_ibm_provider.utils.pubsub.Publisher "qiskit_ibm_provider.utils.pubsub.Publisher") and send events by inheriting this class. Functions can call this class like:
+
+ ```python
+ Publisher().publish("event", args, ... )
+ ```
+
+ ### publish
+
+
+ Triggers an event, and associates some data to it, so if there are any subscribers, their callback will be called synchronously.
+
+ **Return type**
+
+ `None`
+
+
+
+
+ Represents a “subscriber”.
+
+ Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted.
+
+ ### clear
+
+
+ Unsubscribe everything
+
+ **Return type**
+
+ `None`
+
+
+ ### subscribe
+
+
+ Subscribes to an event, associating a callback function to that event, so when the event occurs, the callback will be called.
+
+ This is a blocking call, so try to keep callbacks as lightweight as possible.
+
+ **Return type**
+
+ `bool`
+
+
+ ### unsubscribe
+
+
+ Unsubscribe a pair event-callback, so the callback will not be called anymore when the event occurs.
+
+ **Return type**
+
+ `bool`
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/ibm_visualization.mdx b/docs/api/qiskit-ibm-provider/0.10/ibm_visualization.mdx
new file mode 100644
index 00000000000..a691c216bf6
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/ibm_visualization.mdx
@@ -0,0 +1,35 @@
+---
+title: visualization
+description: API reference for qiskit_ibm_provider.visualization
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider.visualization
+---
+
+
+
+
+
+
+
+# Visualizations
+
+
+
+`qiskit_ibm_provider.visualization`
+
+
+ To use these tools locally, you’ll need to install the additional dependencies for the visualization functions:
+
+ ```python
+ pip install qiskit_ibm_provider[visualization]
+ ```
+
+
+## Interactive Visualizations
+
+| | |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
+| [`iplot_gate_map`](qiskit_ibm_provider.visualization.iplot_gate_map "qiskit_ibm_provider.visualization.iplot_gate_map")(backend\[, figsize, ...]) | Plots an interactive gate map of a device. |
+| [`iplot_error_map`](qiskit_ibm_provider.visualization.iplot_error_map "qiskit_ibm_provider.visualization.iplot_error_map")(backend\[, figsize, ...]) | Plot the error map of a device. |
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/index.mdx b/docs/api/qiskit-ibm-provider/0.10/index.mdx
new file mode 100644
index 00000000000..fd5f3e44452
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/index.mdx
@@ -0,0 +1,14 @@
+---
+title: Qiskit IBM Provider API Docs
+description: API documentation for qiskit-ibm-provider
+---
+
+# qiskit-ibm-provider API Reference
+
+* [IBM Quantum Provider (`qiskit_ibm_provider`)](ibm_provider)
+* [Job (`qiskit_ibm_provider.job`)](ibm_job)
+* [Visualizations (`qiskit_ibm_provider.visualization`)](ibm_visualization)
+* [Jupyter Tools (`qiskit_ibm_provider.jupyter`)](ibm_jupyter)
+* [Utilities (`qiskit_ibm_provider.utils`)](ibm_utils)
+* [IBM Backend Transpiler Tools (`qiskit_ibm_provider.transpiler`)](ibm_transpiler)
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx
new file mode 100644
index 00000000000..4b30d440e28
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackend.mdx
@@ -0,0 +1,626 @@
+---
+title: IBMBackend
+description: API reference for qiskit_ibm_provider.IBMBackend
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.IBMBackend
+---
+
+# IBMBackend
+
+
+ Backend class interfacing with an IBM Quantum device.
+
+ You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow:
+
+ ```python
+ from qiskit import transpile
+ from qiskit_ibm_provider import IBMProvider
+ from qiskit.circuit.random import random_circuit
+
+ provider = IBMProvider()
+ backend = provider.backend.ibmq_vigo
+ qx = random_circuit(n_qubits=5, depth=4)
+ transpiled = transpile(qx, backend=backend)
+ job = backend.run(transpiled)
+ retrieved_job = provider.backend.retrieve_job(job.job_id())
+ ```
+
+
+ * Unlike `qiskit.execute()`, the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method does not transpile the circuits for you, so be sure to do so before submitting them.
+ * You should not instantiate the `IBMBackend` class directly. Instead, use the methods provided by an [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") instance to retrieve and handle backends.
+
+
+ Other methods return information about the backend. For example, the [`status()`](#qiskit_ibm_provider.IBMBackend.status "qiskit_ibm_provider.IBMBackend.status") method returns a [`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)") instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively:
+
+ ```python
+ status = backend.status()
+ is_operational = status.operational
+ jobs_in_queue = status.pending_jobs
+ ```
+
+ **Here is list of attributes available on the `IBMBackend` class:**
+
+ * name: backend name.
+
+ * backend\_version: backend version in the form X.Y.Z.
+
+ * num\_qubits: number of qubits.
+
+ * target: A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend.
+
+ * basis\_gates: list of basis gates names on the backend.
+
+ * gates: list of basis gates on the backend.
+
+ * local: backend is local or remote.
+
+ * simulator: backend is a simulator.
+
+ * conditional: backend supports conditional operations.
+
+ * open\_pulse: backend supports open pulse.
+
+ * memory: backend supports memory.
+
+ * max\_shots: maximum number of shots supported.
+
+ * coupling\_map (list): The coupling map for the device
+
+ * supported\_instructions (List\[str]): Instructions supported by the backend.
+
+ * dynamic\_reprate\_enabled (bool): whether delay between programs can be set dynamically (ie via `rep_delay`). Defaults to False.
+
+ * rep\_delay\_range (List\[float]): 2d list defining supported range of repetition delays for backend in μs. First entry is lower end of the range, second entry is higher end of the range. Optional, but will be specified when `dynamic_reprate_enabled=True`.
+
+ * default\_rep\_delay (float): Value of `rep_delay` if not specified by user and `dynamic_reprate_enabled=True`.
+
+ * n\_uchannels: Number of u-channels.
+
+ * u\_channel\_lo: U-channel relationship on device los.
+
+ * meas\_levels: Supported measurement levels.
+
+ * qubit\_lo\_range: Qubit lo ranges for each qubit with form (min, max) in GHz.
+
+ * meas\_lo\_range: Measurement lo ranges for each qubit with form (min, max) in GHz.
+
+ * dt: Qubit drive channel timestep in nanoseconds.
+
+ * dtm: Measurement drive channel timestep in nanoseconds.
+
+ * rep\_times: Supported repetition times (program execution time) for backend in μs.
+
+ * meas\_kernels: Supported measurement kernels.
+
+ * discriminators: Supported discriminators.
+
+ * hamiltonian: An optional dictionary with fields characterizing the system hamiltonian.
+
+ * channel\_bandwidth (list): Bandwidth of all channels (qubit, measurement, and U)
+
+ * acquisition\_latency (list): Array of dimension n\_qubits x n\_registers. Latency (in units of dt) to write a measurement result from qubit n into register slot m.
+
+ * conditional\_latency (list): Array of dimension n\_channels \[d->u->m] x n\_registers. Latency (in units of dt) to do a conditional operation on channel n from register slot m
+
+ * meas\_map (list): Grouping of measurement which are multiplexed
+
+ * max\_circuits (int): The maximum number of experiments per job
+
+ * sample\_name (str): Sample name for the backend
+
+ * n\_registers (int): Number of register slots available for feedback (if conditional is True)
+
+ * register\_map (list): An array of dimension n\_qubits X n\_registers that specifies whether a qubit can store a measurement in a certain register slot.
+
+ * configurable (bool): True if the backend is configurable, if the backend is a simulator
+
+ * credits\_required (bool): True if backend requires credits to run a job.
+
+ * online\_date (datetime): The date that the device went online
+
+ * display\_name (str): Alternate name field for the backend
+
+ * description (str): A description for the backend
+
+ * tags (list): A list of string tags to describe the backend
+
+ * version: version of `Backend` class (Ex: 1, 2)
+
+ * channels: An optional dictionary containing information of each channel – their purpose, type, and qubits operated on.
+
+ * parametric\_pulses (list): A list of pulse shapes which are supported on the backend. For example: `['gaussian', 'constant']`
+
+ * processor\_type (dict): Processor type for this backend. A dictionary of the form `{"family": , "revision": , segment: }` such as `{"family": "Canary", "revision": "1.0", segment: "A"}`.
+
+ > * family: Processor family of this backend.
+ > * revision: Revision version of this processor.
+ > * segment: Segment this processor belongs to within a larger chip.
+
+ IBMBackend constructor.
+
+ **Parameters**
+
+ * **configuration** (`Union`\[[`QasmBackendConfiguration`](/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v1.0)"), [`PulseBackendConfiguration`](/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v1.0)")]) – Backend configuration.
+ * **provider** ([`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.ibm_provider.IBMProvider")) – IBM Quantum account provider.
+ * **api\_client** (`AccountClient`) – IBM Quantum client used to communicate with the server.
+
+ ## Attributes
+
+ ### coupling\_map
+
+
+ Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.0)") object
+
+
+ ### dt
+
+
+ Return the system time resolution of input signals
+
+ This is required to be implemented if the backend supports Pulse scheduling.
+
+ **Return type**
+
+ `Optional`\[`float`]
+
+ **Returns**
+
+ The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned.
+
+
+ ### dtm
+
+
+ Return the system time resolution of output signals :returns: The output signal timestep in seconds. :rtype: dtm
+
+
+ ### id\_warning\_issued
+
+
+
+ ### instruction\_durations
+
+
+ Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)") object.
+
+
+ ### instruction\_schedule\_map
+
+
+ Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.0)") for the instructions defined in this backend’s target.
+
+
+ ### instructions
+
+
+ A list of Instruction tuples on the backend of the form `(instruction, (qubits)`
+
+ **Return type**
+
+ `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)"), `Tuple`\[`int`]]]
+
+
+ ### max\_circuits
+
+
+ The maximum number of circuits The maximum number of circuits that can be run in a single job. If there is no limit this will return None.
+
+ **Return type**
+
+ `int`
+
+
+ ### meas\_map
+
+
+ Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. :returns: The grouping of measurements which are multiplexed :rtype: meas\_map
+
+
+ ### num\_qubits
+
+
+ Return the number of qubits the backend has.
+
+ **Return type**
+
+ `int`
+
+
+ ### operation\_names
+
+
+ A list of instruction names that the backend supports.
+
+ **Return type**
+
+ `List`\[`str`]
+
+
+ ### operations
+
+
+ A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)") instances that the backend supports.
+
+ **Return type**
+
+ `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)")]
+
+
+ ### options
+
+
+ Return the options for the backend
+
+ The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method.
+
+
+ ### provider
+
+
+ Return the backend Provider.
+
+ **Returns**
+
+ the Provider responsible for the backend.
+
+ **Return type**
+
+ Provider
+
+
+ ### session
+
+
+ Return session
+
+ **Return type**
+
+ [`Session`](qiskit_ibm_provider.Session "qiskit_ibm_provider.session.Session")
+
+
+ ### target
+
+
+ A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. :rtype: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") :returns: Target
+
+
+ ### version
+
+
+
+ ### name
+
+
+ Name of the backend.
+
+
+ ### description
+
+
+ Optional human-readable description.
+
+
+ ### online\_date
+
+
+ Date that the backend came online.
+
+
+ ### backend\_version
+
+
+ Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface.
+
+
+ ## Methods
+
+ ### acquire\_channel
+
+
+ Return the acquisition channel for the given qubit.
+
+ **Returns**
+
+ The Qubit measurement acquisition line.
+
+ **Return type**
+
+ AcquireChannel
+
+
+ ### cancel\_session
+
+
+ Cancel session. All pending jobs will be cancelled.
+
+ **Return type**
+
+ `None`
+
+
+ ### 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**
+
+ `None`
+
+
+ ### 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.
+
+ The schema for backend configuration can be found in [Qiskit/ibm-quantum-schemas](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json).
+
+ **Return type**
+
+ `Union`\[[`QasmBackendConfiguration`](/api/qiskit/qiskit.providers.models.QasmBackendConfiguration "(in Qiskit v1.0)"), [`PulseBackendConfiguration`](/api/qiskit/qiskit.providers.models.PulseBackendConfiguration "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ The configuration for the backend.
+
+
+ ### control\_channel
+
+
+ Return the secondary drive channel for the given qubit.
+
+ This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
+
+ **Parameters**
+
+ **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
+
+ **Returns**
+
+ The Qubit measurement acquisition line.
+
+ **Return type**
+
+ List\[ControlChannel]
+
+
+ ### defaults
+
+
+ Return the pulse defaults for the backend.
+
+ The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json).
+
+ **Parameters**
+
+ **refresh** (`bool`) – If `True`, re-query the server for the backend pulse defaults. Otherwise, return a cached version.
+
+ **Return type**
+
+ `Optional`\[[`PulseDefaults`](/api/qiskit/qiskit.providers.models.PulseDefaults "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ The backend pulse defaults or `None` if the backend does not support pulse.
+
+
+ ### drive\_channel
+
+
+ Return the drive channel for the given qubit.
+
+ **Returns**
+
+ The Qubit drive channel
+
+ **Return type**
+
+ DriveChannel
+
+
+ ### get\_translation\_stage\_plugin
+
+
+ Return the default translation stage plugin name for IBM backends.
+
+ **Return type**
+
+ `str`
+
+
+ ### measure\_channel
+
+
+ Return the measure stimulus channel for the given qubit.
+
+ **Returns**
+
+ The Qubit measurement stimulus line
+
+ **Return type**
+
+ MeasureChannel
+
+
+ ### open\_session
+
+
+ Open session
+
+ **Return type**
+
+ [`Session`](qiskit_ibm_provider.Session "qiskit_ibm_provider.session.Session")
+
+
+ ### properties
+
+
+ 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.
+
+ The schema for backend properties can be found in [Qiskit/ibm-quantum-schemas](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_properties_schema.json).
+
+ **Parameters**
+
+ * **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
+ * **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the [`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)") whose timestamp is closest to, but older than, the specified datetime.
+
+ **Return type**
+
+ `Optional`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ The backend properties or `None` if the backend properties are not currently available.
+
+ **Raises**
+
+ **TypeError** – If an input argument is not of the correct type.
+
+
+ ### qubit\_properties
+
+
+ Return QubitProperties for a given qubit.
+
+ If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented.
+
+ **Parameters**
+
+ **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order
+
+ **Return type**
+
+ `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.0)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.0)")]]
+
+ **Returns**
+
+ The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`.
+
+ **Raises**
+
+ **NotImplementedError** – if the backend doesn’t support querying the qubit properties
+
+
+ ### run
+
+
+ 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**
+
+ * **circuits** (`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)"), `str`, `List`\[`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)"), `str`]]]) – An individual or a list of `QuantumCircuit`.
+
+ * **dynamic** (`Optional`\[`bool`]) – Whether the circuit is dynamic (uses in-circuit conditionals)
+
+ * **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call.
+
+ * **init\_circuit** (`Optional`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")]) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified.
+
+ * **init\_num\_resets** (`Optional`\[`int`]) – The number of qubit resets to insert before each circuit execution.
+
+ * **or** (*The following parameters are applicable only if dynamic=False is specified*) –
+
+ * **to.** (*defaulted*) –
+
+ * **header** (`Optional`\[`Dict`]) – User input that will be attached to the job and will be copied to the corresponding result header. Headers do not affect the run. This replaces the old `Qobj` header.
+
+ * **shots** (`Union`\[`int`, `float`, `None`]) – Number of repetitions of each circuit, for sampling. Default: 4000 or `max_shots` from the backend configuration, whichever is smaller.
+
+ * **memory** (`Optional`\[`bool`]) – If `True`, per-shot measurement bitstrings are returned as well (provided the backend supports it). For OpenPulse jobs, only measurement level 2 supports this option.
+
+ * **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) –
+
+ Level of the measurement output for pulse experiments. See [OpenPulse specification](https://arxiv.org/pdf/1809.03452.pdf) for details:
+
+ * `0`, measurements of the raw signal (the measurement output pulse envelope)
+ * `1`, measurement kernel is selected (a complex number obtained after applying the measurement kernel to the measurement output signal)
+ * `2` (default), a discriminator is selected and the qubit state is stored (0 or 1)
+
+ * **meas\_return** (`Union`\[`str`, `MeasReturnType`, `None`]) –
+
+ Level of measurement data for the backend to return. For `meas_level` 0 and 1:
+
+ * `single` returns information from every shot.
+ * `avg` returns average measurement output (averaged over number of shots).
+
+ * **rep\_delay** (`Optional`\[`float`]) – Delay between programs in seconds. Only supported on certain backends (if `backend.configuration().dynamic_reprate_enabled=True`). If supported, `rep_delay` must be from the range supplied by the backend (`backend.configuration().rep_delay_range`). Default is given by `backend.configuration().default_rep_delay`.
+
+ * **init\_qubits** (`Optional`\[`bool`]) – Whether to reset the qubits to the ground state for each shot. Default: `True`.
+
+ * **use\_measure\_esp** (`Optional`\[`bool`]) – Whether to use excited state promoted (ESP) readout for measurements which are the terminal instruction to a qubit. ESP readout can offer higher fidelity than standard measurement sequences. See [here](https://arxiv.org/pdf/2008.08571.pdf). Default: `True` if backend supports ESP readout, else `False`. Backend support for ESP readout is determined by the flag `measure_esp_enabled` in `backend.configuration()`.
+
+ * **noise\_model** (`Optional`\[`Any`]) – Noise model. (Simulators only)
+
+ * **seed\_simulator** (`Optional`\[`int`]) – Random seed to control sampling. (Simulators only)
+
+ * **\*\*run\_config** – Extra arguments used to configure the run.
+
+ **Return type**
+
+ `IBMJob`
+
+ **Returns**
+
+ The job to be executed.
+
+ **Raises**
+
+ * [**IBMBackendApiError**](qiskit_ibm_provider.IBMBackendApiError "qiskit_ibm_provider.IBMBackendApiError") – If an unexpected error occurred while submitting the job.
+
+ * [**IBMBackendApiProtocolError**](qiskit_ibm_provider.IBMBackendApiProtocolError "qiskit_ibm_provider.IBMBackendApiProtocolError") – If an unexpected value received from the server.
+
+ * [**IBMBackendValueError**](qiskit_ibm_provider.IBMBackendValueError "qiskit_ibm_provider.IBMBackendValueError") –
+
+ * If an input parameter value is not valid. - If ESP readout is used and the backend does not support this.
+
+
+ ### set\_options
+
+
+ Set the options fields for the backend
+
+ This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options.
+
+ **Parameters**
+
+ **fields** – The fields to update the options
+
+ **Raises**
+
+ **AttributeError** – If the field passed in is not part of the options
+
+
+ ### status
+
+
+ Return the backend status.
+
+
+ If the returned [`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)") instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them.
+
+
+ **Return type**
+
+ [`BackendStatus`](/api/qiskit/qiskit.providers.models.BackendStatus "(in Qiskit v1.0)")
+
+ **Returns**
+
+ The status of the backend.
+
+ **Raises**
+
+ [**IBMBackendApiProtocolError**](qiskit_ibm_provider.IBMBackendApiProtocolError "qiskit_ibm_provider.IBMBackendApiProtocolError") – If the status for the backend cannot be formatted properly.
+
+
+ ### target\_history
+
+
+ A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. :rtype: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") :returns: Target with properties found on datetime
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx
new file mode 100644
index 00000000000..e6d966f626c
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMBackendApiError
+description: API reference for qiskit_ibm_provider.IBMBackendApiError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.IBMBackendApiError
+---
+
+# IBMBackendApiError
+
+
+ Errors that occur unexpectedly when querying the server.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx
new file mode 100644
index 00000000000..1852d84849c
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMBackendApiProtocolError
+description: API reference for qiskit_ibm_provider.IBMBackendApiProtocolError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError
+---
+
+# IBMBackendApiProtocolError
+
+
+ Errors raised when an unexpected value is received from the server.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx
new file mode 100644
index 00000000000..1ba2cae9ee5
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMBackendError
+description: API reference for qiskit_ibm_provider.IBMBackendError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.IBMBackendError
+---
+
+# IBMBackendError
+
+
+ Base class for errors raised by the backend modules.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx
new file mode 100644
index 00000000000..d8f11435dc5
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendService.mdx
@@ -0,0 +1,160 @@
+---
+title: IBMBackendService
+description: API reference for qiskit_ibm_provider.IBMBackendService
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.IBMBackendService
+---
+
+# IBMBackendService
+
+
+ Backend namespace for an IBM Quantum account.
+
+ Represent a namespace that provides backend related services for the IBM Quantum backends available to this account. An instance of this class is used as a callable attribute to the [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") class. This allows a convenient way to query for all backends or to access a specific backend:
+
+ ```python
+ backends = provider.backends() # Invoke backends() to get the backends.
+ sim_backend = provider.backend.ibmq_qasm_simulator # Get a specific backend instance.
+ ```
+
+ Also, you are able to retrieve jobs from an account without specifying the backend name. For example, to retrieve the ten most recent jobs you have submitted, regardless of the backend they were submitted to, you could do:
+
+ ```python
+ most_recent_jobs = provider.backend.jobs(limit=10)
+ ```
+
+ It is also possible to retrieve a single job without specifying the backend name:
+
+ ```python
+ job = provider.backend.retrieve_job()
+ ```
+
+ IBMBackendService constructor.
+
+ **Parameters**
+
+ * **provider** ([`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.ibm_provider.IBMProvider")) – IBM Quantum account provider.
+ * **hgp** (`HubGroupProject`) – default hub/group/project to use for the service.
+
+ ## Methods
+
+ ### backends
+
+
+ Return all backends accessible via this account, subject to optional filtering.
+
+ **Parameters**
+
+ * **name** (`Optional`\[`str`]) – Backend name to filter by.
+
+ * **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend must have.
+
+ * **instance** (`Optional`\[`str`]) – The provider in the hub/group/project format.
+
+ * **dynamic\_circuits** (`Optional`\[`bool`]) – Filter by whether the backend supports dynamic circuits.
+
+ * **filters** (`Optional`\[`Callable`\[\[`List`\[[`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.ibm_backend.IBMBackend")]], `bool`]]) –
+
+ More complex filters, such as lambda functions. For example:
+
+ ```python
+ IBMProvider.backends(filters=lambda b: b.max_shots > 50000)
+ IBMProvider.backends(filters=lambda x: ("rz" in x.basis_gates )
+ ```
+
+ * **\*\*kwargs** –
+
+ Simple filters that require a specific value for an attribute in backend configuration, backend status, or provider credentials.
+
+ Examples:
+
+ ```python
+ # Get the operational real backends
+ IBMProvider.backends(simulator=False, operational=True)
+ # Get the backends with at least 127 qubits
+ IBMProvider.backends(min_num_qubits=127)
+ # Get the backends that support OpenPulse
+ IBMProvider.backends(open_pulse=True)
+ ```
+
+ For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)>
+
+ **Return type**
+
+ `List`\[[`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.ibm_backend.IBMBackend")]
+
+ **Returns**
+
+ The list of available backends that match the filter.
+
+ **Raises**
+
+ * [**IBMBackendValueError**](qiskit_ibm_provider.IBMBackendValueError "qiskit_ibm_provider.IBMBackendValueError") – If only one or two parameters from hub, group, project are specified.
+ * **QiskitBackendNotFoundError** – If the backend is not found in any instance.
+
+
+ ### jobs
+
+
+ Return a list of jobs, subject to optional filtering.
+
+ Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server.
+
+ **Parameters**
+
+ * **limit** (`Optional`\[`int`]) – Number of jobs to retrieve. `None` means no limit. Note that the number of sub-jobs within a composite job count towards the limit.
+ * **skip** (`int`) – Starting index for the job retrieval.
+ * **backend\_name** (`Optional`\[`str`]) – Name of the backend to retrieve jobs from.
+ * **status** (`Union`\[`Literal`\[‘pending’, ‘completed’], `List`\[`Union`\[[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)"), `str`]], [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)"), `str`, `None`]) – Filter jobs with either “pending” or “completed” status. You can also specify by
+ * **example** (*exact status. For*) – or status=\[“RUNNING”, “ERROR”].
+ * **status="RUNNING"** (*status=JobStatus.RUNNING or*) – or status=\[“RUNNING”, “ERROR”].
+ * **start\_datetime** (`Optional`\[`datetime`]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time.
+ * **end\_datetime** (`Optional`\[`datetime`]) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time.
+ * **job\_tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to jobs. Matched jobs are associated with all tags.
+ * **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.
+ * **instance** (`Optional`\[`str`]) – The provider in the hub/group/project format.
+ * **legacy** (`bool`) – If `True`, only retrieve jobs run from the archived `qiskit-ibmq-provider`.
+ * **Otherwise** –
+ * **qiskit-ibm-provider.** (*only retrieve jobs run from*) –
+
+ **Return type**
+
+ `List`\[`IBMJob`]
+
+ **Returns**
+
+ A list of `IBMJob` instances.
+
+ **Raises**
+
+ * [**IBMBackendValueError**](qiskit_ibm_provider.IBMBackendValueError "qiskit_ibm_provider.IBMBackendValueError") – If a keyword value is not recognized.
+ * **TypeError** – If the input start\_datetime or end\_datetime parameter value is not valid.
+
+
+ ### retrieve\_job
+
+
+ Return a single job.
+
+ **Parameters**
+
+ **job\_id** (`str`) – The ID of the job to retrieve.
+
+ **Return type**
+
+ `IBMJob`
+
+ **Returns**
+
+ The job with the given id.
+
+ **Raises**
+
+ * [**IBMBackendApiError**](qiskit_ibm_provider.IBMBackendApiError "qiskit_ibm_provider.IBMBackendApiError") – If an unexpected error occurred when retrieving the job.
+ * [**IBMBackendApiProtocolError**](qiskit_ibm_provider.IBMBackendApiProtocolError "qiskit_ibm_provider.IBMBackendApiProtocolError") – If unexpected return value received from the server.
+ * **IBMJobNotFoundError** – If job cannot be found.
+ * **IBMInputValueError** – If job exists but was run from a different service.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx
new file mode 100644
index 00000000000..c5584577e74
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMBackendValueError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMBackendValueError
+description: API reference for qiskit_ibm_provider.IBMBackendValueError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.IBMBackendValueError
+---
+
+# IBMBackendValueError
+
+
+ Value errors raised by the backend modules.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx
new file mode 100644
index 00000000000..9d68fa9ae35
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMError
+description: API reference for qiskit_ibm_provider.IBMError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.IBMError
+---
+
+# IBMError
+
+
+ Base class for errors raised by the provider modules.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx
new file mode 100644
index 00000000000..8787524a16b
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProvider.mdx
@@ -0,0 +1,340 @@
+---
+title: IBMProvider
+description: API reference for qiskit_ibm_provider.IBMProvider
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.IBMProvider
+---
+
+# IBMProvider
+
+
+ Provides access to the IBM Quantum services available to an account.
+
+ Authenticate against IBM Quantum for use from saved credentials or during session.
+
+ Credentials can be saved to disk by calling the save\_account() method:
+
+ ```python
+ from qiskit_ibm_provider import IBMProvider
+ IBMProvider.save_account(token=)
+ ```
+
+ You can set the default project using the hub, group, and project keywords in save\_account(). Once credentials are saved you can simply instantiate the provider like below to load the saved account and default project:
+
+ ```python
+ from qiskit_ibm_provider import IBMProvider
+ provider = IBMProvider()
+ ```
+
+ Instead of saving credentials to disk, you can also set the environment variables QISKIT\_IBM\_TOKEN, QISKIT\_IBM\_URL and QISKIT\_IBM\_INSTANCE and then instantiate the provider as below:
+
+ ```python
+ from qiskit_ibm_provider import IBMProvider
+ provider = IBMProvider()
+ ```
+
+ You can also enable an account just for the current session by instantiating the provider with the API token:
+
+ ```python
+ from qiskit_ibm_provider import IBMProvider
+ provider = IBMProvider(token=)
+ ```
+
+ token is the only required attribute that needs to be set using one of the above methods. If no url is set, it defaults to ‘[https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api)’.
+
+
+ The hub/group/project is selected based on the below selection order, in decreasing order of priority.
+
+ * The hub/group/project you explicity specify when calling a service. Ex: provider.get\_backend(), etc.
+ * The hub/group/project required for the service.
+ * The default hub/group/project you set using save\_account().
+ * A premium hub/group/project in your account.
+ * An open access hub/group/project.
+
+
+ The IBMProvider offers the [`IBMBackendService`](qiskit_ibm_provider.IBMBackendService "qiskit_ibm_provider.ibm_backend_service.IBMBackendService") which gives access to the IBM Quantum devices and simulators.
+
+ You can obtain an instance of the service as an attribute of the `IBMProvider` instance. For example:
+
+ ```python
+ backend_service = provider.backend
+ ```
+
+ Since [`IBMBackendService`](qiskit_ibm_provider.IBMBackendService "qiskit_ibm_provider.ibm_backend_service.IBMBackendService") is the main service, some of the backend-related methods are available through this class for convenience.
+
+ The [`backends()`](#qiskit_ibm_provider.IBMProvider.backends "qiskit_ibm_provider.IBMProvider.backends") method returns all the backends available to this account:
+
+ ```python
+ backends = provider.backends()
+ ```
+
+ The [`get_backend()`](#qiskit_ibm_provider.IBMProvider.get_backend "qiskit_ibm_provider.IBMProvider.get_backend") method returns a backend that matches the filters passed as argument. An example of retrieving a backend that matches a specified name:
+
+ ```python
+ simulator_backend = provider.get_backend('ibmq_qasm_simulator')
+ ```
+
+ IBMBackend’s are uniquely identified by their name. If you invoke [`get_backend()`](#qiskit_ibm_provider.IBMProvider.get_backend "qiskit_ibm_provider.IBMProvider.get_backend") twice, you will get the same IBMBackend instance, and any previously updated options will be reset to the default values.
+
+ It is also possible to use the `backend` attribute to reference a backend. As an example, to retrieve the same backend from the example above:
+
+ ```python
+ simulator_backend = provider.backend.ibmq_qasm_simulator
+ ```
+
+
+ The `backend` attribute can be used to autocomplete the names of backends available to this account. To autocomplete, press `tab` after `provider.backend.`. This feature may not be available if an error occurs during backend discovery. Also note that this feature is only available in interactive sessions, such as in Jupyter Notebook and the Python interpreter.
+
+
+ IBMProvider constructor
+
+ **Parameters**
+
+ * **token** (`Optional`\[`str`]) – IBM Quantum API token.
+ * **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api).
+ * **name** (`Optional`\[`str`]) – Name of the account to load.
+ * **instance** (`Optional`\[`str`]) – Provider in the hub/group/project format.
+ * **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication)
+ * **verify** (`Optional`\[`bool`]) – Whether to verify the server’s TLS certificate.
+
+ **Returns**
+
+ An instance of IBMProvider
+
+ **Raises**
+
+ **IBMInputValueError** – If an input is invalid.
+
+ ## Attributes
+
+ ### backend
+
+
+ Return the backend service.
+
+ **Return type**
+
+ [`IBMBackendService`](qiskit_ibm_provider.IBMBackendService "qiskit_ibm_provider.ibm_backend_service.IBMBackendService")
+
+ **Returns**
+
+ The backend service instance.
+
+
+ ### version
+
+
+
+ ## Methods
+
+ ### active\_account
+
+
+ Return the IBM Quantum account currently in use for the session.
+
+ **Return type**
+
+ `Optional`\[`Dict`\[`str`, `str`]]
+
+ **Returns**
+
+ A dictionary with information about the account currently in the session.
+
+
+ ### backends
+
+
+ Return all backends accessible via this account, subject to optional filtering.
+
+ **Parameters**
+
+ * **name** (`Optional`\[`str`]) – Backend name to filter by.
+
+ * **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend must have.
+
+ * **instance** (`Optional`\[`str`]) – The provider in the hub/group/project format.
+
+ * **filters** (`Optional`\[`Callable`\[\[`List`\[[`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.ibm_backend.IBMBackend")]], `bool`]]) –
+
+ More complex filters, such as lambda functions. For example:
+
+ ```python
+ IBMProvider.backends(filters=lambda b: b.max_shots > 50000)
+ IBMProvider.backends(filters=lambda x: ("rz" in x.basis_gates )
+ ```
+
+ * **\*\*kwargs** –
+
+ Simple filters that require a specific value for an attribute in backend configuration, backend status, or provider credentials. Examples:
+
+ ```python
+ # Get the operational real backends
+ IBMProvider.backends(simulator=False, operational=True)
+ # Get the backends with at least 127 qubits
+ IBMProvider.backends(min_num_qubits=127)
+ # Get the backends that support OpenPulse
+ IBMProvider.backends(open_pulse=True)
+ ```
+
+ For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)>
+
+ **Return type**
+
+ `List`\[[`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.ibm_backend.IBMBackend")]
+
+ **Returns**
+
+ The list of available backends that match the filter.
+
+
+ ### delete\_account
+
+
+ Delete a saved account from disk.
+
+ **Parameters**
+
+ **name** (`Optional`\[`str`]) – Name of the saved account to delete.
+
+ **Return type**
+
+ `bool`
+
+ **Returns**
+
+ True if the account was deleted. False if no account was found.
+
+
+ ### get\_backend
+
+
+ Return a single backend matching the specified filtering.
+
+ **Parameters**
+
+ * **name** (*str*) – Name of the backend.
+ * **instance** (`Optional`\[`str`]) – The provider in the hub/group/project format.
+ * **\*\*kwargs** – Dict used for filtering.
+
+ **Returns**
+
+ a backend matching the filtering.
+
+ **Return type**
+
+ Backend
+
+ **Raises**
+
+ * **QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria.
+ * [**IBMProviderValueError**](qiskit_ibm_provider.IBMProviderValueError "qiskit_ibm_provider.IBMProviderValueError") – If only one or two parameters from hub, group, project are specified.
+
+
+ ### instances
+
+
+ Return the IBM Quantum instances list currently in use for the session.
+
+ **Return type**
+
+ `List`\[`str`]
+
+ **Returns**
+
+ A list with instances currently in the session.
+
+
+ ### jobs
+
+
+ Return a list of jobs, subject to optional filtering.
+
+ Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server.
+
+ **Parameters**
+
+ * **limit** (`Optional`\[`int`]) – Number of jobs to retrieve. `None` means no limit. Note that the number of sub-jobs within a composite job count towards the limit.
+ * **skip** (`int`) – Starting index for the job retrieval.
+ * **backend\_name** (`Optional`\[`str`]) – Name of the backend to retrieve jobs from.
+ * **status** (`Optional`\[`Literal`\[‘pending’, ‘completed’]]) – Filter jobs with either “pending” or “completed” status.
+ * **start\_datetime** (`Optional`\[`datetime`]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time.
+ * **end\_datetime** (`Optional`\[`datetime`]) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time.
+ * **job\_tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to jobs. Matched jobs are associated with all tags.
+ * **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.
+ * **instance** (`Optional`\[`str`]) – The provider in the hub/group/project format.
+ * **legacy** (`bool`) – If `True`, only retrieve jobs run from the deprecated `qiskit-ibmq-provider`.
+ * **Otherwise** –
+ * **qiskit-ibm-provider.** (*only retrieve jobs run from*) –
+
+ **Return type**
+
+ `List`\[`IBMJob`]
+
+ **Returns**
+
+ A list of `IBMJob` instances.
+
+
+ ### retrieve\_job
+
+
+ Return a single job.
+
+ **Parameters**
+
+ **job\_id** (`str`) – The ID of the job to retrieve.
+
+ **Return type**
+
+ `IBMJob`
+
+ **Returns**
+
+ The job with the given id.
+
+
+ ### save\_account
+
+
+ Save the account to disk for future use.
+
+ **Parameters**
+
+ * **token** (`Optional`\[`str`]) – IBM Quantum API token.
+ * **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api)
+ * **instance** (`Optional`\[`str`]) – The hub/group/project.
+ * **name** (`Optional`\[`str`]) – Name of the account to save.
+ * **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication)
+ * **verify** (`Optional`\[`bool`]) – Verify the server’s TLS certificate.
+ * **overwrite** (`Optional`\[`bool`]) – `True` if the existing account is to be overwritten.
+
+ **Return type**
+
+ `None`
+
+
+ ### saved\_accounts
+
+
+ List the accounts saved on disk.
+
+ **Parameters**
+
+ * **default** (`Optional`\[`bool`]) – If set to True, only default accounts are returned.
+ * **name** (`Optional`\[`str`]) – If set, only accounts with the given name are returned.
+
+ **Return type**
+
+ `dict`
+
+ **Returns**
+
+ A dictionary with information about the accounts saved on disk.
+
+ **Raises**
+
+ **ValueError** – If an invalid account is found on disk.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx
new file mode 100644
index 00000000000..88c672229b4
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMProviderError
+description: API reference for qiskit_ibm_provider.IBMProviderError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.IBMProviderError
+---
+
+# IBMProviderError
+
+
+ Base class for errors raise by IBMProvider.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx
new file mode 100644
index 00000000000..465806a90ce
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.IBMProviderValueError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMProviderValueError
+description: API reference for qiskit_ibm_provider.IBMProviderValueError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.IBMProviderValueError
+---
+
+# IBMProviderValueError
+
+
+ Value errors raised by IBMProvider.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx
new file mode 100644
index 00000000000..9afb796f6fe
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.Session.mdx
@@ -0,0 +1,88 @@
+---
+title: Session
+description: API reference for qiskit_ibm_provider.Session
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.Session
+---
+
+# Session
+
+
+ Class for creating a flexible Qiskit Runtime session.
+
+ A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead.
+
+ You can open a Qiskit Runtime session using this `Session` class and submit one or more jobs.
+
+ **For example::**
+
+ from qiskit\_ibm\_provider import IBMProvider
+
+ \# Bell Circuit qr = QuantumRegister(2, name=”qr”) cr = ClassicalRegister(2, name=”cr”) qc = QuantumCircuit(qr, cr, name=”bell”) qc.h(qr\[0]) qc.cx(qr\[0], qr\[1]) qc.measure(qr, cr)
+
+ backend = IBMProvider().get\_backend(“ibmq\_qasm\_simulator”) backend.open\_session()
+
+ job = backend.run(qc) print(f”Job ID: \{job.job\_id()}”) print(f”Result: \{job.result()}”) # Close the session only if all jobs are finished and # you don’t need to run more in the session. backend.cancel\_session()
+
+ Session can also be used as a context manager:
+
+ ```python
+ with backend.open_session() as session:
+ job = backend.run(qc)
+ assert job.job_id() == session.session_id
+ ```
+
+ Session constructor.
+
+ **Parameters**
+
+ **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be in between 300 seconds and the [system imposed maximum](/run/max-execution-time).
+
+ **Raises**
+
+ **ValueError** – If an input value is invalid.
+
+ ## Attributes
+
+ ### active
+
+
+ Return the status of the session.
+
+ **Return type**
+
+ `bool`
+
+ **Returns**
+
+ True if the session is active, False otherwise.
+
+
+ ### session\_id
+
+
+ Return the session ID.
+
+ **Return type**
+
+ `str`
+
+ **Returns**
+
+ Session ID. None until a job runs in the session.
+
+
+ ## Methods
+
+ ### cancel
+
+
+ Set the session.\_active status to False
+
+ **Return type**
+
+ `None`
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx
new file mode 100644
index 00000000000..54763b88421
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCircuitJob.mdx
@@ -0,0 +1,557 @@
+---
+title: IBMCircuitJob
+description: API reference for qiskit_ibm_provider.job.IBMCircuitJob
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.job.IBMCircuitJob
+---
+
+# IBMCircuitJob
+
+
+ Representation of a job that executes on an IBM Quantum backend.
+
+ The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend.
+
+ If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_provider.job.IBMCircuitJob.status "qiskit_ibm_provider.job.IBMCircuitJob.status"). Job status can be one of the [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)") members. For example:
+
+ ```python
+ from qiskit.providers.jobstatus import JobStatus
+
+ job = backend.run(...)
+
+ try:
+ job_status = job.status() # Query the backend server for job status.
+ if job_status is JobStatus.RUNNING:
+ print("The job is still running")
+ except IBMJobApiError as ex:
+ print("Something wrong happened!: {}".format(ex))
+ ```
+
+
+ An error may occur when querying the remote server to get job information. The most common errors are temporary network failures and server errors, in which case an [`IBMJobApiError`](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") is raised. These errors usually clear quickly, so retrying the operation is likely to succeed.
+
+
+ Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](#qiskit_ibm_provider.job.IBMCircuitJob.result "qiskit_ibm_provider.job.IBMCircuitJob.result") is an example of a blocking method:
+
+ ```python
+ job = backend.run(...)
+
+ try:
+ job_result = job.result() # It will block until the job finishes.
+ print("The job finished with result {}".format(job_result))
+ except JobError as ex:
+ print("Something wrong happened!: {}".format(ex))
+ ```
+
+ Job information retrieved from the server is attached to the `IBMCircuitJob` instance as attributes. Given that Qiskit and the server can be updated independently, some of these attributes might be deprecated or experimental. Supported attributes can be retrieved via methods. For example, you can use [`creation_date()`](#qiskit_ibm_provider.job.IBMCircuitJob.creation_date "qiskit_ibm_provider.job.IBMCircuitJob.creation_date") to retrieve the job creation date, which is a supported attribute.
+
+ IBMCircuitJob constructor.
+
+ **Parameters**
+
+ * **backend** ([`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.ibm_backend.IBMBackend")) – The backend instance used to run this job.
+ * **api\_client** (`AccountClient`) – Object for connecting to the server.
+ * **job\_id** (`str`) – Job ID.
+ * **creation\_date** (`Optional`\[`str`]) – Job creation date.
+ * **status** (`Optional`\[`str`]) – Job status returned by the server.
+ * **runtime\_client** (`Optional`\[`RuntimeClient`]) – Object for connecting to the runtime server
+ * **kind** (`Optional`\[`str`]) – Job type.
+ * **name** (`Optional`\[`str`]) – Job name.
+ * **time\_per\_step** (`Optional`\[`dict`]) – Time spent for each processing step.
+ * **result** (`Optional`\[`dict`]) – Job result.
+ * **error** (`Optional`\[`dict`]) – Job error.
+ * **tags** (`Optional`\[`List`\[`str`]]) – Job tags.
+ * **run\_mode** (`Optional`\[`str`]) – Scheduling mode the job runs in.
+ * **client\_info** (`Optional`\[`Dict`\[`str`, `str`]]) – Client information from the API.
+ * **kwargs** (`Any`) – Additional job attributes.
+
+ ## Attributes
+
+ ### client\_version
+
+
+ Return version of the client used for this job.
+
+ **Return type**
+
+ `Dict`\[`str`, `str`]
+
+ **Returns**
+
+ **Client version in dictionary format, where the key is the name**
+
+ of the client and the value is the version.
+
+
+ ### usage\_estimation
+
+
+ Return usage estimation information for this job.
+
+ **Return type**
+
+ `Dict`\[`str`, `Any`]
+
+ **Returns**
+
+ `quantum_seconds` which is the estimated quantum time of the job in seconds. Quantum time represents the time that the QPU complex is occupied exclusively by the job.
+
+
+ ### version
+
+
+
+ ## Methods
+
+ ### backend
+
+
+ Return the backend where this job was executed.
+
+ **Return type**
+
+ [`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")
+
+
+ ### backend\_options
+
+
+ Return the backend configuration options used for this job.
+
+ Options that are not applicable to the job execution are not returned. Some but not all of the options with default values are returned. You can use [`qiskit_ibm_provider.IBMBackend.options`](qiskit_ibm_provider.IBMBackend#options "qiskit_ibm_provider.IBMBackend.options") to see all backend options.
+
+ **Return type**
+
+ `Dict`
+
+ **Returns**
+
+ Backend options used for this job. An empty dictionary is returned if the options cannot be retrieved.
+
+
+ ### cancel
+
+
+ Attempt to cancel the job.
+
+
+ Depending on the state the job is in, it might be impossible to cancel the job.
+
+
+ **Return type**
+
+ `bool`
+
+ **Returns**
+
+ `True` if the job is cancelled, else `False`.
+
+ **Raises**
+
+ * [**IBMJobInvalidStateError**](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError") – If the job is in a state that cannot be cancelled.
+ * [**IBMJobError**](qiskit_ibm_provider.job.IBMJobError "qiskit_ibm_provider.job.IBMJobError") – If unable to cancel job.
+
+
+ ### cancelled
+
+
+ Return whether the job has been cancelled.
+
+ **Return type**
+
+ `bool`
+
+
+ ### circuits
+
+
+ Return the circuits for this job.
+
+ **Return type**
+
+ `List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ The circuits or for this job. An empty list is returned if the circuits cannot be retrieved (for example, if the job uses an old format that is no longer supported).
+
+
+ ### creation\_date
+
+
+ Return job creation date, in local time.
+
+ **Return type**
+
+ `datetime`
+
+ **Returns**
+
+ The job creation date as a datetime object, in local time.
+
+
+ ### done
+
+
+ Return whether the job has successfully run.
+
+ **Return type**
+
+ `bool`
+
+
+ ### error\_message
+
+
+ Provide details about the reason of failure.
+
+ **Return type**
+
+ `Optional`\[`str`]
+
+ **Returns**
+
+ An error report if the job failed or `None` otherwise.
+
+
+ ### header
+
+
+
+ ### in\_final\_state
+
+
+ Return whether the job is in a final job state such as `DONE` or `ERROR`.
+
+ **Return type**
+
+ `bool`
+
+
+ ### job\_id
+
+
+ Return the job ID assigned by the server.
+
+ **Return type**
+
+ `str`
+
+ **Returns**
+
+ Job ID.
+
+
+ ### name
+
+
+ Return the name assigned to this job.
+
+ **Return type**
+
+ `Optional`\[`str`]
+
+ **Returns**
+
+ Job name or `None` if no name was assigned to this job.
+
+
+ ### properties
+
+
+ Return the backend properties for this job.
+
+ **Parameters**
+
+ **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
+
+ **Return type**
+
+ `Optional`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ The backend properties used for this job, at the time the job was run, or `None` if properties are not available.
+
+
+ ### queue\_info
+
+
+ Return queue information for this job.
+
+ The queue information may include queue position, estimated start and end time, and dynamic priorities for the hub, group, and project. See [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo") for more information.
+
+
+ The queue information is calculated after the job enters the queue. Therefore, some or all of the information may not be immediately available, and this method may return `None`.
+
+
+ **Return type**
+
+ `Optional`\[[`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.queueinfo.QueueInfo")]
+
+ **Returns**
+
+ A [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo") instance that contains queue information for this job, or `None` if queue information is unknown or not applicable.
+
+
+ ### queue\_position
+
+
+ Return the position of the job in the server queue.
+
+
+ The position returned is within the scope of the provider and may differ from the global queue position.
+
+
+ **Parameters**
+
+ **refresh** (`bool`) – If `True`, re-query the server to get the latest value. Otherwise return the cached value.
+
+ **Return type**
+
+ `Optional`\[`int`]
+
+ **Returns**
+
+ Position in the queue or `None` if position is unknown or not applicable.
+
+
+ ### refresh
+
+
+ Obtain the latest job information from the server.
+
+ This method may add additional attributes to this job instance, if new information becomes available.
+
+ **Raises**
+
+ [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server.
+
+ **Return type**
+
+ `None`
+
+
+ ### result
+
+
+ Return the result of the job.
+
+
+ Some IBM Quantum job results can only be read once. A second attempt to query the server for the same job will fail, since the job has already been “consumed”.
+
+ The first call to this method in an `IBMCircuitJob` instance will query the server and consume any available job results. Subsequent calls to that instance’s `result()` will also return the results, since they are cached. However, attempting to retrieve the results again in another instance or session might fail due to the job results having been consumed.
+
+
+
+ When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") instance can be used to verify whether it contains partial results.
+
+ For example, if one of the experiments in the job failed, trying to get the counts of the unsuccessful experiment would raise an exception since there are no counts to return:
+
+ ```python
+ try:
+ counts = result.get_counts("failed_experiment")
+ except QiskitError:
+ print("Experiment failed!")
+ ```
+
+
+ If the job failed, you can use [`error_message()`](#qiskit_ibm_provider.job.IBMCircuitJob.error_message "qiskit_ibm_provider.job.IBMCircuitJob.error_message") to get more information.
+
+ **Parameters**
+
+ * **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job.
+ * **refresh** (`bool`) – If `True`, re-query the server for the result. Otherwise return the cached value.
+
+ **Return type**
+
+ [`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)")
+
+ **Returns**
+
+ Job result.
+
+ **Raises**
+
+ * [**IBMJobInvalidStateError**](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError") – If the job was cancelled.
+ * [**IBMJobFailureError**](qiskit_ibm_provider.job.IBMJobFailureError "qiskit_ibm_provider.job.IBMJobFailureError") – If the job failed.
+ * [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server.
+
+
+ ### running
+
+
+ Return whether the job is actively running.
+
+ **Return type**
+
+ `bool`
+
+
+ ### scheduling\_mode
+
+
+ Return the scheduling mode the job is in.
+
+ **Return type**
+
+ `Optional`\[`str`]
+
+ **Returns**
+
+ The scheduling mode the job is in or `None` if the information is not available.
+
+
+ ### status
+
+
+ Query the server for the latest job status.
+
+
+ This method is not designed to be invoked repeatedly in a loop for an extended period of time. Doing so may cause the server to reject your request. Use [`wait_for_final_state()`](#qiskit_ibm_provider.job.IBMCircuitJob.wait_for_final_state "qiskit_ibm_provider.job.IBMCircuitJob.wait_for_final_state") if you want to wait for the job to finish.
+
+
+
+ If the job failed, you can use [`error_message()`](#qiskit_ibm_provider.job.IBMCircuitJob.error_message "qiskit_ibm_provider.job.IBMCircuitJob.error_message") to get more information.
+
+
+ **Return type**
+
+ [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)")
+
+ **Returns**
+
+ The status of the job.
+
+ **Raises**
+
+ [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server.
+
+
+ ### submit
+
+
+ Unsupported method.
+
+
+ This method is not supported, please use `run()` to submit a job.
+
+
+ **Raises**
+
+ **NotImplementedError** – Upon invocation.
+
+ **Return type**
+
+ `None`
+
+
+ ### tags
+
+
+ Return the tags assigned to this job.
+
+ **Return type**
+
+ `List`\[`str`]
+
+ **Returns**
+
+ Tags assigned to this job.
+
+
+ ### time\_per\_step
+
+
+ Return the date and time information on each step of the job processing.
+
+ The output dictionary contains the date and time information on each step of the job processing, in local time. The keys of the dictionary are the names of the steps, and the values are the date and time data, as a datetime object with local timezone info. For example:
+
+ ```python
+ {'CREATING': datetime(2020, 2, 13, 15, 19, 25, 717000, tzinfo=tzlocal(),
+ 'CREATED': datetime(2020, 2, 13, 15, 19, 26, 467000, tzinfo=tzlocal(),
+ 'VALIDATING': datetime(2020, 2, 13, 15, 19, 26, 527000, tzinfo=tzlocal()}
+ ```
+
+ **Return type**
+
+ `Optional`\[`Dict`]
+
+ **Returns**
+
+ Date and time information on job processing steps, in local time, or `None` if the information is not yet available.
+
+
+ ### update\_name
+
+
+ Update the name associated with this job.
+
+ **Parameters**
+
+ **name** (`str`) – The new name for this job.
+
+ **Return type**
+
+ `str`
+
+ **Returns**
+
+ The new name associated with this job.
+
+
+ ### update\_tags
+
+
+ Update the tags associated with this job.
+
+ **Parameters**
+
+ **new\_tags** (`List`\[`str`]) – New tags to assign to the job.
+
+ **Return type**
+
+ `List`\[`str`]
+
+ **Returns**
+
+ The new tags associated with this job.
+
+ **Raises**
+
+ * [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server or updating the job tags.
+ * [**IBMJobInvalidStateError**](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError") – If none of the input parameters are specified or if any of the input parameters are invalid.
+
+
+ ### wait\_for\_final\_state
+
+
+ **Use the websocket server to wait for the final the state of a job. The server**
+
+ will remain open if the job is still running and the connection will be terminated once the job completes. Then update and return the status of the job.
+
+ **Parameters**
+
+ **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely.
+
+ **Raises**
+
+ [**IBMJobTimeoutError**](qiskit_ibm_provider.job.IBMJobTimeoutError "qiskit_ibm_provider.job.IBMJobTimeoutError") – If the job does not complete within given timeout.
+
+ **Return type**
+
+ `None`
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx
new file mode 100644
index 00000000000..2f520b2af14
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMCompositeJob.mdx
@@ -0,0 +1,685 @@
+---
+title: IBMCompositeJob
+description: API reference for qiskit_ibm_provider.job.IBMCompositeJob
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.job.IBMCompositeJob
+---
+
+# IBMCompositeJob
+
+
+ Representation of a set of jobs that execute on an IBM Quantum backend.
+
+ An `IBMCompositeJob` instance is returned when you call `IBMBackend.run()` to submit a list of circuits whose length exceeds the maximum allowed by the backend or by the `max_circuits_per_job` parameter.
+
+ This `IBMCompositeJob` instance manages all the sub-jobs for you and can be used like a traditional job instance. For example, you can continue to use methods like [`status()`](#qiskit_ibm_provider.job.IBMCompositeJob.status "qiskit_ibm_provider.job.IBMCompositeJob.status") and [`result()`](#qiskit_ibm_provider.job.IBMCompositeJob.result "qiskit_ibm_provider.job.IBMCompositeJob.result") to get the job status and result, respectively.
+
+ You can also retrieve a previously executed `IBMCompositeJob` using the `job()` and [`jobs()`](qiskit_ibm_provider.IBMBackendService#jobs "qiskit_ibm_provider.IBMBackendService.jobs") methods, like you would with traditional jobs.
+
+ `IBMCompositeJob` also allows you to re-run failed jobs, using the [`rerun_failed()`](#qiskit_ibm_provider.job.IBMCompositeJob.rerun_failed "qiskit_ibm_provider.job.IBMCompositeJob.rerun_failed") method. This method will re-submit all failed or cancelled sub-jobs. Any circuits that failed to be submitted (e.g. due to server error) will only be re-submitted if the circuits are known. That is, if this `IBMCompositeJob` was returned by [`qiskit_ibm_provider.IBMBackend.run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") and not retrieved from the server.
+
+ Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](#qiskit_ibm_provider.job.IBMCompositeJob.result "qiskit_ibm_provider.job.IBMCompositeJob.result") is an example of a blocking method, and control will return only after all sub-jobs finish.
+
+ `IBMCompositeJob` uses job tags to identify sub-jobs. It is therefore important to preserve these tags. All tags used internally by `IBMCompositeJob` start with `ibm_composite_job_`.
+
+ IBMCompositeJob constructor.
+
+ **Parameters**
+
+ * **backend** ([`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.ibm_backend.IBMBackend")) – The backend instance used to run this job.
+ * **api\_client** (`AccountClient`) – Object for connecting to the server.
+ * **job\_id** (`Optional`\[`str`]) – Job ID.
+ * **creation\_date** (`Optional`\[`datetime`]) – Job creation date.
+ * **jobs** (`Optional`\[`List`\[[`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.ibm_circuit_job.IBMCircuitJob")]]) – A list of sub-jobs.
+ * **circuits\_list** (`Optional`\[`List`\[`List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")]]]) – Circuits for this job.
+ * **run\_config** (`Optional`\[`Dict`]) – Runtime configuration for this job.
+ * **name** (`Optional`\[`str`]) – Job name.
+ * **tags** (`Optional`\[`List`\[`str`]]) – Job tags.
+ * **client\_version** (`Optional`\[`Dict`]) – Client used for the job.
+
+ **Raises**
+
+ [**IBMJobInvalidStateError**](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError") – If one or more subjobs is missing.
+
+ ## Attributes
+
+ ### client\_version
+
+
+ Return version of the client used for this job.
+
+ **Return type**
+
+ `Dict`\[`str`, `str`]
+
+ **Returns**
+
+ **Client version in dictionary format, where the key is the name**
+
+ of the client and the value is the version. An empty dictionary is returned if the information is not yet known.
+
+
+ ### version
+
+
+
+ ## Methods
+
+ ### backend
+
+
+ Return the backend where this job was executed.
+
+ **Return type**
+
+ [`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")
+
+
+ ### backend\_options
+
+
+ Return the backend configuration options used for this job.
+
+ Options that are not applicable to the job execution are not returned. Some but not all of the options with default values are returned. You can use [`qiskit_ibm_provider.IBMBackend.options`](qiskit_ibm_provider.IBMBackend#options "qiskit_ibm_provider.IBMBackend.options") to see all backend options.
+
+ **Return type**
+
+ `Dict`\[`str`, `Any`]
+
+ **Returns**
+
+ Backend options used for this job.
+
+
+ ### block\_for\_submit
+
+
+ Block until all sub-jobs are submitted.
+
+ **Return type**
+
+ `None`
+
+
+ ### cancel
+
+
+ Attempt to cancel the job.
+
+
+ Depending on the state the job is in, it might be impossible to cancel the job.
+
+
+ **Return type**
+
+ `bool`
+
+ **Returns**
+
+ `True` if the job is cancelled, else `False`.
+
+ **Raises**
+
+ [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server.
+
+
+ ### cancelled
+
+
+ Return whether the job has been cancelled.
+
+ **Return type**
+
+ `bool`
+
+
+ ### circuits
+
+
+ Return the circuits for this job.
+
+ **Return type**
+
+ `List`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ The circuits for this job.
+
+
+ ### creation\_date
+
+
+ Return job creation date, in local time.
+
+ **Return type**
+
+ `Optional`\[`datetime`]
+
+ **Returns**
+
+ The job creation date as a datetime object, in local time, or `None` if job submission hasn’t finished or failed.
+
+
+ ### done
+
+
+ Return whether the job has successfully run.
+
+ **Return type**
+
+ `bool`
+
+
+ ### error\_message
+
+
+ Provide details about the reason of failure.
+
+
+ This method blocks until the job finishes.
+
+
+ **Return type**
+
+ `Optional`\[`str`]
+
+ **Returns**
+
+ An error report if the job failed or `None` otherwise.
+
+
+ ### from\_jobs
+
+
+ Return an instance of this class.
+
+ The input job ID is used to query for sub-job information from the server.
+
+ **Parameters**
+
+ * **job\_id** (`str`) – Job ID.
+ * **jobs** (`List`\[[`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.ibm_circuit_job.IBMCircuitJob")]) – A list of circuit jobs that belong to this composite job.
+ * **api\_client** (`AccountClient`) – Client to use to communicate with the server.
+
+ **Return type**
+
+ [`IBMCompositeJob`](#qiskit_ibm_provider.job.IBMCompositeJob "qiskit_ibm_provider.job.ibm_composite_job.IBMCompositeJob")
+
+ **Returns**
+
+ An instance of this class.
+
+
+ ### header
+
+
+
+ ### in\_final\_state
+
+
+ Return whether the job is in a final job state such as `DONE` or `ERROR`.
+
+ **Return type**
+
+ `bool`
+
+
+ ### job\_id
+
+
+ Return a unique id identifying the job.
+
+ **Return type**
+
+ `str`
+
+
+ ### name
+
+
+ Return the name assigned to this job.
+
+ **Return type**
+
+ `Optional`\[`str`]
+
+ **Returns**
+
+ Job name or `None` if no name was assigned to this job.
+
+
+ ### properties
+
+
+ Return the backend properties for this job.
+
+ > **Args:**
+ >
+ > **refresh: If `True`, re-query the server for the backend properties.**
+ >
+ > Otherwise, return a cached version.
+
+
+ This method blocks until all sub-jobs are submitted.
+
+
+ **Return type**
+
+ `Union`\[`List`\[[`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)")], [`BackendProperties`](/api/qiskit/qiskit.providers.models.BackendProperties "(in Qiskit v1.0)"), `None`]
+
+ **Returns**
+
+ The backend properties used for this job, or `None` if properties are not available. A list of backend properties is returned if the sub-jobs used different properties.
+
+ **Raises**
+
+ [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server.
+
+
+ ### queue\_info
+
+
+ Return queue information for this job.
+
+ This method returns the queue information of the sub-job that is last in queue.
+
+ The queue information may include queue position, estimated start and end time, and dynamic priorities for the hub, group, and project. See [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo") for more information.
+
+
+ The queue information is calculated after the job enters the queue. Therefore, some or all of the information may not be immediately available, and this method may return `None`.
+
+
+ **Return type**
+
+ `Optional`\[[`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.queueinfo.QueueInfo")]
+
+ **Returns**
+
+ A [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo") instance that contains queue information for this job, or `None` if queue information is unknown or not applicable.
+
+
+ ### queue\_position
+
+
+ Return the position of the job in the server queue.
+
+ This method returns the queue position of the sub-job that is last in queue.
+
+
+ The position returned is within the scope of the provider and may differ from the global queue position.
+
+
+ **Parameters**
+
+ **refresh** (`bool`) – If `True`, re-query the server to get the latest value. Otherwise return the cached value.
+
+ **Return type**
+
+ `Optional`\[`int`]
+
+ **Returns**
+
+ Position in the queue or `None` if position is unknown or not applicable.
+
+
+ ### refresh
+
+
+ Obtain the latest job information from the server.
+
+ This method may add additional attributes to this job instance, if new information becomes available.
+
+ **Raises**
+
+ [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server.
+
+ **Return type**
+
+ `None`
+
+
+ ### report
+
+
+ Return a report on current sub-job statuses.
+
+ **Parameters**
+
+ **detailed** (`bool`) – If `True`, return a detailed report. Otherwise return a summary report.
+
+ **Return type**
+
+ `str`
+
+ **Returns**
+
+ A report on sub-job statuses.
+
+
+ ### rerun\_failed
+
+
+ Re-submit all failed sub-jobs.
+
+
+ All sub-jobs that are in “ERROR” or “CANCELLED” states will be re-submitted. Sub-jobs that failed to be submitted will only be re-submitted if the circuits are known. That is, if this `IBMCompositeJob` was returned by [`qiskit_ibm_provider.IBMBackend.run()`](qiskit_ibm_provider.IBMBackend#run "qiskit_ibm_provider.IBMBackend.run") and not retrieved from the server.
+
+
+ **Return type**
+
+ `None`
+
+
+ ### result
+
+
+ Return the result of the job.
+
+
+ This method blocks until all sub-jobs finish.
+
+
+
+ Some IBM Quantum job results can only be read once. A second attempt to query the server for the same job will fail, since the job has already been “consumed”.
+
+ The first call to this method in an `IBMCompositeJob` instance will query the server and consume any available job results. Subsequent calls to that instance’s `result()` will also return the results, since they are cached. However, attempting to retrieve the results again in another instance or session might fail due to the job results having been consumed.
+
+
+
+ When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)") instance can be used to verify whether it contains partial results.
+
+ For example, if one of the circuits in the job failed, trying to get the counts of the unsuccessful circuit would raise an exception since there are no counts to return:
+
+ ```python
+ try:
+ counts = result.get_counts("failed_circuit")
+ except QiskitError:
+ print("Circuit execution failed!")
+ ```
+
+
+ If the job failed, you can use [`error_message()`](#qiskit_ibm_provider.job.IBMCompositeJob.error_message "qiskit_ibm_provider.job.IBMCompositeJob.error_message") to get more information.
+
+ **Parameters**
+
+ * **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job.
+ * **wait** (`float`) – Time in seconds between queries.
+ * **partial** (`bool`) – If `True`, return partial results if possible. Partial results refer to experiments within a sub-job, not individual sub-jobs. That is, this method will still block until all sub-jobs finish even if partial is set to `True`.
+ * **refresh** (`bool`) – If `True`, re-query the server for the result. Otherwise return the cached value.
+
+ **Return type**
+
+ [`Result`](/api/qiskit/qiskit.result.Result "(in Qiskit v1.0)")
+
+ **Returns**
+
+ Job result.
+
+ **Raises**
+
+ * [**IBMJobInvalidStateError**](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError") – If the job was cancelled.
+ * [**IBMJobFailureError**](qiskit_ibm_provider.job.IBMJobFailureError "qiskit_ibm_provider.job.IBMJobFailureError") – If the job failed.
+ * [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server.
+
+
+ ### running
+
+
+ Return whether the job is actively running.
+
+ **Return type**
+
+ `bool`
+
+
+ ### scheduling\_mode
+
+
+ Return the scheduling mode the job is in.
+
+ The scheduling mode indicates how the job is scheduled to run. For example, `fairshare` indicates the job is scheduled using a fairshare algorithm.
+
+ `fairshare` is returned if any of the sub-jobs has scheduling mode of `fairshare`.
+
+ This information is only available if the job status is `RUNNING` or `DONE`.
+
+ **Return type**
+
+ `Optional`\[`str`]
+
+ **Returns**
+
+ The scheduling mode the job is in or `None` if the information is not available.
+
+
+ ### status
+
+
+ Query the server for the latest job status.
+
+
+ This method is not designed to be invoked repeatedly in a loop for an extended period of time. Doing so may cause the server to reject your request. Use [`wait_for_final_state()`](#qiskit_ibm_provider.job.IBMCompositeJob.wait_for_final_state "qiskit_ibm_provider.job.IBMCompositeJob.wait_for_final_state") if you want to wait for the job to finish.
+
+
+
+ If the job failed, you can use [`error_message()`](#qiskit_ibm_provider.job.IBMCompositeJob.error_message "qiskit_ibm_provider.job.IBMCompositeJob.error_message") to get more information.
+
+
+
+ Since this job contains multiple sub-jobs, the returned status is mapped in the following order:
+
+ > * INITIALIZING - if any sub-job is being initialized.
+ > * VALIDATING - if any sub-job is being validated.
+ > * QUEUED - if any sub-job is queued.
+ > * RUNNING - if any sub-job is still running.
+ > * ERROR - if any sub-job incurred an error.
+ > * CANCELLED - if any sub-job is cancelled.
+ > * DONE - if all sub-jobs finished.
+
+
+ **Return type**
+
+ [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.0)")
+
+ **Returns**
+
+ The status of the job.
+
+ **Raises**
+
+ [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server.
+
+
+ ### sub\_job
+
+
+ Retrieve the job used to submit the specified circuit.
+
+ **Parameters**
+
+ **circuit\_index** (`int`) – Index of the circuit whose job is to be returned.
+
+ **Return type**
+
+ `Optional`\[[`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.ibm_circuit_job.IBMCircuitJob")]
+
+ **Returns**
+
+ The Job submitted for the circuit, or `None` if the job has not been submitted or the submit failed.
+
+ **Raises**
+
+ [**IBMJobInvalidStateError**](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError") – If the circuit index is out of range.
+
+
+ ### sub\_jobs
+
+
+ Return all submitted sub-jobs.
+
+ **Parameters**
+
+ **block\_for\_submit** (`bool`) – `True` if this method should block until all sub-jobs are submitted. `False` if the method should return immediately with submitted sub-jobs, if any.
+
+ **Return type**
+
+ `List`\[[`IBMCircuitJob`](qiskit_ibm_provider.job.IBMCircuitJob "qiskit_ibm_provider.job.ibm_circuit_job.IBMCircuitJob")]
+
+ **Returns**
+
+ All submitted sub-jobs.
+
+
+ ### submit
+
+
+ Unsupported method.
+
+
+ This method is not supported, please use `run()` to submit a job.
+
+
+ **Raises**
+
+ **NotImplementedError** – Upon invocation.
+
+ **Return type**
+
+ `None`
+
+
+ ### tags
+
+
+ Return the tags assigned to this job.
+
+ **Return type**
+
+ `List`\[`str`]
+
+ **Returns**
+
+ Tags assigned to this job.
+
+
+ ### time\_per\_step
+
+
+ Return the date and time information on each step of the job processing.
+
+ The output dictionary contains the date and time information on each step of the job processing, in local time. The keys of the dictionary are the names of the steps, and the values are the date and time data, as a datetime object with local timezone info. For example:
+
+ ```python
+ {'CREATING': datetime(2020, 2, 13, 15, 19, 25, 717000, tzinfo=tzlocal(),
+ 'CREATED': datetime(2020, 2, 13, 15, 19, 26, 467000, tzinfo=tzlocal(),
+ 'VALIDATING': datetime(2020, 2, 13, 15, 19, 26, 527000, tzinfo=tzlocal()}
+ ```
+
+ **Return type**
+
+ `Optional`\[`Dict`]
+
+ **Returns**
+
+ Date and time information on job processing steps, in local time, or `None` if the information is not yet available.
+
+
+ ### update\_name
+
+
+ Update the name associated with this job.
+
+
+ This method blocks until all sub-jobs are submitted.
+
+
+ **Parameters**
+
+ **name** (`str`) – The new name for this job.
+
+ **Return type**
+
+ `str`
+
+ **Returns**
+
+ The new name associated with this job.
+
+ **Raises**
+
+ * [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server or updating the job name.
+ * [**IBMJobInvalidStateError**](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError") – If the input job name is not a string.
+
+
+ ### update\_tags
+
+
+ Update the tags associated with this job.
+
+
+ This method blocks until all sub-jobs are submitted.
+
+
+ **Parameters**
+
+ **new\_tags** (`List`\[`str`]) – New tags to assign to the job.
+
+ **Return type**
+
+ `List`\[`str`]
+
+ **Returns**
+
+ The new tags associated with this job.
+
+ **Raises**
+
+ * [**IBMJobApiError**](qiskit_ibm_provider.job.IBMJobApiError "qiskit_ibm_provider.job.IBMJobApiError") – If an unexpected error occurred when communicating with the server or updating the job tags.
+ * [**IBMJobInvalidStateError**](qiskit_ibm_provider.job.IBMJobInvalidStateError "qiskit_ibm_provider.job.IBMJobInvalidStateError") – If none of the input parameters are specified or if any of the input parameters are invalid.
+
+
+ ### wait\_for\_final\_state
+
+
+ Wait until the job progresses to a final state such as `DONE` or `ERROR`.
+
+ **Parameters**
+
+ * **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely.
+
+ * **wait** (`Optional`\[`float`]) – Seconds to wait between invoking the callback function. If `None`, the callback function is invoked only if job status or queue position has changed.
+
+ * **callback** (`Optional`\[`Callable`]) –
+
+ Callback function invoked after each querying iteration. The following positional arguments are provided to the callback function:
+
+ > * job\_id: Job ID
+ > * job\_status: Status of the job from the last query.
+ > * job: This `IBMCompositeJob` instance.
+
+ In addition, the following keyword arguments are also provided:
+
+ > * queue\_info: A [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo") instance with job queue information, or `None` if queue information is unknown or not applicable. You can use the `to_dict()` method to convert the [`QueueInfo`](qiskit_ibm_provider.job.QueueInfo "qiskit_ibm_provider.job.QueueInfo") instance to a dictionary, if desired.
+
+ **Raises**
+
+ [**IBMJobTimeoutError**](qiskit_ibm_provider.job.IBMJobTimeoutError "qiskit_ibm_provider.job.IBMJobTimeoutError") – if the job does not reach a final state before the specified timeout.
+
+ **Return type**
+
+ `None`
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx
new file mode 100644
index 00000000000..6bd18edd0a7
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobApiError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMJobApiError
+description: API reference for qiskit_ibm_provider.job.IBMJobApiError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.job.IBMJobApiError
+---
+
+# IBMJobApiError
+
+
+ Errors that occur unexpectedly when querying the server.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx
new file mode 100644
index 00000000000..d74af418e7d
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMJobError
+description: API reference for qiskit_ibm_provider.job.IBMJobError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.job.IBMJobError
+---
+
+# IBMJobError
+
+
+ Base class for errors raised by the job modules.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx
new file mode 100644
index 00000000000..97a26493799
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobFailureError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMJobFailureError
+description: API reference for qiskit_ibm_provider.job.IBMJobFailureError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.job.IBMJobFailureError
+---
+
+# IBMJobFailureError
+
+
+ Errors raised when a job failed.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx
new file mode 100644
index 00000000000..8d565dd0d68
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobInvalidStateError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMJobInvalidStateError
+description: API reference for qiskit_ibm_provider.job.IBMJobInvalidStateError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.job.IBMJobInvalidStateError
+---
+
+# IBMJobInvalidStateError
+
+
+ Errors raised when a job is not in a valid state for the operation.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx
new file mode 100644
index 00000000000..3098f64e6d4
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.IBMJobTimeoutError.mdx
@@ -0,0 +1,16 @@
+---
+title: IBMJobTimeoutError
+description: API reference for qiskit_ibm_provider.job.IBMJobTimeoutError
+in_page_toc_min_heading_level: 1
+python_api_type: exception
+python_api_name: qiskit_ibm_provider.job.IBMJobTimeoutError
+---
+
+# IBMJobTimeoutError
+
+
+ Errors raised when a job operation times out.
+
+ Set the error message.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx
new file mode 100644
index 00000000000..deb265cc4fc
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.QueueInfo.mdx
@@ -0,0 +1,66 @@
+---
+title: QueueInfo
+description: API reference for qiskit_ibm_provider.job.QueueInfo
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.job.QueueInfo
+---
+
+# QueueInfo
+
+
+ Queue information for a job.
+
+ QueueInfo constructor.
+
+ **Parameters**
+
+ * **position** – Position in the queue.
+ * **status** (`Optional`\[`str`]) – Job status.
+ * **estimated\_start\_time** (`Union`\[`str`, `datetime`, `None`]) – Estimated start time for the job, in UTC.
+ * **estimated\_complete\_time** – Estimated complete time for the job, in UTC.
+ * **hub\_priority** (`Optional`\[`float`]) – Dynamic priority for the hub.
+ * **group\_priority** (`Optional`\[`float`]) – Dynamic priority for the group.
+ * **project\_priority** (`Optional`\[`float`]) – Dynamic priority for the project.
+ * **job\_id** (`Optional`\[`str`]) – Job ID.
+ * **kwargs** (`Any`) – Additional attributes.
+
+ ## Attributes
+
+ ### estimated\_complete\_time
+
+
+ Return estimated complete time in local time.
+
+ **Return type**
+
+ `Optional`\[`datetime`]
+
+
+ ### estimated\_start\_time
+
+
+ Return estimated start time in local time.
+
+ **Return type**
+
+ `Optional`\[`datetime`]
+
+
+ ## Methods
+
+ ### format
+
+
+ Build a user-friendly report for the job queue information.
+
+ **Return type**
+
+ `str`
+
+ **Returns**
+
+ The job queue information report.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.job_monitor.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.job_monitor.mdx
new file mode 100644
index 00000000000..bba6b476d4e
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.job.job_monitor.mdx
@@ -0,0 +1,26 @@
+---
+title: job_monitor
+description: API reference for qiskit_ibm_provider.job.job_monitor
+in_page_toc_min_heading_level: 1
+python_api_type: function
+python_api_name: qiskit_ibm_provider.job.job_monitor
+---
+
+
+
+# job\_monitor
+
+
+ Monitor the status of an `IBMJob` instance.
+
+ **Parameters**
+
+ * **job** (`IBMJob`) – Job to monitor.
+ * **interval** (`Optional`\[`float`]) – Time interval between status queries.
+ * **output** (`TextIO`) – The file like object to write status messages to. By default this is sys.stdout.
+
+ **Return type**
+
+ `None`
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.least_busy.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.least_busy.mdx
new file mode 100644
index 00000000000..d91b25ef9b7
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.least_busy.mdx
@@ -0,0 +1,34 @@
+---
+title: least_busy
+description: API reference for qiskit_ibm_provider.least_busy
+in_page_toc_min_heading_level: 1
+python_api_type: function
+python_api_name: qiskit_ibm_provider.least_busy
+---
+
+
+
+# least\_busy
+
+
+ Return the least busy backend from a list.
+
+ Return the least busy available backend for those that have a `pending_jobs` in their `status`. Note that local backends may not have this attribute.
+
+ **Parameters**
+
+ **backends** (`List`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")]) – The backends to choose from.
+
+ **Return type**
+
+ [`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")
+
+ **Returns**
+
+ The backend with the fewest number of pending jobs.
+
+ **Raises**
+
+ [**IBMError**](qiskit_ibm_provider.IBMError "qiskit_ibm_provider.IBMError") – If the backends list is empty, or if none of the backends is available, or if a backend in the list does not have the `pending_jobs` attribute in its status.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.basis.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.basis.mdx
new file mode 100644
index 00000000000..1829954ec20
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.basis.mdx
@@ -0,0 +1,22 @@
+---
+title: basis
+description: API reference for qiskit_ibm_provider.transpiler.passes.basis
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider.transpiler.passes.basis
+---
+
+
+
+# basis
+
+
+
+## Basis
+
+
+
+`qiskit_ibm_provider.transpiler.passes.basis`
+
+Passes to layout circuits to IBM backend’s instruction sets.
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.mdx
new file mode 100644
index 00000000000..b367f821f78
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.mdx
@@ -0,0 +1,27 @@
+---
+title: passes
+description: API reference for qiskit_ibm_provider.transpiler.passes
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider.transpiler.passes
+---
+
+
+
+# passes
+
+
+
+## Transpiler Passes
+
+
+
+`qiskit_ibm_provider.transpiler.passes`
+
+A collection of transpiler passes for IBM backends.
+
+| | |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
+| [`basis`](qiskit_ibm_provider.transpiler.passes.basis#module-qiskit_ibm_provider.transpiler.passes.basis "qiskit_ibm_provider.transpiler.passes.basis") | Basis (qiskit\_ibm\_provider.transpiler.passes.basis) |
+| [`scheduling`](qiskit_ibm_provider.transpiler.passes.scheduling#module-qiskit_ibm_provider.transpiler.passes.scheduling "qiskit_ibm_provider.transpiler.passes.scheduling") | Scheduling (qiskit\_ibm\_provider.transpiler.passes.scheduling) |
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx
new file mode 100644
index 00000000000..7ea503eff1b
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx
@@ -0,0 +1,141 @@
+---
+title: ALAPScheduleAnalysis
+description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis
+---
+
+# ALAPScheduleAnalysis
+
+
+ Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass.
+
+ This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change.
+
+ In its current form this is similar to Qiskit’s ALAP scheduler in which instructions start as late as possible.
+
+ The primary differences are that:
+
+ * **Resets and control-flow currently trigger the end of a “quantum block”. The period between the end**
+
+ of the block and the next is *nondeterministic* ie., we do not know when the next block will begin (as we could be evaluating a classical function of nondeterministic length) and therefore the next block starts at a *relative* t=0.
+
+ * During a measurement it is possible to apply gates in parallel on disjoint qubits.
+
+ * Measurements and resets on disjoint qubits happen simultaneously and are part of the same block.
+
+ Scheduler for dynamic circuit backends.
+
+ **Parameters**
+
+ **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling.
+
+ ## Attributes
+
+ ### is\_analysis\_pass
+
+
+ Check if the pass is an analysis pass.
+
+ If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.
+
+
+ ### is\_transformation\_pass
+
+
+ Check if the pass is a transformation pass.
+
+ If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).
+
+
+ ## Methods
+
+ ### \_\_call\_\_
+
+
+ Runs the pass on circuit.
+
+ **Parameters**
+
+ * **circuit** (*QuantumCircuit*) – The dag on which the pass is run.
+ * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place.
+
+ **Return type**
+
+ QuantumCircuit
+
+ **Returns**
+
+ If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit.
+
+
+ ### execute
+
+
+ Execute optimization task for input Qiskit IR.
+
+ **Parameters**
+
+ * **passmanager\_ir** (`Any`) – Qiskit IR to optimize.
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself.
+ * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task.
+
+ **Return type**
+
+ `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ Optimized Qiskit IR and state of the workflow.
+
+
+ ### name
+
+
+ Name of the pass.
+
+ **Return type**
+
+ `str`
+
+
+ ### run
+
+
+ Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)") :param dag: DAG to schedule. :type dag: DAGCircuit
+
+ **Raises**
+
+ * **TranspilerError** – if the circuit is not mapped on physical qubits.
+ * **TranspilerError** – if conditional bit is added to non-supported instruction.
+
+ **Return type**
+
+ `None`
+
+ **Returns**
+
+ The scheduled DAGCircuit.
+
+
+ ### update\_status
+
+
+ Update workflow status.
+
+ **Parameters**
+
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update.
+ * **run\_state** (`RunState`) – Completion status of current task.
+
+ **Return type**
+
+ [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")
+
+ **Returns**
+
+ Updated pass manager state.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx
new file mode 100644
index 00000000000..88f645ff5c0
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx
@@ -0,0 +1,141 @@
+---
+title: ASAPScheduleAnalysis
+description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis
+---
+
+# ASAPScheduleAnalysis
+
+
+ Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass.
+
+ This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change.
+
+ In its current form this is similar to Qiskit’s ASAP scheduler in which instructions start as early as possible.
+
+ The primary differences are that:
+
+ * **Resets and control-flow currently trigger the end of a “quantum block”. The period between the end**
+
+ of the block and the next is *nondeterministic* ie., we do not know when the next block will begin (as we could be evaluating a classical function of nondeterministic length) and therefore the next block starts at a *relative* t=0.
+
+ * During a measurement it is possible to apply gates in parallel on disjoint qubits.
+
+ * Measurements and resets on disjoint qubits happen simultaneously and are part of the same block.
+
+ Scheduler for dynamic circuit backends.
+
+ **Parameters**
+
+ **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling.
+
+ ## Attributes
+
+ ### is\_analysis\_pass
+
+
+ Check if the pass is an analysis pass.
+
+ If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.
+
+
+ ### is\_transformation\_pass
+
+
+ Check if the pass is a transformation pass.
+
+ If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).
+
+
+ ## Methods
+
+ ### \_\_call\_\_
+
+
+ Runs the pass on circuit.
+
+ **Parameters**
+
+ * **circuit** (*QuantumCircuit*) – The dag on which the pass is run.
+ * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place.
+
+ **Return type**
+
+ QuantumCircuit
+
+ **Returns**
+
+ If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit.
+
+
+ ### execute
+
+
+ Execute optimization task for input Qiskit IR.
+
+ **Parameters**
+
+ * **passmanager\_ir** (`Any`) – Qiskit IR to optimize.
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself.
+ * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task.
+
+ **Return type**
+
+ `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ Optimized Qiskit IR and state of the workflow.
+
+
+ ### name
+
+
+ Name of the pass.
+
+ **Return type**
+
+ `str`
+
+
+ ### run
+
+
+ Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)") :param dag: DAG to schedule. :type dag: DAGCircuit
+
+ **Raises**
+
+ * **TranspilerError** – if the circuit is not mapped on physical qubits.
+ * **TranspilerError** – if conditional bit is added to non-supported instruction.
+
+ **Return type**
+
+ [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")
+
+ **Returns**
+
+ The scheduled DAGCircuit.
+
+
+ ### update\_status
+
+
+ Update workflow status.
+
+ **Parameters**
+
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update.
+ * **run\_state** (`RunState`) – Completion status of current task.
+
+ **Return type**
+
+ [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")
+
+ **Returns**
+
+ Updated pass manager state.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx
new file mode 100644
index 00000000000..642ebefca36
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.mdx
@@ -0,0 +1,135 @@
+---
+title: BlockBasePadder
+description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder
+---
+
+# BlockBasePadder
+
+
+ The base class of padding pass.
+
+ This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled.
+
+ This base class doesn’t define any sequence to interleave, but it manages the location where the sequence is inserted, and provides a set of information necessary to construct the proper sequence. Thus, a subclass of this pass just needs to implement `_pad()` method, in which the subclass constructs a circuit block to insert. This mechanism removes lots of boilerplate logic to manage whole DAG circuits.
+
+ Note that padding pass subclasses should define interleaving sequences satisfying:
+
+ > * Interleaved sequence does not change start time of other nodes
+ > * Interleaved sequence should have total duration of the provided `time_interval`.
+
+ Any manipulation violating these constraints may prevent this base pass from correctly tracking the start time of each instruction, which may result in violation of hardware alignment constraints.
+
+ ## Attributes
+
+ ### is\_analysis\_pass
+
+
+ Check if the pass is an analysis pass.
+
+ If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.
+
+
+ ### is\_transformation\_pass
+
+
+ Check if the pass is a transformation pass.
+
+ If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).
+
+
+ ## Methods
+
+ ### \_\_call\_\_
+
+
+ Runs the pass on circuit.
+
+ **Parameters**
+
+ * **circuit** (*QuantumCircuit*) – The dag on which the pass is run.
+ * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place.
+
+ **Return type**
+
+ QuantumCircuit
+
+ **Returns**
+
+ If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit.
+
+
+ ### execute
+
+
+ Execute optimization task for input Qiskit IR.
+
+ **Parameters**
+
+ * **passmanager\_ir** (`Any`) – Qiskit IR to optimize.
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself.
+ * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task.
+
+ **Return type**
+
+ `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ Optimized Qiskit IR and state of the workflow.
+
+
+ ### name
+
+
+ Name of the pass.
+
+ **Return type**
+
+ `str`
+
+
+ ### run
+
+
+ Run the padding pass on `dag`.
+
+ **Parameters**
+
+ **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked.
+
+ **Returns**
+
+ DAG with idle time filled with instructions.
+
+ **Return type**
+
+ DAGCircuit
+
+ **Raises**
+
+ **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called.
+
+
+ ### update\_status
+
+
+ Update workflow status.
+
+ **Parameters**
+
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update.
+ * **run\_state** (`RunState`) – Completion status of current task.
+
+ **Return type**
+
+ [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")
+
+ **Returns**
+
+ Updated pass manager state.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx
new file mode 100644
index 00000000000..d62ba538038
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx
@@ -0,0 +1,128 @@
+---
+title: DynamicCircuitInstructionDurations
+description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations
+---
+
+# DynamicCircuitInstructionDurations
+
+
+ For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends.
+
+ Dynamic circuit instruction durations.
+
+ ## Attributes
+
+ ### MEASURE\_PATCH\_CYCLES
+
+
+
+ ### MEASURE\_PATCH\_ODD\_OFFSET
+
+
+
+ ## Methods
+
+ ### from\_backend
+
+
+ Construct a `DynamicInstructionDurations` object from the backend.
+
+ **Parameters**
+
+ **backend** ([`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.0)")) – backend from which durations (gate lengths) and dt are extracted.
+
+ **Returns**
+
+ The InstructionDurations constructed from backend.
+
+ **Return type**
+
+ DynamicInstructionDurations
+
+
+ ### from\_target
+
+
+ Construct a `DynamicInstructionDurations` object from the target.
+
+ **Parameters**
+
+ **target** ([`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)")) – target from which durations (gate lengths) and dt are extracted.
+
+ **Returns**
+
+ The InstructionDurations constructed from backend.
+
+ **Return type**
+
+ DynamicInstructionDurations
+
+
+ ### get
+
+
+ Get the duration of the instruction with the name, qubits, and parameters.
+
+ Some instructions may have a parameter dependent duration.
+
+ **Parameters**
+
+ * **inst** (*str |* [*qiskit.circuit.Instruction*](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.0)")) – An instruction or its name to be queried.
+ * **qubits** (*int | list\[int]*) – Qubit indices that the instruction acts on.
+ * **unit** (*str*) – The unit of duration to be returned. It must be ‘s’ or ‘dt’.
+ * **parameters** (*list\[float] | None*) – The value of the parameters of the desired instruction.
+
+ **Returns**
+
+ The duration of the instruction on the qubits.
+
+ **Return type**
+
+ float|int
+
+ **Raises**
+
+ **TranspilerError** – No duration is defined for the instruction.
+
+
+ ### units\_used
+
+
+ Get the set of all units used in this instruction durations.
+
+ **Return type**
+
+ `set`\[`str`]
+
+ **Returns**
+
+ Set of units used in this instruction durations.
+
+
+ ### update
+
+
+ Update self with inst\_durations (inst\_durations overwrite self). Overrides the default durations for certain hardcoded instructions.
+
+ **Parameters**
+
+ * **inst\_durations** (`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]], `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]]]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)"), `None`]) – Instruction durations to be merged into self (overwriting self).
+ * **dt** (`Optional`\[`float`]) – Sampling duration in seconds of the target backend.
+
+ **Returns**
+
+ The updated InstructionDurations.
+
+ **Return type**
+
+ InstructionDurations
+
+ **Raises**
+
+ **TranspilerError** – If the format of instruction\_durations is invalid.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx
new file mode 100644
index 00000000000..4b18d79b217
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.mdx
@@ -0,0 +1,147 @@
+---
+title: PadDelay
+description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay
+---
+
+# PadDelay
+
+
+ Padding idle time with Delay instructions.
+
+ Consecutive delays will be merged in the output of this pass.
+
+ The ASAP-scheduled circuit output may become
+
+ ```python
+ ┌────────────────┐
+ q_0: ┤ Delay(160[dt]) ├──■──
+ └─────┬───┬──────┘┌─┴─┐
+ q_1: ──────┤ X ├───────┤ X ├
+ └───┘ └───┘
+ ```
+
+ Note that the additional idle time of 60dt on the `q_0` wire coming from the duration difference between `Delay` of 100dt (`q_0`) and `XGate` of 160 dt (`q_1`) is absorbed in the delay instruction on the `q_0` wire, i.e. in total 160 dt.
+
+ See [`BlockBasePadder`](qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder") pass for details.
+
+ Create new padding delay pass.
+
+ **Parameters**
+
+ * **fill\_very\_end** (`bool`) – Set `True` to fill the end of circuit with delay.
+ * **schedule\_idle\_qubits** (`bool`) – Set to true if you’d like a delay inserted on idle qubits. This is useful for timeline visualizations, but may cause issues for execution on large backends.
+
+ ## Attributes
+
+ ### is\_analysis\_pass
+
+
+ Check if the pass is an analysis pass.
+
+ If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.
+
+
+ ### is\_transformation\_pass
+
+
+ Check if the pass is a transformation pass.
+
+ If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).
+
+
+ ## Methods
+
+ ### \_\_call\_\_
+
+
+ Runs the pass on circuit.
+
+ **Parameters**
+
+ * **circuit** (*QuantumCircuit*) – The dag on which the pass is run.
+ * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place.
+
+ **Return type**
+
+ QuantumCircuit
+
+ **Returns**
+
+ If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit.
+
+
+ ### execute
+
+
+ Execute optimization task for input Qiskit IR.
+
+ **Parameters**
+
+ * **passmanager\_ir** (`Any`) – Qiskit IR to optimize.
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself.
+ * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task.
+
+ **Return type**
+
+ `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ Optimized Qiskit IR and state of the workflow.
+
+
+ ### name
+
+
+ Name of the pass.
+
+ **Return type**
+
+ `str`
+
+
+ ### run
+
+
+ Run the padding pass on `dag`.
+
+ **Parameters**
+
+ **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked.
+
+ **Returns**
+
+ DAG with idle time filled with instructions.
+
+ **Return type**
+
+ DAGCircuit
+
+ **Raises**
+
+ **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called.
+
+
+ ### update\_status
+
+
+ Update workflow status.
+
+ **Parameters**
+
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update.
+ * **run\_state** (`RunState`) – Completion status of current task.
+
+ **Return type**
+
+ [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")
+
+ **Returns**
+
+ Updated pass manager state.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx
new file mode 100644
index 00000000000..34cbffd5169
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx
@@ -0,0 +1,282 @@
+---
+title: PadDynamicalDecoupling
+description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling
+in_page_toc_min_heading_level: 1
+python_api_type: class
+python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling
+---
+
+# PadDynamicalDecoupling
+
+
+ Dynamical decoupling insertion pass for IBM dynamic circuit backends.
+
+ This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase).
+
+ ```python
+ import numpy as np
+ from qiskit.circuit import QuantumCircuit
+ from qiskit.circuit.library import XGate
+ from qiskit.transpiler import PassManager, InstructionDurations
+ from qiskit.visualization import timeline_drawer
+
+ from qiskit_ibm_provider.transpiler.passes.scheduling import ALAPScheduleAnalysis
+ from qiskit_ibm_provider.transpiler.passes.scheduling import PadDynamicalDecoupling
+
+ circ = QuantumCircuit(4)
+ circ.h(0)
+ circ.cx(0, 1)
+ circ.cx(1, 2)
+ circ.cx(2, 3)
+ circ.measure_all()
+ durations = InstructionDurations(
+ [("h", 0, 50), ("cx", [0, 1], 700), ("reset", None, 10),
+ ("cx", [1, 2], 200), ("cx", [2, 3], 300),
+ ("x", None, 50), ("measure", None, 1000)]
+ )
+ ```
+
+ ```python
+ # balanced X-X sequence on all qubits
+ dd_sequence = [XGate(), XGate()]
+ pm = PassManager([ALAPScheduleAnalysis(durations),
+ PadDynamicalDecoupling(durations, dd_sequence)])
+ circ_dd = pm.run(circ)
+ circ_dd.draw()
+ ```
+
+ ```python
+ ┌───┐ ┌───────────────┐ ┌───┐ »
+ q_0: ──────┤ H ├─────────■──┤ Delay(96[dt]) ├──────┤ X ├──────»
+ ┌─────┴───┴─────┐ ┌─┴─┐└───────────────┘┌─────┴───┴─────┐»
+ q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■────────┤ Delay(48[dt]) ├»
+ ├───────────────┴┐└───┘ ┌─┴─┐ └───────────────┘»
+ q_2: ┤ Delay(750[dt]) ├───────────┤ X ├──────────────■────────»
+ ├────────────────┤ └───┘ ┌─┴─┐ »
+ q_3: ┤ Delay(950[dt]) ├────────────────────────────┤ X ├──────»
+ └────────────────┘ └───┘ »
+ meas: 4/═════════════════════════════════════════════════════════»
+ »
+ « ┌────────────────┐ ┌───┐ ┌───────────────┐ »
+ « q_0: ┤ Delay(208[dt]) ├──────┤ X ├──────┤ Delay(96[dt]) ├─────────────────»
+ « └─────┬───┬──────┘┌─────┴───┴─────┐└─────┬───┬─────┘┌───────────────┐»
+ « q_1: ──────┤ X ├───────┤ Delay(96[dt]) ├──────┤ X ├──────┤ Delay(56[dt]) ├»
+ « └───┘ └───────────────┘ └───┘ └───────────────┘»
+ « q_2: ─────────────────────────────────────────────────────────────────────»
+ « »
+ « q_3: ─────────────────────────────────────────────────────────────────────»
+ « »
+ «meas: 4/═════════════════════════════════════════════════════════════════════»
+ « »
+ « ░ ┌─┐
+ « q_0: ─░─┤M├─────────
+ « ░ └╥┘┌─┐
+ « q_1: ─░──╫─┤M├──────
+ « ░ ║ └╥┘┌─┐
+ « q_2: ─░──╫──╫─┤M├───
+ « ░ ║ ║ └╥┘┌─┐
+ « q_3: ─░──╫──╫──╫─┤M├
+ « ░ ║ ║ ║ └╥┘
+ «meas: 4/════╩══╩══╩══╩═
+ « 0 1 2 3
+ ```
+
+ ```python
+ # Uhrig sequence on qubit 0
+ n = 8
+ dd_sequence = [XGate()] * n
+ def uhrig_pulse_location(k):
+ return np.sin(np.pi * (k + 1) / (2 * n + 2)) ** 2
+ spacings = []
+ for k in range(n):
+ spacings.append(uhrig_pulse_location(k) - sum(spacings))
+ spacings.append(1 - sum(spacings))
+ pm = PassManager(
+ [
+ ALAPScheduleAnalysis(durations),
+ PadDynamicalDecoupling(durations, dd_sequence, qubits=[0], spacings=spacings),
+ ]
+ )
+ circ_dd = pm.run(circ)
+ circ_dd.draw()
+ ```
+
+ ```python
+ ┌───┐ ┌────────────────┐ ░ ┌─┐ »
+ q_0: ──────┤ H ├─────────■──┤ Delay(500[dt]) ├───────────────────░─┤M├──────»
+ ┌─────┴───┴─────┐ ┌─┴─┐└────────────────┘┌────────────────┐ ░ └╥┘┌─┐ »
+ q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■─────────┤ Delay(300[dt]) ├─░──╫─┤M├───»
+ ├───────────────┴┐└───┘ ┌─┴─┐ └────────────────┘ ░ ║ └╥┘┌─┐»
+ q_2: ┤ Delay(750[dt]) ├───────────┤ X ├───────────────■──────────░──╫──╫─┤M├»
+ ├────────────────┤ └───┘ ┌─┴─┐ ░ ║ ║ └╥┘»
+ q_3: ┤ Delay(950[dt]) ├─────────────────────────────┤ X ├────────░──╫──╫──╫─»
+ └────────────────┘ └───┘ ░ ║ ║ ║ »
+ meas: 4/═══════════════════════════════════════════════════════════════╩══╩══╩═»
+ 0 1 2 »
+ «
+ « q_0: ───
+ «
+ « q_1: ───
+ «
+ « q_2: ───
+ « ┌─┐
+ « q_3: ┤M├
+ « └╥┘
+ «meas: 4/═╩═
+ « 3
+ ```
+
+
+ You need to call [`ALAPScheduleAnalysis`](qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis") before running dynamical decoupling to guarantee your circuit satisfies acquisition alignment constraints for dynamic circuit backends.
+
+
+ Dynamical decoupling initializer.
+
+ **Parameters**
+
+ * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.0)")) – Durations of instructions to be used in scheduling.
+
+ * **dd\_sequences** (`Union`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.0)")], `List`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.0)")]]]) – Sequence of gates to apply in idle spots. Alternatively a list of gate sequences may be supplied that will preferentially be inserted if there is a delay of sufficient duration. This may be tuned by the optionally supplied `sequence_min_length_ratios`.
+
+ * **qubits** (`Optional`\[`List`\[`int`]]) – Physical qubits on which to apply DD. If None, all qubits will undergo DD (when possible).
+
+ * **spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates. The available slack will be divided according to this. The list length must be one more than the length of dd\_sequence, and the elements must sum to 1. If None, a balanced spacing will be used \[d/2, d, d, …, d, d, d/2]. This spacing only applies to the first subcircuit, if a `coupling_map` is specified
+
+ * **skip\_reset\_qubits** (`bool`) – If True, does not insert DD on idle periods that immediately follow initialized/reset qubits (as qubits in the ground state are less susceptible to decoherence).
+
+ * **pulse\_alignment** (`int`) – The hardware constraints for gate timing allocation. This is usually provided from `backend.configuration().timing_constraints`. If provided, the delay length, i.e. `spacing`, is implicitly adjusted to satisfy this constraint.
+
+ * **extra\_slack\_distribution** (`str`) –
+
+ The option to control the behavior of DD sequence generation. The duration of the DD sequence should be identical to an idle time in the scheduled quantum circuit, however, the delay in between gates comprising the sequence should be integer number in units of dt, and it might be further truncated when `pulse_alignment` is specified. This sometimes results in the duration of the created sequence being shorter than the idle time that you want to fill with the sequence, i.e. extra slack. This option takes following values.
+
+ > * ”middle”: Put the extra slack to the interval at the middle of the sequence.
+ > * ”edges”: Divide the extra slack as evenly as possible into intervals at beginning and end of the sequence.
+
+ * **sequence\_min\_length\_ratios** (`Union`\[`int`, `List`\[`int`], `None`]) – List of minimum delay length to DD sequence ratio to satisfy in order to insert the DD sequence. For example if the X-X dynamical decoupling sequence is 320dt samples long and the available delay is 384dt it has a ratio of 384dt/320dt=1.2. From the perspective of dynamical decoupling this is likely to add more control noise than decoupling error rate reductions. The defaults value is 2.0.
+
+ * **insert\_multiple\_cycles** (`bool`) – If the available duration exceeds 2\*sequence\_min\_length\_ratio\*duration(dd\_sequence) enable the insertion of multiple rounds of the dynamical decoupling sequence in that delay.
+
+ * **coupling\_map** (`Optional`\[[`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.0)")]) – directed graph representing the coupling map for the device. Specifying a coupling map partitions the device into subcircuits, in order to apply DD sequences with different pulse spacings within each. Currently support 2 subcircuits.
+
+ * **alt\_spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates, for the second subcircuit, as determined by the coupling map. If None, a balanced spacing that is staggered with respect to the first subcircuit will be used \[d, d, d, …, d, d, 0].
+
+ * **schedule\_idle\_qubits** (`bool`) – Set to true if you’d like a delay inserted on idle qubits. This is useful for timeline visualizations, but may cause issues for execution on large backends.
+
+ **Raises**
+
+ * **TranspilerError** – When invalid DD sequence is specified.
+ * **TranspilerError** – When pulse gate with the duration which is non-multiple of the alignment constraint value is found.
+ * **TranspilerError** – When the coupling map is not supported (i.e., if degree > 3)
+
+ ## Attributes
+
+ ### is\_analysis\_pass
+
+
+ Check if the pass is an analysis pass.
+
+ If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.
+
+
+ ### is\_transformation\_pass
+
+
+ Check if the pass is a transformation pass.
+
+ If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).
+
+
+ ## Methods
+
+ ### \_\_call\_\_
+
+
+ Runs the pass on circuit.
+
+ **Parameters**
+
+ * **circuit** (*QuantumCircuit*) – The dag on which the pass is run.
+ * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place.
+
+ **Return type**
+
+ QuantumCircuit
+
+ **Returns**
+
+ If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit.
+
+
+ ### execute
+
+
+ Execute optimization task for input Qiskit IR.
+
+ **Parameters**
+
+ * **passmanager\_ir** (`Any`) – Qiskit IR to optimize.
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – State associated with workflow execution by the pass manager itself.
+ * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task.
+
+ **Return type**
+
+ `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")]
+
+ **Returns**
+
+ Optimized Qiskit IR and state of the workflow.
+
+
+ ### name
+
+
+ Name of the pass.
+
+ **Return type**
+
+ `str`
+
+
+ ### run
+
+
+ Run the padding pass on `dag`.
+
+ **Parameters**
+
+ **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.0)")) – DAG to be checked.
+
+ **Returns**
+
+ DAG with idle time filled with instructions.
+
+ **Return type**
+
+ DAGCircuit
+
+ **Raises**
+
+ **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called.
+
+
+ ### update\_status
+
+
+ Update workflow status.
+
+ **Parameters**
+
+ * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")) – Pass manager state to update.
+ * **run\_state** (`RunState`) – Completion status of current task.
+
+ **Return type**
+
+ [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.0)")
+
+ **Returns**
+
+ Updated pass manager state.
+
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.mdx
new file mode 100644
index 00000000000..1d736992b01
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling.mdx
@@ -0,0 +1,384 @@
+---
+title: scheduling
+description: API reference for qiskit_ibm_provider.transpiler.passes.scheduling
+in_page_toc_min_heading_level: 2
+python_api_type: module
+python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling
+---
+
+
+
+# scheduling
+
+
+
+## Scheduling
+
+
+
+`qiskit_ibm_provider.transpiler.passes.scheduling`
+
+A collection of scheduling passes for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical control-flow/feedback based off of measurement results.
+
+
+ You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)") or [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.0)").
+
+
+Below we demonstrate how to schedule and pad a teleportation circuit with delays for a dynamic circuit backend’s execution model:
+
+```python
+from qiskit.circuit import ClassicalRegister, QuantumCircuit, QuantumRegister
+from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager
+from qiskit.transpiler.passmanager import PassManager
+
+from qiskit_ibm_provider.transpiler.passes.scheduling import DynamicCircuitInstructionDurations
+from qiskit_ibm_provider.transpiler.passes.scheduling import ALAPScheduleAnalysis
+from qiskit_ibm_provider.transpiler.passes.scheduling import PadDelay
+try:
+ from qiskit.providers.fake_provider import Fake7QPulseV1
+except ImportError:
+ from qiskit.providers.fake_provider import FakeJakarta as Fake7QPulseV1
+
+
+backend = Fake7QPulseV1()
+
+# Temporary workaround for mock backends. For real backends this is not required.
+backend.configuration().basis_gates.append("if_else")
+
+
+# Use this duration class to get appropriate durations for dynamic
+# circuit backend scheduling
+durations = DynamicCircuitInstructionDurations.from_backend(backend)
+# Generate the main Qiskit transpile passes.
+pm = generate_preset_pass_manager(optimization_level=1, backend=backend)
+# Configure the as-late-as-possible scheduling pass
+pm.scheduling = PassManager([ALAPScheduleAnalysis(durations), PadDelay()])
+
+qr = QuantumRegister(3)
+crz = ClassicalRegister(1, name="crz")
+crx = ClassicalRegister(1, name="crx")
+result = ClassicalRegister(1, name="result")
+
+teleport = QuantumCircuit(qr, crz, crx, result, name="Teleport")
+
+teleport.h(qr[1])
+teleport.cx(qr[1], qr[2])
+teleport.cx(qr[0], qr[1])
+teleport.h(qr[0])
+teleport.measure(qr[0], crz)
+teleport.measure(qr[1], crx)
+with teleport.if_test((crz, 1)):
+ teleport.z(qr[2])
+with teleport.if_test((crx, 1)):
+ teleport.x(qr[2])
+teleport.measure(qr[2], result)
+
+# Transpile.
+scheduled_teleport = pm.run(teleport)
+
+scheduled_teleport.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_1\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_1_0.png)
+
+Instead of padding with delays we may also insert a dynamical decoupling sequence using the [`PadDynamicalDecoupling`](qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling") pass as shown below:
+
+```python
+from qiskit.circuit.library import XGate
+
+from qiskit_ibm_provider.transpiler.passes.scheduling import PadDynamicalDecoupling
+
+
+dd_sequence = [XGate(), XGate()]
+
+pm = generate_preset_pass_manager(optimization_level=1, backend=backend)
+pm.scheduling = PassManager(
+ [
+ ALAPScheduleAnalysis(durations),
+ PadDynamicalDecoupling(durations, dd_sequence),
+ ]
+)
+
+dd_teleport = pm.run(teleport)
+
+dd_teleport.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_2\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_2_0.png)
+
+When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)") function internally builds its pass set by using [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.0)"). This returns instances of [`StagedPassManager`](/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v1.0)"), which can be extended.
+
+
+
+### Scheduling old format `c_if` conditioned gates
+
+Scheduling with old format `c_if` conditioned gates is not supported.
+
+```python
+qc_c_if = QuantumCircuit(1, 1)
+qc_c_if.x(0).c_if(0, 1)
+qc_c_if.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_3\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_3_0.png)
+
+The [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.0)"). This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification.
+
+```python
+# Temporary workaround for mock backends. For real backends this is not required.
+backend.get_translation_stage_plugin = lambda: "ibm_dynamic_circuits"
+
+pm = generate_preset_pass_manager(optimization_level=1, backend=backend)
+pm.scheduling = PassManager(
+ [
+ ALAPScheduleAnalysis(durations),
+ PadDynamicalDecoupling(durations, dd_sequence),
+ ]
+)
+
+qc_if_dd = pm.run(qc_c_if, backend)
+qc_if_dd.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_4\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_4_0.png)
+
+If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.0)") prior to your scheduling pass.
+
+```python
+from qiskit.transpiler.passes import ConvertConditionsToIfOps
+
+pm = generate_preset_pass_manager(optimization_level=1, backend=backend)
+pm.scheduling = PassManager(
+ [
+ ConvertConditionsToIfOps(),
+ ALAPScheduleAnalysis(durations),
+ PadDelay(),
+ ]
+)
+
+qc_if_dd = pm.run(qc_c_if)
+qc_if_dd.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_5\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_5_0.png)
+
+
+
+### Exploiting IBM backend’s local parallel “fast-path”
+
+IBM quantum hardware supports a localized “fast-path” which enables a block of gates applied to a *single qubit* that are conditional on an immediately predecessor measurement *of the same qubit* to be completed with lower latency. The hardware is also able to do this in *parallel* on disjoint qubits that satisfy this condition.
+
+For example, the conditional gates below are performed in parallel with lower latency as the measurements flow directly into the conditional blocks which in turn only apply gates to the same measurement qubit.
+
+```python
+qc = QuantumCircuit(2, 2)
+qc.measure(0, 0)
+qc.measure(1, 1)
+# Conditional blocks will be performed in parallel in the hardware
+with qc.if_test((0, 1)):
+ qc.x(0)
+with qc.if_test((1, 1)):
+ qc.x(1)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_6\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_6_0.png)
+
+The circuit below will not use the fast-path as the conditional gate is on a different qubit than the measurement qubit.
+
+```python
+qc = QuantumCircuit(2, 2)
+qc.measure(0, 0)
+with qc.if_test((0, 1)):
+ qc.x(1)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_7\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_7_0.png)
+
+Similarly, the circuit below contains gates on multiple qubits and will not be performed using the fast-path.
+
+```python
+qc = QuantumCircuit(2, 2)
+qc.measure(0, 0)
+with qc.if_test((0, 1)):
+ qc.x(0)
+ qc.x(1)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_8\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_8_0.png)
+
+A fast-path block may contain multiple gates as long as they are on the fast-path qubit. If there are multiple fast-path blocks being performed in parallel each block will be padded out to the duration of the longest block.
+
+```python
+qc = QuantumCircuit(2, 2)
+qc.measure(0, 0)
+qc.measure(1, 1)
+# Conditional blocks will be performed in parallel in the hardware
+with qc.if_test((0, 1)):
+ qc.x(0)
+ # Will be padded out to a duration of 1600 on the backend.
+with qc.if_test((1, 1)):
+ qc.delay(1600, 1)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_9\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_9_0.png)
+
+This behavior is also applied to the else condition of a fast-path eligible branch.
+
+```python
+qc = QuantumCircuit(1, 1)
+qc.measure(0, 0)
+# Conditional blocks will be performed in parallel in the hardware
+with qc.if_test((0, 1)) as else_:
+ qc.x(0)
+ # Will be padded out to a duration of 1600 on the backend.
+with else_:
+ qc.delay(1600, 0)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_10\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_10_0.png)
+
+If a single measurement result is used with several conditional blocks, if there is a fast-path eligible block it will be applied followed by the non-fast-path blocks which will execute with the standard higher latency conditional branch.
+
+```python
+qc = QuantumCircuit(2, 2)
+qc.measure(0, 0)
+# Conditional blocks will be performed in parallel in the hardware
+with qc.if_test((0, 1)):
+ # Uses fast-path
+ qc.x(0)
+with qc.if_test((0, 1)):
+ # Does not use fast-path
+ qc.x(1)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_11\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_11_0.png)
+
+If you wish to prevent the usage of the fast-path you may insert a barrier between the measurement and the conditional branch.
+
+```python
+qc = QuantumCircuit(1, 2)
+qc.measure(0, 0)
+# Barrier prevents the fast-path.
+qc.barrier()
+with qc.if_test((0, 1)):
+ qc.x(0)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_12\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_12_0.png)
+
+Conditional measurements are not eligible for the fast-path.
+
+```python
+qc = QuantumCircuit(1, 2)
+qc.measure(0, 0)
+with qc.if_test((0, 1)):
+ # Does not use the fast-path
+ qc.measure(0, 1)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_13\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_13_0.png)
+
+Similarly nested control-flow is not eligible.
+
+```python
+qc = QuantumCircuit(1, 1)
+qc.measure(0, 0)
+with qc.if_test((0, 1)):
+ # Does not use the fast-path
+ qc.x(0)
+ with qc.if_test((0, 1)):
+ qc.x(0)
+
+qc.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_14\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_14_0.png)
+
+The scheduler is aware of the fast-path behavior and will not insert delays on idle qubits in blocks that satisfy the fast-path conditions so as to avoid preventing the backend compiler from performing the necessary optimizations to utilize the fast-path. If there are fast-path blocks that will be performed in parallel they currently *will not* be padded out by the scheduler to ensure they are of the same duration in Qiskit
+
+```python
+dd_sequence = [XGate(), XGate()]
+
+pm = PassManager(
+ [
+ ALAPScheduleAnalysis(durations),
+ PadDynamicalDecoupling(durations, dd_sequence),
+ ]
+)
+
+qc = QuantumCircuit(2, 2)
+qc.measure(0, 0)
+qc.measure(1, 1)
+with qc.if_test((0, 1)):
+ qc.x(0)
+ # Is currently not padded to ensure
+ # a duration of 1000. If you desire
+ # this you would need to manually add
+ # qc.delay(840, 0)
+with qc.if_test((1, 1)):
+ qc.delay(1000, 0)
+
+
+qc.draw(output="mpl", style="iqp")
+
+qc_dd = pm.run(qc)
+
+qc_dd.draw(output="mpl", style="iqp")
+```
+
+![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_15\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_15_0.png)
+
+
+ If there are qubits that are *not* involved in a fast-path decision it is not currently possible to use them in a fast-path branch in parallel with the fast-path qubits resulting from a measurement. This will be revised in the future as we further improve these capabilities.
+
+ For example:
+
+ ```python
+ qc = QuantumCircuit(3, 2)
+ qc.x(1)
+ qc.measure(0, 0)
+ with qc.if_test((0, 1)):
+ qc.x(0)
+ # Qubit 1 sits idle throughout the fast-path decision
+ with qc.if_test((1, 0)):
+ # Qubit 2 is idle but there is no measurement
+ # to make it fast-path eligible. This will
+ # however avoid a communication event in the hardware
+ # since the condition is compile time evaluated.
+ qc.x(2)
+
+ qc.draw(output="mpl", style="iqp")
+ ```
+
+ ![../\_images/qiskit\_ibm\_provider.transpiler.passes.scheduling\_16\_0.png](/images/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.transpiler.passes.scheduling_16_0.png)
+
+
+
+
+#### Scheduling & Dynamical Decoupling
+
+| | |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [`BlockBasePadder`](qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder")(\[schedule\_idle\_qubits]) | The base class of padding pass. |
+| [`ALAPScheduleAnalysis`](qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis")(durations) | Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. |
+| [`ASAPScheduleAnalysis`](qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis "qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis")(durations) | Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. |
+| [`DynamicCircuitInstructionDurations`](qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations "qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations")(\[...]) | For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. |
+| [`PadDelay`](qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay "qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay")(\[fill\_very\_end, schedule\_idle\_qubits]) | Padding idle time with Delay instructions. |
+| [`PadDynamicalDecoupling`](qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling")(durations, dd\_sequences) | Dynamical decoupling insertion pass for IBM dynamic circuit backends. |
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.seconds_to_duration.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.seconds_to_duration.mdx
new file mode 100644
index 00000000000..59993069f8e
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.seconds_to_duration.mdx
@@ -0,0 +1,28 @@
+---
+title: seconds_to_duration
+description: API reference for qiskit_ibm_provider.utils.seconds_to_duration
+in_page_toc_min_heading_level: 1
+python_api_type: function
+python_api_name: qiskit_ibm_provider.utils.seconds_to_duration
+---
+
+
+
+# seconds\_to\_duration
+
+
+ Converts seconds in a datetime delta to a duration.
+
+ **Parameters**
+
+ **seconds** (`float`) – Number of seconds in time delta.
+
+ **Return type**
+
+ `Tuple`\[`int`, `int`, `int`, `int`, `int`]
+
+ **Returns**
+
+ A tuple containing the duration in terms of days, hours, minutes, seconds, and milliseconds.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.to_python_identifier.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.to_python_identifier.mdx
new file mode 100644
index 00000000000..86f85ff371a
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.to_python_identifier.mdx
@@ -0,0 +1,28 @@
+---
+title: to_python_identifier
+description: API reference for qiskit_ibm_provider.utils.to_python_identifier
+in_page_toc_min_heading_level: 1
+python_api_type: function
+python_api_name: qiskit_ibm_provider.utils.to_python_identifier
+---
+
+
+
+# to\_python\_identifier
+
+
+ Convert a name to a valid Python identifier.
+
+ **Parameters**
+
+ **name** (`str`) – Name to be converted.
+
+ **Return type**
+
+ `str`
+
+ **Returns**
+
+ Name that is a valid Python identifier.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.utc_to_local.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.utc_to_local.mdx
new file mode 100644
index 00000000000..2d1cb35acfe
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.utc_to_local.mdx
@@ -0,0 +1,32 @@
+---
+title: utc_to_local
+description: API reference for qiskit_ibm_provider.utils.utc_to_local
+in_page_toc_min_heading_level: 1
+python_api_type: function
+python_api_name: qiskit_ibm_provider.utils.utc_to_local
+---
+
+
+
+# utc\_to\_local
+
+
+ Convert a UTC `datetime` object or string to a local timezone `datetime`.
+
+ **Parameters**
+
+ **utc\_dt** (`Union`\[`datetime`, `str`]) – Input UTC datetime or string.
+
+ **Return type**
+
+ `datetime`
+
+ **Returns**
+
+ A `datetime` with the local timezone.
+
+ **Raises**
+
+ **TypeError** – If the input parameter value is not valid.
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.validate_job_tags.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.validate_job_tags.mdx
new file mode 100644
index 00000000000..a3614b487c2
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.utils.validate_job_tags.mdx
@@ -0,0 +1,29 @@
+---
+title: validate_job_tags
+description: API reference for qiskit_ibm_provider.utils.validate_job_tags
+in_page_toc_min_heading_level: 1
+python_api_type: function
+python_api_name: qiskit_ibm_provider.utils.validate_job_tags
+---
+
+
+
+# validate\_job\_tags
+
+
+ Validates input job tags.
+
+ **Parameters**
+
+ * **job\_tags** (`Optional`\[`List`\[`str`]]) – Job tags to be validated.
+ * **exception** (`Type`\[`Exception`]) – Exception to raise if the tags are invalid.
+
+ **Raises**
+
+ **Exception** – If the job tags are invalid.
+
+ **Return type**
+
+ `None`
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_error_map.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_error_map.mdx
new file mode 100644
index 00000000000..f9f93b50bc1
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_error_map.mdx
@@ -0,0 +1,52 @@
+---
+title: iplot_error_map
+description: API reference for qiskit_ibm_provider.visualization.iplot_error_map
+in_page_toc_min_heading_level: 1
+python_api_type: function
+python_api_name: qiskit_ibm_provider.visualization.iplot_error_map
+---
+
+
+
+# iplot\_error\_map
+
+
+ Plot the error map of a device.
+
+ **Parameters**
+
+ * **backend** ([`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.ibm_backend.IBMBackend")) – Plot the error map for this backend.
+ * **figsize** (`Tuple`\[`int`]) – Figure size in pixels.
+ * **show\_title** (`bool`) – Whether to show figure title.
+ * **remove\_badcal\_edges** (`bool`) – Whether to remove bad CX gate calibration data.
+ * **background\_color** (`str`) – Background color, either ‘white’ or ‘black’.
+ * **as\_widget** (`bool`) – `True` if the figure is to be returned as a `PlotlyWidget`. Otherwise the figure is to be returned as a `PlotlyFigure`.
+
+ **Return type**
+
+ `Union`\[`PlotlyFigure`, `PlotlyWidget`]
+
+ **Returns**
+
+ The error map figure.
+
+ **Raises**
+
+ * **VisualizationValueError** – If an invalid input is received.
+ * **VisualizationTypeError** – If the specified backend is a simulator.
+
+ **Example**
+
+ ```python
+ from qiskit_ibm_provider import IBMProvider
+ from qiskit_ibm_provider.visualization import iplot_error_map
+
+ provider = IBMProvider(group='open', project='main')
+ # Note that this is a mock provider, replace ``FakeOpenPulse2Q``
+ # with any of the currently available IBM devices.
+ backend = provider.get_backend('FakeOpenPulse2Q')
+
+ iplot_error_map(backend, as_widget=True)
+ ```
+
+
diff --git a/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_gate_map.mdx b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_gate_map.mdx
new file mode 100644
index 00000000000..0f405549260
--- /dev/null
+++ b/docs/api/qiskit-ibm-provider/0.10/qiskit_ibm_provider.visualization.iplot_gate_map.mdx
@@ -0,0 +1,53 @@
+---
+title: iplot_gate_map
+description: API reference for qiskit_ibm_provider.visualization.iplot_gate_map
+in_page_toc_min_heading_level: 1
+python_api_type: function
+python_api_name: qiskit_ibm_provider.visualization.iplot_gate_map
+---
+
+
+
+# iplot\_gate\_map
+
+
+ Plots an interactive gate map of a device.
+
+ **Parameters**
+
+ * **backend** ([`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.ibm_backend.IBMBackend")) – Plot the gate map for this backend.
+ * **figsize** (`Tuple`\[`Optional`\[`int`], `Optional`\[`int`]]) – Output figure size (wxh) in inches.
+ * **label\_qubits** (`bool`) – Labels for the qubits.
+ * **qubit\_size** (`Optional`\[`float`]) – Size of qubit marker.
+ * **line\_width** (`Optional`\[`float`]) – Width of lines.
+ * **font\_size** (`Optional`\[`int`]) – Font size of qubit labels.
+ * **qubit\_color** (`Union`\[`List`\[`str`], `str`]) – A list of colors for the qubits. If a single color is given, it’s used for all qubits.
+ * **qubit\_labels** (`Optional`\[`List`\[`str`]]) – A list of qubit labels
+ * **line\_color** (`Union`\[`List`\[`str`], `str`]) – A list of colors for each line from the coupling map. If a single color is given, it’s used for all lines.
+ * **font\_color** (`str`) – The font color for the qubit labels.
+ * **background\_color** (`str`) – The background color, either ‘white’ or ‘black’.
+ * **as\_widget** (`bool`) – `True` if the figure is to be returned as a `PlotlyWidget`. Otherwise the figure is to be returned as a `PlotlyFigure`.
+
+ **Return type**
+
+ `Union`\[`PlotlyFigure`, `PlotlyWidget`]
+
+ **Returns**
+
+ The gate map figure.
+
+ **Example**
+
+ ```python
+ from qiskit_ibm_provider import IBMProvider
+ from qiskit_ibm_provider.visualization import iplot_gate_map
+
+ provider = IBMProvider(group='open', project='main')
+ # Note that this is a mock provider, replace ``FakeOpenPulse2Q``
+ # with any of the currently available IBM devices.
+ backend = provider.get_backend('FakeOpenPulse2Q')
+
+ iplot_gate_map(backend, as_widget=True)
+ ```
+
+
diff --git a/docs/api/qiskit-ibm-provider/_package.json b/docs/api/qiskit-ibm-provider/_package.json
index 9c7a52a5269..6124d590a63 100644
--- a/docs/api/qiskit-ibm-provider/_package.json
+++ b/docs/api/qiskit-ibm-provider/_package.json
@@ -1,4 +1,4 @@
{
"name": "qiskit-ibm-provider",
- "version": "0.10.0"
+ "version": "0.11.0"
}
diff --git a/docs/api/qiskit-ibm-provider/ibm_jupyter.mdx b/docs/api/qiskit-ibm-provider/ibm_jupyter.mdx
index 1a4965ba4cc..73b3943629b 100644
--- a/docs/api/qiskit-ibm-provider/ibm_jupyter.mdx
+++ b/docs/api/qiskit-ibm-provider/ibm_jupyter.mdx
@@ -30,6 +30,11 @@ A Collection of Jupyter magic functions and tools that extend the functionality
## Detailed information on a single backend
+```python
+from qiskit_ibm_provider.test.ibm_provider_mock import mock_get_backend
+mock_get_backend('Fake1Q')
+```
+
```python
from qiskit_ibm_provider import IBMProvider
import qiskit_ibm_provider.jupyter
@@ -39,11 +44,11 @@ backend = provider.get_backend('ibmq_vigo')
```
```python
-backend
+backend.jobs = lambda *args, **kwargs: []
```
```python
-
+backend
```
## IBM Quantum dashboard
diff --git a/docs/api/qiskit-ibm-provider/ibm_utils.mdx b/docs/api/qiskit-ibm-provider/ibm_utils.mdx
index 98295f4919e..e6e7cb9c3ca 100644
--- a/docs/api/qiskit-ibm-provider/ibm_utils.mdx
+++ b/docs/api/qiskit-ibm-provider/ibm_utils.mdx
@@ -42,7 +42,7 @@ Utility functions related to the IBM Quantum Provider.
Message broker for the Publisher / Subscriber mechanism
-
+
Represents a “publisher”.
Every component (class) can become a [`Publisher`](#qiskit_ibm_provider.utils.pubsub.Publisher "qiskit_ibm_provider.utils.pubsub.Publisher") and send events by inheriting this class. Functions can call this class like:
@@ -53,7 +53,7 @@ Message broker for the Publisher / Subscriber mechanism
### publish
-
+
Triggers an event, and associates some data to it, so if there are any subscribers, their callback will be called synchronously.
**Return type**
@@ -62,14 +62,14 @@ Message broker for the Publisher / Subscriber mechanism
-
+
Represents a “subscriber”.
Every component (class) can become a [`Subscriber`](#qiskit_ibm_provider.utils.pubsub.Subscriber "qiskit_ibm_provider.utils.pubsub.Subscriber") and subscribe to events, that will call callback functions when they are emitted.
### clear
-
+
Unsubscribe everything
**Return type**
@@ -79,7 +79,7 @@ Message broker for the Publisher / Subscriber mechanism
### subscribe
-
+
Subscribes to an event, associating a callback function to that event, so when the event occurs, the callback will be called.
This is a blocking call, so try to keep callbacks as lightweight as possible.
@@ -91,7 +91,7 @@ Message broker for the Publisher / Subscriber mechanism
### unsubscribe
-
+
Unsubscribe a pair event-callback, so the callback will not be called anymore when the event occurs.
**Return type**
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.mdx
index 4b30d440e28..41f40e6a939 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackend.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
# IBMBackend
-
+
Backend class interfacing with an IBM Quantum device.
You can run experiments on a backend using the [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method. The [`run()`](#qiskit_ibm_provider.IBMBackend.run "qiskit_ibm_provider.IBMBackend.run") method takes one or more [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.0)") and returns an `IBMJob` instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow:
@@ -317,7 +317,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### acquire\_channel
-
+
Return the acquisition channel for the given qubit.
**Returns**
@@ -331,7 +331,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### cancel\_session
-
+
Cancel session. All pending jobs will be cancelled.
**Return type**
@@ -341,7 +341,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### 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**
@@ -351,7 +351,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### 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.
@@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### control\_channel
-
+
Return the secondary drive channel for the given qubit.
This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels.
@@ -389,7 +389,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### defaults
-
+
Return the pulse defaults for the backend.
The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json).
@@ -409,7 +409,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### drive\_channel
-
+
Return the drive channel for the given qubit.
**Returns**
@@ -423,7 +423,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### get\_translation\_stage\_plugin
-
+
Return the default translation stage plugin name for IBM backends.
**Return type**
@@ -433,7 +433,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### measure\_channel
-
+
Return the measure stimulus channel for the given qubit.
**Returns**
@@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### open\_session
-
+
Open session
**Return type**
@@ -457,7 +457,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### properties
-
+
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.
@@ -508,7 +508,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### run
-
+
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**
@@ -523,9 +523,9 @@ python_api_name: qiskit_ibm_provider.IBMBackend
* **init\_num\_resets** (`Optional`\[`int`]) – The number of qubit resets to insert before each circuit execution.
- * **or** (*The following parameters are applicable only if dynamic=False is specified*) –
+ * **or** (*The following parameters are applicable only if dynamic=False is specified*)
- * **to.** (*defaulted*) –
+ * **to.** (*defaulted*)
* **header** (`Optional`\[`Dict`]) – User input that will be attached to the job and will be copied to the corresponding result header. Headers do not affect the run. This replaces the old `Qobj` header.
@@ -597,7 +597,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### status
-
+
Return the backend status.
@@ -619,7 +619,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend
### target\_history
-
+
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") object for the backend. :rtype: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.0)") :returns: Target with properties found on datetime
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.mdx
index e6d966f626c..78b10d1796d 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiError.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiError
# IBMBackendApiError
-
+
Errors that occur unexpectedly when querying the server.
Set the error message.
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx
index 1852d84849c..69a9a832531 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendApiProtocolError.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendApiProtocolError
# IBMBackendApiProtocolError
-
+
Errors raised when an unexpected value is received from the server.
Set the error message.
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.mdx
index 1ba2cae9ee5..a504ef96cd4 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendError.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendError
# IBMBackendError
-
+
Base class for errors raised by the backend modules.
Set the error message.
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.mdx
index d8f11435dc5..0e90b9db0b4 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendService.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService
# IBMBackendService
-
+
Backend namespace for an IBM Quantum account.
Represent a namespace that provides backend related services for the IBM Quantum backends available to this account. An instance of this class is used as a callable attribute to the [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider") class. This allows a convenient way to query for all backends or to access a specific backend:
@@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService
### backends
-
+
Return all backends accessible via this account, subject to optional filtering.
**Parameters**
@@ -96,7 +96,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService
### jobs
-
+
Return a list of jobs, subject to optional filtering.
Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server.
@@ -115,8 +115,8 @@ python_api_name: qiskit_ibm_provider.IBMBackendService
* **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.
* **instance** (`Optional`\[`str`]) – The provider in the hub/group/project format.
* **legacy** (`bool`) – If `True`, only retrieve jobs run from the archived `qiskit-ibmq-provider`.
- * **Otherwise** –
- * **qiskit-ibm-provider.** (*only retrieve jobs run from*) –
+ * **Otherwise**
+ * **qiskit-ibm-provider.** (*only retrieve jobs run from*)
**Return type**
@@ -134,7 +134,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendService
### retrieve\_job
-
+
Return a single job.
**Parameters**
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.mdx
index c5584577e74..6e638920ece 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMBackendValueError.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMBackendValueError
# IBMBackendValueError
-
+
Value errors raised by the backend modules.
Set the error message.
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.mdx
index 9d68fa9ae35..90311485090 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMError.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMError
# IBMError
-
+
Base class for errors raised by the provider modules.
Set the error message.
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.mdx
index 8787524a16b..dca17cfda5b 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProvider.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
# IBMProvider
-
+
Provides access to the IBM Quantum services available to an account.
Authenticate against IBM Quantum for use from saved credentials or during session.
@@ -130,7 +130,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### active\_account
-
+
Return the IBM Quantum account currently in use for the session.
**Return type**
@@ -144,7 +144,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### backends
-
+
Return all backends accessible via this account, subject to optional filtering.
**Parameters**
@@ -190,7 +190,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### delete\_account
-
+
Delete a saved account from disk.
**Parameters**
@@ -208,7 +208,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### get\_backend
-
+
Return a single backend matching the specified filtering.
**Parameters**
@@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### instances
-
+
Return the IBM Quantum instances list currently in use for the session.
**Return type**
@@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### jobs
-
+
Return a list of jobs, subject to optional filtering.
Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server.
@@ -264,8 +264,8 @@ python_api_name: qiskit_ibm_provider.IBMProvider
* **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.
* **instance** (`Optional`\[`str`]) – The provider in the hub/group/project format.
* **legacy** (`bool`) – If `True`, only retrieve jobs run from the deprecated `qiskit-ibmq-provider`.
- * **Otherwise** –
- * **qiskit-ibm-provider.** (*only retrieve jobs run from*) –
+ * **Otherwise**
+ * **qiskit-ibm-provider.** (*only retrieve jobs run from*)
**Return type**
@@ -278,7 +278,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### retrieve\_job
-
+
Return a single job.
**Parameters**
@@ -296,7 +296,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### save\_account
-
+
Save the account to disk for future use.
**Parameters**
@@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider
### saved\_accounts
-
+
List the accounts saved on disk.
**Parameters**
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.mdx
index 88c672229b4..18b178fccf2 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderError.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderError
# IBMProviderError
-
+
Base class for errors raise by IBMProvider.
Set the error message.
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.mdx
index 465806a90ce..5fc77201dea 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.IBMProviderValueError.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.IBMProviderValueError
# IBMProviderValueError
-
+
Value errors raised by IBMProvider.
Set the error message.
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.mdx
index 9afb796f6fe..9ae77feb02a 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.Session.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.Session
# Session
-
+
Class for creating a flexible Qiskit Runtime session.
A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead.
@@ -77,7 +77,7 @@ python_api_name: qiskit_ibm_provider.Session
### cancel
-
+
Set the session.\_active status to False
**Return type**
diff --git a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.mdx b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.mdx
index 54763b88421..7cbb6e82873 100644
--- a/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.mdx
+++ b/docs/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob
# IBMCircuitJob
-
+
Representation of a job that executes on an IBM Quantum backend.
The job may be executed on a simulator or a real device. A new `IBMCircuitJob` instance is returned when you call `IBMBackend.run()` to submit a job to a particular backend.
@@ -116,7 +116,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob
### backend\_options
-
+
Return the backend configuration options used for this job.
Options that are not applicable to the job execution are not returned. Some but not all of the options with default values are returned. You can use [`qiskit_ibm_provider.IBMBackend.options`](qiskit_ibm_provider.IBMBackend#options "qiskit_ibm_provider.IBMBackend.options") to see all backend options.
@@ -132,7 +132,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob
### cancel
-
+
Attempt to cancel the job.
@@ -165,7 +165,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob
### circuits
-
+
Return the circuits for this job.
**Return type**
@@ -179,7 +179,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob
### creation\_date
-
+
Return job creation date, in local time.
**Return type**
@@ -203,7 +203,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob
### error\_message
-
+
Provide details about the reason of failure.
**Return type**
@@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob
### header
-