scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update API dev docs (#2393) 

An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
  > [!NOTE]
  > This pull request was created by a GitHub action.

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
This commit is contained in:
github-actions[bot] 2024-11-26 06:38:16 -05:00 committed by GitHub
parent bc03c60c52
commit 881ff8ee30
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
120 changed files with 3485 additions and 4479 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/qiskit-ibm-runtime/dev/debug_tools.mdx
View File

@ -18,9 +18,9 @@ The tools for debugging and analyzing qiskit-ibm-runtime jobs.
## Classes
| | |
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`Neat`](qiskit_ibm_runtime.debug_tools.Neat "qiskit_ibm_runtime.debug_tools.Neat")(backend\[, noise\_model]) | A class to help understand the expected performance of estimator jobs. |
| [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.NeatResult")(pub\_results) | A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. |
| [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult")(vals) | A class to store the PUB results of `Neat`. |
| | |
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`Neat`](qiskit_ibm_runtime.debug_tools.Neat "qiskit_ibm_runtime.debug_tools.Neat") | A class to help understand the expected performance of estimator jobs. |
| [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.NeatResult") | A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. |
| [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") | A class to store the PUB results of `Neat`. |

16
docs/api/qiskit-ibm-runtime/dev/execution_span.mdx
View File

@ -20,12 +20,12 @@ An [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_i
## Classes
| | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`DoubleSliceSpan`](qiskit_ibm_runtime.execution_span.DoubleSliceSpan "qiskit_ibm_runtime.execution_span.DoubleSliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |
| [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")(start, stop) | Abstract parent for classes that store an execution time span for a subset of job data. |
| [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")(spans) | A collection of timings for pub results. |
| [`ShapeType`](qiskit_ibm_runtime.execution_span.ShapeType "qiskit_ibm_runtime.execution_span.ShapeType") | alias of `Tuple`\[`int`, ...] |
| [`SliceSpan`](qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |
| [`TwirledSliceSpan`](qiskit_ibm_runtime.execution_span.TwirledSliceSpan "qiskit_ibm_runtime.execution_span.TwirledSliceSpan")(start, stop, data\_slices) | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format when twirling. |
| | |
| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`DoubleSliceSpan`](qiskit_ibm_runtime.execution_span.DoubleSliceSpan "qiskit_ibm_runtime.execution_span.DoubleSliceSpan") | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |
| [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") | Abstract parent for classes that store an execution time span for a subset of job data. |
| [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") | A collection of timings for pub results. |
| [`ShapeType`](qiskit_ibm_runtime.execution_span.ShapeType "qiskit_ibm_runtime.execution_span.ShapeType") | alias of `Tuple`\[`int`, ...] |
| [`SliceSpan`](qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan") | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format. |
| [`TwirledSliceSpan`](qiskit_ibm_runtime.execution_span.TwirledSliceSpan "qiskit_ibm_runtime.execution_span.TwirledSliceSpan") | An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format when twirling. |

124
docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx
View File

@ -78,9 +78,9 @@ plot_histogram(counts)
Fake providers provide access to a list of fake backends.
| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| [`FakeProviderForBackendV2`](qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 "qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2")() | Fake provider containing fake V2 backends. |
| | |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| [`FakeProviderForBackendV2`](qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 "qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2") | Fake provider containing fake V2 backends. |
## Fake Backends
@ -88,63 +88,63 @@ Fake providers provide access to a list of fake backends.
Fake V2 backends are fake backends with IBM Quantum systems snapshots implemented with `BackendV2` interface. They are all subclasses of `FakeBackendV2`.
| | |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| [`FakeAlgiers`](qiskit_ibm_runtime.fake_provider.FakeAlgiers "qiskit_ibm_runtime.fake_provider.FakeAlgiers")() | A fake 27 qubit backend. |
| [`FakeAlmadenV2`](qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 "qiskit_ibm_runtime.fake_provider.FakeAlmadenV2")() | A fake Almaden V2 backend. |
| [`FakeArmonkV2`](qiskit_ibm_runtime.fake_provider.FakeArmonkV2 "qiskit_ibm_runtime.fake_provider.FakeArmonkV2")() | A fake 1 qubit backend. |
| [`FakeAthensV2`](qiskit_ibm_runtime.fake_provider.FakeAthensV2 "qiskit_ibm_runtime.fake_provider.FakeAthensV2")() | A fake 5 qubit backend. |
| [`FakeAuckland`](qiskit_ibm_runtime.fake_provider.FakeAuckland "qiskit_ibm_runtime.fake_provider.FakeAuckland")() | A fake 27 qubit backend. |
| [`FakeBelemV2`](qiskit_ibm_runtime.fake_provider.FakeBelemV2 "qiskit_ibm_runtime.fake_provider.FakeBelemV2")() | A fake 5 qubit backend. |
| [`FakeBoeblingenV2`](qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 "qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2")() | A fake Boeblingen V2 backend. |
| [`FakeBogotaV2`](qiskit_ibm_runtime.fake_provider.FakeBogotaV2 "qiskit_ibm_runtime.fake_provider.FakeBogotaV2")() | A fake 5 qubit backend. |
| [`FakeBrisbane`](qiskit_ibm_runtime.fake_provider.FakeBrisbane "qiskit_ibm_runtime.fake_provider.FakeBrisbane")() | A fake 127 qubit backend. |
| [`FakeBrooklynV2`](qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 "qiskit_ibm_runtime.fake_provider.FakeBrooklynV2")() | A fake Brooklyn V2 backend. |
| [`FakeBurlingtonV2`](qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 "qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2")() | A fake 5 qubit backend. |
| [`FakeCairoV2`](qiskit_ibm_runtime.fake_provider.FakeCairoV2 "qiskit_ibm_runtime.fake_provider.FakeCairoV2")() | A fake 27 qubit backend. |
| [`FakeCambridgeV2`](qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 "qiskit_ibm_runtime.fake_provider.FakeCambridgeV2")() | A fake Cambridge backend. |
| [`FakeCasablancaV2`](qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 "qiskit_ibm_runtime.fake_provider.FakeCasablancaV2")() | A fake 7 qubit backend. |
| [`FakeCusco`](qiskit_ibm_runtime.fake_provider.FakeCusco "qiskit_ibm_runtime.fake_provider.FakeCusco")() | A fake 127 qubit backend. |
| [`FakeEssexV2`](qiskit_ibm_runtime.fake_provider.FakeEssexV2 "qiskit_ibm_runtime.fake_provider.FakeEssexV2")() | A fake 5 qubit backend. |
| [`FakeGeneva`](qiskit_ibm_runtime.fake_provider.FakeGeneva "qiskit_ibm_runtime.fake_provider.FakeGeneva")() | A fake 27 qubit backend. |
| [`FakeGuadalupeV2`](qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 "qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2")() | A fake 16 qubit backend. |
| [`FakeHanoiV2`](qiskit_ibm_runtime.fake_provider.FakeHanoiV2 "qiskit_ibm_runtime.fake_provider.FakeHanoiV2")() | A fake 27 qubit backend. |
| [`FakeJakartaV2`](qiskit_ibm_runtime.fake_provider.FakeJakartaV2 "qiskit_ibm_runtime.fake_provider.FakeJakartaV2")() | A fake 7 qubit V2 backend. |
| [`FakeJohannesburgV2`](qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 "qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2")() | A fake Johannesburg V2 backend. |
| [`FakeKawasaki`](qiskit_ibm_runtime.fake_provider.FakeKawasaki "qiskit_ibm_runtime.fake_provider.FakeKawasaki")() | A fake 127 qubit backend. |
| [`FakeKolkataV2`](qiskit_ibm_runtime.fake_provider.FakeKolkataV2 "qiskit_ibm_runtime.fake_provider.FakeKolkataV2")() | A fake 27 qubit backend. |
| [`FakeKyiv`](qiskit_ibm_runtime.fake_provider.FakeKyiv "qiskit_ibm_runtime.fake_provider.FakeKyiv")() | A fake 127 qubit backend. |
| [`FakeKyoto`](qiskit_ibm_runtime.fake_provider.FakeKyoto "qiskit_ibm_runtime.fake_provider.FakeKyoto")() | A fake 127 qubit backend. |
| [`FakeLagosV2`](qiskit_ibm_runtime.fake_provider.FakeLagosV2 "qiskit_ibm_runtime.fake_provider.FakeLagosV2")() | A fake 7 qubit backend. |
| [`FakeLimaV2`](qiskit_ibm_runtime.fake_provider.FakeLimaV2 "qiskit_ibm_runtime.fake_provider.FakeLimaV2")() | A fake 5 qubit backend. |
| [`FakeFractionalBackend`](qiskit_ibm_runtime.fake_provider.FakeFractionalBackend "qiskit_ibm_runtime.fake_provider.FakeFractionalBackend")() | A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima. |
| [`FakeLondonV2`](qiskit_ibm_runtime.fake_provider.FakeLondonV2 "qiskit_ibm_runtime.fake_provider.FakeLondonV2")() | A fake 5 qubit backend. |
| [`FakeManhattanV2`](qiskit_ibm_runtime.fake_provider.FakeManhattanV2 "qiskit_ibm_runtime.fake_provider.FakeManhattanV2")() | A fake Manhattan backend. |
| [`FakeManilaV2`](qiskit_ibm_runtime.fake_provider.FakeManilaV2 "qiskit_ibm_runtime.fake_provider.FakeManilaV2")() | A fake 5 qubit backend. |
| [`FakeMelbourneV2`](qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2")() | A fake 14 qubit backend. |
| [`FakeMontrealV2`](qiskit_ibm_runtime.fake_provider.FakeMontrealV2 "qiskit_ibm_runtime.fake_provider.FakeMontrealV2")() | A fake 27 qubit backend. |
| [`FakeMumbaiV2`](qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2")() | A fake 27 qubit backend. |
| [`FakeNairobiV2`](qiskit_ibm_runtime.fake_provider.FakeNairobiV2 "qiskit_ibm_runtime.fake_provider.FakeNairobiV2")() | A fake 7 qubit backend. |
| [`FakeOsaka`](qiskit_ibm_runtime.fake_provider.FakeOsaka "qiskit_ibm_runtime.fake_provider.FakeOsaka")() | A fake 127 qubit backend. |
| [`FakeOslo`](qiskit_ibm_runtime.fake_provider.FakeOslo "qiskit_ibm_runtime.fake_provider.FakeOslo")() | A fake 7 qubit backend. |
| [`FakeOurenseV2`](qiskit_ibm_runtime.fake_provider.FakeOurenseV2 "qiskit_ibm_runtime.fake_provider.FakeOurenseV2")() | A fake 5 qubit backend. |
| [`FakeParisV2`](qiskit_ibm_runtime.fake_provider.FakeParisV2 "qiskit_ibm_runtime.fake_provider.FakeParisV2")() | A fake Paris backend. |
| [`FakePeekskill`](qiskit_ibm_runtime.fake_provider.FakePeekskill "qiskit_ibm_runtime.fake_provider.FakePeekskill")() | A fake 27 qubit backend. |
| [`FakePerth`](qiskit_ibm_runtime.fake_provider.FakePerth "qiskit_ibm_runtime.fake_provider.FakePerth")() | A fake 7 qubit backend. |
| [`FakePrague`](qiskit_ibm_runtime.fake_provider.FakePrague "qiskit_ibm_runtime.fake_provider.FakePrague")() | A fake 33 qubit backend. |
| [`FakePoughkeepsieV2`](qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 "qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2")() | A fake Poughkeepsie backend. |
| [`FakeQuebec`](qiskit_ibm_runtime.fake_provider.FakeQuebec "qiskit_ibm_runtime.fake_provider.FakeQuebec")() | A fake 127 qubit backend. |
| [`FakeQuitoV2`](qiskit_ibm_runtime.fake_provider.FakeQuitoV2 "qiskit_ibm_runtime.fake_provider.FakeQuitoV2")() | A fake 5 qubit backend. |
| [`FakeRochesterV2`](qiskit_ibm_runtime.fake_provider.FakeRochesterV2 "qiskit_ibm_runtime.fake_provider.FakeRochesterV2")() | A fake Rochester backend. |
| [`FakeRomeV2`](qiskit_ibm_runtime.fake_provider.FakeRomeV2 "qiskit_ibm_runtime.fake_provider.FakeRomeV2")() | A fake 5 qubit backend. |
| [`FakeSantiagoV2`](qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 "qiskit_ibm_runtime.fake_provider.FakeSantiagoV2")() | A fake Santiago backend. |
| [`FakeSherbrooke`](qiskit_ibm_runtime.fake_provider.FakeSherbrooke "qiskit_ibm_runtime.fake_provider.FakeSherbrooke")() | A fake 127 qubit backend. |
| [`FakeSingaporeV2`](qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 "qiskit_ibm_runtime.fake_provider.FakeSingaporeV2")() | A fake Singapore backend. |
| [`FakeSydneyV2`](qiskit_ibm_runtime.fake_provider.FakeSydneyV2 "qiskit_ibm_runtime.fake_provider.FakeSydneyV2")() | A fake 27 qubit backend. |
| [`FakeTorino`](qiskit_ibm_runtime.fake_provider.FakeTorino "qiskit_ibm_runtime.fake_provider.FakeTorino")() | A fake 133 qubit backend. |
| [`FakeTorontoV2`](qiskit_ibm_runtime.fake_provider.FakeTorontoV2 "qiskit_ibm_runtime.fake_provider.FakeTorontoV2")() | A fake 27 qubit backend. |
| [`FakeValenciaV2`](qiskit_ibm_runtime.fake_provider.FakeValenciaV2 "qiskit_ibm_runtime.fake_provider.FakeValenciaV2")() | A fake 5 qubit backend. |
| [`FakeVigoV2`](qiskit_ibm_runtime.fake_provider.FakeVigoV2 "qiskit_ibm_runtime.fake_provider.FakeVigoV2")() | A fake 5 qubit backend. |
| [`FakeWashingtonV2`](qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 "qiskit_ibm_runtime.fake_provider.FakeWashingtonV2")() | A fake 127 qubit backend. |
| [`FakeYorktownV2`](qiskit_ibm_runtime.fake_provider.FakeYorktownV2 "qiskit_ibm_runtime.fake_provider.FakeYorktownV2")() | A fake 5 qubit backend. |
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- |
| [`FakeAlgiers`](qiskit_ibm_runtime.fake_provider.FakeAlgiers "qiskit_ibm_runtime.fake_provider.FakeAlgiers") | A fake 27 qubit backend. |
| [`FakeAlmadenV2`](qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 "qiskit_ibm_runtime.fake_provider.FakeAlmadenV2") | A fake Almaden V2 backend. |
| [`FakeArmonkV2`](qiskit_ibm_runtime.fake_provider.FakeArmonkV2 "qiskit_ibm_runtime.fake_provider.FakeArmonkV2") | A fake 1 qubit backend. |
| [`FakeAthensV2`](qiskit_ibm_runtime.fake_provider.FakeAthensV2 "qiskit_ibm_runtime.fake_provider.FakeAthensV2") | A fake 5 qubit backend. |
| [`FakeAuckland`](qiskit_ibm_runtime.fake_provider.FakeAuckland "qiskit_ibm_runtime.fake_provider.FakeAuckland") | A fake 27 qubit backend. |
| [`FakeBelemV2`](qiskit_ibm_runtime.fake_provider.FakeBelemV2 "qiskit_ibm_runtime.fake_provider.FakeBelemV2") | A fake 5 qubit backend. |
| [`FakeBoeblingenV2`](qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 "qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2") | A fake Boeblingen V2 backend. |
| [`FakeBogotaV2`](qiskit_ibm_runtime.fake_provider.FakeBogotaV2 "qiskit_ibm_runtime.fake_provider.FakeBogotaV2") | A fake 5 qubit backend. |
| [`FakeBrisbane`](qiskit_ibm_runtime.fake_provider.FakeBrisbane "qiskit_ibm_runtime.fake_provider.FakeBrisbane") | A fake 127 qubit backend. |
| [`FakeBrooklynV2`](qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 "qiskit_ibm_runtime.fake_provider.FakeBrooklynV2") | A fake Brooklyn V2 backend. |
| [`FakeBurlingtonV2`](qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 "qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2") | A fake 5 qubit backend. |
| [`FakeCairoV2`](qiskit_ibm_runtime.fake_provider.FakeCairoV2 "qiskit_ibm_runtime.fake_provider.FakeCairoV2") | A fake 27 qubit backend. |
| [`FakeCambridgeV2`](qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 "qiskit_ibm_runtime.fake_provider.FakeCambridgeV2") | A fake Cambridge backend. |
| [`FakeCasablancaV2`](qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 "qiskit_ibm_runtime.fake_provider.FakeCasablancaV2") | A fake 7 qubit backend. |
| [`FakeCusco`](qiskit_ibm_runtime.fake_provider.FakeCusco "qiskit_ibm_runtime.fake_provider.FakeCusco") | A fake 127 qubit backend. |
| [`FakeEssexV2`](qiskit_ibm_runtime.fake_provider.FakeEssexV2 "qiskit_ibm_runtime.fake_provider.FakeEssexV2") | A fake 5 qubit backend. |
| [`FakeGeneva`](qiskit_ibm_runtime.fake_provider.FakeGeneva "qiskit_ibm_runtime.fake_provider.FakeGeneva") | A fake 27 qubit backend. |
| [`FakeGuadalupeV2`](qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 "qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2") | A fake 16 qubit backend. |
| [`FakeHanoiV2`](qiskit_ibm_runtime.fake_provider.FakeHanoiV2 "qiskit_ibm_runtime.fake_provider.FakeHanoiV2") | A fake 27 qubit backend. |
| [`FakeJakartaV2`](qiskit_ibm_runtime.fake_provider.FakeJakartaV2 "qiskit_ibm_runtime.fake_provider.FakeJakartaV2") | A fake 7 qubit V2 backend. |
| [`FakeJohannesburgV2`](qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 "qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2") | A fake Johannesburg V2 backend. |
| [`FakeKawasaki`](qiskit_ibm_runtime.fake_provider.FakeKawasaki "qiskit_ibm_runtime.fake_provider.FakeKawasaki") | A fake 127 qubit backend. |
| [`FakeKolkataV2`](qiskit_ibm_runtime.fake_provider.FakeKolkataV2 "qiskit_ibm_runtime.fake_provider.FakeKolkataV2") | A fake 27 qubit backend. |
| [`FakeKyiv`](qiskit_ibm_runtime.fake_provider.FakeKyiv "qiskit_ibm_runtime.fake_provider.FakeKyiv") | A fake 127 qubit backend. |
| [`FakeKyoto`](qiskit_ibm_runtime.fake_provider.FakeKyoto "qiskit_ibm_runtime.fake_provider.FakeKyoto") | A fake 127 qubit backend. |
| [`FakeLagosV2`](qiskit_ibm_runtime.fake_provider.FakeLagosV2 "qiskit_ibm_runtime.fake_provider.FakeLagosV2") | A fake 7 qubit backend. |
| [`FakeLimaV2`](qiskit_ibm_runtime.fake_provider.FakeLimaV2 "qiskit_ibm_runtime.fake_provider.FakeLimaV2") | A fake 5 qubit backend. |
| [`FakeFractionalBackend`](qiskit_ibm_runtime.fake_provider.FakeFractionalBackend "qiskit_ibm_runtime.fake_provider.FakeFractionalBackend") | A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima. |
| [`FakeLondonV2`](qiskit_ibm_runtime.fake_provider.FakeLondonV2 "qiskit_ibm_runtime.fake_provider.FakeLondonV2") | A fake 5 qubit backend. |
| [`FakeManhattanV2`](qiskit_ibm_runtime.fake_provider.FakeManhattanV2 "qiskit_ibm_runtime.fake_provider.FakeManhattanV2") | A fake Manhattan backend. |
| [`FakeManilaV2`](qiskit_ibm_runtime.fake_provider.FakeManilaV2 "qiskit_ibm_runtime.fake_provider.FakeManilaV2") | A fake 5 qubit backend. |
| [`FakeMelbourneV2`](qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2") | A fake 14 qubit backend. |
| [`FakeMontrealV2`](qiskit_ibm_runtime.fake_provider.FakeMontrealV2 "qiskit_ibm_runtime.fake_provider.FakeMontrealV2") | A fake 27 qubit backend. |
| [`FakeMumbaiV2`](qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2") | A fake 27 qubit backend. |
| [`FakeNairobiV2`](qiskit_ibm_runtime.fake_provider.FakeNairobiV2 "qiskit_ibm_runtime.fake_provider.FakeNairobiV2") | A fake 7 qubit backend. |
| [`FakeOsaka`](qiskit_ibm_runtime.fake_provider.FakeOsaka "qiskit_ibm_runtime.fake_provider.FakeOsaka") | A fake 127 qubit backend. |
| [`FakeOslo`](qiskit_ibm_runtime.fake_provider.FakeOslo "qiskit_ibm_runtime.fake_provider.FakeOslo") | A fake 7 qubit backend. |
| [`FakeOurenseV2`](qiskit_ibm_runtime.fake_provider.FakeOurenseV2 "qiskit_ibm_runtime.fake_provider.FakeOurenseV2") | A fake 5 qubit backend. |
| [`FakeParisV2`](qiskit_ibm_runtime.fake_provider.FakeParisV2 "qiskit_ibm_runtime.fake_provider.FakeParisV2") | A fake Paris backend. |
| [`FakePeekskill`](qiskit_ibm_runtime.fake_provider.FakePeekskill "qiskit_ibm_runtime.fake_provider.FakePeekskill") | A fake 27 qubit backend. |
| [`FakePerth`](qiskit_ibm_runtime.fake_provider.FakePerth "qiskit_ibm_runtime.fake_provider.FakePerth") | A fake 7 qubit backend. |
| [`FakePrague`](qiskit_ibm_runtime.fake_provider.FakePrague "qiskit_ibm_runtime.fake_provider.FakePrague") | A fake 33 qubit backend. |
| [`FakePoughkeepsieV2`](qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 "qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2") | A fake Poughkeepsie backend. |
| [`FakeQuebec`](qiskit_ibm_runtime.fake_provider.FakeQuebec "qiskit_ibm_runtime.fake_provider.FakeQuebec") | A fake 127 qubit backend. |
| [`FakeQuitoV2`](qiskit_ibm_runtime.fake_provider.FakeQuitoV2 "qiskit_ibm_runtime.fake_provider.FakeQuitoV2") | A fake 5 qubit backend. |
| [`FakeRochesterV2`](qiskit_ibm_runtime.fake_provider.FakeRochesterV2 "qiskit_ibm_runtime.fake_provider.FakeRochesterV2") | A fake Rochester backend. |
| [`FakeRomeV2`](qiskit_ibm_runtime.fake_provider.FakeRomeV2 "qiskit_ibm_runtime.fake_provider.FakeRomeV2") | A fake 5 qubit backend. |
| [`FakeSantiagoV2`](qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 "qiskit_ibm_runtime.fake_provider.FakeSantiagoV2") | A fake Santiago backend. |
| [`FakeSherbrooke`](qiskit_ibm_runtime.fake_provider.FakeSherbrooke "qiskit_ibm_runtime.fake_provider.FakeSherbrooke") | A fake 127 qubit backend. |
| [`FakeSingaporeV2`](qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 "qiskit_ibm_runtime.fake_provider.FakeSingaporeV2") | A fake Singapore backend. |
| [`FakeSydneyV2`](qiskit_ibm_runtime.fake_provider.FakeSydneyV2 "qiskit_ibm_runtime.fake_provider.FakeSydneyV2") | A fake 27 qubit backend. |
| [`FakeTorino`](qiskit_ibm_runtime.fake_provider.FakeTorino "qiskit_ibm_runtime.fake_provider.FakeTorino") | A fake 133 qubit backend. |
| [`FakeTorontoV2`](qiskit_ibm_runtime.fake_provider.FakeTorontoV2 "qiskit_ibm_runtime.fake_provider.FakeTorontoV2") | A fake 27 qubit backend. |
| [`FakeValenciaV2`](qiskit_ibm_runtime.fake_provider.FakeValenciaV2 "qiskit_ibm_runtime.fake_provider.FakeValenciaV2") | A fake 5 qubit backend. |
| [`FakeVigoV2`](qiskit_ibm_runtime.fake_provider.FakeVigoV2 "qiskit_ibm_runtime.fake_provider.FakeVigoV2") | A fake 5 qubit backend. |
| [`FakeWashingtonV2`](qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 "qiskit_ibm_runtime.fake_provider.FakeWashingtonV2") | A fake 127 qubit backend. |
| [`FakeYorktownV2`](qiskit_ibm_runtime.fake_provider.FakeYorktownV2 "qiskit_ibm_runtime.fake_provider.FakeYorktownV2") | A fake 5 qubit backend. |

4
docs/api/qiskit-ibm-runtime/dev/index.mdx
View File

@ -3,7 +3,9 @@ title: Qiskit Runtime client API documentation (dev version)
description: Index of all the modules in the dev version of qiskit-ibm-runtime.
---
# qiskit-ibm-runtime API reference
<span id="qiskit-ibm-runtime-api-reference" />
# `qiskit-ibm-runtime` API reference
* [Qiskit Runtime (`qiskit_ibm_runtime`)](runtime_service)
* [Noise learner (`qiskit_ibm_runtime.noise_learner.NoiseLearner`)](noise_learner)

8
docs/api/qiskit-ibm-runtime/dev/noise_learner_result.mdx
View File

@ -14,8 +14,8 @@ python_api_name: qiskit_ibm_runtime.utils.noise_learner_result
`qiskit_ibm_runtime.utils.noise_learner_result`
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------- |
| [`PauliLindbladError`](qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError")(generators, rates) | A Pauli error channel generated by a Pauli Lindblad dissipators. |
| [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError")(circuit, qubits\[, error]) | The error channel (in Pauli-Lindblad format) of a single layer of instructions. |
| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [`PauliLindbladError`](qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError") | A Pauli error channel generated by a Pauli Lindblad dissipators. |
| [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError") | The error channel (in Pauli-Lindblad format) of a single layer of instructions. |

36
docs/api/qiskit-ibm-runtime/dev/options.mdx
View File

@ -50,25 +50,25 @@ Refer to [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ib
### Base primitive options
| | |
| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")(\*args, \*\*kwargs) | Options for V2 Estimator. |
| [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions")(\*args, \*\*kwargs) | Options for V2 Sampler. |
| | |
| --------------------------------------------------------------------------------------------------------------- | ------------------------- |
| [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions") | Options for V2 Estimator. |
| [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions") | Options for V2 Sampler. |
### Suboptions
| | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`NoiseLearnerOptions`](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.NoiseLearnerOptions")(\*args, \*\*kwargs) | Options for [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner"). |
| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\*args, \*\*kwargs) | Options for dynamical decoupling (DD). |
| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\*args, \*\*kwargs) | Resilience options for V2 Estimator. |
| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\*args, \*\*kwargs) | Options for learning layer noise. |
| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\*args, \*\*kwargs) | Options for measurement noise learning. |
| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\*args, \*\*kwargs) | Probabalistic error cancellation mitigation options. |
| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\*args, \*\*kwargs) | Zero noise extrapolation mitigation options. |
| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\*args, \*\*kwargs) | Twirling options. |
| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\*args, \*\*kwargs) | Execution options for V2 primitives. |
| [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2")(\*args, \*\*kwargs) | Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. |
| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\*args, \*\*kwargs) | Options related to the execution environment. |
| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\*args, \*\*kwargs) | Simulator options. |
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`NoiseLearnerOptions`](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.NoiseLearnerOptions") | Options for [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner"). |
| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") | Options for dynamical decoupling (DD). |
| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2") | Resilience options for V2 Estimator. |
| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") | Options for learning layer noise. |
| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") | Options for measurement noise learning. |
| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") | Probabalistic error cancellation mitigation options. |
| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") | Zero noise extrapolation mitigation options. |
| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") | Twirling options. |
| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") | Execution options for V2 primitives. |
| [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2") | Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. |
| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions") | Options related to the execution environment. |
| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions") | Simulator options. |

73
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.Batch
# Batch
<Class id="qiskit_ibm_runtime.Batch" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/batch.py#L24-L141" signature="Batch(service=None, backend=None, max_time=None)" modifiers="class">
<Class id="qiskit_ibm_runtime.Batch" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/batch.py#L23-L117" signature="Batch(backend=None, max_time=None)" modifiers="class">
Bases: [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
Class for running jobs in batch execution mode.
The `batch` mode is designed to efficiently perform experiments that comprise multiple independent jobs.
@ -66,9 +68,8 @@ python_api_name: qiskit_ibm_runtime.Batch
**Parameters**
* **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account.
* **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), `None`]) – Instance of `Backend` class or backend string name. Note that passing a backend name is deprecated.
* **max\_time** (`Union`\[`int`, `str`, `None`]) – 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 less than the [system imposed maximum](/guides/max-execution-time).
* **backend** ([*BackendV1*](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)") *|*[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") *| None*) – Instance of `Backend` class.
* **max\_time** (*int | str | None*) – 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 less than the [system imposed maximum](/guides/max-execution-time).
**Raises**
@ -81,10 +82,6 @@ python_api_name: qiskit_ibm_runtime.Batch
<Attribute id="qiskit_ibm_runtime.Batch.service">
Return service associated with this session.
**Return type**
[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")
**Returns**
[`qiskit_ibm_runtime.QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") associated with this session.
@ -95,10 +92,6 @@ python_api_name: qiskit_ibm_runtime.Batch
<Attribute id="qiskit_ibm_runtime.Batch.session_id">
Return the session ID.
**Return type**
`Optional`\[`str`]
**Returns**
Session ID. None if the backend is a simulator.
@ -108,47 +101,43 @@ python_api_name: qiskit_ibm_runtime.Batch
### backend
<Function id="qiskit_ibm_runtime.Batch.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L240-L248" signature="backend()">
<Function id="qiskit_ibm_runtime.Batch.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L204-L212" signature="backend()">
Return backend for this session.
**Return type**
`Optional`\[`str`]
**Returns**
Backend for this session. None if unknown.
**Return type**
str | None
</Function>
### cancel
<Function id="qiskit_ibm_runtime.Batch.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L226-L230" signature="cancel()">
<Function id="qiskit_ibm_runtime.Batch.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L190-L194" signature="cancel()">
Cancel all pending jobs in a session.
**Return type**
`None`
None
</Function>
### close
<Function id="qiskit_ibm_runtime.Batch.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L232-L238" signature="close()">
<Function id="qiskit_ibm_runtime.Batch.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L196-L202" signature="close()">
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`
None
</Function>
### details
<Function id="qiskit_ibm_runtime.Batch.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L291-L333" signature="details()">
<Function id="qiskit_ibm_runtime.Batch.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L255-L297" signature="details()">
Return session details.
**Return type**
`Optional`\[`Dict`\[`str`, `Any`]]
**Returns**
A dictionary with the sessions details.
@ -167,18 +156,22 @@ python_api_name: qiskit_ibm_runtime.Batch
* `activated_at`: Timestamp of when the session state was changed to active.
* `mode`: Execution mode of the session.
* `usage_time`: The usage time, in seconds, of this Session or Batch. Usage is defined as the time a quantum system is committed to complete a job.
**Return type**
*Dict*\[str, *Any*] | None
</Function>
### from\_id
<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L353-L386" signature="from_id(session_id, service)" modifiers="classmethod">
<Function id="qiskit_ibm_runtime.Batch.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L317-L350" signature="from_id(session_id, service)" modifiers="classmethod">
Construct a Session object with a given session\_id
**Parameters**
* **session\_id** (`str`) – the id of the session to be created. This must be an already existing session id.
* **session\_id** (*str*) – the id of the session to be created. This must be an already existing session id.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –
* **service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –
instance of the `QiskitRuntimeService` class.
@ -186,24 +179,20 @@ python_api_name: qiskit_ibm_runtime.Batch
IBMInputValueError: If given session\_id does not exist.
**Return type**
[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
**Returns**
A new Session with the given `session_id`
**Return type**
[*Session*](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
</Function>
### status
<Function id="qiskit_ibm_runtime.Batch.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L250-L275" signature="status()">
<Function id="qiskit_ibm_runtime.Batch.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L214-L239" signature="status()">
Return current session status.
**Return type**
`Optional`\[`str`]
**Returns**
Session status as a string.
@ -213,11 +202,15 @@ python_api_name: qiskit_ibm_runtime.Batch
* `In progress, not accepting new jobs`: session is active and not accepting new jobs.
* `Closed`: max\_time expired or session was explicitly closed.
* `None`: status details are not available.
**Return type**
str | None
</Function>
### usage
<Function id="qiskit_ibm_runtime.Batch.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L277-L289" signature="usage()">
<Function id="qiskit_ibm_runtime.Batch.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L241-L253" signature="usage()">
Return session usage in seconds.
Session usage is the time from when the first job starts until the session goes inactive, is closed, or when its last job completes, whichever happens last.
@ -226,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.Batch
**Return type**
`Optional`\[`float`]
float | None
</Function>
</Class>

2
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx
View File

@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator
# Estimator
<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L45-L181">
<Attribute id="qiskit_ibm_runtime.Estimator" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L44-L173">
alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2")
</Attribute>

28
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
# EstimatorV2
<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L45-L181" signature="EstimatorV2(mode=None, options=None)" modifiers="class">
<Class id="qiskit_ibm_runtime.EstimatorV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L44-L173" signature="EstimatorV2(mode=None, options=None)" modifiers="class">
Bases: `BasePrimitiveV2`\[[`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions")], `Estimator`, [`BaseEstimatorV2`](/api/qiskit/qiskit.primitives.BaseEstimatorV2 "(in Qiskit v1.2)")
Class for interacting with Qiskit Runtime Estimator primitive service.
Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables.
@ -53,7 +55,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
**Parameters**
* **mode** (`Union`\[[`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.batch.Batch"), `str`, `None`]) –
* **mode** (*Optional\[Union\[BackendV1, BackendV2,* [*Session*](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session")*,* [*Batch*](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")*, str]]*) –
The execution mode used to make the primitive query. It can be:
@ -63,7 +65,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
Refer to the [Qiskit Runtime documentation](/guides/execution-modes). for more information about the `Execution modes`.
* **options** (`Union`\[`Dict`, [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – Estimator options, see `EstimatorOptions` for detailed description.
* **options** (*Optional\[Union\[Dict,* [*EstimatorOptions*](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")*]]*) – Estimator options, see `EstimatorOptions` for detailed description.
## Attributes
@ -72,10 +74,6 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
<Attribute id="qiskit_ibm_runtime.EstimatorV2.mode">
Return the execution mode used by this primitive.
**Return type**
Optional\[[Session](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") | [Batch](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")]
**Returns**
Mode used by this primitive, or `None` if an execution mode is not used.
@ -85,10 +83,6 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
<Attribute id="qiskit_ibm_runtime.EstimatorV2.options">
Return options
**Return type**
`TypeVar`(`OptionsT`, bound= `BaseOptions`)
</Attribute>
### version
@ -99,7 +93,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
### backend
<Function id="qiskit_ibm_runtime.EstimatorV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L242-L244" signature="backend()">
<Function id="qiskit_ibm_runtime.EstimatorV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L219-L221" signature="backend()">
Return the backend the primitive query will be run on.
**Return type**
@ -109,7 +103,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
### run
<Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L134-L157" signature="run(pubs, *, precision=None)">
<Function id="qiskit_ibm_runtime.EstimatorV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L126-L149" signature="run(pubs, *, precision=None)">
Submit a request to the estimator primitive.
**Parameters**
@ -117,10 +111,6 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
* **pubs** (*Iterable\[EstimatorPubLike]*) – An iterable of pub-like (primitive unified bloc) objects, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`.
* **precision** (*float | None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used.
**Return type**
[RuntimeJobV2](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")
**Returns**
Submitted job.
@ -128,6 +118,10 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2
**Raises**
**ValueError** – if precision value is not strictly greater than 0.
**Return type**
[RuntimeJobV2](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")
</Function>
</Class>

175
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
# IBMBackend
<Class id="qiskit_ibm_runtime.IBMBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L75-L914" signature="IBMBackend(configuration, service, api_client, instance=None)" modifiers="class">
Bases: [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")
Backend class interfacing with an IBM Quantum backend.
<Admonition title="Note" type="note">
@ -125,9 +127,10 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Parameters**
* **configuration** (`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]) – Backend configuration.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Instance of QiskitRuntimeService.
* **api\_client** (`RuntimeClient`) – IBM client used to communicate with the server.
* **configuration** (*QasmBackendConfiguration | PulseBackendConfiguration*) – Backend configuration.
* **service** ([*qiskit\_runtime\_service.QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Instance of QiskitRuntimeService.
* **api\_client** (*RuntimeClient*) – IBM client used to communicate with the server.
* **instance** (*str | None*)
## Attributes
@ -144,10 +147,6 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
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.
@ -187,10 +186,6 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
<Attribute id="qiskit_ibm_runtime.IBMBackend.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
@ -199,10 +194,6 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
The maximum number of circuits
The maximum number of circuits (or Pulse schedules) that can be run in a single job. If there is no limit this will return None.
**Return type**
`int`
</Attribute>
### meas\_map
@ -225,30 +216,18 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
<Attribute id="qiskit_ibm_runtime.IBMBackend.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.IBMBackend.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.IBMBackend.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -291,10 +270,6 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
<Attribute id="qiskit_ibm_runtime.IBMBackend.session">
Return session
**Return type**
`Session`
</Attribute>
### target
@ -302,10 +277,6 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
<Attribute id="qiskit_ibm_runtime.IBMBackend.target">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
[`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)")
**Returns**
Target
@ -348,7 +319,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
[`IBMBackend`](#qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")
[*IBMBackend*](#qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")
</Function>
### acquire\_channel
@ -363,6 +334,10 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### cancel\_session
@ -372,7 +347,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
`None`
None
</Function>
### check\_faulty
@ -382,7 +357,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -390,7 +365,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
`None`
None
</Function>
### close\_session
@ -400,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
`None`
None
</Function>
### configuration
@ -424,13 +399,13 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
jobs at once. Parts of the classical computation will be parallelized.
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
**Returns**
The configuration for the backend.
**Return type**
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -442,7 +417,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -462,15 +437,15 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Parameters**
**refresh** (`bool`) – If `True`, re-query the server for the backend pulse defaults. Otherwise, return a cached version.
**Return type**
`Optional`\[`PulseDefaults`]
**refresh** (*bool*) – If `True`, re-query the server for the backend pulse defaults. Otherwise, return a cached version.
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults* | None
</Function>
### drive\_channel
@ -485,6 +460,10 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### get\_translation\_stage\_plugin
@ -494,7 +473,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
`str`
str
</Function>
### measure\_channel
@ -509,6 +488,10 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### open\_session
@ -516,9 +499,13 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
<Function id="qiskit_ibm_runtime.IBMBackend.open_session" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L849-L865" signature="open_session(max_time=None)">
Open session
**Parameters**
**max\_time** (*int | str | None*)
**Return type**
`Session`
*Session*
</Function>
### properties
@ -532,12 +519,8 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**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` whose timestamp is closest to, but older than, the specified datetime. Note that this is only supported using `ibm_quantum` runtime.
**Return type**
`Optional`\[`BackendProperties`]
* **refresh** (*bool*) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
* **datetime** (*datetime | None*) – By specifying datetime, this function returns an instance of the `BackendProperties` whose timestamp is closest to, but older than, the specified datetime. Note that this is only supported using `ibm_quantum` runtime.
**Returns**
@ -547,6 +530,10 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
* **TypeError** – If an input argument is not of the correct type.
* **NotImplementedError** – If datetime is specified when cloud runtime is used.
**Return type**
*BackendProperties* | None
</Function>
### qubit\_properties
@ -558,11 +545,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -571,6 +554,10 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -580,7 +567,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Return type**
`None`
None
</Function>
### run
@ -590,23 +577,23 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Parameters**
* **circuits** (`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `str`, `List`\[`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `str`]]]) – An individual or a list of `QuantumCircuit`.
* **circuits** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") *| str | List\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") *| str]*) – An individual or a list of `QuantumCircuit`.
* **dynamic** (`Optional`\[`bool`]) – Whether the circuit is dynamic (uses in-circuit conditionals)
* **dynamic** (*bool | None*) – 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.
* **job\_tags** (*List\[str] | None*) – 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.2)")]) – 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\_circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") *| None*) – 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.
* **init\_num\_resets** (*int | None*) – The number of qubit resets to insert before each circuit execution.
* **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. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **header** (*Dict | None*) – 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. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **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. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **shots** (*int | float | None*) – Number of repetitions of each circuit, for sampling. Default: 4000 or `max_shots` from the backend configuration, whichever is smaller. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **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. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **memory** (*bool | None*) – 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. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) –
* **meas\_level** (*int | MeasLevel | None*) –
Level of the measurement output for pulse experiments. See [OpenPulse specification](https://arxiv.org/pdf/1809.03452.pdf) for details:
@ -616,7 +603,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **meas\_return** (`Union`\[`str`, `MeasReturnType`, `None`]) –
* **meas\_return** (*str | MeasReturnType | None*) –
Level of measurement data for the backend to return. For `meas_level` 0 and 1:
@ -625,21 +612,17 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **rep\_delay** (`Optional`\[`float`]) – Delay between primitives 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`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **rep\_delay** (*float | None*) – Delay between primitives 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`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **init\_qubits** (`Optional`\[`bool`]) – Whether to reset the qubits to the ground state for each shot. Default: `True`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **init\_qubits** (*bool | None*) – Whether to reset the qubits to the ground state for each shot. Default: `True`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **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()`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **use\_measure\_esp** (*bool | None*) – 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()`. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **noise\_model** (`Optional`\[`Any`]) – Noise model (Simulators only). This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **noise\_model** (*Any | None*) – Noise model (Simulators only). This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **seed\_simulator** (`Optional`\[`int`]) – Random seed to control sampling (Simulators only). This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **seed\_simulator** (*int | None*) – Random seed to control sampling (Simulators only). This parameter is applicable only if `dynamic=False` is specified or defaulted to.
* **\*\*run\_config** – Extra arguments used to configure the run. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
**Return type**
[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob")
* **\*\*run\_config** (*Dict*) – Extra arguments used to configure the run. This parameter is applicable only if `dynamic=False` is specified or defaulted to.
**Returns**
@ -654,6 +637,10 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
* **IBMBackendValueError** –
* If an input parameter value is not valid. - If ESP readout is used and the backend does not support this.
**Return type**
[*RuntimeJob*](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob")
</Function>
### set\_options
@ -681,10 +668,6 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
If the returned `BackendStatus` instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them.
</Admonition>
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
@ -692,6 +675,10 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
**Raises**
**IBMBackendApiProtocolError** – If the status for the backend cannot be formatted properly.
**Return type**
*BackendStatus*
</Function>
### target\_history
@ -699,13 +686,17 @@ python_api_name: qiskit_ibm_runtime.IBMBackend
<Function id="qiskit_ibm_runtime.IBMBackend.target_history" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L322-L334" signature="target_history(datetime=None)">
A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend.
**Return type**
[`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)")
**Returns**
Target with properties found on datetime
**Parameters**
**datetime** (*datetime | None*)
**Return type**
[*Target*](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)")
</Function>
</Class>

224
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
# QiskitRuntimeService
<Class id="qiskit_ibm_runtime.QiskitRuntimeService" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L53-L1191" signature="QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, private_endpoint=None, url_resolver=None)" modifiers="class">
<Class id="qiskit_ibm_runtime.QiskitRuntimeService" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L53-L1188" signature="QiskitRuntimeService(*args, **kwargs)" modifiers="class">
Bases: `object`
Class for interacting with the Qiskit Runtime service.
QiskitRuntimeService constructor
@ -27,16 +29,16 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
**Parameters**
* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type. `ibm_cloud`, `ibm_quantum` or `local`. If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/guides/local-testing-mode) documentation.
* **token** (`Optional`\[`str`]) – IBM Cloud API key or IBM Quantum API token.
* **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum).
* **filename** (`Optional`\[`str`]) – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE
* **name** (`Optional`\[`str`]) – Name of the account to load.
* **instance** (`Optional`\[`str`]) – The service instance to use. For `ibm_cloud` runtime, this is the Cloud Resource Name (CRN) or the service name. For `ibm_quantum` runtime, this is the hub/group/project in that 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.
* **private\_endpoint** (`Optional`\[`bool`]) – Connect to private API URL.
* **url\_resolver** (`Optional`\[`Callable`\[\[`str`, `str`, `Optional`\[`bool`]], `str`]]) – Function used to resolve the runtime url.
* **channel** – Channel type. `ibm_cloud`, `ibm_quantum` or `local`. If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/guides/local-testing-mode) documentation.
* **token** – IBM Cloud API key or IBM Quantum API token.
* **url** – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum).
* **filename** – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE
* **name** – Name of the account to load.
* **instance** – The service instance to use. For `ibm_cloud` runtime, this is the Cloud Resource Name (CRN) or the service name. For `ibm_quantum` runtime, this is the hub/group/project in that format.
* **proxies** – 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** – Whether to verify the server’s TLS certificate.
* **private\_endpoint** – Connect to private API URL.
* **url\_resolver** – Function used to resolve the runtime url.
**Returns**
@ -53,45 +55,37 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
<Attribute id="qiskit_ibm_runtime.QiskitRuntimeService.channel">
Return the channel type used.
**Return type**
`str`
**Returns**
The channel type used.
</Attribute>
### global\_service
<Attribute id="qiskit_ibm_runtime.QiskitRuntimeService.global_service" attributeValue="None" />
## Methods
### active\_account
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.active_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L616-L622" signature="active_account()">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.active_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L613-L619" signature="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.
**Return type**
*Dict*\[str, str] | None
</Function>
### backend
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L725-L766" signature="backend(name, instance=None, use_fractional_gates=False)">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L722-L763" signature="backend(name, instance=None, use_fractional_gates=False)">
Return a single backend matching the specified filtering.
**Parameters**
* **name** (`str`) – Name of the backend.
* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. If an instance is not given, among the providers with access to the backend, a premium provider will be prioritized. For users without access to a premium provider, the default open provider will be used.
* **use\_fractional\_gates** (`Optional`\[`bool`]) – Set True to allow for the backends to include fractional gates. Currently this feature cannot be used simultaneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend. When you use a dynamic circuits feature (e.g. `if_else`) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. If `None`, then both fractional gates and control flow operations are included in the backends.
* **name** (*str*) – Name of the backend.
* **instance** (*str | None*) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. If an instance is not given, among the providers with access to the backend, a premium provider will be prioritized. For users without access to a premium provider, the default open provider will be used.
* **use\_fractional\_gates** (*bool | None*) – Set True to allow for the backends to include fractional gates. Currently this feature cannot be used simultaneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend. When you use a dynamic circuits feature (e.g. `if_else`) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. If `None`, then both fractional gates and control flow operations are included in the backends.
**Returns**
@ -108,20 +102,20 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
### backends
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backends" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L432-L551" signature="backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.backends" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L429-L548" signature="backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, *, use_fractional_gates=False, **kwargs)">
Return all backends accessible via this account, subject to optional filtering.
**Parameters**
* **name** (`Optional`\[`str`]) – Backend name to filter by.
* **name** (*str | None*) – Backend name to filter by.
* **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have.
* **min\_num\_qubits** (*int | None*) – Minimum number of qubits the backend has to have.
* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **instance** (*str | None*) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **dynamic\_circuits** (`Optional`\[`bool`]) – Filter by whether the backend supports dynamic circuits.
* **dynamic\_circuits** (*bool | None*) – Filter by whether the backend supports dynamic circuits.
* **filters** (`Optional`\[`Callable`\[\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")], `bool`]]) –
* **filters** (*Callable\[\[*[*IBMBackend*](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")*], bool] | None*) –
More complex filters, such as lambda functions. For example:
@ -134,9 +128,9 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
)
```
* **use\_fractional\_gates** (`Optional`\[`bool`]) – Set True to allow for the backends to include fractional gates. Currently this feature cannot be used simultaneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend. When you use a dynamic circuits feature (e.g. `if_else`) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. If `None`, then both fractional gates and control flow operations are included in the backends.
* **use\_fractional\_gates** (*bool | None*) – Set True to allow for the backends to include fractional gates. Currently this feature cannot be used simultaneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend. When you use a dynamic circuits feature (e.g. `if_else`) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. If `None`, then both fractional gates and control flow operations are included in the backends.
* **\*\*kwargs** –
* **\*\*kwargs** (*Any*) –
Simple filters that require a specific value for an attribute in backend configuration or status. Examples:
@ -153,10 +147,6 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
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_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")]
**Returns**
The list of available backends that match the filter.
@ -165,48 +155,52 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
* **IBMInputValueError** – If an input is invalid.
* **QiskitBackendNotFoundError** – If the backend is not in any instance.
**Return type**
*List*\[[*IBMBackend*](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")]
</Function>
### check\_pending\_jobs
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.check_pending_jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L883-L910" signature="check_pending_jobs()">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.check_pending_jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L880-L907" signature="check_pending_jobs()">
Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached.
**Return type**
`None`
None
</Function>
### delete\_account
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L624-L642" signature="delete_account(filename=None, name=None, channel=None)" modifiers="static">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L621-L639" signature="delete_account(filename=None, name=None, channel=None)" modifiers="static">
Delete a saved account from disk.
**Parameters**
* **filename** (`Optional`\[`str`]) – Name of file from which to delete the account.
* **name** (`Optional`\[`str`]) – Name of the saved account to delete.
* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type of the default account to delete. Ignored if account name is provided.
**Return type**
`bool`
* **filename** (*str | None*) – Name of file from which to delete the account.
* **name** (*str | None*) – Name of the saved account to delete.
* **channel** (*Literal\['ibm\_cloud', 'ibm\_quantum', 'local'] | None*) – Channel type of the default account to delete. Ignored if account name is provided.
**Returns**
True if the account was deleted. False if no account was found.
**Return type**
bool
</Function>
### delete\_job
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1029-L1046" signature="delete_job(job_id)">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.delete_job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1026-L1043" signature="delete_job(job_id)">
Delete a runtime job.
Note that this operation cannot be reversed.
**Parameters**
**job\_id** (`str`) – ID of the job to delete.
**job\_id** (*str*) – ID of the job to delete.
**Raises**
@ -215,35 +209,31 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
**Return type**
`None`
None
</Function>
### instances
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.instances" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1164-L1172" signature="instances()">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.instances" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1161-L1169" signature="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.
**Return type**
*List*\[str]
</Function>
### job
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L912-L931" signature="job(job_id)">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.job" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L909-L928" signature="job(job_id)">
Retrieve a runtime job.
**Parameters**
**job\_id** (`str`) – Job ID.
**Return type**
`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]
**job\_id** (*str*) – Job ID.
**Returns**
@ -253,30 +243,30 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
* **RuntimeJobNotFound** – If the job doesn’t exist.
* **IBMRuntimeError** – If the request failed.
**Return type**
[*RuntimeJob*](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") | [*RuntimeJobV2*](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")
</Function>
### jobs
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L933-L1027" signature="jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.jobs" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L930-L1024" signature="jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)">
Retrieve all runtime jobs, subject to optional filtering.
**Parameters**
* **limit** (`Optional`\[`int`]) – Number of jobs to retrieve. `None` means no limit.
* **skip** (`int`) – Starting index for the job retrieval.
* **backend\_name** (`Optional`\[`str`]) – Name of the backend to retrieve jobs from.
* **pending** (`Optional`\[`bool`]) – Filter by job pending state. If `True`, ‘QUEUED’ and ‘RUNNING’ jobs are included. If `False`, ‘DONE’, ‘CANCELLED’ and ‘ERROR’ jobs are included.
* **program\_id** (`Optional`\[`str`]) – Filter by Program ID.
* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **job\_tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to jobs. Matched jobs are associated with all tags.
* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session.
* **created\_after** (`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.
* **created\_before** (`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.
* **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.
**Return type**
`List`\[`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]]
* **limit** (*int | None*) – Number of jobs to retrieve. `None` means no limit.
* **skip** (*int*) – Starting index for the job retrieval.
* **backend\_name** (*str | None*) – Name of the backend to retrieve jobs from.
* **pending** (*bool | None*) – Filter by job pending state. If `True`, ‘QUEUED’ and ‘RUNNING’ jobs are included. If `False`, ‘DONE’, ‘CANCELLED’ and ‘ERROR’ jobs are included.
* **program\_id** (*str | None*) – Filter by Program ID.
* **instance** (*str | None*) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **job\_tags** (*List\[str] | None*) – Filter by tags assigned to jobs. Matched jobs are associated with all tags.
* **session\_id** (*str | None*) – Job ID of the first job in a runtime session.
* **created\_after** (*datetime | None*) – 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.
* **created\_before** (*datetime | None*) – 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.
* **descending** (*bool*) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached.
**Returns**
@ -285,20 +275,24 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
**Raises**
**IBMInputValueError** – If an input value is invalid.
**Return type**
*List*\[[*RuntimeJob*](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") | [*RuntimeJobV2*](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]
</Function>
### least\_busy
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.least_busy" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1127-L1162" signature="least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.least_busy" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1124-L1159" signature="least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)">
Return the least busy available backend.
**Parameters**
* **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have.
* **min\_num\_qubits** (*int | None*) – Minimum number of qubits the backend has to have.
* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **instance** (*str | None*) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format.
* **filters** (`Optional`\[`Callable`\[\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")], `bool`]]) –
* **filters** (*Callable\[\[*[*IBMBackend*](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")*], bool] | None*) –
Filters can be defined as for the [`backends()`](#qiskit_ibm_runtime.QiskitRuntimeService.backends "qiskit_ibm_runtime.QiskitRuntimeService.backends") method. An example to get the operational backends with 5 qubits:
@ -306,9 +300,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
QiskitRuntimeService.least_busy(n_qubits=5, operational=True)
```
**Return type**
[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")
* **kwargs** (*Any*)
**Returns**
@ -317,47 +309,47 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
**Raises**
**QiskitBackendNotFoundError** – If no backend matches the criteria.
**Return type**
[*IBMBackend*](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")
</Function>
### save\_account
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.save_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L644-L693" signature="save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, set_as_default=None, private_endpoint=False)" modifiers="static">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.save_account" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L641-L690" signature="save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, set_as_default=None, private_endpoint=False)" modifiers="static">
Save the account to disk for future use.
**Parameters**
* **token** (`Optional`\[`str`]) – IBM Cloud API key or IBM Quantum API token.
* **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum).
* **instance** (`Optional`\[`str`]) – The CRN (ibm\_cloud) or hub/group/project (ibm\_quantum).
* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type. ibm\_cloud or ibm\_quantum.
* **filename** (`Optional`\[`str`]) – Full path of the file where the account is saved.
* **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.
* **set\_as\_default** (`Optional`\[`bool`]) – If `True`, the account is saved in filename, as the default account.
* **private\_endpoint** (`Optional`\[`bool`]) – Connect to private API URL.
* **token** (*str | None*) – IBM Cloud API key or IBM Quantum API token.
* **url** (*str | None*) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum).
* **instance** (*str | None*) – The CRN (ibm\_cloud) or hub/group/project (ibm\_quantum).
* **channel** (*Literal\['ibm\_cloud', 'ibm\_quantum', 'local'] | None*) – Channel type. ibm\_cloud or ibm\_quantum.
* **filename** (*str | None*) – Full path of the file where the account is saved.
* **name** (*str | None*) – Name of the account to save.
* **proxies** (*dict | None*) – 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** (*bool | None*) – Verify the server’s TLS certificate.
* **overwrite** (*bool | None*) – `True` if the existing account is to be overwritten.
* **set\_as\_default** (*bool | None*) – If `True`, the account is saved in filename, as the default account.
* **private\_endpoint** (*bool | None*) – Connect to private API URL.
**Return type**
`None`
None
</Function>
### saved\_accounts
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L695-L723" signature="saved_accounts(default=None, channel=None, filename=None, name=None)" modifiers="static">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.saved_accounts" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L692-L720" signature="saved_accounts(default=None, channel=None, filename=None, name=None)" modifiers="static">
List the accounts saved on disk.
**Parameters**
* **default** (`Optional`\[`bool`]) – If set to True, only default accounts are returned.
* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type. ibm\_cloud or ibm\_quantum.
* **filename** (`Optional`\[`str`]) – Name of file whose accounts are returned.
* **name** (`Optional`\[`str`]) – If set, only accounts with the given name are returned.
**Return type**
`dict`
* **default** (*bool | None*) – If set to True, only default accounts are returned.
* **channel** (*Literal\['ibm\_cloud', 'ibm\_quantum', 'local'] | None*) – Channel type. ibm\_cloud or ibm\_quantum.
* **filename** (*str | None*) – Name of file whose accounts are returned.
* **name** (*str | None*) – If set, only accounts with the given name are returned.
**Returns**
@ -366,17 +358,17 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
**Raises**
**ValueError** – If an invalid account is found on disk.
**Return type**
dict
</Function>
### usage
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1048-L1061" signature="usage()">
<Function id="qiskit_ibm_runtime.QiskitRuntimeService.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1045-L1058" signature="usage()">
Return monthly open plan usage information.
**Return type**
`Dict`\[`str`, `Any`]
**Returns**
Dict with usage details.
@ -384,6 +376,10 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService
**Raises**
**IBMInputValueError** – If method is called when using the ibm\_cloud channel
**Return type**
*Dict*\[str, *Any*]
</Function>
</Class>

13
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder
# RuntimeDecoder
<Class id="qiskit_ibm_runtime.RuntimeDecoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L396-L510" signature="RuntimeDecoder(*args, **kwargs)" modifiers="class">
Bases: `JSONDecoder`
JSON Decoder used by runtime service.
`object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting).
@ -25,6 +27,11 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder
## Methods
**Parameters**
* **args** (*Any*)
* **kwargs** (*Any*)
### decode
<Function id="qiskit_ibm_runtime.RuntimeDecoder.decode" signature="decode(s, _w=<built-in method match of re.Pattern object>)">
@ -36,9 +43,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder
<Function id="qiskit_ibm_runtime.RuntimeDecoder.object_hook" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L404-L510" signature="object_hook(obj)">
Called to decode object.
**Parameters**
**obj** (*Any*)
**Return type**
`Any`
*Any*
</Function>
### raw\_decode

8
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder
# RuntimeEncoder
<Class id="qiskit_ibm_runtime.RuntimeEncoder" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L236-L393" signature="RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)" modifiers="class">
Bases: `JSONEncoder`
JSON Encoder used by runtime service.
Constructor for JSONEncoder, with sensible defaults.
@ -60,9 +62,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder
return JSONEncoder.default(self, o)
```
**Parameters**
**obj** (*Any*)
**Return type**
`Any`
*Any*
</Function>
### encode

158
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
# RuntimeJob
<Class id="qiskit_ibm_runtime.RuntimeJob" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L47-L368" signature="RuntimeJob(backend, api_client, client_params, job_id, program_id, service, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None, version=None)" modifiers="class">
Bases: [`JobV1`](/api/qiskit/qiskit.providers.JobV1 "(in Qiskit v1.2)"), `BaseRuntimeJob`
Representation of a runtime primitive execution.
A new `RuntimeJob` instance is returned when you call `QiskitRuntimeService.run` to execute a runtime primitive, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job.
@ -33,19 +35,19 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Parameters**
* **backend** ([`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) – The backend instance used to run this job.
* **api\_client** (`RuntimeClient`) – Object for connecting to the server.
* **client\_params** (`ClientParameters`) – Parameters used for server connection.
* **job\_id** (`str`) – Job ID.
* **program\_id** (`str`) – ID of the program this job is for.
* **creation\_date** (`Optional`\[`str`]) – Job creation date, in UTC.
* **user\_callback** (`Optional`\[`Callable`]) – User callback function.
* **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results.
* **image** (`Optional`\[`str`]) – Runtime image used for this job: image\_name:tag.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service.
* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session.
* **tags** (`Optional`\[`List`]) – Tags assigned to the job.
* **version** (`Optional`\[`int`]) – Primitive version.
* **backend** ([*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) – The backend instance used to run this job.
* **api\_client** (*RuntimeClient*) – Object for connecting to the server.
* **client\_params** (*ClientParameters*) – Parameters used for server connection.
* **job\_id** (*str*) – Job ID.
* **program\_id** (*str*) – ID of the program this job is for.
* **creation\_date** (*str | None*) – Job creation date, in UTC.
* **user\_callback** (*Callable | None*) – User callback function.
* **result\_decoder** (*Type\[ResultDecoder] | Sequence\[Type\[ResultDecoder]] | None*) – A `ResultDecoder` subclass used to decode job results.
* **image** (*str | None*) – Runtime image used for this job: image\_name:tag.
* **service** ([*qiskit\_runtime\_service.QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service.
* **session\_id** (*str | None*) – Job ID of the first job in a runtime session.
* **tags** (*List | None*) – Tags assigned to the job.
* **version** (*int | None*) – Primitive version.
## Attributes
@ -62,10 +64,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
<Attribute id="qiskit_ibm_runtime.RuntimeJob.creation_date">
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 creation date is not available.
@ -90,10 +88,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
<Attribute id="qiskit_ibm_runtime.RuntimeJob.inputs">
Job input parameters.
**Return type**
`Dict`
**Returns**
Input parameters used in this job.
@ -103,16 +97,12 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
<Attribute id="qiskit_ibm_runtime.RuntimeJob.instance">
For ibm\_quantum channel jobs, return the instance where the job was run. For ibm\_cloud, None is returned.
**Return type**
`Optional`\[`str`]
</Attribute>
### primitive\_id
<Attribute id="qiskit_ibm_runtime.RuntimeJob.primitive_id">
Primitive name. :rtype: `str` :returns: Primitive this job is for.
Primitive name. :returns: Primitive this job is for.
</Attribute>
### session\_id
@ -120,10 +110,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
<Attribute id="qiskit_ibm_runtime.RuntimeJob.session_id">
Session ID.
**Return type**
`str`
**Returns**
Session ID. None if the backend is a simulator.
@ -134,10 +120,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
<Attribute id="qiskit_ibm_runtime.RuntimeJob.tags">
Job tags.
**Return type**
`List`
**Returns**
Tags assigned to the job that can be used for filtering.
@ -148,10 +130,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
<Attribute id="qiskit_ibm_runtime.RuntimeJob.usage_estimation">
Return the usage estimation infromation for this job.
**Return type**
`Dict`\[`str`, `Any`]
**Returns**
`quantum_seconds` which is the estimated system execution time of the job in seconds. Quantum time represents the time that the system is dedicated to processing your job.
@ -172,9 +150,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**IBMRuntimeError** – If a network error occurred.
**Parameters**
**timeout** (*float | None*)
**Return type**
`Optional`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")]
[*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)") | None
</Function>
### cancel
@ -189,7 +171,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`None`
None
</Function>
### cancel\_result\_streaming
@ -199,7 +181,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`None`
None
</Function>
### cancelled
@ -209,7 +191,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`bool`
bool
</Function>
### done
@ -219,7 +201,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`bool`
bool
</Function>
### error\_message
@ -227,13 +209,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
<Function id="qiskit_ibm_runtime.RuntimeJob.error_message" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_runtime_job.py#L207-L214" signature="error_message()">
Returns the reason if the job failed.
**Return type**
`Optional`\[`str`]
**Returns**
Error message string or `None`.
**Return type**
str | None
</Function>
### errored
@ -243,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`bool`
bool
</Function>
### in\_final\_state
@ -253,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`bool`
bool
</Function>
### job\_id
@ -263,7 +245,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`str`
str
</Function>
### logs
@ -275,10 +257,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
Job logs are only available after the job finishes.
</Admonition>
**Return type**
`str`
**Returns**
Job logs, including standard output and error.
@ -286,6 +264,10 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Raises**
**IBMRuntimeError** – If a network error occurred.
**Return type**
str
</Function>
### metrics
@ -317,15 +299,15 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Parameters**
**refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
**Return type**
`Optional`\[`BackendProperties`]
**refresh** (*bool*) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
**Returns**
The backend properties used for this job, at the time the job was run, or `None` if properties are not available.
**Return type**
*BackendProperties* | None
</Function>
### queue\_info
@ -339,13 +321,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
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`.
</Admonition>
**Return type**
`Optional`\[`QueueInfo`]
**Returns**
A `QueueInfo` instance that contains queue information for this job, or `None` if queue information is unknown or not applicable.
**Return type**
*QueueInfo* | None
</Function>
### queue\_position
@ -359,15 +341,15 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Parameters**
**refresh** (`bool`) – If `True`, re-query the server to get the latest value. Otherwise return the cached value.
**Return type**
`Optional`\[`int`]
**refresh** (*bool*) – If `True`, re-query the server to get the latest value. Otherwise return the cached value.
**Returns**
Position in the queue or `None` if position is unknown or not applicable.
**Return type**
int | None
</Function>
### result
@ -377,12 +359,8 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Parameters**
* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job.
* **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results.
**Return type**
`Any`
* **timeout** (*float | None*) – Number of seconds to wait for job.
* **decoder** (*Type\[ResultDecoder] | None*) – A `ResultDecoder` subclass used to decode job results.
**Returns**
@ -393,6 +371,10 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
* **RuntimeJobFailureError** – If the job failed.
* **RuntimeJobMaxTimeoutError** – If the job does not complete within given timeout.
* **RuntimeInvalidStateError** – If the job was cancelled, and attempting to retrieve result.
**Return type**
*Any*
</Function>
### running
@ -402,7 +384,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`bool`
bool
</Function>
### status
@ -410,13 +392,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
<Function id="qiskit_ibm_runtime.RuntimeJob.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L188-L206" signature="status()">
Return the status of the job.
**Return type**
[`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.2)")
**Returns**
Status of this job.
**Return type**
[*JobStatus*](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.2)")
</Function>
### submit
@ -436,7 +418,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`None`
None
</Function>
### update\_tags
@ -446,11 +428,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Parameters**
**new\_tags** (`List`\[`str`]) – New tags to assign to the job.
**Return type**
`List`\[`str`]
**new\_tags** (*List\[str]*) – New tags to assign to the job.
**Returns**
@ -459,6 +437,10 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Raises**
**IBMApiError** – If an unexpected error occurred when communicating with the server or updating the job tags.
**Return type**
*List*\[str]
</Function>
### usage
@ -468,7 +450,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`float`
float
</Function>
### wait\_for\_final\_state
@ -478,7 +460,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Parameters**
**timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely.
**timeout** (*float | None*) – Seconds to wait for the job. If `None`, wait indefinitely.
**Raises**
@ -486,7 +468,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob
**Return type**
`None`
None
</Function>
</Class>

138
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx
View File

@ -9,25 +9,27 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
# RuntimeJobV2
<Class id="qiskit_ibm_runtime.RuntimeJobV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job_v2.py#L53-L273" signature="RuntimeJobV2(backend, api_client, client_params, job_id, program_id, service, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None, version=None)" modifiers="class">
Bases: [`BasePrimitiveJob`](/api/qiskit/qiskit.primitives.BasePrimitiveJob "(in Qiskit v1.2)")\[[`PrimitiveResult`](/api/qiskit/qiskit.primitives.PrimitiveResult "(in Qiskit v1.2)"), `Literal`\[‘INITIALIZING’, ‘QUEUED’, ‘RUNNING’, ‘CANCELLED’, ‘DONE’, ‘ERROR’]], `BaseRuntimeJob`
Representation of a runtime V2 primitive exeuction.
RuntimeJob constructor.
**Parameters**
* **backend** ([`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) – The backend instance used to run this job.
* **api\_client** (`RuntimeClient`) – Object for connecting to the server.
* **client\_params** (`ClientParameters`) – Parameters used for server connection.
* **job\_id** (`str`) – Job ID.
* **program\_id** (`str`) – ID of the program this job is for.
* **creation\_date** (`Optional`\[`str`]) – Job creation date, in UTC.
* **user\_callback** (`Optional`\[`Callable`]) – User callback function.
* **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results.
* **image** (`Optional`\[`str`]) – Runtime image used for this job: image\_name:tag.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service.
* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session.
* **tags** (`Optional`\[`List`]) – Tags assigned to the job.
* **version** (`Optional`\[`int`]) – Primitive version.
* **backend** ([*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) – The backend instance used to run this job.
* **api\_client** (*RuntimeClient*) – Object for connecting to the server.
* **client\_params** (*ClientParameters*) – Parameters used for server connection.
* **job\_id** (*str*) – Job ID.
* **program\_id** (*str*) – ID of the program this job is for.
* **creation\_date** (*str | None*) – Job creation date, in UTC.
* **user\_callback** (*Callable | None*) – User callback function.
* **result\_decoder** (*Type\[ResultDecoder] | Sequence\[Type\[ResultDecoder]] | None*) – A `ResultDecoder` subclass used to decode job results.
* **image** (*str | None*) – Runtime image used for this job: image\_name:tag.
* **service** ([*qiskit\_runtime\_service.QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service.
* **session\_id** (*str | None*) – Job ID of the first job in a runtime session.
* **tags** (*List | None*) – Tags assigned to the job.
* **version** (*int | None*) – Primitive version.
## Attributes
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.creation_date">
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 creation date is not available.
@ -72,10 +70,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.inputs">
Job input parameters.
**Return type**
`Dict`
**Returns**
Input parameters used in this job.
@ -85,16 +79,12 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.instance">
For ibm\_quantum channel jobs, return the instance where the job was run. For ibm\_cloud, None is returned.
**Return type**
`Optional`\[`str`]
</Attribute>
### primitive\_id
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.primitive_id">
Primitive name. :rtype: `str` :returns: Primitive this job is for.
Primitive name. :returns: Primitive this job is for.
</Attribute>
### session\_id
@ -102,10 +92,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.session_id">
Session ID.
**Return type**
`str`
**Returns**
Session ID. None if the backend is a simulator.
@ -116,10 +102,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.tags">
Job tags.
**Return type**
`List`
**Returns**
Tags assigned to the job that can be used for filtering.
@ -130,10 +112,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
<Attribute id="qiskit_ibm_runtime.RuntimeJobV2.usage_estimation">
Return the usage estimation infromation for this job.
**Return type**
`Dict`\[`str`, `Any`]
**Returns**
`quantum_seconds` which is the estimated system execution time of the job in seconds. Quantum time represents the time that the system is dedicated to processing your job.
@ -150,9 +128,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**IBMRuntimeError** – If a network error occurred.
**Parameters**
**timeout** (*float | None*)
**Return type**
`Optional`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")]
[*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)") | None
</Function>
### cancel
@ -167,7 +149,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`None`
None
</Function>
### cancel\_result\_streaming
@ -177,7 +159,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`None`
None
</Function>
### cancelled
@ -187,7 +169,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`bool`
bool
</Function>
### done
@ -197,7 +179,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`bool`
bool
</Function>
### error\_message
@ -205,13 +187,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
<Function id="qiskit_ibm_runtime.RuntimeJobV2.error_message" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_runtime_job.py#L207-L214" signature="error_message()">
Returns the reason if the job failed.
**Return type**
`Optional`\[`str`]
**Returns**
Error message string or `None`.
**Return type**
str | None
</Function>
### errored
@ -221,7 +203,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`bool`
bool
</Function>
### in\_final\_state
@ -231,7 +213,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`bool`
bool
</Function>
### job\_id
@ -241,7 +223,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`str`
str
</Function>
### logs
@ -253,10 +235,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
Job logs are only available after the job finishes.
</Admonition>
**Return type**
`str`
**Returns**
Job logs, including standard output and error.
@ -264,6 +242,10 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Raises**
**IBMRuntimeError** – If a network error occurred.
**Return type**
str
</Function>
### metrics
@ -295,15 +277,15 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Parameters**
**refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
**Return type**
`Optional`\[`BackendProperties`]
**refresh** (*bool*) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version.
**Returns**
The backend properties used for this job, at the time the job was run, or `None` if properties are not available.
**Return type**
*BackendProperties* | None
</Function>
### result
@ -313,12 +295,8 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Parameters**
* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job.
* **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results.
**Return type**
`Any`
* **timeout** (*float | None*) – Number of seconds to wait for job.
* **decoder** (*Type\[ResultDecoder] | None*) – A `ResultDecoder` subclass used to decode job results.
**Returns**
@ -329,6 +307,10 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
* **RuntimeJobFailureError** – If the job failed.
* **RuntimeJobMaxTimeoutError** – If the job does not complete within given timeout.
* **RuntimeInvalidStateError** – If the job was cancelled, and attempting to retrieve result.
**Return type**
*Any*
</Function>
### running
@ -338,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`bool`
bool
</Function>
### status
@ -346,13 +328,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
<Function id="qiskit_ibm_runtime.RuntimeJobV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job_v2.py#L164-L171" signature="status()">
Return the status of the job.
**Return type**
`Literal`\[‘INITIALIZING’, ‘QUEUED’, ‘RUNNING’, ‘CANCELLED’, ‘DONE’, ‘ERROR’]
**Returns**
Status of this job.
**Return type**
*Literal*\[‘INITIALIZING’, ‘QUEUED’, ‘RUNNING’, ‘CANCELLED’, ‘DONE’, ‘ERROR’]
</Function>
### update\_tags
@ -362,11 +344,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Parameters**
**new\_tags** (`List`\[`str`]) – New tags to assign to the job.
**Return type**
`List`\[`str`]
**new\_tags** (*List\[str]*) – New tags to assign to the job.
**Returns**
@ -375,6 +353,10 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Raises**
**IBMApiError** – If an unexpected error occurred when communicating with the server or updating the job tags.
**Return type**
*List*\[str]
</Function>
### usage
@ -384,7 +366,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`float`
float
</Function>
### wait\_for\_final\_state
@ -394,7 +376,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Parameters**
**timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely.
**timeout** (*float | None*) – Seconds to wait for the job. If `None`, wait indefinitely.
**Raises**
@ -402,7 +384,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2
**Return type**
`None`
None
</Function>
</Class>

2
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx
View File

@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler
# Sampler
<Attribute id="qiskit_ibm_runtime.Sampler" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L45-L134">
<Attribute id="qiskit_ibm_runtime.Sampler" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L44-L124">
alias of [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.sampler.SamplerV2")
</Attribute>

28
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
# SamplerV2
<Class id="qiskit_ibm_runtime.SamplerV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L45-L134" signature="SamplerV2(mode=None, options=None)" modifiers="class">
<Class id="qiskit_ibm_runtime.SamplerV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L44-L124" signature="SamplerV2(mode=None, options=None)" modifiers="class">
Bases: `BasePrimitiveV2`\[[`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.sampler_options.SamplerOptions")], `Sampler`, [`BaseSamplerV2`](/api/qiskit/qiskit.primitives.BaseSamplerV2 "(in Qiskit v1.2)")
Class for interacting with Qiskit Runtime Sampler primitive service.
This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1.
@ -21,7 +23,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
**Parameters**
* **mode** (`Union`\[[`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.batch.Batch"), `str`, `None`]) –
* **mode** (*Optional\[Union\[BackendV1, BackendV2,* [*Session*](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session")*,* [*Batch*](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")*]]*) –
The execution mode used to make the primitive query. It can be:
@ -31,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
Refer to the [Qiskit Runtime documentation](/guides/execution-modes). for more information about the `Execution modes`.
* **options** (`Union`\[`Dict`, [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.sampler_options.SamplerOptions"), `None`]) – Sampler options, see `SamplerOptions` for detailed description.
* **options** (*Optional\[Union\[Dict,* [*SamplerOptions*](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions")*]]*) – Sampler options, see `SamplerOptions` for detailed description.
## Attributes
@ -40,10 +42,6 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
<Attribute id="qiskit_ibm_runtime.SamplerV2.mode">
Return the execution mode used by this primitive.
**Return type**
Optional\[[Session](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") | [Batch](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")]
**Returns**
Mode used by this primitive, or `None` if an execution mode is not used.
@ -53,10 +51,6 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
<Attribute id="qiskit_ibm_runtime.SamplerV2.options" attributeTypeHint="SamplerOptions">
Return options
**Return type**
`TypeVar`(`OptionsT`, bound= `BaseOptions`)
</Attribute>
### version
@ -67,7 +61,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
### backend
<Function id="qiskit_ibm_runtime.SamplerV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L242-L244" signature="backend()">
<Function id="qiskit_ibm_runtime.SamplerV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L219-L221" signature="backend()">
Return the backend the primitive query will be run on.
**Return type**
@ -77,7 +71,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
### run
<Function id="qiskit_ibm_runtime.SamplerV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L98-L120" signature="run(pubs, *, shots=None)">
<Function id="qiskit_ibm_runtime.SamplerV2.run" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L88-L110" signature="run(pubs, *, shots=None)">
Submit a request to the sampler primitive.
**Parameters**
@ -85,10 +79,6 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
* **pubs** (*Iterable\[SamplerPubLike]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`.
* **shots** (*int | None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation.
**Return type**
[RuntimeJobV2](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")
**Returns**
Submitted job. The result of the job is an instance of `qiskit.primitives.containers.PrimitiveResult`.
@ -96,6 +86,10 @@ python_api_name: qiskit_ibm_runtime.SamplerV2
**Raises**
**ValueError** – Invalid arguments are given.
**Return type**
[RuntimeJobV2](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")
</Function>
</Class>

73
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.Session
# Session
<Class id="qiskit_ibm_runtime.Session" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L47-L399" signature="Session(service=None, backend=None, max_time=None)" modifiers="class">
<Class id="qiskit_ibm_runtime.Session" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L46-L363" signature="Session(backend=None, max_time=None)" modifiers="class">
Bases: `object`
Class for creating a 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.
@ -48,9 +50,8 @@ python_api_name: qiskit_ibm_runtime.Session
**Parameters**
* **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account.
* **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), `None`]) – Instance of `Backend` class or string name of backend. Note that passing a backend name is deprecated.
* **max\_time** (`Union`\[`int`, `str`, `None`]) – 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 less than the [system imposed maximum](/guides/max-execution-time).
* **backend** (*Optional\[Union\[BackendV1, BackendV2]]*) – Instance of `Backend` class.
* **max\_time** (*Optional\[Union\[int, str]]*) – 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 less than the [system imposed maximum](/guides/max-execution-time).
**Raises**
@ -63,10 +64,6 @@ python_api_name: qiskit_ibm_runtime.Session
<Attribute id="qiskit_ibm_runtime.Session.service">
Return service associated with this session.
**Return type**
[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")
**Returns**
[`qiskit_ibm_runtime.QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") associated with this session.
@ -77,10 +74,6 @@ python_api_name: qiskit_ibm_runtime.Session
<Attribute id="qiskit_ibm_runtime.Session.session_id">
Return the session ID.
**Return type**
`Optional`\[`str`]
**Returns**
Session ID. None if the backend is a simulator.
@ -90,47 +83,43 @@ python_api_name: qiskit_ibm_runtime.Session
### backend
<Function id="qiskit_ibm_runtime.Session.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L240-L248" signature="backend()">
<Function id="qiskit_ibm_runtime.Session.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L204-L212" signature="backend()">
Return backend for this session.
**Return type**
`Optional`\[`str`]
**Returns**
Backend for this session. None if unknown.
**Return type**
str | None
</Function>
### cancel
<Function id="qiskit_ibm_runtime.Session.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L226-L230" signature="cancel()">
<Function id="qiskit_ibm_runtime.Session.cancel" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L190-L194" signature="cancel()">
Cancel all pending jobs in a session.
**Return type**
`None`
None
</Function>
### close
<Function id="qiskit_ibm_runtime.Session.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L232-L238" signature="close()">
<Function id="qiskit_ibm_runtime.Session.close" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L196-L202" signature="close()">
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`
None
</Function>
### details
<Function id="qiskit_ibm_runtime.Session.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L291-L333" signature="details()">
<Function id="qiskit_ibm_runtime.Session.details" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L255-L297" signature="details()">
Return session details.
**Return type**
`Optional`\[`Dict`\[`str`, `Any`]]
**Returns**
A dictionary with the sessions details.
@ -149,18 +138,22 @@ python_api_name: qiskit_ibm_runtime.Session
* `activated_at`: Timestamp of when the session state was changed to active.
* `mode`: Execution mode of the session.
* `usage_time`: The usage time, in seconds, of this Session or Batch. Usage is defined as the time a quantum system is committed to complete a job.
**Return type**
*Dict*\[str, *Any*] | None
</Function>
### from\_id
<Function id="qiskit_ibm_runtime.Session.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L353-L386" signature="from_id(session_id, service)" modifiers="classmethod">
<Function id="qiskit_ibm_runtime.Session.from_id" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L317-L350" signature="from_id(session_id, service)" modifiers="classmethod">
Construct a Session object with a given session\_id
**Parameters**
* **session\_id** (`str`) – the id of the session to be created. This must be an already existing session id.
* **session\_id** (*str*) – the id of the session to be created. This must be an already existing session id.
* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –
* **service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) –
instance of the `QiskitRuntimeService` class.
@ -168,24 +161,20 @@ python_api_name: qiskit_ibm_runtime.Session
IBMInputValueError: If given session\_id does not exist.
**Return type**
[`Session`](#qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
**Returns**
A new Session with the given `session_id`
**Return type**
[*Session*](#qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")
</Function>
### status
<Function id="qiskit_ibm_runtime.Session.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L250-L275" signature="status()">
<Function id="qiskit_ibm_runtime.Session.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L214-L239" signature="status()">
Return current session status.
**Return type**
`Optional`\[`str`]
**Returns**
Session status as a string.
@ -195,11 +184,15 @@ python_api_name: qiskit_ibm_runtime.Session
* `In progress, not accepting new jobs`: session is active and not accepting new jobs.
* `Closed`: max\_time expired or session was explicitly closed.
* `None`: status details are not available.
**Return type**
str | None
</Function>
### usage
<Function id="qiskit_ibm_runtime.Session.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L277-L289" signature="usage()">
<Function id="qiskit_ibm_runtime.Session.usage" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L241-L253" signature="usage()">
Return session usage in seconds.
Session usage is the time from when the first job starts until the session goes inactive, is closed, or when its last job completes, whichever happens last.
@ -208,7 +201,7 @@ python_api_name: qiskit_ibm_runtime.Session
**Return type**
`Optional`\[`float`]
float | None
</Function>
</Class>

54
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.Neat.mdx
View File

@ -9,14 +9,16 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat
# Neat
<Class id="qiskit_ibm_runtime.debug_tools.Neat" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/debug_tools/neat.py#L37-L277" signature="Neat(backend, noise_model=None)" modifiers="class">
Bases: `object`
A class to help understand the expected performance of estimator jobs.
The “Noisy Estimator Analyzer Tool” (or “NEAT”) is a convenience tool that users of the `Estimator` primitive can employ to analyze and predict the performance of their queries. Its simulate method uses `qiskit-aer` to simulate the estimation task classically efficiently, either in ideal conditions or in the presence of noise. The simulations’ results can be compared with other simulation results or with primitive results results to draw custom figures of merit.
**Parameters**
* **backend** ([`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")) – A backend.
* **noise\_model** (`Optional`\[[`NoiseModel`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.noise.NoiseModel.html#qiskit_aer.noise.NoiseModel "(in Qiskit Aer v0.15.0)")]) – A noise model for the operations of the given backend. If `None`, it defaults to the noise model generated by `NoiseModel.from_backend()`.
* **backend** (*Backend*) – A backend.
* **noise\_model** (*Optional\[NoiseModel]*) – A noise model for the operations of the given backend. If `None`, it defaults to the noise model generated by `NoiseModel.from_backend()`.
## Attributes
@ -24,10 +26,6 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat
<Attribute id="qiskit_ibm_runtime.debug_tools.Neat.noise_model">
The noise model used by this analyzer tool for the noisy simulations.
**Return type**
[`NoiseModel`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.noise.NoiseModel.html#qiskit_aer.noise.NoiseModel "(in Qiskit Aer v0.15.0)")
</Attribute>
## Methods
@ -39,7 +37,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat
**Return type**
[`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")
[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")
</Function>
### ideal\_sim
@ -55,18 +53,18 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat
**Parameters**
* **pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs specifying the estimation task of interest.
* **cliffordize** (`bool`) – Whether or not to automatically apply the `ConvertISAToClifford` transpiler pass to the given `pubs` before performing the simulations.
* **seed\_simulator** (`Optional`\[`int`]) – A seed for the simulator.
* **precision** (`float`) – The target precision for the estimates of each expectation value in the returned results.
**Return type**
[`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatResult")
* **pubs** (*Sequence\[EstimatorPubLike]*) – The PUBs specifying the estimation task of interest.
* **cliffordize** (*bool*) – Whether or not to automatically apply the `ConvertISAToClifford` transpiler pass to the given `pubs` before performing the simulations.
* **seed\_simulator** (*int | None*) – A seed for the simulator.
* **precision** (*float*) – The target precision for the estimates of each expectation value in the returned results.
**Returns**
The results of the simulation.
**Return type**
[*NeatResult*](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatResult")
</Function>
### noisy\_sim
@ -82,18 +80,18 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat
**Parameters**
* **pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs specifying the estimation task of interest.
* **cliffordize** (`bool`) – Whether or not to automatically apply the `ConvertISAToClifford` transpiler pass to the given `pubs` before performing the simulations.
* **seed\_simulator** (`Optional`\[`int`]) – A seed for the simulator.
* **precision** (`float`) – The target precision for the estimates of each expectation value in the returned results.
**Return type**
[`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatResult")
* **pubs** (*Sequence\[EstimatorPubLike]*) – The PUBs specifying the estimation task of interest.
* **cliffordize** (*bool*) – Whether or not to automatically apply the `ConvertISAToClifford` transpiler pass to the given `pubs` before performing the simulations.
* **seed\_simulator** (*int | None*) – A seed for the simulator.
* **precision** (*float*) – The target precision for the estimates of each expectation value in the returned results.
**Returns**
The results of the simulation.
**Return type**
[*NeatResult*](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatResult")
</Function>
### to\_clifford
@ -105,15 +103,15 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat
**Parameters**
**pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs to turn into Clifford PUBs.
**Return type**
`list`\[`EstimatorPub`]
**pubs** (*Sequence\[EstimatorPubLike]*) – The PUBs to turn into Clifford PUBs.
**Returns**
The Clifford PUBs.
**Return type**
list\[*EstimatorPub*]
</Function>
</Class>

14
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx
View File

@ -9,13 +9,15 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult
# NeatPubResult
<Class id="qiskit_ibm_runtime.debug_tools.NeatPubResult" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/debug_tools/neat_results.py#L28-L115" signature="NeatPubResult(vals)" modifiers="class">
Bases: `object`
A class to store the PUB results of `Neat`.
It allows performing mathematical operations (`+`, `-`, `*`, `/`, `abs`, and `**`) with other objects of type `NeatPubResultLike` and with scalars.
**Parameters**
**vals** (`Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]) – The values in this `NeatPubResult`.
**vals** (*ArrayLike*) – The values in this `NeatPubResult`.
## Attributes
@ -23,10 +25,6 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult
<Attribute id="qiskit_ibm_runtime.debug_tools.NeatPubResult.vals">
The values in this result.
**Return type**
[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")
</Attribute>
## Methods
@ -34,9 +32,13 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult
### \_\_mul\_\_
<Function id="qiskit_ibm_runtime.debug_tools.NeatPubResult.__mul__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/debug_tools/neat_results.py#L90-L91" signature="__mul__(other)">
**Parameters**
**other** (*int | float |* [*NeatPubResult*](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") *|*[*PubResult*](/api/qiskit/qiskit.primitives.PubResult "(in Qiskit v1.2)") *|*[*DataBin*](/api/qiskit/qiskit.primitives.DataBin "(in Qiskit v1.2)"))
**Return type**
[`NeatPubResult`](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult")
[*NeatPubResult*](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult")
</Function>
</Class>

12
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatResult.mdx
View File

@ -9,20 +9,26 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatResult
# NeatResult
<Class id="qiskit_ibm_runtime.debug_tools.NeatResult" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/debug_tools/neat_results.py#L118-L138" signature="NeatResult(pub_results)" modifiers="class">
Bases: `object`
A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects.
**Parameters**
**pub\_results** (`Iterable`\[[`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult")]) – An iterable of [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects.
**pub\_results** (*Iterable\[*[*NeatPubResult*](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult")*]*) – An iterable of [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects.
## Methods
### \_\_getitem\_\_
<Function id="qiskit_ibm_runtime.debug_tools.NeatResult.__getitem__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/debug_tools/neat_results.py#L128-L129" signature="__getitem__(index)">
**Parameters**
**index** (*int*)
**Return type**
[`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult")
[*NeatPubResult*](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult")
</Function>
### \_\_len\_\_
@ -30,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatResult
<Function id="qiskit_ibm_runtime.debug_tools.NeatResult.__len__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/debug_tools/neat_results.py#L131-L132" signature="__len__()">
**Return type**
`int`
int
</Function>
</Class>

58
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.DoubleSliceSpan.mdx
View File

@ -9,15 +9,17 @@ python_api_name: qiskit_ibm_runtime.execution_span.DoubleSliceSpan
# DoubleSliceSpan
<Class id="qiskit_ibm_runtime.execution_span.DoubleSliceSpan" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/double_slice_span.py#L27-L79" signature="DoubleSliceSpan(start, stop, data_slices)" modifiers="class">
Bases: [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.execution_span.ExecutionSpan")
An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format.
This type of execution span references pub result data by assuming that it is a sliceable portion of the data where the shots are the outermost slice and the rest of the data is flattened. Therefore, for each pub dependent on this span, the constructor accepts two `slice` objects, along with the corresponding shape of the data to be sliced; in contrast to [`SliceSpan`](qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan"), this class does not assume that *all* shots for a particular set of parameter values are contiguous in the array of data.
**Parameters**
* **start** (`datetime`) – The start time of the span, in UTC.
* **stop** (`datetime`) – The stop time of the span, in UTC.
* **data\_slices** (`dict`\[`int`, `tuple`\[`Tuple`\[`int`, `...`], `slice`, `slice`]]) – A map from pub indices to `(shape_tuple, flat_shape_slice, shots_slice)`.
* **start** (*datetime*) – The start time of the span, in UTC.
* **stop** (*datetime*) – The stop time of the span, in UTC.
* **data\_slices** (*dict\[int, tuple\[ShapeType, slice, slice]]*) – A map from pub indices to `(shape_tuple, flat_shape_slice, shots_slice)`.
## Attributes
@ -25,46 +27,26 @@ python_api_name: qiskit_ibm_runtime.execution_span.DoubleSliceSpan
<Attribute id="qiskit_ibm_runtime.execution_span.DoubleSliceSpan.duration">
The duration of this span, in seconds.
**Return type**
`float`
</Attribute>
### pub\_idxs
<Attribute id="qiskit_ibm_runtime.execution_span.DoubleSliceSpan.pub_idxs">
**Return type**
`list`\[`int`]
</Attribute>
<Attribute id="qiskit_ibm_runtime.execution_span.DoubleSliceSpan.pub_idxs" />
### size
<Attribute id="qiskit_ibm_runtime.execution_span.DoubleSliceSpan.size">
**Return type**
`int`
</Attribute>
<Attribute id="qiskit_ibm_runtime.execution_span.DoubleSliceSpan.size" />
### start
<Attribute id="qiskit_ibm_runtime.execution_span.DoubleSliceSpan.start">
The start time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
### stop
<Attribute id="qiskit_ibm_runtime.execution_span.DoubleSliceSpan.stop">
The stop time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
## Methods
@ -78,13 +60,13 @@ python_api_name: qiskit_ibm_runtime.execution_span.DoubleSliceSpan
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
bool
**Returns**
Whether there is dependence on this span.
**Return type**
bool
</Function>
### filter\_by\_pub
@ -98,13 +80,13 @@ python_api_name: qiskit_ibm_runtime.execution_span.DoubleSliceSpan
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
[DoubleSliceSpan](#qiskit_ibm_runtime.execution_span.DoubleSliceSpan "qiskit_ibm_runtime.execution_span.DoubleSliceSpan")
**Returns**
A new filtered span.
**Return type**
[DoubleSliceSpan](#qiskit_ibm_runtime.execution_span.DoubleSliceSpan "qiskit_ibm_runtime.execution_span.DoubleSliceSpan")
</Function>
### mask
@ -114,15 +96,15 @@ python_api_name: qiskit_ibm_runtime.execution_span.DoubleSliceSpan
**Parameters**
**pub\_idx** (`int`) – The index of the pub to return a mask for.
**Return type**
[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[`Any`, [`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[`bool`](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
**pub\_idx** (*int*) – The index of the pub to return a mask for.
**Returns**
An array with the same shape as the pub data.
**Return type**
[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[*Any*, [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[*bool*](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
</Function>
</Class>

52
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan
# ExecutionSpan
<Class id="qiskit_ibm_runtime.execution_span.ExecutionSpan" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_span.py#L31-L137" signature="ExecutionSpan(start, stop)" modifiers="class">
Bases: `ABC`
Abstract parent for classes that store an execution time span for a subset of job data.
A pub is said to have dependence on an execution span if the corresponding execution includes data that forms any part of the pub’s results.
@ -17,8 +19,8 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan
**Parameters**
* **start** (`datetime`) – The start time of the span, in UTC.
* **stop** (`datetime`) – The stop time of the span, in UTC.
* **start** (*datetime*) – The start time of the span, in UTC.
* **stop** (*datetime*) – The stop time of the span, in UTC.
## Attributes
@ -26,20 +28,12 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.duration">
The duration of this span, in seconds.
**Return type**
`float`
</Attribute>
### pub\_idxs
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.pub_idxs">
Which pubs, by index, have dependence on this execution span.
**Return type**
`list`\[`int`]
</Attribute>
### size
@ -54,30 +48,18 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan
```python
span.filter_by_pub(2).size
```
**Return type**
`int`
</Attribute>
### start
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.start">
The start time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
### stop
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpan.stop">
The stop time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
## Methods
@ -91,13 +73,13 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
bool
**Returns**
Whether there is dependence on this span.
**Return type**
bool
</Function>
### filter\_by\_pub
@ -111,13 +93,13 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
[ExecutionSpan](#qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")
**Returns**
A new filtered span.
**Return type**
[ExecutionSpan](#qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")
</Function>
### mask
@ -127,15 +109,15 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan
**Parameters**
**pub\_idx** (`int`) – The index of the pub to return a mask for.
**Return type**
[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[`Any`, [`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[`bool`](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
**pub\_idx** (*int*) – The index of the pub to return a mask for.
**Returns**
An array with the same shape as the pub data.
**Return type**
[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[*Any*, [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[*bool*](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
</Function>
</Class>

54
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans
# ExecutionSpans
<Class id="qiskit_ibm_runtime.execution_span.ExecutionSpans" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L26-L144" signature="ExecutionSpans(spans)" modifiers="class">
Bases: `object`
A collection of timings for pub results.
This class is a list-like containing [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")s, where each execution span represents a time window of data collection, and contains a reference to exactly which of the data were collected during the window.
@ -17,62 +19,46 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans
## Attributes
**Parameters**
**spans** (*Iterable\[*[*ExecutionSpan*](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")*]*)
### duration
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpans.duration">
The total duration of this collection, in seconds.
**Return type**
`float`
</Attribute>
### pub\_idxs
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpans.pub_idxs">
Which pubs, by index, have dependence on one or more execution spans present.
**Return type**
`list`\[`int`]
</Attribute>
### start
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpans.start">
The start time of the entire collection, in UTC.
**Return type**
`datetime`
</Attribute>
### stop
<Attribute id="qiskit_ibm_runtime.execution_span.ExecutionSpans.stop">
The stop time of the entire collection, in UTC.
**Return type**
`datetime`
</Attribute>
## Methods
### \_\_getitem\_\_
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.__getitem__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L59-L64" signature="__getitem__(idxs: int) → ExecutionSpan" extraSignatures={["__getitem__(idxs: slice | list[int]) → ExecutionSpans"]}>
**Return type**
[ExecutionSpan](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") | ‘ExecutionSpans
</Function>
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.__getitem__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L59-L64" signature="__getitem__(idxs: int) → ExecutionSpan" extraSignatures={["__getitem__(idxs: slice | list[int]) → ExecutionSpans"]} />
### \_\_len\_\_
<Function id="qiskit_ibm_runtime.execution_span.ExecutionSpans.__len__" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/execution_spans.py#L50-L51" signature="__len__()">
**Return type**
`int`
int
</Function>
### draw
@ -86,17 +72,17 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans
**Parameters**
* **name** (`Optional`\[`str`]) – The name of this set of spans.
* **normalize\_y** (`bool`) – Whether to display the y-axis units as a percentage of work complete, rather than cumulative shots completed.
* **line\_width** (`int`) – The thickness of line segments.
**Return type**
`Figure`
* **name** (*str*) – The name of this set of spans.
* **normalize\_y** (*bool*) – Whether to display the y-axis units as a percentage of work complete, rather than cumulative shots completed.
* **line\_width** (*int*) – The thickness of line segments.
**Returns**
A plotly figure.
**Return type**
PlotlyFigure
</Function>
### filter\_by\_pub
@ -124,15 +110,15 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans
**Parameters**
**inplace** (`bool`) – Whether to sort this instance in place, or return a copy.
**Return type**
[`ExecutionSpans`](#qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.execution_spans.ExecutionSpans")
**inplace** (*bool*) – Whether to sort this instance in place, or return a copy.
**Returns**
This instance if `inplace`, a new instance otherwise, sorted.
**Return type**
[*ExecutionSpans*](#qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.execution_spans.ExecutionSpans")
</Function>
</Class>

2
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ShapeType.mdx
View File

@ -6,6 +6,8 @@ python_api_type: data
python_api_name: qiskit_ibm_runtime.execution_span.ShapeType
---
<span id="qiskit-ibm-runtime-execution-span-shapetype" />
# ShapeType
<Attribute id="qiskit_ibm_runtime.execution_span.ShapeType" isDedicatedPage={true}>

58
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.SliceSpan.mdx
View File

@ -9,15 +9,17 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan
# SliceSpan
<Class id="qiskit_ibm_runtime.execution_span.SliceSpan" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/slice_span.py#L27-L74" signature="SliceSpan(start, stop, data_slices)" modifiers="class">
Bases: [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.execution_span.ExecutionSpan")
An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format.
This type of execution span references pub result data by assuming that it is a sliceable portion of the (row major) flattened data. Therefore, for each pub dependent on this span, the constructor accepts a single `slice` object, along with the corresponding shape of the data to be sliced.
**Parameters**
* **start** (`datetime`) – The start time of the span, in UTC.
* **stop** (`datetime`) – The stop time of the span, in UTC.
* **data\_slices** (`dict`\[`int`, `tuple`\[`Tuple`\[`int`, `...`], `slice`]]) – A map from pub indices to pairs `(shape_tuple, slice)`.
* **start** (*datetime*) – The start time of the span, in UTC.
* **stop** (*datetime*) – The stop time of the span, in UTC.
* **data\_slices** (*dict\[int, tuple\[ShapeType, slice]]*) – A map from pub indices to pairs `(shape_tuple, slice)`.
## Attributes
@ -25,46 +27,26 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.duration">
The duration of this span, in seconds.
**Return type**
`float`
</Attribute>
### pub\_idxs
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.pub_idxs">
**Return type**
`list`\[`int`]
</Attribute>
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.pub_idxs" />
### size
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.size">
**Return type**
`int`
</Attribute>
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.size" />
### start
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.start">
The start time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
### stop
<Attribute id="qiskit_ibm_runtime.execution_span.SliceSpan.stop">
The stop time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
## Methods
@ -78,13 +60,13 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
bool
**Returns**
Whether there is dependence on this span.
**Return type**
bool
</Function>
### filter\_by\_pub
@ -98,13 +80,13 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
[SliceSpan](#qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")
**Returns**
A new filtered span.
**Return type**
[SliceSpan](#qiskit_ibm_runtime.execution_span.SliceSpan "qiskit_ibm_runtime.execution_span.SliceSpan")
</Function>
### mask
@ -114,15 +96,15 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan
**Parameters**
**pub\_idx** (`int`) – The index of the pub to return a mask for.
**Return type**
[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[`Any`, [`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[`bool`](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
**pub\_idx** (*int*) – The index of the pub to return a mask for.
**Returns**
An array with the same shape as the pub data.
**Return type**
[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[*Any*, [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[*bool*](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
</Function>
</Class>

58
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.TwirledSliceSpan.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.execution_span.TwirledSliceSpan
# TwirledSliceSpan
<Class id="qiskit_ibm_runtime.execution_span.TwirledSliceSpan" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/execution_span/twirled_slice_span.py#L27-L92" signature="TwirledSliceSpan(start, stop, data_slices)" modifiers="class">
Bases: [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.execution_span.ExecutionSpan")
An [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") for data stored in a sliceable format when twirling.
This type of execution span references pub result data that came from a twirled sampler experiment which was executed by either prepending or appending an axis to paramater values to account for twirling. Concretely, `data_slices` is a map from pub slices to tuples `(twirled_shape, at_front, shape_slice, shots_slice)` where
@ -20,9 +22,9 @@ python_api_name: qiskit_ibm_runtime.execution_span.TwirledSliceSpan
**Parameters**
* **start** (`datetime`) – The start time of the span, in UTC.
* **stop** (`datetime`) – The stop time of the span, in UTC.
* **data\_slices** (`dict`\[`int`, `tuple`\[`Tuple`\[`int`, `...`], `bool`, `slice`, `slice`]]) – A map from pub indices to length-4 tuples described above.
* **start** (*datetime*) – The start time of the span, in UTC.
* **stop** (*datetime*) – The stop time of the span, in UTC.
* **data\_slices** (*dict\[int, tuple\[ShapeType, bool, slice, slice]]*) – A map from pub indices to length-4 tuples described above.
## Attributes
@ -30,46 +32,26 @@ python_api_name: qiskit_ibm_runtime.execution_span.TwirledSliceSpan
<Attribute id="qiskit_ibm_runtime.execution_span.TwirledSliceSpan.duration">
The duration of this span, in seconds.
**Return type**
`float`
</Attribute>
### pub\_idxs
<Attribute id="qiskit_ibm_runtime.execution_span.TwirledSliceSpan.pub_idxs">
**Return type**
`list`\[`int`]
</Attribute>
<Attribute id="qiskit_ibm_runtime.execution_span.TwirledSliceSpan.pub_idxs" />
### size
<Attribute id="qiskit_ibm_runtime.execution_span.TwirledSliceSpan.size">
**Return type**
`int`
</Attribute>
<Attribute id="qiskit_ibm_runtime.execution_span.TwirledSliceSpan.size" />
### start
<Attribute id="qiskit_ibm_runtime.execution_span.TwirledSliceSpan.start">
The start time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
### stop
<Attribute id="qiskit_ibm_runtime.execution_span.TwirledSliceSpan.stop">
The stop time of the span, in UTC.
**Return type**
`datetime`
</Attribute>
## Methods
@ -83,13 +65,13 @@ python_api_name: qiskit_ibm_runtime.execution_span.TwirledSliceSpan
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
bool
**Returns**
Whether there is dependence on this span.
**Return type**
bool
</Function>
### filter\_by\_pub
@ -103,13 +85,13 @@ python_api_name: qiskit_ibm_runtime.execution_span.TwirledSliceSpan
**pub\_idx** (*int | Iterable\[int]*) – One or more pub indices from the original primitive call.
**Return type**
[TwirledSliceSpan](#qiskit_ibm_runtime.execution_span.TwirledSliceSpan "qiskit_ibm_runtime.execution_span.TwirledSliceSpan")
**Returns**
A new filtered span.
**Return type**
[TwirledSliceSpan](#qiskit_ibm_runtime.execution_span.TwirledSliceSpan "qiskit_ibm_runtime.execution_span.TwirledSliceSpan")
</Function>
### mask
@ -119,15 +101,15 @@ python_api_name: qiskit_ibm_runtime.execution_span.TwirledSliceSpan
**Parameters**
**pub\_idx** (`int`) – The index of the pub to return a mask for.
**Return type**
[`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[`Any`, [`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[`bool`](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
**pub\_idx** (*int*) – The index of the pub to return a mask for.
**Returns**
An array with the same shape as the pub data.
**Return type**
[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")\[*Any*, [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[[*bool*](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool "(in NumPy v2.1)")]]
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
# FakeAlgiers
<Class id="qiskit_ibm_runtime.fake_provider.FakeAlgiers" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/algiers/fake_algiers.py#L21-L28" signature="FakeAlgiers" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlgiers.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
# FakeAlmadenV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L21-L38" signature="FakeAlmadenV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Almaden V2 backend.
```text
@ -54,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
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.
@ -68,10 +66,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -93,29 +87,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -125,30 +107,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -231,6 +201,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -240,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Return type**
`None`
None
</Function>
### configuration
@ -258,7 +232,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -272,7 +246,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -290,16 +264,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -316,6 +290,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -332,6 +310,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -341,16 +323,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -362,11 +344,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -375,6 +353,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -390,7 +372,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -399,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
**Return type**
`None`
None
</Function>
### run
@ -452,13 +434,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
# FakeArmonkV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L21-L33" signature="FakeArmonkV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 1 qubit backend.
```text
@ -48,10 +50,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
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.
@ -62,10 +60,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -87,29 +81,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -119,30 +101,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -225,6 +195,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -234,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -242,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Return type**
`None`
None
</Function>
### configuration
@ -252,7 +226,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -266,7 +240,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -284,16 +258,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -310,6 +284,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -326,6 +304,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -335,16 +317,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -356,11 +338,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -369,6 +347,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -384,7 +366,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -393,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
**Return type**
`None`
None
</Function>
### run
@ -446,13 +428,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeArmonkV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
# FakeAthensV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeAthensV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L21-L28" signature="FakeAthensV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeAthensV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
# FakeAuckland
<Class id="qiskit_ibm_runtime.fake_provider.FakeAuckland" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py#L22-L29" signature="FakeAuckland" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeAuckland.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland
<Function id="qiskit_ibm_runtime.fake_provider.FakeAuckland.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
# FakeBelemV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBelemV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L21-L28" signature="FakeBelemV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeBelemV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
# FakeBoeblingenV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L21-L39" signature="FakeBoeblingenV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Boeblingen V2 backend.
```text
@ -54,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
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.
@ -68,10 +66,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -93,29 +87,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -125,30 +107,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -231,6 +201,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -240,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Return type**
`None`
None
</Function>
### configuration
@ -258,7 +232,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -272,7 +246,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -290,16 +264,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -316,6 +290,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -332,6 +310,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -341,16 +323,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -362,11 +344,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -375,6 +353,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -390,7 +372,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -399,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
**Return type**
`None`
None
</Function>
### run
@ -452,13 +434,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
# FakeBogotaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L21-L28" signature="FakeBogotaV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeBogotaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
# FakeBrisbane
<Class id="qiskit_ibm_runtime.fake_provider.FakeBrisbane" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/brisbane/fake_brisbane.py#L21-L28" signature="FakeBrisbane" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrisbane.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
# FakeBrooklynV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L21-L28" signature="FakeBrooklynV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Brooklyn V2 backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
# FakeBurlingtonV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L21-L34" signature="FakeBurlingtonV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
```text
@ -50,10 +52,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
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.
@ -64,10 +62,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -89,29 +83,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -121,30 +103,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -227,6 +197,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -236,7 +210,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -244,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Return type**
`None`
None
</Function>
### configuration
@ -254,7 +228,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -268,7 +242,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -286,16 +260,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -312,6 +286,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -328,6 +306,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -337,16 +319,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -358,11 +340,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -371,6 +349,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -386,7 +368,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -395,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
**Return type**
`None`
None
</Function>
### run
@ -448,13 +430,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
# FakeCairoV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeCairoV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L21-L28" signature="FakeCairoV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeCairoV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
# FakeCambridgeV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L21-L40" signature="FakeCambridgeV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Cambridge backend.
```text
@ -56,10 +58,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
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.
@ -70,10 +68,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -95,29 +89,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -127,30 +109,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -233,6 +203,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -242,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -250,7 +224,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Return type**
`None`
None
</Function>
### configuration
@ -260,7 +234,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -274,7 +248,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -292,16 +266,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -318,6 +292,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -334,6 +312,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -343,16 +325,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -364,11 +346,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -377,6 +355,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -392,7 +374,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -401,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
**Return type**
`None`
None
</Function>
### run
@ -454,13 +436,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
# FakeCasablancaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L21-L28" signature="FakeCasablancaV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 7 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
# FakeCusco
<Class id="qiskit_ibm_runtime.fake_provider.FakeCusco" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/cusco/fake_cusco.py#L21-L28" signature="FakeCusco" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeCusco.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco
<Function id="qiskit_ibm_runtime.fake_provider.FakeCusco.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
# FakeEssexV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeEssexV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L21-L36" signature="FakeEssexV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
```text
@ -52,10 +54,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
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.
@ -66,10 +64,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -91,29 +85,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -123,30 +105,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -229,6 +199,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -246,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Return type**
`None`
None
</Function>
### configuration
@ -256,7 +230,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -270,7 +244,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -288,16 +262,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -314,6 +288,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -330,6 +308,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -339,16 +321,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -360,11 +342,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -373,6 +351,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -388,7 +370,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -397,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
**Return type**
`None`
None
</Function>
### run
@ -450,13 +432,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeEssexV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
# FakeFractionalBackend
<Class id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/fractional/fake_fractional.py#L21-L36" signature="FakeFractionalBackend" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima.
This backend include following features.
@ -51,10 +53,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
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.
@ -65,10 +63,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -90,29 +84,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -122,30 +104,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -228,6 +198,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -237,7 +211,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -245,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Return type**
`None`
None
</Function>
### configuration
@ -255,7 +229,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -269,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -287,16 +261,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -313,6 +287,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -329,6 +307,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -338,16 +320,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -359,11 +341,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -372,6 +350,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -387,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -396,7 +378,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
**Return type**
`None`
None
</Function>
### run
@ -449,13 +431,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend
<Function id="qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
# FakeGeneva
<Class id="qiskit_ibm_runtime.fake_provider.FakeGeneva" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py#L22-L29" signature="FakeGeneva" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGeneva.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva
<Function id="qiskit_ibm_runtime.fake_provider.FakeGeneva.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
# FakeGuadalupeV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L22-L29" signature="FakeGuadalupeV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 16 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
# FakeHanoiV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L21-L28" signature="FakeHanoiV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeHanoiV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
# FakeJakartaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L21-L28" signature="FakeJakartaV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 7 qubit V2 backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeJakartaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
# FakeJohannesburgV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L21-L38" signature="FakeJohannesburgV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Johannesburg V2 backend.
```text
@ -54,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
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.
@ -68,10 +66,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -93,29 +87,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -125,30 +107,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -231,6 +201,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -240,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Return type**
`None`
None
</Function>
### configuration
@ -258,7 +232,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -272,7 +246,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -290,16 +264,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -316,6 +290,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -332,6 +310,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -341,16 +323,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -362,11 +344,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -375,6 +353,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -390,7 +372,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -399,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
**Return type**
`None`
None
</Function>
### run
@ -452,13 +434,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
# FakeKawasaki
<Class id="qiskit_ibm_runtime.fake_provider.FakeKawasaki" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/kawasaki/fake_kawasaki.py#L21-L28" signature="FakeKawasaki" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki
<Function id="qiskit_ibm_runtime.fake_provider.FakeKawasaki.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
# FakeKolkataV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L21-L28" signature="FakeKolkataV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeKolkataV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
# FakeKyiv
<Class id="qiskit_ibm_runtime.fake_provider.FakeKyiv" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/kyiv/fake_kyiv.py#L21-L28" signature="FakeKyiv" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyiv.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyiv.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
# FakeKyoto
<Class id="qiskit_ibm_runtime.fake_provider.FakeKyoto" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/kyoto/fake_kyoto.py#L21-L28" signature="FakeKyoto" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeKyoto.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto
<Function id="qiskit_ibm_runtime.fake_provider.FakeKyoto.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
# FakeLagosV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeLagosV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L21-L28" signature="FakeLagosV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 7 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeLagosV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
# FakeLimaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeLimaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L21-L28" signature="FakeLimaV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeLimaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
# FakeLondonV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeLondonV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L21-L36" signature="FakeLondonV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
```text
@ -52,10 +54,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
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.
@ -66,10 +64,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -91,29 +85,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -123,30 +105,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -229,6 +199,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -246,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Return type**
`None`
None
</Function>
### configuration
@ -256,7 +230,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -270,7 +244,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -288,16 +262,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -314,6 +288,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -330,6 +308,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -339,16 +321,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -360,11 +342,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -373,6 +351,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -388,7 +370,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -397,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
**Return type**
`None`
None
</Function>
### run
@ -450,13 +432,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeLondonV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
# FakeManhattanV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L21-L28" signature="FakeManhattanV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Manhattan backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeManhattanV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
# FakeManilaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeManilaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L21-L28" signature="FakeManilaV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeManilaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
# FakeMelbourneV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L22-L28" signature="FakeMelbourneV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 14 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
# FakeMontrealV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L21-L28" signature="FakeMontrealV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeMontrealV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
# FakeMumbaiV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L21-L28" signature="FakeMumbaiV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
# FakeNairobiV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L21-L28" signature="FakeNairobiV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 7 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeNairobiV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
# FakeOsaka
<Class id="qiskit_ibm_runtime.fake_provider.FakeOsaka" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/osaka/fake_osaka.py#L21-L28" signature="FakeOsaka" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOsaka.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka
<Function id="qiskit_ibm_runtime.fake_provider.FakeOsaka.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
# FakeOslo
<Class id="qiskit_ibm_runtime.fake_provider.FakeOslo" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py#L22-L29" signature="FakeOslo" modifiers="class">
Bases: `FakeBackendV2`
A fake 7 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOslo.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo
<Function id="qiskit_ibm_runtime.fake_provider.FakeOslo.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
# FakeOurenseV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L21-L34" signature="FakeOurenseV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
```text
@ -50,10 +52,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
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.
@ -64,10 +62,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -89,29 +83,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -121,30 +103,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -227,6 +197,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -236,7 +210,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -244,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Return type**
`None`
None
</Function>
### configuration
@ -254,7 +228,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -268,7 +242,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -286,16 +260,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -312,6 +286,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -328,6 +306,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -337,16 +319,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -358,11 +340,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -371,6 +349,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -386,7 +368,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -395,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
**Return type**
`None`
None
</Function>
### run
@ -448,13 +430,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeOurenseV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
# FakeParisV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeParisV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L21-L41" signature="FakeParisV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Paris backend.
```text
@ -56,10 +58,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
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.
@ -70,10 +68,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -95,29 +89,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -127,30 +109,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeParisV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -233,6 +203,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -242,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -250,7 +224,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Return type**
`None`
None
</Function>
### configuration
@ -260,7 +234,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -274,7 +248,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -292,16 +266,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -318,6 +292,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -334,6 +312,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -343,16 +325,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -364,11 +346,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -377,6 +355,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -392,7 +374,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -401,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
**Return type**
`None`
None
</Function>
### run
@ -454,13 +436,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeParisV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
# FakePeekskill
<Class id="qiskit_ibm_runtime.fake_provider.FakePeekskill" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/peekskill/fake_peekskill.py#L21-L28" signature="FakePeekskill" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePeekskill.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill
<Function id="qiskit_ibm_runtime.fake_provider.FakePeekskill.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
# FakePerth
<Class id="qiskit_ibm_runtime.fake_provider.FakePerth" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py#L22-L29" signature="FakePerth" modifiers="class">
Bases: `FakeBackendV2`
A fake 7 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePerth.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth
<Function id="qiskit_ibm_runtime.fake_provider.FakePerth.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
# FakePoughkeepsieV2
<Class id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L22-L29" signature="FakePoughkeepsieV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Poughkeepsie backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2
<Function id="qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
# FakePrague
<Class id="qiskit_ibm_runtime.fake_provider.FakePrague" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py#L22-L28" signature="FakePrague" modifiers="class">
Bases: `FakeBackendV2`
A fake 33 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakePrague.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague
<Function id="qiskit_ibm_runtime.fake_provider.FakePrague.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

16
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2
# FakeProviderForBackendV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py#L26-L112" signature="FakeProviderForBackendV2" modifiers="class">
Bases: `object`
Fake provider containing fake V2 backends.
Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider").
@ -20,9 +22,14 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.backend" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py#L33-L45" signature="backend(name=None, **kwargs)">
Filter backends in provider by name.
**Parameters**
* **name** (*str | None*)
* **kwargs** (*Any*)
**Return type**
`FakeBackendV2`
*FakeBackendV2*
</Function>
### backends
@ -30,9 +37,14 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.backends" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py#L47-L49" signature="backends(name=None, **kwargs)">
Return all backends accessible via this account.
**Parameters**
* **name** (*str | None*)
* **kwargs** (*Any*)
**Return type**
`List`\[`FakeBackendV2`]
*List*\[*FakeBackendV2*]
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
# FakeQuebec
<Class id="qiskit_ibm_runtime.fake_provider.FakeQuebec" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/quebec/fake_quebec.py#L21-L28" signature="FakeQuebec" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuebec.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuebec.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
# FakeQuitoV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py#L21-L28" signature="FakeQuitoV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeQuitoV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
# FakeRochesterV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py#L21-L27" signature="FakeRochesterV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Rochester backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeRochesterV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
# FakeRomeV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeRomeV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py#L21-L28" signature="FakeRomeV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeRomeV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
# FakeSantiagoV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py#L21-L28" signature="FakeSantiagoV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Santiago backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
# FakeSherbrooke
<Class id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py#L21-L28" signature="FakeSherbrooke" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke
<Function id="qiskit_ibm_runtime.fake_provider.FakeSherbrooke.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
# FakeSingaporeV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py#L21-L38" signature="FakeSingaporeV2" modifiers="class">
Bases: `FakeBackendV2`
A fake Singapore backend.
```text
@ -54,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
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.
@ -68,10 +66,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -93,29 +87,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -125,30 +107,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -231,6 +201,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -240,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Return type**
`None`
None
</Function>
### configuration
@ -258,7 +232,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -272,7 +246,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -290,16 +264,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -316,6 +290,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -332,6 +310,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -341,16 +323,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -362,11 +344,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -375,6 +353,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -390,7 +372,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -399,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
**Return type**
`None`
None
</Function>
### run
@ -452,13 +434,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
# FakeSydneyV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py#L21-L28" signature="FakeSydneyV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeSydneyV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
# FakeTorino
<Class id="qiskit_ibm_runtime.fake_provider.FakeTorino" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/torino/fake_torino.py#L21-L28" signature="FakeTorino" modifiers="class">
Bases: `FakeBackendV2`
A fake 133 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorino.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorino.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorino.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorino.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorino.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorino.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorino.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorino.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino
<Function id="qiskit_ibm_runtime.fake_provider.FakeTorino.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
# FakeTorontoV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py#L21-L28" signature="FakeTorontoV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 27 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeTorontoV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
# FakeValenciaV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py#L21-L28" signature="FakeValenciaV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeValenciaV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
# FakeVigoV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeVigoV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py#L21-L34" signature="FakeVigoV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
```text
@ -50,10 +52,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
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.
@ -64,10 +62,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -89,29 +83,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -121,30 +103,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -227,6 +197,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -236,7 +210,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -244,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Return type**
`None`
None
</Function>
### configuration
@ -254,7 +228,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -268,7 +242,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -286,16 +260,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -312,6 +286,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -328,6 +306,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -337,16 +319,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -358,11 +340,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -371,6 +349,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -386,7 +368,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -395,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
**Return type**
`None`
None
</Function>
### run
@ -448,13 +430,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeVigoV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
# FakeWashingtonV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py#L21-L28" signature="FakeWashingtonV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 127 qubit backend.
FakeBackendV2 initializer.
@ -44,10 +46,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
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.
@ -58,10 +56,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -83,29 +77,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -115,30 +97,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -221,6 +191,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -230,7 +204,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Return type**
`None`
None
</Function>
### configuration
@ -248,7 +222,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -262,7 +236,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -280,16 +254,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -306,6 +280,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -322,6 +300,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -331,16 +313,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -352,11 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -365,6 +343,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -380,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -389,7 +371,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
**Return type**
`None`
None
</Function>
### run
@ -442,13 +424,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

98
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
# FakeYorktownV2
<Class id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py#L21-L36" signature="FakeYorktownV2" modifiers="class">
Bases: `FakeBackendV2`
A fake 5 qubit backend.
```text
@ -52,10 +54,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
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.
@ -66,10 +64,6 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.dtm">
Return the system time resolution of output signals
**Return type**
`float`
**Returns**
The output signal timestep in seconds.
@ -91,29 +85,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.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.2)"), `Tuple`\[`int`]]]
</Attribute>
### max\_circuits
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.max_circuits">
**Return type**
`None`
</Attribute>
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.max_circuits" />
### meas\_map
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.meas_map">
Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling.
**Return type**
`List`\[`List`\[`int`]]
**Returns**
The grouping of measurements which are multiplexed
@ -123,30 +105,18 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.num_qubits">
Return the number of qubits the backend has.
**Return type**
`int`
</Attribute>
### operation\_names
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.operation_names">
A list of instruction names that the backend supports.
**Return type**
`List`\[`str`]
</Attribute>
### operations
<Attribute id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.operations">
A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports.
**Return type**
`List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")]
</Attribute>
### options
@ -229,6 +199,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Return type**
AcquireChannel
**Parameters**
**qubit** (*int*)
</Function>
### check\_faulty
@ -238,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Parameters**
**circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check.
**Raises**
@ -246,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Return type**
`None`
None
</Function>
### configuration
@ -256,7 +230,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Return type**
`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]
*QasmBackendConfiguration* | *PulseBackendConfiguration*
</Function>
### control\_channel
@ -270,7 +244,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Parameters**
**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**qubits** (*Iterable\[int]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`.
**Returns**
@ -288,16 +262,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the
* **refresh** (*bool*) – If `True`, re-retrieve the backend defaults from the
* **file.** (*local*)
**Return type**
`PulseDefaults`
**Returns**
The backend pulse defaults or `None` if the backend does not support pulse.
**Return type**
*PulseDefaults*
</Function>
### drive\_channel
@ -314,6 +288,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Return type**
DriveChannel
**Parameters**
**qubit** (*int*)
</Function>
### measure\_channel
@ -330,6 +308,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Return type**
MeasureChannel
**Parameters**
**qubit** (*int*)
</Function>
### properties
@ -339,16 +321,16 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Parameters**
* **refresh** (`bool`) – If `True`, re-retrieve the backend properties
* **refresh** (*bool*) – If `True`, re-retrieve the backend properties
* **file.** (*from the local*)
**Return type**
`BackendProperties`
**Returns**
The backend properties.
**Return type**
*BackendProperties*
</Function>
### qubit\_properties
@ -360,11 +342,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**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.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]]
**qubit** (*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
**Returns**
@ -373,6 +351,10 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Raises**
**NotImplementedError** – if the backend doesn’t support querying the qubit properties
**Return type**
[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]
</Function>
### refresh
@ -388,7 +370,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Parameters**
**service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**service** ([*QiskitRuntimeService*](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance
**Raises**
@ -397,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
**Return type**
`None`
None
</Function>
### run
@ -450,13 +432,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2
<Function id="qiskit_ibm_runtime.fake_provider.FakeYorktownV2.status" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L179-L195" signature="status()">
Return the backend status.
**Return type**
`BackendStatus`
**Returns**
The status of the backend.
**Return type**
*BackendStatus*
</Function>
</Class>

22
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx
View File

@ -9,6 +9,8 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner
# NoiseLearner
<Class id="qiskit_ibm_runtime.noise_learner.NoiseLearner" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/noise_learner/noise_learner.py#L48-L273" signature="NoiseLearner(mode=None, options=None)" modifiers="class">
Bases: `object`
Class for executing noise learning experiments.
<Admonition title="Note" type="note">
@ -59,7 +61,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner
**Parameters**
* **mode** (`Union`\[[`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)"), [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.batch.Batch"), `None`]) –
* **mode** (*Optional\[Union\[BackendV2,* [*Session*](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session")*,* [*Batch*](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")*]]*) –
The execution mode used to make the primitive query. It can be:
@ -69,7 +71,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner
Refer to the [Qiskit Runtime documentation](/guides/execution-modes) for more information about the execution modes.
* **options** (`Union`\[`Dict`, [`NoiseLearnerOptions`](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.noise_learner_options.NoiseLearnerOptions"), [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – `NoiseLearnerOptions`. Alternatively, `EstimatorOptions` can be provided for convenience, in which case the estimator options get reformatted into noise learner options and all the irrelevant fields are ignored.
* **options** (*Optional\[Union\[Dict,* [*NoiseLearnerOptions*](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.NoiseLearnerOptions")*,* [*EstimatorOptions*](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")*]]*) – `NoiseLearnerOptions`. Alternatively, `EstimatorOptions` can be provided for convenience, in which case the estimator options get reformatted into noise learner options and all the irrelevant fields are ignored.
**References**
@ -81,10 +83,6 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner
<Attribute id="qiskit_ibm_runtime.noise_learner.NoiseLearner.options">
The options in this noise learner.
**Return type**
[`NoiseLearnerOptions`](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.noise_learner_options.NoiseLearnerOptions")
</Attribute>
## Methods
@ -96,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner
**Return type**
[`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")
[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")
</Function>
### run
@ -108,15 +106,15 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner
**Parameters**
**circuits** (`Iterable`\[`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – An iterable of circuits to run the noise learner program for. Alternatively, estimator pub-like (primitive unified bloc) objects can be specified, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. In this case, the pub-like objects are converted to a list of circuits, and all the other fields (such as `observables` and `parameter_values`) are ignored.
**Return type**
[`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")
**circuits** (*Iterable\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") *| EstimatorPubLike]*) – An iterable of circuits to run the noise learner program for. Alternatively, estimator pub-like (primitive unified bloc) objects can be specified, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. In this case, the pub-like objects are converted to a list of circuits, and all the other fields (such as `observables` and `parameter_values`) are ignored.
**Returns**
The submitted job.
**Return type**
[*RuntimeJobV2*](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")
</Function>
</Class>

12
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx
View File

@ -8,11 +8,21 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions
# DynamicalDecouplingOptions
<Class id="qiskit_ibm_runtime.options.DynamicalDecouplingOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/dynamical_decoupling_options.py#L20-L63" signature="DynamicalDecouplingOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.DynamicalDecouplingOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/dynamical_decoupling_options.py#L20-L63" signature="DynamicalDecouplingOptions(enable=Unset, sequence_type=Unset, extra_slack_distribution=Unset, scheduling_method=Unset, skip_reset_qubits=Unset)" modifiers="class">
Bases: `object`
Options for dynamical decoupling (DD).
## Attributes
**Parameters**
* **enable** (*UnsetType | bool*)
* **sequence\_type** (*UnsetType | Literal\['XX', 'XpXm', 'XY4']*)
* **extra\_slack\_distribution** (*UnsetType | Literal\['middle', 'edges']*)
* **scheduling\_method** (*UnsetType | Literal\['alap', 'asap']*)
* **skip\_reset\_qubits** (*UnsetType | bool*)
### enable
<Attribute id="qiskit_ibm_runtime.options.DynamicalDecouplingOptions.enable" attributeTypeHint="UnsetType | bool" attributeValue="Unset">

11
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.mdx
View File

@ -8,11 +8,20 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions
# EnvironmentOptions
<Class id="qiskit_ibm_runtime.options.EnvironmentOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/environment_options.py#L28-L55" signature="EnvironmentOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.EnvironmentOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/environment_options.py#L28-L55" signature="EnvironmentOptions(log_level='WARNING', callback=None, job_tags=None, private=False)" modifiers="class">
Bases: `object`
Options related to the execution environment.
## Attributes
**Parameters**
* **log\_level** (*Literal\['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']*)
* **callback** (*Callable | None*)
* **job\_tags** (*List | None*)
* **private** (*bool | None*)
### callback
<Attribute id="qiskit_ibm_runtime.options.EnvironmentOptions.callback" attributeTypeHint="Callable | None" attributeValue="None">

26
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx
View File

@ -8,11 +8,29 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions
# EstimatorOptions
<Class id="qiskit_ibm_runtime.options.EstimatorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/estimator_options.py#L34-L112" signature="EstimatorOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.EstimatorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/estimator_options.py#L34-L112" signature="EstimatorOptions(_VERSION=2, max_execution_time=Unset, environment=<factory>, simulator=<factory>, default_precision=Unset, default_shots=Unset, resilience_level=Unset, seed_estimator=Unset, dynamical_decoupling=<factory>, resilience=<factory>, execution=<factory>, twirling=<factory>, experimental=Unset)" modifiers="class">
Bases: `OptionsV2`
Options for V2 Estimator.
## Attributes
**Parameters**
* **\_VERSION** (*int*)
* **max\_execution\_time** (*UnsetType | int*)
* **environment** ([*EnvironmentOptions*](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*)
* **simulator** ([*SimulatorOptions*](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*)
* **default\_precision** (*UnsetType | float*)
* **default\_shots** (*UnsetType | int | None*)
* **resilience\_level** (*UnsetType | int*)
* **seed\_estimator** (*UnsetType | int*)
* **dynamical\_decoupling** ([*DynamicalDecouplingOptions*](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.dynamical_decoupling_options.DynamicalDecouplingOptions") *| Dict*)
* **resilience** ([*ResilienceOptionsV2*](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.resilience_options.ResilienceOptionsV2") *| Dict*)
* **execution** ([*ExecutionOptionsV2*](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.execution_options.ExecutionOptionsV2") *| Dict*)
* **twirling** ([*TwirlingOptions*](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.twirling_options.TwirlingOptions") *| Dict*)
* **experimental** (*UnsetType | dict*)
### default\_precision
<Attribute id="qiskit_ibm_runtime.options.EstimatorOptions.default_precision" attributeTypeHint="UnsetType | float" attributeValue="Unset">
@ -112,9 +130,13 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions
<Function id="qiskit_ibm_runtime.options.EstimatorOptions.update" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py#L146-L155" signature="update(**kwargs)">
Update the options.
**Parameters**
**kwargs** (*Any*)
**Return type**
`None`
None
</Function>
</Class>

9
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx
View File

@ -8,11 +8,18 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2
# ExecutionOptionsV2
<Class id="qiskit_ibm_runtime.options.ExecutionOptionsV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/execution_options.py#L20-L34" signature="ExecutionOptionsV2(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.ExecutionOptionsV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/execution_options.py#L20-L34" signature="ExecutionOptionsV2(init_qubits=Unset, rep_delay=Unset)" modifiers="class">
Bases: `object`
Execution options for V2 primitives.
## Attributes
**Parameters**
* **init\_qubits** (*UnsetType | bool*)
* **rep\_delay** (*UnsetType | float*)
### init\_qubits
<Attribute id="qiskit_ibm_runtime.options.ExecutionOptionsV2.init_qubits" attributeTypeHint="UnsetType | bool" attributeValue="Unset">

11
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions
# LayerNoiseLearningOptions
<Class id="qiskit_ibm_runtime.options.LayerNoiseLearningOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/layer_noise_learning_options.py#L28-L108" signature="LayerNoiseLearningOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.LayerNoiseLearningOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/layer_noise_learning_options.py#L28-L108" signature="LayerNoiseLearningOptions(max_layers_to_learn=Unset, shots_per_randomization=Unset, num_randomizations=Unset, layer_pair_depths=Unset)" modifiers="class">
Bases: `object`
Options for learning layer noise. This is only used by V2 Estimator.
<Admonition title="Note" type="note">
@ -27,6 +29,13 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions
## Attributes
**Parameters**
* **max\_layers\_to\_learn** (*UnsetType | int | None*)
* **shots\_per\_randomization** (*UnsetType | int*)
* **num\_randomizations** (*UnsetType | int*)
* **layer\_pair\_depths** (*UnsetType | List\[int]*)
### layer\_pair\_depths
<Attribute id="qiskit_ibm_runtime.options.LayerNoiseLearningOptions.layer_pair_depths" attributeTypeHint="UnsetType | List[int]" attributeValue="Unset">

9
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions
# MeasureNoiseLearningOptions
<Class id="qiskit_ibm_runtime.options.MeasureNoiseLearningOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/measure_noise_learning_options.py#L20-L44" signature="MeasureNoiseLearningOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.MeasureNoiseLearningOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/measure_noise_learning_options.py#L20-L44" signature="MeasureNoiseLearningOptions(num_randomizations=Unset, shots_per_randomization=Unset)" modifiers="class">
Bases: `object`
Options for measurement noise learning. This is only used by V2 Estimator.
<Admonition title="Note" type="note">
@ -17,6 +19,11 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions
## Attributes
**Parameters**
* **num\_randomizations** (*UnsetType | int*)
* **shots\_per\_randomization** (*UnsetType | int | Literal\['auto']*)
### num\_randomizations
<Attribute id="qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.num_randomizations" attributeTypeHint="UnsetType | int" attributeValue="Unset">

23
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions
# NoiseLearnerOptions
<Class id="qiskit_ibm_runtime.options.NoiseLearnerOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/noise_learner_options.py#L25-L124" signature="NoiseLearnerOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.NoiseLearnerOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/noise_learner_options.py#L25-L124" signature="NoiseLearnerOptions(_VERSION=2, max_execution_time=Unset, environment=<factory>, simulator=<factory>, max_layers_to_learn=Unset, shots_per_randomization=Unset, num_randomizations=Unset, layer_pair_depths=Unset, twirling_strategy=Unset, experimental=Unset)" modifiers="class">
Bases: `OptionsV2`
Options for [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner").
<Admonition title="Note" type="note">
@ -23,6 +25,19 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions
## Attributes
**Parameters**
* **\_VERSION** (*int*)
* **max\_execution\_time** (*UnsetType | int*)
* **environment** ([*EnvironmentOptions*](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*)
* **simulator** ([*SimulatorOptions*](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*)
* **max\_layers\_to\_learn** (*UnsetType | int | None*)
* **shots\_per\_randomization** (*UnsetType | int*)
* **num\_randomizations** (*UnsetType | int*)
* **layer\_pair\_depths** (*UnsetType | List\[int]*)
* **twirling\_strategy** (*UnsetType | Literal\['active', 'active-accum', 'active-circuit', 'all']*)
* **experimental** (*UnsetType | dict*)
### environment
<Attribute id="qiskit_ibm_runtime.options.NoiseLearnerOptions.environment" attributeTypeHint="EnvironmentOptions | Dict" attributeValue="FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)" />
@ -108,9 +123,13 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions
<Function id="qiskit_ibm_runtime.options.NoiseLearnerOptions.update" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py#L146-L155" signature="update(**kwargs)">
Update the options.
**Parameters**
**kwargs** (*Any*)
**Return type**
`None`
None
</Function>
</Class>

9
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.mdx
View File

@ -8,11 +8,18 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions
# PecOptions
<Class id="qiskit_ibm_runtime.options.PecOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/pec_options.py#L20-L46" signature="PecOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.PecOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/pec_options.py#L20-L46" signature="PecOptions(max_overhead=Unset, noise_gain=Unset)" modifiers="class">
Bases: `object`
Probabalistic error cancellation mitigation options. This is only used by V2 Estimator.
## Attributes
**Parameters**
* **max\_overhead** (*UnsetType | float | None*)
* **noise\_gain** (*UnsetType | float | Literal\['auto']*)
### max\_overhead
<Attribute id="qiskit_ibm_runtime.options.PecOptions.max_overhead" attributeTypeHint="UnsetType | float | None" attributeValue="Unset">

15
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx
View File

@ -8,11 +8,24 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptionsV2
# ResilienceOptionsV2
<Class id="qiskit_ibm_runtime.options.ResilienceOptionsV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/resilience_options.py#L37-L108" signature="ResilienceOptionsV2(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.ResilienceOptionsV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/resilience_options.py#L37-L108" signature="ResilienceOptionsV2(measure_mitigation=Unset, measure_noise_learning=<factory>, zne_mitigation=Unset, zne=<factory>, pec_mitigation=Unset, pec=<factory>, layer_noise_learning=<factory>, layer_noise_model=Unset)" modifiers="class">
Bases: `object`
Resilience options for V2 Estimator.
## Attributes
**Parameters**
* **measure\_mitigation** (*UnsetType | bool*)
* **measure\_noise\_learning** ([*MeasureNoiseLearningOptions*](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.measure_noise_learning_options.MeasureNoiseLearningOptions") *| Dict*)
* **zne\_mitigation** (*UnsetType | bool*)
* **zne** ([*ZneOptions*](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.zne_options.ZneOptions") *| Dict*)
* **pec\_mitigation** (*UnsetType | bool*)
* **pec** ([*PecOptions*](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.pec_options.PecOptions") *| Dict*)
* **layer\_noise\_learning** ([*LayerNoiseLearningOptions*](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.layer_noise_learning_options.LayerNoiseLearningOptions") *| Dict*)
* **layer\_noise\_model** (*UnsetType | NoiseLearnerResult | Sequence\[*[*LayerError*](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError")*]*)
### layer\_noise\_learning
<Attribute id="qiskit_ibm_runtime.options.ResilienceOptionsV2.layer_noise_learning" attributeTypeHint="LayerNoiseLearningOptions | Dict" attributeValue="FieldInfo(annotation=Union[LayerNoiseLearningOptions, Dict], required=False, default_factory=LayerNoiseLearningOptions)">

10
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx
View File

@ -8,11 +8,19 @@ python_api_name: qiskit_ibm_runtime.options.SamplerExecutionOptionsV2
# SamplerExecutionOptionsV2
<Class id="qiskit_ibm_runtime.options.SamplerExecutionOptionsV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/sampler_execution_options.py#L19-L51" signature="SamplerExecutionOptionsV2(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.SamplerExecutionOptionsV2" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/sampler_execution_options.py#L19-L51" signature="SamplerExecutionOptionsV2(init_qubits=Unset, rep_delay=Unset, meas_type=Unset)" modifiers="class">
Bases: [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.execution_options.ExecutionOptionsV2")
Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive.
## Attributes
**Parameters**
* **init\_qubits** (*UnsetType | bool*)
* **rep\_delay** (*UnsetType | float*)
* **meas\_type** (*UnsetType | Literal\['classified', 'kerneled', 'avg\_kerneled']*)
### init\_qubits
<Attribute id="qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.init_qubits" attributeTypeHint="UnsetType | bool" attributeValue="Unset">

22
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx
View File

@ -8,11 +8,25 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions
# SamplerOptions
<Class id="qiskit_ibm_runtime.options.SamplerOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/sampler_options.py#L27-L57" signature="SamplerOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.SamplerOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/sampler_options.py#L27-L57" signature="SamplerOptions(_VERSION=2, max_execution_time=Unset, environment=<factory>, simulator=<factory>, default_shots=Unset, dynamical_decoupling=<factory>, execution=<factory>, twirling=<factory>, experimental=Unset)" modifiers="class">
Bases: `OptionsV2`
Options for V2 Sampler.
## Attributes
**Parameters**
* **\_VERSION** (*int*)
* **max\_execution\_time** (*UnsetType | int*)
* **environment** ([*EnvironmentOptions*](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*)
* **simulator** ([*SimulatorOptions*](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*)
* **default\_shots** (*UnsetType | int*)
* **dynamical\_decoupling** ([*DynamicalDecouplingOptions*](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.dynamical_decoupling_options.DynamicalDecouplingOptions") *| Dict*)
* **execution** ([*SamplerExecutionOptionsV2*](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.sampler_execution_options.SamplerExecutionOptionsV2") *| Dict*)
* **twirling** ([*TwirlingOptions*](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.twirling_options.TwirlingOptions") *| Dict*)
* **experimental** (*UnsetType | dict*)
### default\_shots
<Attribute id="qiskit_ibm_runtime.options.SamplerOptions.default_shots" attributeTypeHint="UnsetType | int" attributeValue="Unset">
@ -64,9 +78,13 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions
<Function id="qiskit_ibm_runtime.options.SamplerOptions.update" github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py#L146-L155" signature="update(**kwargs)">
Update the options.
**Parameters**
**kwargs** (*Any*)
**Return type**
`None`
None
</Function>
</Class>

15
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx
View File

@ -8,13 +8,22 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions
# SimulatorOptions
<Class id="qiskit_ibm_runtime.options.SimulatorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L33-L113" signature="SimulatorOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.SimulatorOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L33-L113" signature="SimulatorOptions(noise_model=Unset, seed_simulator=Unset, coupling_map=Unset, basis_gates=Unset)" modifiers="class">
Bases: `object`
Simulator options.
For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend.
## Attributes
**Parameters**
* **noise\_model** (*UnsetType | dict | NoiseModel | None*)
* **seed\_simulator** (*UnsetType | int*)
* **coupling\_map** (*UnsetType | List\[List\[int]] |* [*CouplingMap*](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)"))
* **basis\_gates** (*UnsetType | List\[str]*)
### basis\_gates
<Attribute id="qiskit_ibm_runtime.options.SimulatorOptions.basis_gates" attributeTypeHint="UnsetType | List[str]" attributeValue="Unset">
@ -56,7 +65,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions
**Parameters**
**backend** (`Union`\[[`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")]) – backend to be set.
**backend** ([*BackendV1*](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)") *|*[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")) – backend to be set.
**Raises**
@ -64,7 +73,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions
**Return type**
`None`
None
</Function>
</Class>

12
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx
View File

@ -8,11 +8,21 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions
# TwirlingOptions
<Class id="qiskit_ibm_runtime.options.TwirlingOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/twirling_options.py#L28-L99" signature="TwirlingOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.TwirlingOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/twirling_options.py#L28-L99" signature="TwirlingOptions(enable_gates=Unset, enable_measure=Unset, num_randomizations=Unset, shots_per_randomization=Unset, strategy=Unset)" modifiers="class">
Bases: `object`
Twirling options.
## Attributes
**Parameters**
* **enable\_gates** (*UnsetType | bool*)
* **enable\_measure** (*UnsetType | bool*)
* **num\_randomizations** (*UnsetType | int | Literal\['auto']*)
* **shots\_per\_randomization** (*UnsetType | int | Literal\['auto']*)
* **strategy** (*UnsetType | Literal\['active', 'active-accum', 'active-circuit', 'all']*)
### enable\_gates
<Attribute id="qiskit_ibm_runtime.options.TwirlingOptions.enable_gates" attributeTypeHint="UnsetType | bool" attributeValue="Unset">

12
docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx
View File

@ -8,7 +8,9 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions
# ZneOptions
<Class id="qiskit_ibm_runtime.options.ZneOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/zne_options.py#L36-L188" signature="ZneOptions(*args, **kwargs)" modifiers="class">
<Class id="qiskit_ibm_runtime.options.ZneOptions" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/zne_options.py#L36-L188" signature="ZneOptions(amplifier=Unset, noise_factors=Unset, extrapolator=Unset, extrapolated_noise_factors=Unset)" modifiers="class">
Bases: `object`
Zero noise extrapolation mitigation options. This is only used by the V2 Estimator.
<Admonition title="Note" type="note">
@ -27,7 +29,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions
**Parameters**
* **amplifier** –
* **amplifier** (*UnsetType | Literal\['gate\_folding', 'gate\_folding\_front', 'gate\_folding\_back', 'pea']*) –
Which technique to use for amplifying noise. One of:
@ -43,11 +45,11 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions
In this technique, the twirled noise model of each each unique layer of entangling gates in your ISA circuits is learned beforehand, see [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for relevant learning options. Once complete, your circuits are executed at each noise factor, where every entangling layer of your circuits is amplified by probabilistically injecting single-qubit noise proportional to the corresponding learned noise model.
* **noise\_factors** – Noise factors to use for noise amplification. Default: `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise.
* **noise\_factors** (*UnsetType | Sequence\[float]*) – Noise factors to use for noise amplification. Default: `(1, 1.5, 2)` for PEA, and `(1, 3, 5)` otherwise.
* **extrapolated\_noise\_factors** – Noise factors to evaluate the fit extrapolation models at. If unset, this will default to `[0, *noise_factors]`. This option does not affect execution or model fitting in any way, it only determines the points at which the `extrapolator`s are evaluated to be returned in the data fields called `evs_extrapolated` and `stds_extrapolated`.
* **extrapolated\_noise\_factors** (*UnsetType | Sequence\[float]*) – Noise factors to evaluate the fit extrapolation models at. If unset, this will default to `[0, *noise_factors]`. This option does not affect execution or model fitting in any way, it only determines the points at which the `extrapolator`s are evaluated to be returned in the data fields called `evs_extrapolated` and `stds_extrapolated`.
* **extrapolator** –
* **extrapolator** (*UnsetType | Literal\['linear', 'exponential', 'double\_exponential', 'polynomial\_degree\_1', 'polynomial\_degree\_2', 'polynomial\_degree\_3', 'polynomial\_degree\_4', 'polynomial\_degree\_5', 'polynomial\_degree\_6', 'polynomial\_degree\_7', 'fallback'] | \~typing.Sequence\[\~typing.Literal\['linear', 'exponential', 'double\_exponential', 'polynomial\_degree\_1', 'polynomial\_degree\_2', 'polynomial\_degree\_3', 'polynomial\_degree\_4', 'polynomial\_degree\_5', 'polynomial\_degree\_6', 'polynomial\_degree\_7', 'fallback']]*) –
Extrapolator(s) to try (in order) for extrapolating to zero noise. The available options are:

Some files were not shown because too many files have changed in this diff Show More