diff --git a/docs/api/qiskit-ibm-runtime/0.31/_package.json b/docs/api/qiskit-ibm-runtime/0.31/_package.json new file mode 100644 index 00000000000..becbcc5520c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/_package.json @@ -0,0 +1,4 @@ +{ + "name": "qiskit-ibm-runtime", + "version": "0.31.0" +} diff --git a/docs/api/qiskit-ibm-runtime/0.31/_toc.json b/docs/api/qiskit-ibm-runtime/0.31/_toc.json new file mode 100644 index 00000000000..aacef710182 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/_toc.json @@ -0,0 +1,517 @@ +{ + "title": "Qiskit Runtime client", + "children": [ + { + "title": "API index", + "url": "/api/qiskit-ibm-runtime/0.31" + }, + { + "title": "qiskit_ibm_runtime", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/runtime_service" + }, + { + "title": "Batch", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Batch" + }, + { + "title": "Estimator", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Estimator" + }, + { + "title": "EstimatorV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.EstimatorV2" + }, + { + "title": "IBMBackend", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.IBMBackend" + }, + { + "title": "QiskitRuntimeService", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.QiskitRuntimeService" + }, + { + "title": "RuntimeDecoder", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeDecoder" + }, + { + "title": "RuntimeEncoder", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeEncoder" + }, + { + "title": "RuntimeJob", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeJob" + }, + { + "title": "RuntimeJobV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeJobV2" + }, + { + "title": "Sampler", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Sampler" + }, + { + "title": "SamplerV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.SamplerV2" + }, + { + "title": "Session", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Session" + } + ] + }, + { + "title": "qiskit_ibm_runtime.debug_tools", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/debug_tools" + }, + { + "title": "Neat", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.Neat" + }, + { + "title": "NeatPubResult", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.NeatPubResult" + }, + { + "title": "NeatResult", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.NeatResult" + } + ] + }, + { + "title": "qiskit_ibm_runtime.execution_span", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/execution_span" + }, + { + "title": "ExecutionSpan", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ExecutionSpan" + }, + { + "title": "ExecutionSpans", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ExecutionSpans" + }, + { + "title": "ShapeType", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ShapeType" + }, + { + "title": "SliceSpan", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.SliceSpan" + } + ] + }, + { + "title": "qiskit_ibm_runtime.fake_provider", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/fake_provider" + }, + { + "title": "FakeAlgiers", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAlgiers" + }, + { + "title": "FakeAlmadenV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2" + }, + { + "title": "FakeArmonkV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeArmonkV2" + }, + { + "title": "FakeAthensV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAthensV2" + }, + { + "title": "FakeAuckland", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAuckland" + }, + { + "title": "FakeBelemV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBelemV2" + }, + { + "title": "FakeBoeblingenV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2" + }, + { + "title": "FakeBogotaV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBogotaV2" + }, + { + "title": "FakeBrisbane", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBrisbane" + }, + { + "title": "FakeBrooklynV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2" + }, + { + "title": "FakeBurlingtonV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2" + }, + { + "title": "FakeCairoV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCairoV2" + }, + { + "title": "FakeCambridgeV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2" + }, + { + "title": "FakeCasablancaV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2" + }, + { + "title": "FakeCusco", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCusco" + }, + { + "title": "FakeEssexV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeEssexV2" + }, + { + "title": "FakeFractionalBackend", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend" + }, + { + "title": "FakeGeneva", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeGeneva" + }, + { + "title": "FakeGuadalupeV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2" + }, + { + "title": "FakeHanoiV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeHanoiV2" + }, + { + "title": "FakeJakartaV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeJakartaV2" + }, + { + "title": "FakeJohannesburgV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2" + }, + { + "title": "FakeKawasaki", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKawasaki" + }, + { + "title": "FakeKolkataV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKolkataV2" + }, + { + "title": "FakeKyiv", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKyiv" + }, + { + "title": "FakeKyoto", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKyoto" + }, + { + "title": "FakeLagosV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLagosV2" + }, + { + "title": "FakeLimaV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLimaV2" + }, + { + "title": "FakeLondonV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLondonV2" + }, + { + "title": "FakeManhattanV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeManhattanV2" + }, + { + "title": "FakeManilaV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeManilaV2" + }, + { + "title": "FakeMelbourneV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2" + }, + { + "title": "FakeMontrealV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMontrealV2" + }, + { + "title": "FakeMumbaiV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2" + }, + { + "title": "FakeNairobiV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeNairobiV2" + }, + { + "title": "FakeOsaka", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOsaka" + }, + { + "title": "FakeOslo", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOslo" + }, + { + "title": "FakeOurenseV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOurenseV2" + }, + { + "title": "FakeParisV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeParisV2" + }, + { + "title": "FakePeekskill", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePeekskill" + }, + { + "title": "FakePerth", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePerth" + }, + { + "title": "FakePoughkeepsieV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2" + }, + { + "title": "FakePrague", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePrague" + }, + { + "title": "FakeProviderForBackendV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2" + }, + { + "title": "FakeQuebec", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeQuebec" + }, + { + "title": "FakeQuitoV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeQuitoV2" + }, + { + "title": "FakeRochesterV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeRochesterV2" + }, + { + "title": "FakeRomeV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeRomeV2" + }, + { + "title": "FakeSantiagoV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2" + }, + { + "title": "FakeSherbrooke", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSherbrooke" + }, + { + "title": "FakeSingaporeV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2" + }, + { + "title": "FakeSydneyV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSydneyV2" + }, + { + "title": "FakeTorino", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeTorino" + }, + { + "title": "FakeTorontoV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeTorontoV2" + }, + { + "title": "FakeValenciaV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeValenciaV2" + }, + { + "title": "FakeVigoV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeVigoV2" + }, + { + "title": "FakeWashingtonV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2" + }, + { + "title": "FakeYorktownV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeYorktownV2" + } + ] + }, + { + "title": "qiskit_ibm_runtime.noise_learner", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/noise_learner" + }, + { + "title": "NoiseLearner", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.noise_learner.NoiseLearner" + } + ] + }, + { + "title": "qiskit_ibm_runtime.options", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/options" + }, + { + "title": "DynamicalDecouplingOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.DynamicalDecouplingOptions" + }, + { + "title": "EnvironmentOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.EnvironmentOptions" + }, + { + "title": "EstimatorOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.EstimatorOptions" + }, + { + "title": "ExecutionOptionsV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ExecutionOptionsV2" + }, + { + "title": "LayerNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.LayerNoiseLearningOptions" + }, + { + "title": "MeasureNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions" + }, + { + "title": "NoiseLearnerOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.NoiseLearnerOptions" + }, + { + "title": "PecOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.PecOptions" + }, + { + "title": "ResilienceOptionsV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ResilienceOptionsV2" + }, + { + "title": "SamplerExecutionOptionsV2", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2" + }, + { + "title": "SamplerOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SamplerOptions" + }, + { + "title": "SimulatorOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SimulatorOptions" + }, + { + "title": "TwirlingOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.TwirlingOptions" + }, + { + "title": "ZneOptions", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ZneOptions" + } + ] + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/transpiler" + }, + { + "title": "ConvertIdToDelay", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay" + }, + { + "title": "ConvertISAToClifford", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford" + } + ] + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes.scheduling", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling" + }, + { + "title": "ALAPScheduleAnalysis", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis" + }, + { + "title": "ASAPScheduleAnalysis", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis" + }, + { + "title": "BlockBasePadder", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder" + }, + { + "title": "DynamicCircuitInstructionDurations", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations" + }, + { + "title": "PadDelay", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay" + }, + { + "title": "PadDynamicalDecoupling", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling" + } + ] + }, + { + "title": "qiskit_ibm_runtime.utils.noise_learner_result", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/noise_learner_result" + }, + { + "title": "LayerError", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.utils.noise_learner_result.LayerError" + }, + { + "title": "PauliLindbladError", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError" + } + ] + }, + { + "title": "qiskit_ibm_runtime.visualization", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.31/visualization" + }, + { + "title": "draw_layer_error_map", + "url": "/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.visualization.draw_layer_error_map" + } + ] + }, + { + "title": "Release notes", + "url": "/api/qiskit-ibm-runtime/release-notes" + } + ], + "collapsed": true +} + diff --git a/docs/api/qiskit-ibm-runtime/0.31/debug_tools.mdx b/docs/api/qiskit-ibm-runtime/0.31/debug_tools.mdx new file mode 100644 index 00000000000..9bfae74d34d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/debug_tools.mdx @@ -0,0 +1,26 @@ +--- +title: debug_tools +description: API reference for qiskit_ibm_runtime.debug_tools +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.debug_tools +--- + + + + + +# Debugging tools + +`qiskit_ibm_runtime.debug_tools` + +The tools for debugging and analyzing qiskit-ibm-runtime jobs. + +## Classes + +| | | +| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`Neat`](qiskit_ibm_runtime.debug_tools.Neat "qiskit_ibm_runtime.debug_tools.Neat")(backend\[, noise\_model]) | A class to help understand the expected performance of estimator jobs. | +| [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.NeatResult")(pub\_results) | A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. | +| [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult")(vals) | A class to store the PUB results of `Neat`. | + diff --git a/docs/api/qiskit-ibm-runtime/0.31/execution_span.mdx b/docs/api/qiskit-ibm-runtime/0.31/execution_span.mdx new file mode 100644 index 00000000000..9d0cf9f8970 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/execution_span.mdx @@ -0,0 +1,29 @@ +--- +title: execution_span +description: API reference for qiskit_ibm_runtime.execution_span +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.execution_span +--- + + + + + +# Execution Spans + +`qiskit_ibm_runtime.execution_span` + +## Overview + +An [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") class instance is an iterable of [`ExecutionSpan`](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan")s, where each iterand gives timing information about a chunk of data. Execution spans are returned as part of the metadata of a primitive job result. + +## Classes + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`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. | + diff --git a/docs/api/qiskit-ibm-runtime/0.31/fake_provider.mdx b/docs/api/qiskit-ibm-runtime/0.31/fake_provider.mdx new file mode 100644 index 00000000000..a2555db839c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/fake_provider.mdx @@ -0,0 +1,150 @@ +--- +title: fake_provider +description: API reference for qiskit_ibm_runtime.fake_provider +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.fake_provider +--- + + + + + +# Fake Provider + +`qiskit_ibm_runtime.fake_provider` + +## Overview + +The fake provider module contains fake providers and fake backends classes. The fake backends are built to mimic the behaviors of IBM Quantum systems using system snapshots. The system snapshots contain important information about the quantum system such as coupling map, basis gates, qubit properties (T1, T2, error rate, etc.) which are useful for testing the transpiler and performing noisy simulations of the system. + +## Example Usage + +Here is an example of using a fake backend for transpilation and simulation. + +```python +from qiskit import QuantumCircuit +from qiskit import transpile +from qiskit.visualization import plot_histogram +from qiskit_ibm_runtime import SamplerV2 +from qiskit_ibm_runtime.fake_provider import FakeManilaV2 + +# Get a fake backend from the fake provider +backend = FakeManilaV2() + +# Create a simple circuit +circuit = QuantumCircuit(3) +circuit.h(0) +circuit.cx(0,1) +circuit.cx(0,2) +circuit.measure_all() +circuit.draw('mpl', style="iqp") + +# Transpile the ideal circuit to a circuit that can be directly executed by the backend +transpiled_circuit = transpile(circuit, backend) +transpiled_circuit.draw('mpl', style="iqp") + +# Run the transpiled circuit using the simulated fake backend +sampler = SamplerV2(backend) +job = sampler.run([transpiled_circuit]) +pub_result = job.result()[0] +counts = pub_result.data.meas.get_counts() +plot_histogram(counts) +``` + +![../\_images/fake\_provider-1\_00.png](/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_00.png) + +![../\_images/fake\_provider-1\_01.png](/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_01.png) + +![../\_images/fake\_provider-1\_02.png](/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_02.png) + + + Please note that the simulation is done using a noise model generated from system snapshots obtained in the past (sometimes a few years ago) and the results are not representative of the latest behaviours of the real quantum system which the fake backend is mimicking. If you want to run noisy simulations to compare with the real quantum system, you should use the `qiskit_aer` library. After installation, you can follow the steps below to generate a simulator that mimics a real quantum system with the latest calibration results. + + ```python + from qiskit_ibm_runtime import QiskitRuntimeService + from qiskit_aer import AerSimulator + + # get a real backend from the runtime service + service = QiskitRuntimeService() + backend = service.backend('ibmq_manila') + + # generate a simulator that mimics the real quantum system with the latest calibration results + backend_sim = AerSimulator.from_backend(backend) + ``` + + +## Fake Providers + +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. | + +## Fake Backends + +### Fake V2 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. | + diff --git a/docs/api/qiskit-ibm-runtime/0.31/index.mdx b/docs/api/qiskit-ibm-runtime/0.31/index.mdx new file mode 100644 index 00000000000..1a96e625b79 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/index.mdx @@ -0,0 +1,18 @@ +--- +title: Qiskit Runtime Client API Docs +description: API documentation for the qiskit-ibm-runtime client +--- + +# qiskit-ibm-runtime API reference + +* [Qiskit Runtime (`qiskit_ibm_runtime`)](runtime_service) +* [Noise learner (`qiskit_ibm_runtime.noise_learner.NoiseLearner`)](noise_learner) +* [NoiseLearner result classes (`qiskit_ibm_runtime.utils.noise_learner_result`)](noise_learner_result) +* [Primitive options (`qiskit_ibm_runtime.options`)](options) +* [Transpiler passes (`qiskit_ibm_runtime.transpiler.passes`)](transpiler) +* [Transpiler scheduling passes (`qiskit_ibm_runtime.transpiler.passes.scheduling`)](qiskit_ibm_runtime.transpiler.passes.scheduling) +* [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider) +* [Execution Spans (`qiskit_ibm_runtime.execution_span`)](execution_span) +* [Debugging tools (`qiskit_ibm_runtime.debug_tools`)](debug_tools) +* [Visualization (`qiskit_ibm_runtime.visualization`)](visualization) + diff --git a/docs/api/qiskit-ibm-runtime/0.31/noise_learner.mdx b/docs/api/qiskit-ibm-runtime/0.31/noise_learner.mdx new file mode 100644 index 00000000000..fd91bfc9cd4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/noise_learner.mdx @@ -0,0 +1,24 @@ +--- +title: noise_learner +description: API reference for qiskit_ibm_runtime.noise_learner +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.noise_learner +--- + + + + + +# Noise learner + +`qiskit_ibm_runtime.noise_learner.NoiseLearner` + +The tools to characterize the noise processes affecting the gates in noisy quantum circuits. + +## Classes + +| | | +| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner")(\[mode, options]) | Class for executing noise learning experiments. | + diff --git a/docs/api/qiskit-ibm-runtime/0.31/noise_learner_result.mdx b/docs/api/qiskit-ibm-runtime/0.31/noise_learner_result.mdx new file mode 100644 index 00000000000..277fbade34b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/noise_learner_result.mdx @@ -0,0 +1,21 @@ +--- +title: noise_learner_result +description: API reference for qiskit_ibm_runtime.utils.noise_learner_result +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.utils.noise_learner_result +--- + + + + + +# NoiseLearner result classes + +`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. | + diff --git a/docs/api/qiskit-ibm-runtime/0.31/options.mdx b/docs/api/qiskit-ibm-runtime/0.31/options.mdx new file mode 100644 index 00000000000..bc56ae4cf27 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/options.mdx @@ -0,0 +1,74 @@ +--- +title: options +description: API reference for qiskit_ibm_runtime.options +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.options +--- + + + + + +# Primitive options + +`qiskit_ibm_runtime.options` + +Options that can be passed to the Qiskit Runtime primitives. + +## V2 Primitives + +`SamplerV2` and `EstimatorV2` each have their own options. You can use the `options` attribute to set the options. For example: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) +estimator = EstimatorV2(mode=backend) +estimator.options.resilience_level = 1 +``` + +You can also use the `update()` method to do bulk update. For example: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) +estimator = EstimatorV2(mode=backend) +estimator.options.update(resilience_level=1) +``` + +Refer to [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions") and [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions") for V2 Sampler and V2 Estimator options, respectively. + + + If an option is not specified, the server default value is used. The default values are subject to change. Refer to this current module’s documentation for the latest defaults. + + +## Classes + +### 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. | + +### 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. | + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Batch.mdx new file mode 100644 index 00000000000..99cc487da48 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Batch.mdx @@ -0,0 +1,232 @@ +--- +title: Batch +description: API reference for qiskit_ibm_runtime.Batch +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.Batch +--- + +# Batch + + + Class for running jobs in batch execution mode. + + The `batch` mode is designed to efficiently perform experiments that comprise multiple independent jobs. + + **Using the `batch` mode provides the following benefits:** + + * The jobs’ classical computation, such as compilation, is run in parallel. Thus, running multiple jobs in a batch is significantly faster than running them serially. + * There is usually minimal delay between job, which can help avoid drift. + * If you partition your workload into multiple jobs and run them in `batch` mode, you can get results from individual jobs, which makes them more flexible to work with. For example, if a job’s results do not meet your expectations, you can cancel the remaining jobs, or simply re-submit that individual job and avoid re-running the entire workload. + + Batch mode can shorten processing time if all jobs are provided at the outset. If you want to submit iterative jobs, use `session` mode instead. + + You can open a Qiskit Runtime batch by using this `Batch` class, then submit jobs to one or more primitives. + + For example: + + ```python + import numpy as np + from qiskit.circuit.library import IQP + from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + from qiskit.quantum_info import random_hermitian + from qiskit_ibm_runtime import QiskitRuntimeService, SamplerV2 as Sampler, Batch + + n_qubits = 127 + + service = QiskitRuntimeService() + backend = service.least_busy(operational=True, simulator=False, min_num_qubits=n_qubits) + + rng = np.random.default_rng() + mats = [np.real(random_hermitian(n_qubits, seed=rng)) for _ in range(30)] + circuits = [IQP(mat) for mat in mats] + for circuit in circuits: + circuit.measure_all() + + pm = generate_preset_pass_manager(backend=backend, optimization_level=1) + isa_circuits = pm.run(circuits) + + max_circuits = 10 + all_partitioned_circuits = [] + for i in range(0, len(isa_circuits), max_circuits): + all_partitioned_circuits.append(isa_circuits[i : i + max_circuits]) + jobs = [] + start_idx = 0 + + with Batch(backend=backend): + sampler = Sampler() + for partitioned_circuits in all_partitioned_circuits: + job = sampler.run(partitioned_circuits) + jobs.append(job) + ``` + + For more details, check the “[Run jobs in a batch](/guides/run-jobs-batch)” page. + + Batch constructor. + + **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). + + **Raises** + + **ValueError** – If an input value is invalid. + + ## Attributes + + ### 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. + + + ### session\_id + + + Return the session ID. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Session ID. None if the backend is a simulator. + + + ## Methods + + ### backend + + + Return backend for this session. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Backend for this session. None if unknown. + + + ### cancel + + + Cancel all pending jobs in a session. + + **Return type** + + `None` + + + ### 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` + + + ### details + + + Return session details. + + **Return type** + + `Optional`\[`Dict`\[`str`, `Any`]] + + **Returns** + + A dictionary with the sessions details. + + * `id`: id of the session. + * `backend_name`: backend used for the session. + * `interactive_timeout`: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated. + * `max_time`: Maximum allowed time (in seconds) for the session, subject to plan limits. + * `active_timeout`: The maximum time (in seconds) a session can stay active. + * `state`: State of the session - open, active, inactive, or closed. + * `accepting_jobs`: Whether or not the session is accepting jobs. + * `last_job_started`: Timestamp of when the last job in the session started. + * `last_job_completed`: Timestamp of when the last job in the session completed. + * `started_at`: Timestamp of when the session was started. + * `closed_at`: Timestamp of when the session was closed. + * `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. + + + ### from\_id + + + 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. + + * **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – + + instance of the `QiskitRuntimeService` class. + + **Raises:** + + 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` + + + ### status + + + Return current session status. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Session status as a string. + + * `Pending`: Session is created but not active. It will become active when the next job of this session is dequeued. + * `In progress, accepting new jobs`: session is active and accepting new jobs. + * `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. + + + ### 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. + + Batch usage is the amount of time all jobs spend on the QPU. + + **Return type** + + `Optional`\[`float`] + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Estimator.mdx new file mode 100644 index 00000000000..0ff89fcbd70 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Estimator.mdx @@ -0,0 +1,14 @@ +--- +title: Estimator +description: API reference for qiskit_ibm_runtime.Estimator +in_page_toc_min_heading_level: 1 +python_api_type: attribute +python_api_name: qiskit_ibm_runtime.Estimator +--- + +# Estimator + + + alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2") + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.EstimatorV2.mdx new file mode 100644 index 00000000000..997a7f76fcd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.EstimatorV2.mdx @@ -0,0 +1,127 @@ +--- +title: EstimatorV2 +description: API reference for qiskit_ibm_runtime.EstimatorV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.EstimatorV2 +--- + +# EstimatorV2 + + + Class for interacting with Qiskit Runtime Estimator primitive service. + + Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. + + The [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. + + Following construction, an estimator is used by calling its [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") method with a list of PUBs (Primitive Unified Blocs). Each PUB contains four values that, together, define a computation unit of work for the estimator to complete: + + * a single [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), possibly parametrized, whose final state we define as $\psi(\theta)$, + * one or more observables (specified as any `ObservablesArrayLike`, including `Pauli`, `SparsePauliOp`, `str`) that specify which expectation values to estimate, denoted $H_j$, and + * a collection parameter value sets to bind the circuit against, $\theta_k$. + * an optional target precision for expectation value estimates. + + Here is an example of how the estimator is used. + + ```python + from qiskit.circuit.library import RealAmplitudes + from qiskit.quantum_info import SparsePauliOp + from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 as Estimator + + service = QiskitRuntimeService() + backend = service.least_busy(operational=True, simulator=False) + + psi = RealAmplitudes(num_qubits=2, reps=2) + hamiltonian = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) + theta = [0, 1, 1, 2, 3, 5] + + pm = generate_preset_pass_manager(backend=backend, optimization_level=1) + isa_psi = pm.run(psi) + isa_observables = hamiltonian.apply_layout(isa_psi.layout) + + estimator = Estimator(mode=backend) + + # calculate [ ] + job = estimator.run([(isa_psi, isa_observables, [theta])]) + pub_result = job.result()[0] + print(f"Expectation values: {pub_result.data.evs}") + ``` + + Initializes the Estimator primitive. + + **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`]) – + + The execution mode used to make the primitive query. It can be: + + * A `Backend` if you are using job mode. + * A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode. + * A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode. + + 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. + + **Raises** + + **NotImplementedError** – If “q-ctrl” channel strategy is used. + + ## Attributes + + ### 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. + + + ### options + + + Return options + + **Return type** + + `TypeVar`(`OptionsT`, bound= `BaseOptions`) + + + ### version + + + + ## Methods + + ### run + + + Submit a request to the estimator primitive. + + **Parameters** + + * **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. + + **Raises** + + **ValueError** – if precision value is not strictly greater than 0. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.IBMBackend.mdx new file mode 100644 index 00000000000..25ce5498e74 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.IBMBackend.mdx @@ -0,0 +1,701 @@ +--- +title: IBMBackend +description: API reference for qiskit_ibm_runtime.IBMBackend +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.IBMBackend +--- + +# IBMBackend + + + Backend class interfacing with an IBM Quantum backend. + + + * You should not instantiate the `IBMBackend` class directly. Instead, use the methods provided by an [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") instance to retrieve and handle backends. + + + This class represents an IBM Quantum backend. Its attributes and methods provide information about the backend. For example, the [`status()`](#qiskit_ibm_runtime.IBMBackend.status "qiskit_ibm_runtime.IBMBackend.status") method returns a `BackendStatus` instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: + + ```python + status = backend.status() + is_operational = status.operational + jobs_in_queue = status.pending_jobs + ``` + + Here is list of attributes available on the `IBMBackend` class: + + > * name: backend name. + > + > * backend\_version: backend version in the form X.Y.Z. + > + > * num\_qubits: number of qubits. + > + > * target: A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + > + > * basis\_gates: list of basis gates names on the backend. + > + > * gates: list of basis gates on the backend. + > + > * local: backend is local or remote. + > + > * simulator: backend is a simulator. + > + > * conditional: backend supports conditional operations. + > + > * open\_pulse: backend supports open pulse. + > + > * memory: backend supports memory. + > + > * max\_shots: maximum number of shots supported. + > + > * coupling\_map (list): The coupling map for the device + > + > * supported\_instructions (List\[str]): Instructions supported by the backend. + > + > * dynamic\_reprate\_enabled (bool): whether delay between primitives can be set dynamically (ie via `rep_delay`). Defaults to False. + > + > * rep\_delay\_range (List\[float]): 2d list defining supported range of repetition delays for backend in μs. First entry is lower end of the range, second entry is higher end of the range. Optional, but will be specified when `dynamic_reprate_enabled=True`. + > + > * default\_rep\_delay (float): Value of `rep_delay` if not specified by user and `dynamic_reprate_enabled=True`. + > + > * n\_uchannels: Number of u-channels. + > + > * u\_channel\_lo: U-channel relationship on device los. + > + > * meas\_levels: Supported measurement levels. + > + > * qubit\_lo\_range: Qubit lo ranges for each qubit with form (min, max) in GHz. + > + > * meas\_lo\_range: Measurement lo ranges for each qubit with form (min, max) in GHz. + > + > * dt: Qubit drive channel timestep in nanoseconds. + > + > * dtm: Measurement drive channel timestep in nanoseconds. + > + > * rep\_times: Supported repetition times (program execution time) for backend in μs. + > + > * meas\_kernels: Supported measurement kernels. + > + > * discriminators: Supported discriminators. + > + > * hamiltonian: An optional dictionary with fields characterizing the system hamiltonian. + > + > * channel\_bandwidth (list): Bandwidth of all channels (qubit, measurement, and U) + > + > * acquisition\_latency (list): Array of dimension n\_qubits x n\_registers. Latency (in units of dt) to write a measurement result from qubit n into register slot m. + > + > * conditional\_latency (list): Array of dimension n\_channels \[d->u->m] x n\_registers. Latency (in units of dt) to do a conditional operation on channel n from register slot m + > + > * meas\_map (list): Grouping of measurement which are multiplexed + > + > * max\_circuits (int): The maximum number of experiments per job + > + > * sample\_name (str): Sample name for the backend + > + > * n\_registers (int): Number of register slots available for feedback (if conditional is True) + > + > * register\_map (list): An array of dimension n\_qubits X n\_registers that specifies whether a qubit can store a measurement in a certain register slot. + > + > * configurable (bool): True if the backend is configurable, if the backend is a simulator + > + > * credits\_required (bool): True if backend requires credits to run a job. + > + > * online\_date (datetime): The date that the device went online + > + > * display\_name (str): Alternate name field for the backend + > + > * description (str): A description for the backend + > + > * tags (list): A list of string tags to describe the backend + > + > * version: version of `Backend` class (Ex: 1, 2) + > + > * channels: An optional dictionary containing information of each channel – their purpose, type, and qubits operated on. + > + > * parametric\_pulses (list): A list of pulse shapes which are supported on the backend. For example: `['gaussian', 'constant']` + > + > * processor\_type (dict): Processor type for this backend. A dictionary of the form `{"family": , "revision": , segment: }` such as `{"family": "Canary", "revision": "1.0", segment: "A"}`. + > + > > * family: Processor family of this backend. + > > * revision: Revision version of this processor. + > > * segment: Segment this processor belongs to within a larger chip. + + IBMBackend constructor. + + **Parameters** + + * **configuration** (`Union`\[`QasmBackendConfiguration`, `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. + + ## Attributes + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Returns** + + The output signal timestep in seconds. + + **Return type** + + dtm + + + ### id\_warning\_issued + + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + 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` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The grouping of measurements which are multiplexed + + **Return type** + + meas\_map + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.IBMBackend.run "qiskit_ibm_runtime.IBMBackend.run") method. + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### service + + + Return the `service` object + + **Returns** + + instance of QiskitRuntimeService + + **Return type** + + service + + + ### session + + + Return session + + **Return type** + + `Session` + + + ### 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 + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### \_\_call\_\_ + + + Call self as a function. + + **Return type** + + [`IBMBackend`](#qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend") + + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### cancel\_session + + + Cancel session. All pending jobs will be cancelled. + + **Return type** + + `None` + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### close\_session + + + Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + Backend configuration contains fixed information about the backend, such as its name, number of qubits, basis gates, coupling map, quantum volume, etc. + + The schema for backend configuration can be found in [Qiskit/ibm-quantum-schemas/backend\_configuration](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json). + + More details about backend configuration properties can be found here [QasmBackendConfiguration](/api/qiskit/qiskit.providers.models.QasmBackendConfiguration). + + **IBM backends may also include the following properties:** + + * **`supported_features`: a list of strings of supported features like “qasm3” for dynamic** + + circuits support. + + * **`parallel_compilation`: a boolean of whether or not the backend can process multiple** + + jobs at once. Parts of the classical computation will be parallelized. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + **Returns** + + The configuration for the backend. + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend. + + The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas/default\_pulse\_configuration](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json). + + **Parameters** + + **refresh** (`bool`) – If `True`, re-query the server for the backend pulse defaults. Otherwise, return a cached version. + + **Return type** + + `Optional`\[`PulseDefaults`] + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### get\_translation\_stage\_plugin + + + Return the default translation stage plugin name for IBM backends. + + **Return type** + + `str` + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### open\_session + + + Open session + + **Return type** + + `Session` + + + ### properties + + + Return the backend properties, subject to optional filtering. + + This data describes qubits properties (such as T1 and T2), gates properties (such as gate length and error), and other general properties of the backend. + + The schema for backend properties can be found in [Qiskit/ibm-quantum-schemas/backend\_properties](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_properties_schema.json). + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version. + * **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the `BackendProperties` 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`] + + **Returns** + + The backend properties or `None` if the backend properties are not currently available. + + **Raises** + + * **TypeError** – If an input argument is not of the correct type. + * **NotImplementedError** – If datetime is specified when cloud runtime is used. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### run + + + Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. + + **Parameters** + + * **circuits** (`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `str`, `List`\[`Union`\[[`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) + + * **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call. + + * **init\_circuit** (`Optional`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.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\_num\_resets** (`Optional`\[`int`]) – 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. + + * **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. + + * **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. + + * **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) – + + Level of the measurement output for pulse experiments. See [OpenPulse specification](https://arxiv.org/pdf/1809.03452.pdf) for details: + + * `0`, measurements of the raw signal (the measurement output pulse envelope) + * `1`, measurement kernel is selected (a complex number obtained after applying the measurement kernel to the measurement output signal) + * `2` (default), a discriminator is selected and the qubit state is stored (0 or 1) + + This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **meas\_return** (`Union`\[`str`, `MeasReturnType`, `None`]) – + + Level of measurement data for the backend to return. For `meas_level` 0 and 1: + + * `single` returns information from every shot. + * `avg` returns average measurement output (averaged over number of shots). + + 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. + + * **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. + + * **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. + + * **noise\_model** (`Optional`\[`Any`]) – 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. + + * **\*\*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") + + **Returns** + + The job to be executed. + + **Raises** + + * **IBMBackendApiError** – If an unexpected error occurred while submitting the job. + + * **IBMBackendApiProtocolError** – If an unexpected value received from the server. + + * **IBMBackendValueError** – + + * If an input parameter value is not valid. - If ESP readout is used and the backend does not support this. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + + If the returned `BackendStatus` instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them. + + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + **Raises** + + **IBMBackendApiProtocolError** – If the status for the backend cannot be formatted properly. + + + ### target\_history + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") + + **Returns** + + Target with properties found on datetime + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.QiskitRuntimeService.mdx new file mode 100644 index 00000000000..454df61c788 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -0,0 +1,391 @@ +--- +title: QiskitRuntimeService +description: API reference for qiskit_ibm_runtime.QiskitRuntimeService +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.QiskitRuntimeService +--- + +# QiskitRuntimeService + + + Class for interacting with the Qiskit Runtime service. + + QiskitRuntimeService constructor + + An account is selected in the following order: + + > * Account with the input name, if specified. + > * Default account for the channel type, if channel is specified but token is not. + > * Account defined by the input channel and token, if specified. + > * Account defined by the default\_channel if defined in filename + > * Account defined by the environment variables, if defined. + > * Default account for the `ibm_cloud` account, if one is available. + > * Default account for the `ibm_quantum` account, if one is available. + + instance, proxies, and verify can be used to overwrite corresponding values in the loaded account. + + **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. + * **channel\_strategy** (`Optional`\[`str`]) – (DEPRECATED) Error mitigation strategy. + * **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. + + **Returns** + + An instance of QiskitRuntimeService or QiskitRuntimeLocalService for local channel. + + **Raises** + + **IBMInputValueError** – If an input is invalid. + + ## Attributes + + ### channel + + + Return the channel type used. + + **Return type** + + `str` + + **Returns** + + The channel type used. + + + ### global\_service + + + + ## Methods + + ### active\_account + + + Return the IBM Quantum account currently in use for the session. + + **Return type** + + `Optional`\[`Dict`\[`str`, `str`]] + + **Returns** + + A dictionary with information about the account currently in the session. + + + ### backend + + + 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 in target. Currently this feature cannot be used simulataneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend target. When you use the 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 backend targets. + + **Returns** + + A backend matching the filtering. + + **Return type** + + Backend + + **Raises** + + **QiskitBackendNotFoundError** – if no backend could be found. + + + ### backends + + + Return all backends accessible via this account, subject to optional filtering. + + **Parameters** + + * **name** (`Optional`\[`str`]) – Backend name to filter by. + + * **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have. + + * **instance** (`Optional`\[`str`]) – 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. + + * **filters** (`Optional`\[`Callable`\[\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")], `bool`]]) – + + More complex filters, such as lambda functions. For example: + + ```python + QiskitRuntimeService.backends( + filters=lambda b: b.max_shots > 50000 + ) + QiskitRuntimeService.backends( + filters=lambda x: ("rz" in x.basis_gates ) + ) + ``` + + * **use\_fractional\_gates** (`Optional`\[`bool`]) – Set True to allow for the backends to include fractional gates in target. Currently this feature cannot be used simulataneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend target. When you use the 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 backend targets. + + * **\*\*kwargs** – + + Simple filters that require a specific value for an attribute in backend configuration or status. Examples: + + ```python + # Get the operational real backends + QiskitRuntimeService.backends(simulator=False, operational=True) + + # Get the backends with at least 127 qubits + QiskitRuntimeService.backends(min_num_qubits=127) + + # Get the backends that support OpenPulse + QiskitRuntimeService.backends(open_pulse=True) + ``` + + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> + + **Return type** + + `List`\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")] + + **Returns** + + The list of available backends that match the filter. + + **Raises** + + * **IBMInputValueError** – If an input is invalid. + * **QiskitBackendNotFoundError** – If the backend is not in any instance. + + + ### 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` + + + ### delete\_account + + + 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` + + **Returns** + + True if the account was deleted. False if no account was found. + + + ### delete\_job + + + Delete a runtime job. + + Note that this operation cannot be reversed. + + **Parameters** + + **job\_id** (`str`) – ID of the job to delete. + + **Raises** + + * **RuntimeJobNotFound** – If the job doesn’t exist. + * **IBMRuntimeError** – If the request failed. + + **Return type** + + `None` + + + ### 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. + + + ### job + + + 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")] + + **Returns** + + Runtime job retrieved. + + **Raises** + + * **RuntimeJobNotFound** – If the job doesn’t exist. + * **IBMRuntimeError** – If the request failed. + + + ### jobs + + + 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")]] + + **Returns** + + A list of runtime jobs. + + **Raises** + + **IBMInputValueError** – If an input value is invalid. + + + ### least\_busy + + + Return the least busy available backend. + + **Parameters** + + * **min\_num\_qubits** (`Optional`\[`int`]) – 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. + + * **filters** (`Optional`\[`Callable`\[\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")], `bool`]]) – + + 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: + + ```python + QiskitRuntimeService.least_busy(n_qubits=5, operational=True) + ``` + + **Return type** + + [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend") + + **Returns** + + The backend with the fewest number of pending jobs. + + **Raises** + + **QiskitBackendNotFoundError** – If no backend matches the criteria. + + + ### save\_account + + + 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. + * **channel\_strategy** (`Optional`\[`str`]) – (DEPRECATED) Error mitigation strategy. + * **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. + + **Return type** + + `None` + + + ### saved\_accounts + + + 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` + + **Returns** + + A dictionary with information about the accounts saved on disk. + + **Raises** + + **ValueError** – If an invalid account is found on disk. + + + ### usage + + + Return monthly open plan usage information. + + **Return type** + + `Dict`\[`str`, `Any`] + + **Returns** + + Dict with usage details. + + **Raises** + + **IBMInputValueError** – If method is called when using the ibm\_cloud channel + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeDecoder.mdx new file mode 100644 index 00000000000..8ff0f862699 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -0,0 +1,52 @@ +--- +title: RuntimeDecoder +description: API reference for qiskit_ibm_runtime.RuntimeDecoder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.RuntimeDecoder +--- + +# RuntimeDecoder + + + 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). + + `object_pairs_hook`, if specified will be called with the result of every JSON object decoded with an ordered list of pairs. The return value of `object_pairs_hook` will be used instead of the `dict`. This feature can be used to implement custom decoders. If `object_hook` is also defined, the `object_pairs_hook` takes priority. + + `parse_float`, if specified, will be called with the string of every JSON float to be decoded. By default this is equivalent to float(num\_str). This can be used to use another datatype or parser for JSON floats (e.g. decimal.Decimal). + + `parse_int`, if specified, will be called with the string of every JSON int to be decoded. By default this is equivalent to int(num\_str). This can be used to use another datatype or parser for JSON integers (e.g. float). + + `parse_constant`, if specified, will be called with one of the following strings: -Infinity, Infinity, NaN. This can be used to raise an exception if invalid JSON numbers are encountered. + + If `strict` is false (true is the default), then control characters will be allowed inside strings. Control characters in this context are those with character codes in the 0-31 range, including `'\t'` (tab), `'\n'`, `'\r'` and `'\0'`. + + ## Methods + + ### decode + + + Return the Python representation of `s` (a `str` instance containing a JSON document). + + + ### object\_hook + + + Called to decode object. + + **Return type** + + `Any` + + + ### raw\_decode + + + Decode a JSON document from `s` (a `str` beginning with a JSON document) and return a 2-tuple of the Python representation and the index in `s` where the document ended. + + This can be used to decode a JSON document from a string that may have extraneous data at the end. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeEncoder.mdx new file mode 100644 index 00000000000..12811df1999 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -0,0 +1,93 @@ +--- +title: RuntimeEncoder +description: API reference for qiskit_ibm_runtime.RuntimeEncoder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.RuntimeEncoder +--- + +# RuntimeEncoder + + + JSON Encoder used by runtime service. + + Constructor for JSONEncoder, with sensible defaults. + + If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped. + + If ensure\_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure\_ascii is false, the output can contain non-ASCII characters. + + If check\_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an RecursionError). Otherwise, no such check takes place. + + If allow\_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats. + + If sort\_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis. + + If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation. + + If specified, separators should be an (item\_separator, key\_separator) tuple. The default is (’, ‘, ‘: ‘) if *indent* is `None` and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace. + + If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a `TypeError`. + + ## Attributes + + ### item\_separator + + + + ### key\_separator + + + + ## Methods + + ### default + + + Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). + + For example, to support arbitrary iterators, you could implement default like this: + + ```python + def default(self, o): + try: + iterable = iter(o) + except TypeError: + pass + else: + return list(iterable) + # Let the base class default method raise the TypeError + return JSONEncoder.default(self, o) + ``` + + **Return type** + + `Any` + + + ### encode + + + Return a JSON string representation of a Python data structure. + + ```python + >>> from json.encoder import JSONEncoder + >>> JSONEncoder().encode({"foo": ["bar", "baz"]}) + '{"foo": ["bar", "baz"]}' + ``` + + + ### iterencode + + + Encode the given object and yield each string representation as available. + + For example: + + ```python + for chunk in JSONEncoder().iterencode(bigobject): + mysocket.write(chunk) + ``` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeJob.mdx new file mode 100644 index 00000000000..b88bfd635be --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeJob.mdx @@ -0,0 +1,539 @@ +--- +title: RuntimeJob +description: API reference for qiskit_ibm_runtime.RuntimeJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.RuntimeJob +--- + +# RuntimeJob + + + 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. + + If the primitive execution is successful, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_runtime.RuntimeJob.status "qiskit_ibm_runtime.RuntimeJob.status"). Job status can be one of the [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.2)") members. + + Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](#qiskit_ibm_runtime.RuntimeJob.result "qiskit_ibm_runtime.RuntimeJob.result") is an example of a blocking method: + + ```python + job = service.run(...) + + try: + job_result = job.result() # It will block until the job finishes. + print("The job finished with result {}".format(job_result)) + except RuntimeJobFailureError as ex: + print("Job failed!: {}".format(ex)) + ``` + + If the primitive has any interim results, you can use the `callback` parameter of the `run()` method to stream the interim results along with the final result. Alternatively, you can use the [`stream_results()`](#qiskit_ibm_runtime.RuntimeJob.stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes. + + 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. + + ## Attributes + + ### ERROR + + + + ### JOB\_FINAL\_STATES + + + + ### 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. + + + ### image + + + Return the runtime image used for the job. + + **Returns** + + image\_name:tag or “” if the default image is used. + + **Return type** + + Runtime image + + + ### inputs + + + Job input parameters. + + **Return type** + + `Dict` + + **Returns** + + Input parameters used in this job. + + + ### instance + + + For ibm\_quantum channel jobs, return the instance where the job was run. For ibm\_cloud, None is returned. + + **Return type** + + `Optional`\[`str`] + + + ### primitive\_id + + + Primitive name. :rtype: `str` :returns: Primitive this job is for. + + + ### session\_id + + + Session ID. + + **Return type** + + `str` + + **Returns** + + Session ID. None if the backend is a simulator. + + + ### tags + + + Job tags. + + **Return type** + + `List` + + **Returns** + + Tags assigned to the job that can be used for filtering. + + + ### 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. + + + ### version + + + + ## Methods + + ### backend + + + Return the backend where this job was executed. Retrieve data again if backend is None. + + **Raises** + + **IBMRuntimeError** – If a network error occurred. + + **Return type** + + `Optional`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")] + + + ### cancel + + + Cancel the job. + + **Raises** + + * **RuntimeInvalidStateError** – If the job is in a state that cannot be cancelled. + * **IBMRuntimeError** – If unable to cancel job. + + **Return type** + + `None` + + + ### cancel\_result\_streaming + + + Cancel result streaming. + + **Return type** + + `None` + + + ### cancelled + + + Return whether the job has been cancelled. + + **Return type** + + `bool` + + + ### done + + + Return whether the job has successfully run. + + **Return type** + + `bool` + + + ### error\_message + + + Returns the reason if the job failed. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Error message string or `None`. + + + ### errored + + + Return whether the job has failed. + + **Return type** + + `bool` + + + ### in\_final\_state + + + Return whether the job is in a final job state such as `DONE` or `ERROR`. + + **Return type** + + `bool` + + + ### interim\_results + + + (DEPRECATED) Return the interim results of the job. + + **Parameters** + + **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode interim results. + + **Return type** + + `Any` + + **Returns** + + Runtime job interim results. + + **Raises** + + **RuntimeJobFailureError** – If the job failed. + + + ### job\_id + + + Return a unique id identifying the job. + + **Return type** + + `str` + + + ### logs + + + Return job logs. + + + Job logs are only available after the job finishes. + + + **Return type** + + `str` + + **Returns** + + Job logs, including standard output and error. + + **Raises** + + **IBMRuntimeError** – If a network error occurred. + + + ### metrics + + + Return job metrics. + + **Returns** + + * `timestamps`: Timestamps of when the job was created, started running, and finished. + + * **`usage`: Details regarding job usage, the measurement of the amount of** + + time the QPU is locked for your workload. + + **Return type** + + A dictionary with job metrics including but not limited to the following + + **Raises** + + **IBMRuntimeError** – If a network error occurred. + + + ### properties + + + Return the backend properties for this job. + + **Parameters** + + **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version. + + **Return type** + + `Optional`\[`BackendProperties`] + + **Returns** + + The backend properties used for this job, at the time the job was run, or `None` if properties are not available. + + + ### queue\_info + + + Return queue information for this job. + + The queue information may include queue position, estimated start and end time, and dynamic priorities for the hub, group, and project. See `QueueInfo` for more information. + + + The queue information is calculated after the job enters the queue. Therefore, some or all of the information may not be immediately available, and this method may return `None`. + + + **Return type** + + `Optional`\[`QueueInfo`] + + **Returns** + + A `QueueInfo` instance that contains queue information for this job, or `None` if queue information is unknown or not applicable. + + + ### queue\_position + + + Return the position of the job in the server queue. + + + The position returned is within the scope of the provider and may differ from the global queue position. + + + **Parameters** + + **refresh** (`bool`) – If `True`, re-query the server to get the latest value. Otherwise return the cached value. + + **Return type** + + `Optional`\[`int`] + + **Returns** + + Position in the queue or `None` if position is unknown or not applicable. + + + ### result + + + Return the results of the job. + + **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` + + **Returns** + + Runtime job result. + + **Raises** + + * **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. + + + ### running + + + Return whether the job is actively running. + + **Return type** + + `bool` + + + ### status + + + Return the status of the job. + + **Return type** + + [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.2)") + + **Returns** + + Status of this job. + + + ### stream\_results + + + (DEPRECATED) Start streaming job results. + + **Parameters** + + * **callback** (`Callable`) – + + Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: + + > 1. Job ID + > 2. Job result. + + * **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results. + + **Raises** + + **RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished. + + **Return type** + + `None` + + + ### submit + + + Unsupported method. .. note: + + ```python + This method is not supported, please use + :meth:`~qiskit_ibm_runtime.QiskitRuntimeService.run` + to submit a job. + ``` + + **Raises** + + **NotImplementedError** – Upon invocation. + + **Return type** + + `None` + + + ### update\_tags + + + Update the tags associated with this job. + + **Parameters** + + **new\_tags** (`List`\[`str`]) – New tags to assign to the job. + + **Return type** + + `List`\[`str`] + + **Returns** + + The new tags associated with this job. + + **Raises** + + **IBMApiError** – If an unexpected error occurred when communicating with the server or updating the job tags. + + + ### usage + + + Return job usage in seconds. + + **Return type** + + `float` + + + ### wait\_for\_final\_state + + + Poll for the job status from the API until the status is in a final state. + + **Parameters** + + **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + + **Raises** + + **RuntimeJobTimeoutError** – If the job does not complete within given timeout. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeJobV2.mdx new file mode 100644 index 00000000000..c4347d7223b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -0,0 +1,455 @@ +--- +title: RuntimeJobV2 +description: API reference for qiskit_ibm_runtime.RuntimeJobV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.RuntimeJobV2 +--- + +# RuntimeJobV2 + + + 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. + + ## Attributes + + ### ERROR + + + + ### JOB\_FINAL\_STATES + + + + ### 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. + + + ### image + + + Return the runtime image used for the job. + + **Returns** + + image\_name:tag or “” if the default image is used. + + **Return type** + + Runtime image + + + ### inputs + + + Job input parameters. + + **Return type** + + `Dict` + + **Returns** + + Input parameters used in this job. + + + ### instance + + + For ibm\_quantum channel jobs, return the instance where the job was run. For ibm\_cloud, None is returned. + + **Return type** + + `Optional`\[`str`] + + + ### primitive\_id + + + Primitive name. :rtype: `str` :returns: Primitive this job is for. + + + ### session\_id + + + Session ID. + + **Return type** + + `str` + + **Returns** + + Session ID. None if the backend is a simulator. + + + ### tags + + + Job tags. + + **Return type** + + `List` + + **Returns** + + Tags assigned to the job that can be used for filtering. + + + ### 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. + + + ## Methods + + ### backend + + + Return the backend where this job was executed. Retrieve data again if backend is None. + + **Raises** + + **IBMRuntimeError** – If a network error occurred. + + **Return type** + + `Optional`\[[`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")] + + + ### cancel + + + Cancel the job. + + **Raises** + + * **RuntimeInvalidStateError** – If the job is in a state that cannot be cancelled. + * **IBMRuntimeError** – If unable to cancel job. + + **Return type** + + `None` + + + ### cancel\_result\_streaming + + + Cancel result streaming. + + **Return type** + + `None` + + + ### cancelled + + + Return whether the job has been cancelled. + + **Return type** + + `bool` + + + ### done + + + Return whether the job has successfully run. + + **Return type** + + `bool` + + + ### error\_message + + + Returns the reason if the job failed. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Error message string or `None`. + + + ### errored + + + Return whether the job has failed. + + **Return type** + + `bool` + + + ### in\_final\_state + + + Return whether the job is in a final job state such as `DONE` or `ERROR`. + + **Return type** + + `bool` + + + ### interim\_results + + + (DEPRECATED) Return the interim results of the job. + + **Parameters** + + **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode interim results. + + **Return type** + + `Any` + + **Returns** + + Runtime job interim results. + + **Raises** + + **RuntimeJobFailureError** – If the job failed. + + + ### job\_id + + + Return a unique id identifying the job. + + **Return type** + + `str` + + + ### logs + + + Return job logs. + + + Job logs are only available after the job finishes. + + + **Return type** + + `str` + + **Returns** + + Job logs, including standard output and error. + + **Raises** + + **IBMRuntimeError** – If a network error occurred. + + + ### metrics + + + Return job metrics. + + **Returns** + + * `timestamps`: Timestamps of when the job was created, started running, and finished. + + * **`usage`: Details regarding job usage, the measurement of the amount of** + + time the QPU is locked for your workload. + + **Return type** + + A dictionary with job metrics including but not limited to the following + + **Raises** + + **IBMRuntimeError** – If a network error occurred. + + + ### properties + + + Return the backend properties for this job. + + **Parameters** + + **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version. + + **Return type** + + `Optional`\[`BackendProperties`] + + **Returns** + + The backend properties used for this job, at the time the job was run, or `None` if properties are not available. + + + ### result + + + Return the results of the job. + + **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` + + **Returns** + + Runtime job result. + + **Raises** + + * **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. + + + ### running + + + Return whether the job is actively running. + + **Return type** + + `bool` + + + ### status + + + Return the status of the job. + + **Return type** + + `Literal`\[‘INITIALIZING’, ‘QUEUED’, ‘RUNNING’, ‘CANCELLED’, ‘DONE’, ‘ERROR’] + + **Returns** + + Status of this job. + + + ### stream\_results + + + (DEPRECATED) Start streaming job results. + + **Parameters** + + * **callback** (`Callable`) – + + Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: + + > 1. Job ID + > 2. Job result. + + * **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results. + + **Raises** + + **RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished. + + **Return type** + + `None` + + + ### update\_tags + + + Update the tags associated with this job. + + **Parameters** + + **new\_tags** (`List`\[`str`]) – New tags to assign to the job. + + **Return type** + + `List`\[`str`] + + **Returns** + + The new tags associated with this job. + + **Raises** + + **IBMApiError** – If an unexpected error occurred when communicating with the server or updating the job tags. + + + ### usage + + + Return job usage in seconds. + + **Return type** + + `float` + + + ### wait\_for\_final\_state + + + Poll for the job status from the API until the status is in a final state. + + **Parameters** + + **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + + **Raises** + + **RuntimeJobTimeoutError** – If the job does not complete within given timeout. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Sampler.mdx new file mode 100644 index 00000000000..9c08360a745 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Sampler.mdx @@ -0,0 +1,14 @@ +--- +title: Sampler +description: API reference for qiskit_ibm_runtime.Sampler +in_page_toc_min_heading_level: 1 +python_api_type: attribute +python_api_name: qiskit_ibm_runtime.Sampler +--- + +# Sampler + + + alias of [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.sampler.SamplerV2") + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.SamplerV2.mdx new file mode 100644 index 00000000000..e906e9e6537 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.SamplerV2.mdx @@ -0,0 +1,95 @@ +--- +title: SamplerV2 +description: API reference for qiskit_ibm_runtime.SamplerV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.SamplerV2 +--- + +# SamplerV2 + + + 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. + + Qiskit Runtime Sampler primitive returns the sampled result according to the specified output type. For example, it returns a bitstring for each shot if measurement level 2 (bits) is requested. + + The [`run()`](#qiskit_ibm_runtime.SamplerV2.run "qiskit_ibm_runtime.SamplerV2.run") method can be used to submit circuits and parameters to the Sampler primitive. + + Initializes the Sampler primitive. + + **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`]) – + + The execution mode used to make the primitive query. It can be: + + * A `Backend` if you are using job mode. + * A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode. + * A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode. + + 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. + + **Raises** + + **NotImplementedError** – If “q-ctrl” channel strategy is used. + + ## Attributes + + ### 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. + + + ### options + + + Return options + + **Return type** + + `TypeVar`(`OptionsT`, bound= `BaseOptions`) + + + ### version + + + + ## Methods + + ### run + + + Submit a request to the sampler primitive. + + **Parameters** + + * **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`. + + **Raises** + + **ValueError** – Invalid arguments are given. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Session.mdx new file mode 100644 index 00000000000..dc5416a8ecb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.Session.mdx @@ -0,0 +1,214 @@ +--- +title: Session +description: API reference for qiskit_ibm_runtime.Session +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.Session +--- + +# Session + + + 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. + + You can open a Qiskit Runtime session using this `Session` class and submit jobs to one or more primitives. + + For example: + + ```python + from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister + from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + from qiskit_ibm_runtime import Session, SamplerV2 as Sampler + + service = QiskitRuntimeService() + backend = service.least_busy(operational=True, simulator=False) + + # Bell Circuit + qr = QuantumRegister(2, name="qr") + cr = ClassicalRegister(2, name="cr") + qc = QuantumCircuit(qr, cr, name="bell") + qc.h(qr[0]) + qc.cx(qr[0], qr[1]) + qc.measure(qr, cr) + + pm = generate_preset_pass_manager(backend=backend, optimization_level=1) + isa_circuit = pm.run(qc) + + with Session(backend=backend) as session: + sampler = Sampler(session=session) + job = sampler.run([isa_circuit]) + pub_result = job.result()[0] + print(f"Sampler job ID: {job.job_id()}") + print(f"Counts: {pub_result.data.cr.get_counts()}") + ``` + + Session constructor. + + **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). + + **Raises** + + **ValueError** – If an input value is invalid. + + ## Attributes + + ### 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. + + + ### session\_id + + + Return the session ID. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Session ID. None if the backend is a simulator. + + + ## Methods + + ### backend + + + Return backend for this session. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Backend for this session. None if unknown. + + + ### cancel + + + Cancel all pending jobs in a session. + + **Return type** + + `None` + + + ### 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` + + + ### details + + + Return session details. + + **Return type** + + `Optional`\[`Dict`\[`str`, `Any`]] + + **Returns** + + A dictionary with the sessions details. + + * `id`: id of the session. + * `backend_name`: backend used for the session. + * `interactive_timeout`: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated. + * `max_time`: Maximum allowed time (in seconds) for the session, subject to plan limits. + * `active_timeout`: The maximum time (in seconds) a session can stay active. + * `state`: State of the session - open, active, inactive, or closed. + * `accepting_jobs`: Whether or not the session is accepting jobs. + * `last_job_started`: Timestamp of when the last job in the session started. + * `last_job_completed`: Timestamp of when the last job in the session completed. + * `started_at`: Timestamp of when the session was started. + * `closed_at`: Timestamp of when the session was closed. + * `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. + + + ### from\_id + + + 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. + + * **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – + + instance of the `QiskitRuntimeService` class. + + **Raises:** + + 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` + + + ### status + + + Return current session status. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Session status as a string. + + * `Pending`: Session is created but not active. It will become active when the next job of this session is dequeued. + * `In progress, accepting new jobs`: session is active and accepting new jobs. + * `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. + + + ### 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. + + Batch usage is the amount of time all jobs spend on the QPU. + + **Return type** + + `Optional`\[`float`] + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.Neat.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.Neat.mdx new file mode 100644 index 00000000000..42088766f7a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.Neat.mdx @@ -0,0 +1,119 @@ +--- +title: Neat +description: API reference for qiskit_ibm_runtime.debug_tools.Neat +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.Neat +--- + +# Neat + + + 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()`. + + ## Attributes + + ### 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)") + + + ## Methods + + ### backend + + + The backend used by this analyzer tool. + + **Return type** + + [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") + + + ### ideal\_sim + + + Perform an ideal, noiseless simulation of the estimator task specified by `pubs`. + + This function uses `qiskit-aer`’s `Estimator` class to simulate the estimation task classically. + + + To ensure scalability, every circuit in `pubs` is required to be a Clifford circuit, so that it can be simulated efficiently regardless of its size. For estimation tasks that involve non-Clifford circuits, the recommended workflow consists of mapping the non-Clifford circuits to the nearest Clifford circuits using the `ConvertISAToClifford` transpiler pass, or equivalently, to use the Neat’s [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") convenience method. Alternatively, setting `cliffordize` to `True` ensures that the [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") method is applied automatically to the given `pubs` prior to the simulation. + + + **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") + + **Returns** + + The results of the simulation. + + + ### noisy\_sim + + + Perform a noisy simulation of the estimator task specified by `pubs`. + + This function uses `qiskit-aer`’s `Estimator` class to simulate the estimation task classically. + + + To ensure scalability, every circuit in `pubs` is required to be a Clifford circuit, so that it can be simulated efficiently regardless of its size. For estimation tasks that involve non-Clifford circuits, the recommended workflow consists of mapping the non-Clifford circuits to the nearest Clifford circuits using the `ConvertISAToClifford` transpiler pass, or equivalently, to use the Neat’s [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") convenience method. Alternatively, setting `cliffordize` to `True` ensures that the [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") method is applied automatically to the given `pubs` prior to the simulation. + + + **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") + + **Returns** + + The results of the simulation. + + + ### to\_clifford + + + Return the cliffordized version of the given `pubs`. + + This convenience method runs the `ConvertISAToClifford` transpiler pass on the PUBs’ circuits. + + **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`] + + **Returns** + + The Clifford PUBs. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx new file mode 100644 index 00000000000..544ead60137 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx @@ -0,0 +1,42 @@ +--- +title: NeatPubResult +description: API reference for qiskit_ibm_runtime.debug_tools.NeatPubResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult +--- + +# NeatPubResult + + + 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`. + + ## Attributes + + ### 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)") + + + ## Methods + + ### \_\_mul\_\_ + + + **Return type** + + [`NeatPubResult`](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.NeatResult.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.NeatResult.mdx new file mode 100644 index 00000000000..c5f6bd9daec --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.debug_tools.NeatResult.mdx @@ -0,0 +1,36 @@ +--- +title: NeatResult +description: API reference for qiskit_ibm_runtime.debug_tools.NeatResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.NeatResult +--- + +# NeatResult + + + 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. + + ## Methods + + ### \_\_getitem\_\_ + + + **Return type** + + [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") + + + ### \_\_len\_\_ + + + **Return type** + + `int` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx new file mode 100644 index 00000000000..d225a962fb3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx @@ -0,0 +1,141 @@ +--- +title: ExecutionSpan +description: API reference for qiskit_ibm_runtime.execution_span.ExecutionSpan +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan +--- + +# ExecutionSpan + + + 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. + + Execution spans are equality checkable, and they implement a comparison operator based on the tuple `(start, stop)`, so can be sorted. + + **Parameters** + + * **start** (`datetime`) – The start time of the span, in UTC. + * **stop** (`datetime`) – The stop time of the span, in UTC. + + ## Attributes + + ### duration + + + The duration of this span, in seconds. + + **Return type** + + `float` + + + ### pub\_idxs + + + Which pubs, by index, have dependence on this execution span. + + **Return type** + + `list`\[`int`] + + + ### size + + + The total number of results with dependence on this execution span, across all pubs. + + This attribute is equivalent to the sum of the elements of all present [`mask()`](#qiskit_ibm_runtime.execution_span.ExecutionSpan.mask "qiskit_ibm_runtime.execution_span.ExecutionSpan.mask")s. For sampler results, it represents the total number of shots with dependence on this execution span. + + Combine this attribute with [`filter_by_pub()`](#qiskit_ibm_runtime.execution_span.ExecutionSpan.filter_by_pub "qiskit_ibm_runtime.execution_span.ExecutionSpan.filter_by_pub") to find the size of some particular pub: + + ```python + span.filter_by_pub(2).size + ``` + + **Return type** + + `int` + + + ### start + + + The start time of the span, in UTC. + + **Return type** + + `datetime` + + + ### stop + + + The stop time of the span, in UTC. + + **Return type** + + `datetime` + + + ## Methods + + ### contains\_pub + + + Return whether the pub with the given index has data with dependence on this span. + + **Parameters** + + **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. + + + ### filter\_by\_pub + + + Return a new span whose slices are filtered to the provided pub indices. + + For example, if this span contains slice information for pubs with indices 1, 3, 4 and `[1, 4]` is provided, then the span returned by this method will contain slice information for only those two indices, but be identical otherwise. + + **Parameters** + + **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. + + + ### mask + + + Return an array-valued mask specifying which parts of a pub result depend on this span. + + **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)")]] + + **Returns** + + An array with the same shape as the pub data. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx new file mode 100644 index 00000000000..f8c3cc4ad89 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx @@ -0,0 +1,114 @@ +--- +title: ExecutionSpans +description: API reference for qiskit_ibm_runtime.execution_span.ExecutionSpans +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans +--- + +# ExecutionSpans + + + 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. + + It is possible for distinct time windows to overlap. This is not because a QPU was performing multiple executions at once, but is instead an artifact of certain classical processing that may happen concurrently with quantum execution. The guarantee being made is that the referenced data definitely occurred in the reported execution span, but not necessarily that the limits of the time window are as tight as possible. + + ## Attributes + + ### duration + + + The total duration of this collection, in seconds. + + **Return type** + + `float` + + + ### pub\_idxs + + + Which pubs, by index, have dependence on one or more execution spans present. + + **Return type** + + `list`\[`int`] + + + ### start + + + The start time of the entire collection, in UTC. + + **Return type** + + `datetime` + + + ### stop + + + The stop time of the entire collection, in UTC. + + **Return type** + + `datetime` + + + ## Methods + + ### \_\_getitem\_\_ + + + **Return type** + + [ExecutionSpan](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") | ‘ExecutionSpans + + + ### \_\_len\_\_ + + + **Return type** + + `int` + + + ### filter\_by\_pub + + + Return a new set of spans where each one has been filtered to the specified pubs. + + See also :meth:\~.ExecutionSpan.filter\_by\_pub\`. + + **Parameters** + + **pub\_idx** (*int | Iterable\[int]*) – One or more pub indices to filter. + + **Return type** + + [ExecutionSpans](#qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") + + + ### sort + + + Return the same execution spans, sorted. + + Sorting is done by the [`start`](qiskit_ibm_runtime.execution_span.ExecutionSpan#start "qiskit_ibm_runtime.execution_span.ExecutionSpan.start") timestamp of each execution span. + + **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") + + **Returns** + + This instance if `inplace`, a new instance otherwise, sorted. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ShapeType.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ShapeType.mdx new file mode 100644 index 00000000000..7e0fd552068 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.ShapeType.mdx @@ -0,0 +1,14 @@ +--- +title: ShapeType +description: API reference for qiskit_ibm_runtime.execution_span.ShapeType +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit_ibm_runtime.execution_span.ShapeType +--- + +# ShapeType + + + alias of `Tuple`\[`int`, …] + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.SliceSpan.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.SliceSpan.mdx new file mode 100644 index 00000000000..61d5b35a550 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.execution_span.SliceSpan.mdx @@ -0,0 +1,128 @@ +--- +title: SliceSpan +description: API reference for qiskit_ibm_runtime.execution_span.SliceSpan +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan +--- + +# SliceSpan + + + 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)`. + + ## Attributes + + ### duration + + + The duration of this span, in seconds. + + **Return type** + + `float` + + + ### pub\_idxs + + + **Return type** + + `list`\[`int`] + + + ### size + + + **Return type** + + `int` + + + ### start + + + The start time of the span, in UTC. + + **Return type** + + `datetime` + + + ### stop + + + The stop time of the span, in UTC. + + **Return type** + + `datetime` + + + ## Methods + + ### contains\_pub + + + Return whether the pub with the given index has data with dependence on this span. + + **Parameters** + + **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. + + + ### filter\_by\_pub + + + Return a new span whose slices are filtered to the provided pub indices. + + For example, if this span contains slice information for pubs with indices 1, 3, 4 and `[1, 4]` is provided, then the span returned by this method will contain slice information for only those two indices, but be identical otherwise. + + **Parameters** + + **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. + + + ### mask + + + Return an array-valued mask specifying which parts of a pub result depend on this span. + + **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)")]] + + **Returns** + + An array with the same shape as the pub data. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx new file mode 100644 index 00000000000..c32045eb8bb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -0,0 +1,454 @@ +--- +title: FakeAlgiers +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlgiers +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers +--- + +# FakeAlgiers + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAlgiers.run "qiskit_ibm_runtime.fake_provider.FakeAlgiers.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx new file mode 100644 index 00000000000..8022c3e591d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -0,0 +1,464 @@ +--- +title: FakeAlmadenV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 +--- + +# FakeAlmadenV2 + + + A fake Almaden V2 backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run "qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx new file mode 100644 index 00000000000..07110a2a402 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -0,0 +1,458 @@ +--- +title: FakeArmonkV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeArmonkV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 +--- + +# FakeArmonkV2 + + + A fake 1 qubit backend. + + ```python + 0 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeArmonkV2.run "qiskit_ibm_runtime.fake_provider.FakeArmonkV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx new file mode 100644 index 00000000000..c75f05f41ac --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeAthensV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAthensV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 +--- + +# FakeAthensV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAthensV2.run "qiskit_ibm_runtime.fake_provider.FakeAthensV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx new file mode 100644 index 00000000000..3ed88fdd8e1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -0,0 +1,454 @@ +--- +title: FakeAuckland +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAuckland +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland +--- + +# FakeAuckland + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAuckland.run "qiskit_ibm_runtime.fake_provider.FakeAuckland.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx new file mode 100644 index 00000000000..ca168c10b43 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeBelemV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBelemV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 +--- + +# FakeBelemV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBelemV2.run "qiskit_ibm_runtime.fake_provider.FakeBelemV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx new file mode 100644 index 00000000000..5d81f536d7c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -0,0 +1,464 @@ +--- +title: FakeBoeblingenV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 +--- + +# FakeBoeblingenV2 + + + A fake Boeblingen V2 backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.run "qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx new file mode 100644 index 00000000000..5e43b960539 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeBogotaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBogotaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 +--- + +# FakeBogotaV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBogotaV2.run "qiskit_ibm_runtime.fake_provider.FakeBogotaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx new file mode 100644 index 00000000000..021c2847210 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -0,0 +1,454 @@ +--- +title: FakeBrisbane +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrisbane +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane +--- + +# FakeBrisbane + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBrisbane.run "qiskit_ibm_runtime.fake_provider.FakeBrisbane.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx new file mode 100644 index 00000000000..336893a30e4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeBrooklynV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 +--- + +# FakeBrooklynV2 + + + A fake Brooklyn V2 backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.run "qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx new file mode 100644 index 00000000000..6aa31b665f8 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -0,0 +1,460 @@ +--- +title: FakeBurlingtonV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 +--- + +# FakeBurlingtonV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.run "qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx new file mode 100644 index 00000000000..b08db244ec1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeCairoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCairoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 +--- + +# FakeCairoV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCairoV2.run "qiskit_ibm_runtime.fake_provider.FakeCairoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx new file mode 100644 index 00000000000..5876f4f0c60 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -0,0 +1,466 @@ +--- +title: FakeCambridgeV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 +--- + +# FakeCambridgeV2 + + + A fake Cambridge backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 06 + ↕ ↕ + 07 ↔ 08 ↔ 09 ↔ 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 ↔ 15 + ↕ ↕ ↕ + 16 17 18 + ↕ ↕ ↕ + 19 ↔ 20 ↔ 21 ↔ 22 ↔ 23 ↔ 24 ↔ 25 ↔ 26 ↔ 27 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.run "qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx new file mode 100644 index 00000000000..3200dccd376 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeCasablancaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 +--- + +# FakeCasablancaV2 + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.run "qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx new file mode 100644 index 00000000000..8fdc03729c5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -0,0 +1,454 @@ +--- +title: FakeCusco +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCusco +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco +--- + +# FakeCusco + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCusco.run "qiskit_ibm_runtime.fake_provider.FakeCusco.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx new file mode 100644 index 00000000000..42ceff241dc --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -0,0 +1,462 @@ +--- +title: FakeEssexV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeEssexV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 +--- + +# FakeEssexV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 2 + ↕ + 3 + ↕ + 4 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeEssexV2.run "qiskit_ibm_runtime.fake_provider.FakeEssexV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx new file mode 100644 index 00000000000..2cf022e9536 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx @@ -0,0 +1,461 @@ +--- +title: FakeFractionalBackend +description: API reference for qiskit_ibm_runtime.fake_provider.FakeFractionalBackend +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend +--- + +# FakeFractionalBackend + + + A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima. + + This backend include following features. + + * Fractional gates (rx, rzx) in addition to the standard basis gates. + * Control flow operations (if\_else, while\_loop). + * Pulse calibrations (fractional gates don’t support calibration). + * Gate properties of all instructions. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.run "qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx new file mode 100644 index 00000000000..01fdfcce0fe --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -0,0 +1,454 @@ +--- +title: FakeGeneva +description: API reference for qiskit_ibm_runtime.fake_provider.FakeGeneva +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva +--- + +# FakeGeneva + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeGeneva.run "qiskit_ibm_runtime.fake_provider.FakeGeneva.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx new file mode 100644 index 00000000000..15c0e866261 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeGuadalupeV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 +--- + +# FakeGuadalupeV2 + + + A fake 16 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.run "qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx new file mode 100644 index 00000000000..ab96df41c4d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeHanoiV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeHanoiV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 +--- + +# FakeHanoiV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeHanoiV2.run "qiskit_ibm_runtime.fake_provider.FakeHanoiV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx new file mode 100644 index 00000000000..cb03b8dc162 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeJakartaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeJakartaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 +--- + +# FakeJakartaV2 + + + A fake 7 qubit V2 backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeJakartaV2.run "qiskit_ibm_runtime.fake_provider.FakeJakartaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx new file mode 100644 index 00000000000..70d39f63125 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -0,0 +1,464 @@ +--- +title: FakeJohannesburgV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 +--- + +# FakeJohannesburgV2 + + + A fake Johannesburg V2 backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.run "qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx new file mode 100644 index 00000000000..3649e87c980 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -0,0 +1,454 @@ +--- +title: FakeKawasaki +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKawasaki +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki +--- + +# FakeKawasaki + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKawasaki.run "qiskit_ibm_runtime.fake_provider.FakeKawasaki.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx new file mode 100644 index 00000000000..bb01b7c20e9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeKolkataV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKolkataV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 +--- + +# FakeKolkataV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKolkataV2.run "qiskit_ibm_runtime.fake_provider.FakeKolkataV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx new file mode 100644 index 00000000000..8dc985d2eab --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -0,0 +1,454 @@ +--- +title: FakeKyiv +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKyiv +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv +--- + +# FakeKyiv + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKyiv.run "qiskit_ibm_runtime.fake_provider.FakeKyiv.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx new file mode 100644 index 00000000000..b8f745b7c6c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -0,0 +1,454 @@ +--- +title: FakeKyoto +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKyoto +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto +--- + +# FakeKyoto + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKyoto.run "qiskit_ibm_runtime.fake_provider.FakeKyoto.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx new file mode 100644 index 00000000000..785308c0508 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeLagosV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLagosV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 +--- + +# FakeLagosV2 + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLagosV2.run "qiskit_ibm_runtime.fake_provider.FakeLagosV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx new file mode 100644 index 00000000000..2d0b2179389 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeLimaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLimaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 +--- + +# FakeLimaV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLimaV2.run "qiskit_ibm_runtime.fake_provider.FakeLimaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx new file mode 100644 index 00000000000..c8265710a69 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -0,0 +1,462 @@ +--- +title: FakeLondonV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLondonV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 +--- + +# FakeLondonV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 2 + ↕ + 3 + ↕ + 4 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLondonV2.run "qiskit_ibm_runtime.fake_provider.FakeLondonV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx new file mode 100644 index 00000000000..566e2f5a7d9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeManhattanV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeManhattanV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 +--- + +# FakeManhattanV2 + + + A fake Manhattan backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeManhattanV2.run "qiskit_ibm_runtime.fake_provider.FakeManhattanV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx new file mode 100644 index 00000000000..d42d71fb2b6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeManilaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeManilaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 +--- + +# FakeManilaV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeManilaV2.run "qiskit_ibm_runtime.fake_provider.FakeManilaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx new file mode 100644 index 00000000000..f987ea5b87a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeMelbourneV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 +--- + +# FakeMelbourneV2 + + + A fake 14 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.run "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx new file mode 100644 index 00000000000..124e32c77b5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeMontrealV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMontrealV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 +--- + +# FakeMontrealV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMontrealV2.run "qiskit_ibm_runtime.fake_provider.FakeMontrealV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx new file mode 100644 index 00000000000..f141e5ee473 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeMumbaiV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 +--- + +# FakeMumbaiV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.run "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx new file mode 100644 index 00000000000..ca7c9f1ead7 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeNairobiV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeNairobiV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 +--- + +# FakeNairobiV2 + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeNairobiV2.run "qiskit_ibm_runtime.fake_provider.FakeNairobiV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx new file mode 100644 index 00000000000..4d2340a7295 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -0,0 +1,454 @@ +--- +title: FakeOsaka +description: API reference for qiskit_ibm_runtime.fake_provider.FakeOsaka +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka +--- + +# FakeOsaka + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOsaka.run "qiskit_ibm_runtime.fake_provider.FakeOsaka.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx new file mode 100644 index 00000000000..5a00c34d949 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -0,0 +1,454 @@ +--- +title: FakeOslo +description: API reference for qiskit_ibm_runtime.fake_provider.FakeOslo +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo +--- + +# FakeOslo + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOslo.run "qiskit_ibm_runtime.fake_provider.FakeOslo.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx new file mode 100644 index 00000000000..660dd42ebef --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -0,0 +1,460 @@ +--- +title: FakeOurenseV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeOurenseV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 +--- + +# FakeOurenseV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOurenseV2.run "qiskit_ibm_runtime.fake_provider.FakeOurenseV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx new file mode 100644 index 00000000000..8071be20e3d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -0,0 +1,466 @@ +--- +title: FakeParisV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeParisV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 +--- + +# FakeParisV2 + + + A fake Paris backend. + + ```python + 06 17 + ↕ ↕ + 00 ↔ 01 ↔ 04 ↔ 07 ↔ 10 ↔ 12 ↔ 15 ↔ 18 ↔ 20 ↔ 23 + ↕ ↕ ↕ + 02 13 24 + ↕ ↕ ↕ + 03 ↔ 05 ↔ 08 ↔ 11 ↔ 14 ↔ 16 ↔ 19 ↔ 22 ↔ 25 ↔ 26 + ↕ ↕ + 09 20 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeParisV2.run "qiskit_ibm_runtime.fake_provider.FakeParisV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx new file mode 100644 index 00000000000..0bee3fd7398 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -0,0 +1,454 @@ +--- +title: FakePeekskill +description: API reference for qiskit_ibm_runtime.fake_provider.FakePeekskill +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill +--- + +# FakePeekskill + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePeekskill.run "qiskit_ibm_runtime.fake_provider.FakePeekskill.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePerth.mdx new file mode 100644 index 00000000000..2c3b233bffd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -0,0 +1,454 @@ +--- +title: FakePerth +description: API reference for qiskit_ibm_runtime.fake_provider.FakePerth +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth +--- + +# FakePerth + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePerth.run "qiskit_ibm_runtime.fake_provider.FakePerth.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx new file mode 100644 index 00000000000..01a4f6c35ab --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakePoughkeepsieV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 +--- + +# FakePoughkeepsieV2 + + + A fake Poughkeepsie backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.run "qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePrague.mdx new file mode 100644 index 00000000000..bed93f13811 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -0,0 +1,454 @@ +--- +title: FakePrague +description: API reference for qiskit_ibm_runtime.fake_provider.FakePrague +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague +--- + +# FakePrague + + + A fake 33 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePrague.run "qiskit_ibm_runtime.fake_provider.FakePrague.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx new file mode 100644 index 00000000000..771050045a2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -0,0 +1,38 @@ +--- +title: FakeProviderForBackendV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 +--- + +# FakeProviderForBackendV2 + + + 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"). + + ## Methods + + ### backend + + + Filter backends in provider by name. + + **Return type** + + `FakeBackendV2` + + + ### backends + + + Return all backends accessible via this account. + + **Return type** + + `List`\[`FakeBackendV2`] + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx new file mode 100644 index 00000000000..0dd6397beb6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -0,0 +1,454 @@ +--- +title: FakeQuebec +description: API reference for qiskit_ibm_runtime.fake_provider.FakeQuebec +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec +--- + +# FakeQuebec + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeQuebec.run "qiskit_ibm_runtime.fake_provider.FakeQuebec.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx new file mode 100644 index 00000000000..8226331957a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeQuitoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeQuitoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 +--- + +# FakeQuitoV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeQuitoV2.run "qiskit_ibm_runtime.fake_provider.FakeQuitoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx new file mode 100644 index 00000000000..be2b9df06a3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeRochesterV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeRochesterV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 +--- + +# FakeRochesterV2 + + + A fake Rochester backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRochesterV2.run "qiskit_ibm_runtime.fake_provider.FakeRochesterV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx new file mode 100644 index 00000000000..4ce5ef12271 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeRomeV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeRomeV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 +--- + +# FakeRomeV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRomeV2.run "qiskit_ibm_runtime.fake_provider.FakeRomeV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx new file mode 100644 index 00000000000..e084bbea270 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeSantiagoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 +--- + +# FakeSantiagoV2 + + + A fake Santiago backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.run "qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx new file mode 100644 index 00000000000..7f6bb665588 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -0,0 +1,454 @@ +--- +title: FakeSherbrooke +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSherbrooke +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke +--- + +# FakeSherbrooke + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSherbrooke.run "qiskit_ibm_runtime.fake_provider.FakeSherbrooke.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx new file mode 100644 index 00000000000..f62977bc9c1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -0,0 +1,464 @@ +--- +title: FakeSingaporeV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 +--- + +# FakeSingaporeV2 + + + A fake Singapore backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.run "qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx new file mode 100644 index 00000000000..8c1f6dd4ebb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeSydneyV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSydneyV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 +--- + +# FakeSydneyV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSydneyV2.run "qiskit_ibm_runtime.fake_provider.FakeSydneyV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx new file mode 100644 index 00000000000..20b0538a6f9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -0,0 +1,454 @@ +--- +title: FakeTorino +description: API reference for qiskit_ibm_runtime.fake_provider.FakeTorino +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino +--- + +# FakeTorino + + + A fake 133 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeTorino.run "qiskit_ibm_runtime.fake_provider.FakeTorino.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx new file mode 100644 index 00000000000..68a5a650a3e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeTorontoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeTorontoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 +--- + +# FakeTorontoV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeTorontoV2.run "qiskit_ibm_runtime.fake_provider.FakeTorontoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx new file mode 100644 index 00000000000..8a388446ee1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeValenciaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeValenciaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 +--- + +# FakeValenciaV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeValenciaV2.run "qiskit_ibm_runtime.fake_provider.FakeValenciaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx new file mode 100644 index 00000000000..030237b25f1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -0,0 +1,460 @@ +--- +title: FakeVigoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeVigoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 +--- + +# FakeVigoV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeVigoV2.run "qiskit_ibm_runtime.fake_provider.FakeVigoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx new file mode 100644 index 00000000000..8a6959ca804 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeWashingtonV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 +--- + +# FakeWashingtonV2 + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.run "qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx new file mode 100644 index 00000000000..ca7d472bd98 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -0,0 +1,462 @@ +--- +title: FakeYorktownV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeYorktownV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 +--- + +# FakeYorktownV2 + + + A fake 5 qubit backend. + + ```python + 1 + / | + 0 - 2 - 3 + | / + 4 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### 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 + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeYorktownV2.run "qiskit_ibm_runtime.fake_provider.FakeYorktownV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **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. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx new file mode 100644 index 00000000000..108e9ee995f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx @@ -0,0 +1,112 @@ +--- +title: NoiseLearner +description: API reference for qiskit_ibm_runtime.noise_learner.NoiseLearner +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner +--- + +# NoiseLearner + + + Class for executing noise learning experiments. + + + Currently, the [`NoiseLearner`](#qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner") is released an experimental feature. As such, it is subject to change without notification and its stability is not guaranteed. + + + The noise learner class allows characterizing the noise processes affecting the gates in one or more circuits of interest, based on the Pauli-Lindblad noise model described in \[1]. + + The [`run()`](#qiskit_ibm_runtime.noise_learner.NoiseLearner.run "qiskit_ibm_runtime.noise_learner.NoiseLearner.run") method allows runnig a noise learner job for a list of circuits. After the job is submitted, the gates are collected into independent layers, and subsequently the resulting layers are are characterized individually. + + The way in which the gates are collected into layers depends on the twirling `strategy` specified in the given `options` (see `NoiseLearnerOptions` for more details). Note that all strategies obey barriers. For example, if you have three ISA entangling layers of interest, consider putting them into one circuit separated by barriers acting on the qubits you wish to twirl, and select `strategy="active-circuit"`. + + The following snippet shows an example where the noise learner is used to characterized the layers of two GHZ circuits. + + ```python + from qiskit.circuit import QuantumCircuit + from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + from qiskit_ibm_runtime import QiskitRuntimeService + from qiskit_ibm_runtime.noise_learner import NoiseLearner + from qiskit_ibm_runtime.options import NoiseLearnerOptions + + service = QiskitRuntimeService() + backend = service.least_busy(operational=True, simulator=False) + + # a circuit returning a two-qubit GHZ state + ghz = QuantumCircuit(2) + ghz.h(0) + ghz.cx(0, 1) + + # another circuit returning a two-qubit GHZ state + another_ghz = QuantumCircuit(3) + another_ghz.h(0) + another_ghz.cx(0, 1) + another_ghz.cx(1, 2) + another_ghz.cx(0, 1) + + pm = generate_preset_pass_manager(backend=backend, optimization_level=1) + circuits = pm.run([ghz, another_ghz]) + + # set the options + options = NoiseLearnerOptions() + options.layer_pair_depths = [0, 1, 10] + + # run the noise learner job + learner = NoiseLearner(backend, options) + job = learner.run(circuits) + ``` + + **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`]) – + + The execution mode used to make the primitive query. It can be: + + * A `Backend` if you are using job mode. + * A `Session` if you are using session execution mode. + * A `Batch` if you are using batch execution mode. + + 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. + + **References** + + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + + ## Attributes + + ### options + + + The options in this noise learner. + + **Return type** + + [`NoiseLearnerOptions`](qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.noise_learner_options.NoiseLearnerOptions") + + + ## Methods + + ### run + + + Submit a request to the noise learner program. + + This function breaks the given list of circuits into a list of unique layers, following the strategy set by the `twirling_strategy` field specified in the `options` (see `NoiseLearnerOptions` for more details) and sorting them based on the number of times they occur in the various circuits. Then, it runs the noise learning experiment for as many layers as specified by the `max_layers_to_learn` field in the `options`, prioritizing layers that occurr more frequently. + + **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") + + **Returns** + + The submitted job. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx new file mode 100644 index 00000000000..7d027ba33ac --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -0,0 +1,64 @@ +--- +title: DynamicalDecouplingOptions +description: API reference for qiskit_ibm_runtime.options.DynamicalDecouplingOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions +--- + +# DynamicalDecouplingOptions + + + Options for dynamical decoupling (DD). + + ## Attributes + + ### enable + + + Whether to enable DD as specified by the other options in this class. + + Default: False. + + + ### extra\_slack\_distribution + + + Where to put extra timing delays due to rounding issues. Rounding issues arise because the discrete time step `dt` of the system cannot be divided. This option takes following values. + + Default: “middle”. + + * `"middle"`: Put the extra slack to the interval at the middle of the sequence. + + * **`"edges"`: Divide the extra slack as evenly as possible into intervals at** + + beginning and end of the sequence. + + + ### scheduling\_method + + + Whether to schedule gates as soon as (“asap”) or as late as (“alap”) possible. + + Default: “alap”. + + + ### sequence\_type + + + Which dynamical decoupling sequence to use. + + Default: “XX”. + + * `"XX"`: use the sequence `tau/2 - (+X) - tau - (+X) - tau/2` + + * `"XpXm"`: use the sequence `tau/2 - (+X) - tau - (-X) - tau/2` + + * **`"XY4"`:use the sequence** + + `tau/2 - (+X) - tau - (+Y) - tau (-X) - tau - (-Y) - tau/2` + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.EnvironmentOptions.mdx new file mode 100644 index 00000000000..91d916b9e7c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -0,0 +1,51 @@ +--- +title: EnvironmentOptions +description: API reference for qiskit_ibm_runtime.options.EnvironmentOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions +--- + +# EnvironmentOptions + + + Options related to the execution environment. + + ## Attributes + + ### callback + + + Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: + + > 1. Job ID + > 2. Job result. + + Default: `None`. + + + ### job\_tags + + + Tags to be assigned to the job. The tags can subsequently be used as a filter in the `qiskit_ibm_runtime.qiskit_runtime_service.jobs()` function call. + + Default: `None`. + + + ### log\_level + + + logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. + + Default: `WARNING`. + + + ### private + + + Boolean value for marking jobs as private. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.EstimatorOptions.mdx new file mode 100644 index 00000000000..8d56e9ab5bd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -0,0 +1,131 @@ +--- +title: EstimatorOptions +description: API reference for qiskit_ibm_runtime.options.EstimatorOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.EstimatorOptions +--- + +# EstimatorOptions + + + Options for V2 Estimator. + + ## Attributes + + ### default\_precision + + + The default precision to use for any PUB or `run()` call that does not specify one. Each Estimator PUB can specify its own precision. If the `run()` method is given a precision, then that value is used for all PUBs in the `run()` call that do not specify their own. + + Default: 0.015625 (1 / sqrt(4096)). + + + ### default\_shots + + + The total number of shots to use per circuit per configuration. + + + If set, this value overrides [`default_precision`](#qiskit_ibm_runtime.options.EstimatorOptions.default_precision "qiskit_ibm_runtime.options.EstimatorOptions.default_precision"). + + + A configuration is a combination of a specific parameter value binding set and a physical measurement basis. A physical measurement basis groups together some collection of qubit-wise commuting observables for some specific circuit/parameter value set to create a single measurement with basis rotations that is inserted into hardware executions. + + If twirling is enabled, the value of this option will be divided over circuit randomizations, with a smaller number of shots per randomization. See the [`twirling`](#qiskit_ibm_runtime.options.EstimatorOptions.twirling "qiskit_ibm_runtime.options.EstimatorOptions.twirling") options. + + Default: `None`. + + + ### dynamical\_decoupling + + + Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. + + + ### environment + + + + ### execution + + + Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + + + ### experimental + + + Experimental options. These options are subject to change without notification, and stability is not guaranteed. + + + ### max\_execution\_time + + + + ### optimization\_level + + + (DEPRECATED) How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times. + + * 0: no optimization + * 1: light optimization + + Default: 0. + + + ### resilience + + + Advanced resilience options to fine-tune the resilience strategy. See [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2") for all available options. + + + ### resilience\_level + + + How much resilience to build against errors. Higher levels generate more accurate results, at the expense of longer processing times. + + * 0: No mitigation. + + * 1: Minimal mitigation costs. Mitigate error associated with readout errors. + + * **2: Medium mitigation costs. Typically reduces bias in estimators but** + + is not guaranteed to be zero bias. + + Refer to the [Configure error mitigation for Qiskit Runtime](/guides/configure-error-mitigation) guide for more information about the error mitigation methods used at each level. + + Default: 1. + + + ### seed\_estimator + + + Seed used to control sampling. + + Default: `None`. + + + ### simulator + + + + ### twirling + + + Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. + + + ## Methods + + ### update + + + Update the options. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx new file mode 100644 index 00000000000..752c6842d5b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -0,0 +1,30 @@ +--- +title: ExecutionOptionsV2 +description: API reference for qiskit_ibm_runtime.options.ExecutionOptionsV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2 +--- + +# ExecutionOptionsV2 + + + Execution options for V2 primitives. + + ## Attributes + + ### init\_qubits + + + Whether to reset the qubits to the ground state for each shot. Default is `True`. + + + ### rep\_delay + + + The repetition delay. This is the delay between a measurement and the subsequent quantum circuit. This is only supported on backends that have `backend.dynamic_reprate_enabled=True`. It must be from the range supplied by `backend.rep_delay_range`. Default is given by `backend.default_rep_delay`. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx new file mode 100644 index 00000000000..eaeefa355ea --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -0,0 +1,54 @@ +--- +title: LayerNoiseLearningOptions +description: API reference for qiskit_ibm_runtime.options.LayerNoiseLearningOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions +--- + +# LayerNoiseLearningOptions + + + Options for learning layer noise. This is only used by V2 Estimator. + + + These options are only used when the resilience level or options specify a technique that requires layer noise learning. + + + ## Attributes + + ### layer\_pair\_depths + + + The circuit depths (measured in number of pairs) to use in learning experiments. Pairs are used as the unit because we exploit the order-2 nature of our entangling gates in the noise learning implementation. A value of `3` would correspond to 6 layers of the layer of interest, for example. + + Default: (0, 1, 2, 4, 16, 32). + + + ### max\_layers\_to\_learn + + + The max number of unique layers to learn. A `None` value indicates that there is no limit. If there are more unique layers present, then some layers will not be learned or mitigated. The learned layers are prioritized based on the number of times they occur in a set of run Estimator PUBs, and for equally occurring layers are further sorted by the number of two-qubit gates in the layer. + + Default: 4. + + + ### num\_randomizations + + + The number of random circuits to use per learning circuit configuration. A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, and nine required measurement bases, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each). + + Default: 32. + + + ### shots\_per\_randomization + + + The total number of shots to use per random learning circuit. A learning circuit is a random circuit at a specific learning depth with a specific measurement basis that is executed on hardware. + + Default: 128. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx new file mode 100644 index 00000000000..956f9d0c9ce --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -0,0 +1,38 @@ +--- +title: MeasureNoiseLearningOptions +description: API reference for qiskit_ibm_runtime.options.MeasureNoiseLearningOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions +--- + +# MeasureNoiseLearningOptions + + + Options for measurement noise learning. This is only used by V2 Estimator. + + + These options are only used when the resilience level or options specify a technique that requires measurement noise learning. + + + ## Attributes + + ### num\_randomizations + + + The number of random circuits to draw for the measurement learning experiment. + + Default: 32. + + + ### shots\_per\_randomization + + + The number of shots to use for the learning experiment per random circuit. If “auto”, the value will be chosen automatically based on the input PUBs. + + Default: “auto”. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx new file mode 100644 index 00000000000..6c35f2eabea --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx @@ -0,0 +1,106 @@ +--- +title: NoiseLearnerOptions +description: API reference for qiskit_ibm_runtime.options.NoiseLearnerOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions +--- + +# NoiseLearnerOptions + + + Options for [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner"). + + ## Attributes + + ### environment + + + + ### experimental + + + Experimental options. + + These options are subject to change without notification, and stability is not guaranteed. + + + ### layer\_pair\_depths + + + The circuit depths (measured in number of pairs) to use in learning experiments. + + Pairs are used as the unit because we exploit the order-2 nature of our entangling gates in the noise learning implementation. A value of `3` would correspond to 6 layers of the layer of interest, for example. Default: (0, 1, 2, 4, 16, 32). + + + ### max\_execution\_time + + + + ### max\_layers\_to\_learn + + + The max number of unique layers to learn. + + A `None` value indicates that there is no limit. If there are more unique layers present, then some layers will not be learned or mitigated. The learned layers are prioritized based on the number of times they occur, and for equally occurring layers are further sorted by the number of two-qubit gates in the layer. Default: 4. + + + ### num\_randomizations + + + The number of random circuits to use per learning circuit configuration. + + A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, and nine required measurement bases, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization "qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization") each). Default: 32. + + + ### shots\_per\_randomization + + + The total number of shots to use per random learning circuit. + + A learning circuit is a random circuit at a specific learning depth with a specific measurement basis that is executed on hardware. Default: 128. + + + ### simulator + + + + ### twirling\_strategy + + + The twirling strategy in the identified layers of two-qubit twirled gates. + + The allowed values are: + + > * `"active"`: in each individual twirled layer, only the instruction qubits are twirled. + > + > * **`"active-circuit"`: in each individual twirled layer, the union of all instruction** + > + > qubits in the circuit are twirled. + > + > * **`"active-accum"`: in each individual twirled layer, the union of instructions qubits** + > + > in the circuit up to the current twirled layer are twirled. + > + > * `"all"`: in each individual twirled layer, all qubits in the input circuit are twirled. + + + Barriers and delay instructions are ignored when determining whether a qubit is active. + + + Default: “active-accum”. + + + ## Methods + + ### update + + + Update the options. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.PecOptions.mdx new file mode 100644 index 00000000000..638891240ed --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.PecOptions.mdx @@ -0,0 +1,41 @@ +--- +title: PecOptions +description: API reference for qiskit_ibm_runtime.options.PecOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.PecOptions +--- + +# PecOptions + + + Probabalistic error cancellation mitigation options. This is only used by V2 Estimator. + + ## Attributes + + ### max\_overhead + + + The maximum circuit sampling overhead allowed, or `None` for no maximum. + + Default: 100. + + + ### noise\_gain + + + The amount by which to scale the noise, where: + + * A value of 0 corresponds to removing the full learned noise. + * A value of 1 corresponds to no removal of the learned noise. + * A value between 0 and 1 corresponds to partially removing the learned noise. + * A value greater than one corresponds to amplifying the learned noise. + + If “auto”, the value in the range `[0, 1]` will be chosen automatically for each input PUB based on the learned noise strength, `max_overhead`, and the depth of the PUB. + + Default: “auto”. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx new file mode 100644 index 00000000000..f8f7c85a424 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx @@ -0,0 +1,72 @@ +--- +title: ResilienceOptionsV2 +description: API reference for qiskit_ibm_runtime.options.ResilienceOptionsV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.ResilienceOptionsV2 +--- + +# ResilienceOptionsV2 + + + Resilience options for V2 Estimator. + + ## Attributes + + ### layer\_noise\_learning + + + Layer noise learning options. See [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for all options. + + + ### layer\_noise\_model + + + A `NoiseLearnerResult` or a sequence of `LayerError` objects. If set, all the mitigation strategies that require noise data (e.g., PEC and PEA) skip the noise-learning stage, and instead gather the required information from `layer_noise_model`. Layers whose information is missing in `layer_noise_model` are treated as noiseless and their noise is not mitigated. + + + ### measure\_mitigation + + + Whether to enable measurement error mitigation method. If you enable measurement mitigation, you can fine-tune its noise learning by using [`measure_noise_learning`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning "qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning"). See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all measurement mitigation noise learning options. + + Default: True. + + + ### measure\_noise\_learning + + + Additional measurement noise learning options. See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all options. + + + ### pec + + + Additional probabalistic error cancellation mitigation options. See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for all options. + + + ### pec\_mitigation + + + Whether to turn on Probabilistic Error Cancellation error mitigation method. If you enable PEC, you can fine-tune its options by using [`pec`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.pec "qiskit_ibm_runtime.options.ResilienceOptionsV2.pec"). See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for additional PEC-related options. + + Default: False. + + + ### zne + + + Additional zero-noise extrapolation mitigation options. See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for all options. + + + ### zne\_mitigation + + + Whether to turn on Zero-Noise Extrapolation error mitigation method. If you enable ZNE, you can fine-tune its options by using [`zne`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.zne "qiskit_ibm_runtime.options.ResilienceOptionsV2.zne"). See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for additional ZNE related options. + + Default: False. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx new file mode 100644 index 00000000000..38f13d7f87b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx @@ -0,0 +1,46 @@ +--- +title: SamplerExecutionOptionsV2 +description: API reference for qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 +--- + +# SamplerExecutionOptionsV2 + + + Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. + + ## Attributes + + ### init\_qubits + + + Whether to reset the qubits to the ground state for each shot. Default is `True`. + + + ### meas\_type + + + How to process and return measurement results. + + This option sets the return type of all classical registers in all `SamplerPubResult`s. If a sampler pub with shape `pub_shape` has a circuit that contains a classical register with size `creg_size`, then the returned data associated with this register will have one of the following formats depending on the value of this option. + + * `"classified"`: A `BitArray` of shape `pub_shape` over `num_shots` with a number of bits equal to `creg_size`. + * `"kerneled"`: A complex NumPy array of shape `(*pub_shape, num_shots, creg_size)`, where each entry represents an IQ data point (resulting from kerneling the measurement trace) in arbitrary units. + * `"avg_kerneled"`: A complex NumPy array of shape `(*pub_shape, creg_size)`, where each entry represents an IQ data point (resulting from kerneling the measurement trace and averaging over shots) in arbitrary units. This option is equivalent to selecting `"kerneled"` and then averaging over the shots axis, but requires less data bandwidth. + + Default: “classified”. + + See [here](https://pubs.aip.org/aip/rsi/article/88/10/104703/836456) for a description of kerneling. + + + ### rep\_delay + + + The repetition delay. This is the delay between a measurement and the subsequent quantum circuit. This is only supported on backends that have `backend.dynamic_reprate_enabled=True`. It must be from the range supplied by `backend.rep_delay_range`. Default is given by `backend.default_rep_delay`. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SamplerOptions.mdx new file mode 100644 index 00000000000..7b156e29866 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -0,0 +1,72 @@ +--- +title: SamplerOptions +description: API reference for qiskit_ibm_runtime.options.SamplerOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.SamplerOptions +--- + +# SamplerOptions + + + Options for V2 Sampler. + + ## Attributes + + ### default\_shots + + + The default number of shots to use if none are specified in the PUBs or in the run method. + + Default: 4096. + + + ### dynamical\_decoupling + + + Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. + + + ### environment + + + + ### execution + + + Execution time options. See [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2") for all available options. + + + ### experimental + + + Experimental options. + + + ### max\_execution\_time + + + + ### simulator + + + + ### twirling + + + Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. + + + ## Methods + + ### update + + + Update the options. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SimulatorOptions.mdx new file mode 100644 index 00000000000..e6d6a917368 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -0,0 +1,70 @@ +--- +title: SimulatorOptions +description: API reference for qiskit_ibm_runtime.options.SimulatorOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.SimulatorOptions +--- + +# SimulatorOptions + + + Simulator options. + + For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. + + ## Attributes + + ### basis\_gates + + + List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set. + + Default: all basis gates supported by the simulator. + + + ### coupling\_map + + + Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interaction, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]`. + + Default: `None`, which implies no connectivity constraints. + + + ### noise\_model + + + Noise model for the simulator. + + Default: `None`. + + + ### seed\_simulator + + + Random seed to control sampling. + + Default: `None`. + + + ## Methods + + ### set\_backend + + + Set backend for simulation. This method changes noise\_model, coupling\_map, basis\_gates according to given backend. + + **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. + + **Raises** + + **MissingOptionalLibraryError** – if qiskit-aer is not found. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.TwirlingOptions.mdx new file mode 100644 index 00000000000..42be9a5ebeb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -0,0 +1,81 @@ +--- +title: TwirlingOptions +description: API reference for qiskit_ibm_runtime.options.TwirlingOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.TwirlingOptions +--- + +# TwirlingOptions + + + Twirling options. + + ## Attributes + + ### enable\_gates + + + Whether to apply 2-qubit Clifford gate twirling. Default: False. + + + ### enable\_measure + + + Whether to enable twirling of measurements. + + Twirling will only be applied to those measurement registers not involved within a conditional logic. Default: True for Estimator, false for Sampler. + + + ### num\_randomizations + + + The number of random samples to use when twirling or peforming sampled mitigation. + + If `num_randomizations` is “auto”, for every pub executed `shots` times: + + > * If `shots_per_randomization` is also “auto”, `shots_per_randomization` is set first as described below, then `num_randomizations` is set as `ceil(shots/shots_per_randomization)`, where `ceil` is the ceiling function. + > * Otherwise, the value is set to `ceil(shots/shots_per_randomization)`. + > + > Default: “auto”. + + + The `shots` value specified in a PUB or in the `run()` method is considered part of the primitive execution interface and therefore is always obeyed. `default_shots`, on the other hand, is considered a Qiskit Runtime specific option. Therefore, the product of `num_randomizations` and `shots_per_randomization` takes precedence over `default_shots`. + + + + ### shots\_per\_randomization + + + The number of shots to run for each random sample. + + If “auto”, for every pub executed `shots` times: + + > * If `num_randomizations` is also “auto”, the value is set to `64` for PEC mitigation or to `max(64, ceil(shots / 32))` in all other cases, where `ceil` is the ceiling function. + > * Otherwise, the value is set to `ceil(shots/num_randomizations)`. + > + > Default: “auto”. + + + The `shots` value specified in a PUB or in the `run()` method is considered part of the primitive execution interface and therefore is always obeyed. `default_shots`, on the other hand, is considered a Qiskit Runtime specific option. Therefore, the product of `num_randomizations` and `shots_per_randomization` takes precedence over `default_shots`. + + + + ### strategy + + + Specify the strategy of twirling qubits in identified layers of 2-qubit twirled gates. + + Allowed values are: + + > * If `"active"` only the instruction qubits in each individual twirled layer will be twirled. + > * If `"active-circuit"` the union of all instruction qubits in the circuit will be twirled in each twirled layer. + > * If `"active-accum"` the union of instructions qubits in the circuit up to the current twirled layer will be twirled in each individual twirled layer. + > * If `"all"` all qubits in the input circuit will be twirled in each twirled layer. + > + > Default: “active-accum”. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ZneOptions.mdx new file mode 100644 index 00000000000..70b47e566d2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -0,0 +1,88 @@ +--- +title: ZneOptions +description: API reference for qiskit_ibm_runtime.options.ZneOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.ZneOptions +--- + +# ZneOptions + + + Zero noise extrapolation mitigation options. This is only used by the V2 Estimator. + + + Any V2 estimator is guaranteed to return data fields called `evs` and `stds` that report the desired expectation value estimates and errors, respectively. When ZNE options are enabled in the runtime estimator, additional data is returned. + + In particular, suppose an input pub has observable array shape `obs_shape` and parameter values shape `par_shape`, with corresponding pub shape `shape=np.broadcast_shapes(obs_shape, par_shape)`. Then the corresponding pub result will additionally contain: + + 1. **pub\_result.data.evs\_extrapolated and pub\_result.data.stds\_extrapolated,** + + both with shape `(*shape, num_extrapolators, num_evaluation_points)`, where `num_extrapolators` is the length of the list of `options.resilience.zne.extrapolators`, and `num_evaluation_points` is the length of the list `options.resilience.extrapolated_noise_factors`. These values provide evaluations of every extrapolator at every specified noise extrapolation value. + + 2. `pub_result.data.evs_noise_factors`, `pub_result.data.stds_noise_factors`, and `ensemble_stds_noise_factors` all have shape `(*shape, num_noise_factors)` where `num_noise_factors` is the length of `options.resilience.zne.noise_factors`. These values provide evaluations of the best-fit model at each of the noise amplifications. In the case of no twirling, both `*stds*` arrays will be equal, otherwise, `stds_noise_factors` is derived from the spread over twirling samples, whereas `ensemble_stds_noise_factors` assumes only shot noise and no drift. + + Technical note: for single observables with multiple basis terms it might turn out that multiple extrapolation methods are used in *the same* expectation value, for example, `XX` gets linearly extrapolated but `XY` gets exponentially extrapolated in the observable `{"XX": 0.5, "XY": 0.5}`. Let’s call this a *hetergeneous fit*. The data from (2) is evaluated from heterogeneous fits by selecting the best fit for every individual distinct term, whereas data from (1) is evaluated from forced homogenous fits, one for each provided extrapolator. If your work requires a nuanced distinction in this regard, we presently recommend that you use single-term observables in addition to your multi-term observables. + + + **Parameters** + + * **amplifier** – + + Which technique to use for amplifying noise. One of: + + * ”gate\_folding” (default) uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are chosen randomly. + + * ”gate\_folding\_front” uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are selected from the front of the topologically ordered DAG circuit. + + * ”gate\_folding\_back” uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are selected from the back of the topologically ordered DAG circuit. + + * ”pea” uses a technique called Probabilistic Error Amplification ([PEA](https://www.nature.com/articles/s41586-023-06096-3)) to amplify noise. + + When this option is selected, gate twirling will always be used whether or not it has been enabled in the options. + + 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. + + * **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`. + + * **extrapolator** – + + Extrapolator(s) to try (in order) for extrapolating to zero noise. The available options are: + + > * `"exponential"`, which fits the data using an exponential decaying function defined as $f(x; A, au) = A e^{-x/ au}$, where $A = f(0; A, au)$ is the value at zero noise ($x=0$) and :math:\` au>0\` is a positive rate. + > * `"double_exponential"`, which uses a sum of two exponential as in Ref. 1. + > * `"polynomial_degree_(1 <= k <= 7)"`, which uses a polynomial function defined as $f(x; c_0, c_1, \ldots, c_k) = \sum_{i=0, k} c_i x^i$. + > * `"linear"`, which is equivalent to `"polynomial_degree_1"`. + > * `"fallback"`, which simply returns the raw data corresponding to the lowest noise factor (typically `1`) without performing any sort of extrapolation. + + If more than one extrapolator is specified, the `evs` and `stds` reported in the result’s data refer to the first one, while the extrapolated values (`evs_extrapolated` and `stds_extrapolated`) are sorted according to the order of the extrapolators provided. + + Default: `("exponential", "linear")`. + + **References** + + 1. Z. Cai, *Multi-exponential error extrapolation and combining error mitigation techniques for NISQ applications*, [npj Quantum Inf 7, 80 (2021)](https://www.nature.com/articles/s41534-021-00404-3) + + ## Attributes + + ### amplifier + + + + ### extrapolated\_noise\_factors + + + + ### extrapolator + + + + ### noise\_factors + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx new file mode 100644 index 00000000000..c88e83e4424 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx @@ -0,0 +1,149 @@ +--- +title: ConvertISAToClifford +description: API reference for qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford +--- + +# ConvertISAToClifford + + + Convert the gates of an ISA circuit to Clifford gates. + + ISA circuits only contain Clifford gates from a restricted set or [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.2)")s by arbitrary angles. To convert them to Clifford circuits, this pass rounds the angle of every [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.2)") to the closest multiple of pi/2 (or to a random multiple of pi/2 if the angle is unspecified), while it skips every Clifford gate, measurement, and barrier. + + ```python + import numpy as np + + from qiskit.circuit import QuantumCircuit, Parameter + from qiskit.transpiler import PassManager + + from qiskit_ibm_runtime.transpiler.passes import ConvertISAToClifford + + # An ISA circuit ending with a Z rotation by pi/3 + qc = QuantumCircuit(2, 2) + qc.sx(0) + qc.rz(np.pi/2, 0) + qc.sx(0) + qc.barrier() + qc.cx(0, 1) + qc.rz(np.pi/3, 0) # non-Clifford Z rotation + qc.rz(Parameter("th"), 0) # Z rotation with unspecified angle + + # Turn into a Clifford circuit + pm = PassManager([ConvertISAToClifford()]) + clifford_qc = pm.run(qc) + ``` + + **Raises** + + **ValueError** – If the given circuit contains unsupported operations, such as non-ISA gates. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run a pass on the DAGCircuit. This is implemented by the pass developer. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run. + + **Raises** + + **NotImplementedError** – when this is left unimplemented for a pass. + + **Return type** + + [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx new file mode 100644 index 00000000000..0ebb38050d3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx @@ -0,0 +1,127 @@ +--- +title: ConvertIdToDelay +description: API reference for qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay +--- + +# ConvertIdToDelay + + + Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. + + Convert [`qiskit.circuit.library.IGate`](/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.2)") to a Convert [`qiskit.circuit.Delay`](/api/qiskit/circuit#qiskit.circuit.Delay "(in Qiskit v1.2)"). + + **Parameters** + + * **duration** – Duration of the delay to replace the identity gate with. + * **gate** (`str`) – Single qubit gate to extract duration from. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run a pass on the DAGCircuit. This is implemented by the pass developer. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run. + + **Raises** + + **NotImplementedError** – when this is left unimplemented for a pass. + + **Return type** + + [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx new file mode 100644 index 00000000000..ec57aa6fff4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -0,0 +1,142 @@ +--- +title: ALAPScheduleAnalysis +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis +--- + +# ALAPScheduleAnalysis + + + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. + + This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. + + In its current form this is similar to Qiskit’s ALAP scheduler in which instructions start as late as possible. + + The primary differences are that: + + * **Resets and control-flow currently trigger the end of a “quantum block”. The period between the end** + + of the block and the next is *nondeterministic* ie., we do not know when the next block will begin (as we could be evaluating a classical function of nondeterministic length) and therefore the next block starts at a *relative* t=0. + + * During a measurement it is possible to apply gates in parallel on disjoint qubits. + + * Measurements and resets on disjoint qubits happen simultaneously and are part of the same block. + + Scheduler for dynamic circuit backends. + + **Parameters** + + * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)")) – Durations of instructions to be used in scheduling. + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")], `Generator`\[[`DAGOpNode`](/api/qiskit/qiskit.dagcircuit.DAGOpNode "(in Qiskit v1.2)"), `None`, `None`]]]) – A callable used to produce an ordering of the nodes to minimize the number of blocks needed. If not provided, `block_order_op_nodes()` will be used. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") :param dag: DAG to schedule. :type dag: DAGCircuit + + **Raises** + + * **TranspilerError** – if the circuit is not mapped on physical qubits. + * **TranspilerError** – if conditional bit is added to non-supported instruction. + + **Return type** + + `None` + + **Returns** + + The scheduled DAGCircuit. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx new file mode 100644 index 00000000000..37f8703ae96 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -0,0 +1,142 @@ +--- +title: ASAPScheduleAnalysis +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis +--- + +# ASAPScheduleAnalysis + + + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. + + This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. + + In its current form this is similar to Qiskit’s ASAP scheduler in which instructions start as early as possible. + + The primary differences are that: + + * **Resets and control-flow currently trigger the end of a “quantum block”. The period between the end** + + of the block and the next is *nondeterministic* ie., we do not know when the next block will begin (as we could be evaluating a classical function of nondeterministic length) and therefore the next block starts at a *relative* t=0. + + * During a measurement it is possible to apply gates in parallel on disjoint qubits. + + * Measurements and resets on disjoint qubits happen simultaneously and are part of the same block. + + Scheduler for dynamic circuit backends. + + **Parameters** + + * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)")) – Durations of instructions to be used in scheduling. + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")], `Generator`\[[`DAGOpNode`](/api/qiskit/qiskit.dagcircuit.DAGOpNode "(in Qiskit v1.2)"), `None`, `None`]]]) – A callable used to produce an ordering of the nodes to minimize the number of blocks needed. If not provided, `block_order_op_nodes()` will be used. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") :param dag: DAG to schedule. :type dag: DAGCircuit + + **Raises** + + * **TranspilerError** – if the circuit is not mapped on physical qubits. + * **TranspilerError** – if conditional bit is added to non-supported instruction. + + **Return type** + + [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") + + **Returns** + + The scheduled DAGCircuit. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx new file mode 100644 index 00000000000..c1e8b78ccee --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -0,0 +1,135 @@ +--- +title: BlockBasePadder +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder +--- + +# BlockBasePadder + + + The base class of padding pass. + + This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. + + This base class doesn’t define any sequence to interleave, but it manages the location where the sequence is inserted, and provides a set of information necessary to construct the proper sequence. Thus, a subclass of this pass just needs to implement `_pad()` method, in which the subclass constructs a circuit block to insert. This mechanism removes lots of boilerplate logic to manage whole DAG circuits. + + Note that padding pass subclasses should define interleaving sequences satisfying: + + > * Interleaved sequence does not change start time of other nodes + > * Interleaved sequence should have total duration of the provided `time_interval`. + + Any manipulation violating these constraints may prevent this base pass from correctly tracking the start time of each instruction, which may result in violation of hardware alignment constraints. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the padding pass on `dag`. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – DAG to be checked. + + **Returns** + + DAG with idle time filled with instructions. + + **Return type** + + DAGCircuit + + **Raises** + + **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx new file mode 100644 index 00000000000..bd160bb9dd4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -0,0 +1,120 @@ +--- +title: DynamicCircuitInstructionDurations +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations +--- + +# DynamicCircuitInstructionDurations + + + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. + + Dynamic circuit instruction durations. + + ## Attributes + + ### MEASURE\_PATCH\_CYCLES + + + + ### MEASURE\_PATCH\_ODD\_OFFSET + + + + ## Methods + + ### from\_backend + + + Construct a `DynamicInstructionDurations` object from the backend. :type backend: [`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)") :param backend: backend from which durations (gate lengths) and dt are extracted. + + **Returns** + + The InstructionDurations constructed from backend. + + **Return type** + + DynamicInstructionDurations + + + ### from\_target + + + Construct a `DynamicInstructionDurations` object from the target. :type target: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") :param target: target from which durations (gate lengths) and dt are extracted. + + **Returns** + + The InstructionDurations constructed from backend. + + **Return type** + + DynamicInstructionDurations + + + ### get + + + Get the duration of the instruction with the name, qubits, and parameters. + + Some instructions may have a parameter dependent duration. + + **Parameters** + + * **inst** (*str |* [*qiskit.circuit.Instruction*](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")) – An instruction or its name to be queried. + * **qubits** (*int | list\[int]*) – Qubit indices that the instruction acts on. + * **unit** (*str*) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. + * **parameters** (*list\[float] | None*) – The value of the parameters of the desired instruction. + + **Returns** + + The duration of the instruction on the qubits. + + **Return type** + + float|int + + **Raises** + + **TranspilerError** – No duration is defined for the instruction. + + + ### units\_used + + + Get the set of all units used in this instruction durations. + + **Return type** + + `set`\[`str`] + + **Returns** + + Set of units used in this instruction durations. + + + ### update + + + Update self with inst\_durations (inst\_durations overwrite self). Overrides the default durations for certain hardcoded instructions. + + **Parameters** + + * **inst\_durations** (`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]], `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]]]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)"), `None`]) – Instruction durations to be merged into self (overwriting self). + * **dt** (`Optional`\[`float`]) – Sampling duration in seconds of the target backend. + + **Returns** + + The updated InstructionDurations. + + **Return type** + + InstructionDurations + + **Raises** + + **TranspilerError** – If the format of instruction\_durations is invalid. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx new file mode 100644 index 00000000000..261c35f5685 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -0,0 +1,149 @@ +--- +title: PadDelay +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay +--- + +# PadDelay + + + Padding idle time with Delay instructions. + + Consecutive delays will be merged in the output of this pass. + + The ASAP-scheduled circuit output may become + + ```python + ┌────────────────┐ + q_0: ┤ Delay(160[dt]) ├──■── + └─────┬───┬──────┘┌─┴─┐ + q_1: ──────┤ X ├───────┤ X ├ + └───┘ └───┘ + ``` + + Note that the additional idle time of 60dt on the `q_0` wire coming from the duration difference between `Delay` of 100dt (`q_0`) and `XGate` of 160 dt (`q_1`) is absorbed in the delay instruction on the `q_0` wire, i.e. in total 160 dt. + + See [`BlockBasePadder`](qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder") pass for details. + + Create new padding delay pass. + + **Parameters** + + * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)")) – Durations of instructions to be used in scheduling. + * **fill\_very\_end** (`bool`) – Set `True` to fill the end of circuit with delay. + * **schedule\_idle\_qubits** (`bool`) – Set to true if you’d like a delay inserted on idle qubits. This is useful for timeline visualizations, but may cause issues for execution on large backends. + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")], `Generator`\[[`DAGOpNode`](/api/qiskit/qiskit.dagcircuit.DAGOpNode "(in Qiskit v1.2)"), `None`, `None`]]]) – A callable used to produce an ordering of the nodes to minimize the number of blocks needed. If not provided, `block_order_op_nodes()` will be used. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the padding pass on `dag`. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – DAG to be checked. + + **Returns** + + DAG with idle time filled with instructions. + + **Return type** + + DAGCircuit + + **Raises** + + **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx new file mode 100644 index 00000000000..1735443239d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -0,0 +1,286 @@ +--- +title: PadDynamicalDecoupling +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling +--- + +# PadDynamicalDecoupling + + + Dynamical decoupling insertion pass for IBM dynamic circuit backends. + + This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). + + ```python + import numpy as np + from qiskit.circuit import QuantumCircuit + from qiskit.circuit.library import XGate + from qiskit.transpiler import PassManager, InstructionDurations + from qiskit.visualization import timeline_drawer + + from qiskit_ibm_runtime.transpiler.passes.scheduling import ALAPScheduleAnalysis + from qiskit_ibm_runtime.transpiler.passes.scheduling import PadDynamicalDecoupling + + circ = QuantumCircuit(4) + circ.h(0) + circ.cx(0, 1) + circ.cx(1, 2) + circ.cx(2, 3) + circ.measure_all() + durations = InstructionDurations( + [("h", 0, 50), ("cx", [0, 1], 700), ("reset", None, 10), + ("cx", [1, 2], 200), ("cx", [2, 3], 300), + ("x", None, 50), ("measure", None, 1000)] + ) + ``` + + ```python + # balanced X-X sequence on all qubits + dd_sequence = [XGate(), XGate()] + pm = PassManager([ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence)]) + circ_dd = pm.run(circ) + circ_dd.draw() + ``` + + ```python + ┌───┐ ┌───────────────┐ ┌───┐ » + q_0: ──────┤ H ├─────────■──┤ Delay(96[dt]) ├──────┤ X ├──────» + ┌─────┴───┴─────┐ ┌─┴─┐└───────────────┘┌─────┴───┴─────┐» + q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■────────┤ Delay(48[dt]) ├» + ├───────────────┴┐└───┘ ┌─┴─┐ └───────────────┘» + q_2: ┤ Delay(750[dt]) ├───────────┤ X ├──────────────■────────» + ├────────────────┤ └───┘ ┌─┴─┐ » + q_3: ┤ Delay(950[dt]) ├────────────────────────────┤ X ├──────» + └────────────────┘ └───┘ » + meas: 4/═════════════════════════════════════════════════════════» + » + « ┌────────────────┐ ┌───┐ ┌───────────────┐ » + « q_0: ┤ Delay(208[dt]) ├──────┤ X ├──────┤ Delay(96[dt]) ├─────────────────» + « └─────┬───┬──────┘┌─────┴───┴─────┐└─────┬───┬─────┘┌───────────────┐» + « q_1: ──────┤ X ├───────┤ Delay(96[dt]) ├──────┤ X ├──────┤ Delay(56[dt]) ├» + « └───┘ └───────────────┘ └───┘ └───────────────┘» + « q_2: ─────────────────────────────────────────────────────────────────────» + « » + « q_3: ─────────────────────────────────────────────────────────────────────» + « » + «meas: 4/═════════════════════════════════════════════════════════════════════» + « » + « ░ ┌─┐ + « q_0: ─░─┤M├───────── + « ░ └╥┘┌─┐ + « q_1: ─░──╫─┤M├────── + « ░ ║ └╥┘┌─┐ + « q_2: ─░──╫──╫─┤M├─── + « ░ ║ ║ └╥┘┌─┐ + « q_3: ─░──╫──╫──╫─┤M├ + « ░ ║ ║ ║ └╥┘ + «meas: 4/════╩══╩══╩══╩═ + « 0 1 2 3 + ``` + + ```python + # Uhrig sequence on qubit 0 + n = 8 + dd_sequence = [XGate()] * n + def uhrig_pulse_location(k): + return np.sin(np.pi * (k + 1) / (2 * n + 2)) ** 2 + spacings = [] + for k in range(n): + spacings.append(uhrig_pulse_location(k) - sum(spacings)) + spacings.append(1 - sum(spacings)) + pm = PassManager( + [ + ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence, qubits=[0], spacings=spacings), + ] + ) + circ_dd = pm.run(circ) + circ_dd.draw() + ``` + + ```python + ┌───┐ ┌────────────────┐ ░ ┌─┐ » + q_0: ──────┤ H ├─────────■──┤ Delay(500[dt]) ├───────────────────░─┤M├──────» + ┌─────┴───┴─────┐ ┌─┴─┐└────────────────┘┌────────────────┐ ░ └╥┘┌─┐ » + q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■─────────┤ Delay(300[dt]) ├─░──╫─┤M├───» + ├───────────────┴┐└───┘ ┌─┴─┐ └────────────────┘ ░ ║ └╥┘┌─┐» + q_2: ┤ Delay(750[dt]) ├───────────┤ X ├───────────────■──────────░──╫──╫─┤M├» + ├────────────────┤ └───┘ ┌─┴─┐ ░ ║ ║ └╥┘» + q_3: ┤ Delay(950[dt]) ├─────────────────────────────┤ X ├────────░──╫──╫──╫─» + └────────────────┘ └───┘ ░ ║ ║ ║ » + meas: 4/═══════════════════════════════════════════════════════════════╩══╩══╩═» + 0 1 2 » + « + « q_0: ─── + « + « q_1: ─── + « + « q_2: ─── + « ┌─┐ + « q_3: ┤M├ + « └╥┘ + «meas: 4/═╩═ + « 3 + ``` + + + You need to call [`ALAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis") before running dynamical decoupling to guarantee your circuit satisfies acquisition alignment constraints for dynamic circuit backends. + + + Dynamical decoupling initializer. + + **Parameters** + + * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)")) – Durations of instructions to be used in scheduling. + + * **dd\_sequences** (`Union`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.2)")], `List`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.2)")]]]) – Sequence of gates to apply in idle spots. Alternatively a list of gate sequences may be supplied that will preferentially be inserted if there is a delay of sufficient duration. This may be tuned by the optionally supplied `sequence_min_length_ratios`. + + * **qubits** (`Optional`\[`List`\[`int`]]) – Physical qubits on which to apply DD. If None, all qubits will undergo DD (when possible). + + * **spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates. The available slack will be divided according to this. The list length must be one more than the length of dd\_sequence, and the elements must sum to 1. If None, a balanced spacing will be used \[d/2, d, d, …, d, d, d/2]. This spacing only applies to the first subcircuit, if a `coupling_map` is specified + + * **skip\_reset\_qubits** (`bool`) – If True, does not insert DD on idle periods that immediately follow initialized/reset qubits (as qubits in the ground state are less susceptible to decoherence). + + * **pulse\_alignment** (`int`) – The hardware constraints for gate timing allocation. This is usually provided from `backend.configuration().timing_constraints`. If provided, the delay length, i.e. `spacing`, is implicitly adjusted to satisfy this constraint. + + * **extra\_slack\_distribution** (`str`) – + + The option to control the behavior of DD sequence generation. The duration of the DD sequence should be identical to an idle time in the scheduled quantum circuit, however, the delay in between gates comprising the sequence should be integer number in units of dt, and it might be further truncated when `pulse_alignment` is specified. This sometimes results in the duration of the created sequence being shorter than the idle time that you want to fill with the sequence, i.e. extra slack. This option takes following values. + + > * ”middle”: Put the extra slack to the interval at the middle of the sequence. + > * ”edges”: Divide the extra slack as evenly as possible into intervals at beginning and end of the sequence. + + * **sequence\_min\_length\_ratios** (`Union`\[`int`, `List`\[`int`], `None`]) – List of minimum delay length to DD sequence ratio to satisfy in order to insert the DD sequence. For example if the X-X dynamical decoupling sequence is 320dt samples long and the available delay is 384dt it has a ratio of 384dt/320dt=1.2. From the perspective of dynamical decoupling this is likely to add more control noise than decoupling error rate reductions. The defaults value is 2.0. + + * **insert\_multiple\_cycles** (`bool`) – If the available duration exceeds 2\*sequence\_min\_length\_ratio\*duration(dd\_sequence) enable the insertion of multiple rounds of the dynamical decoupling sequence in that delay. + + * **coupling\_map** (`Optional`\[[`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)")]) – directed graph representing the coupling map for the device. Specifying a coupling map partitions the device into subcircuits, in order to apply DD sequences with different pulse spacings within each. Currently support 2 subcircuits. + + * **alt\_spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates, for the second subcircuit, as determined by the coupling map. If None, a balanced spacing that is staggered with respect to the first subcircuit will be used \[d, d, d, …, d, d, 0]. + + * **schedule\_idle\_qubits** (`bool`) – Set to true if you’d like a delay inserted on idle qubits. This is useful for timeline visualizations, but may cause issues for execution on large backends. + + * **dd\_barrier** (`Optional`\[`str`]) – only apply DD to delays terminating with a barrier whose label contains the specified string + + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")], `Generator`\[[`DAGOpNode`](/api/qiskit/qiskit.dagcircuit.DAGOpNode "(in Qiskit v1.2)"), `None`, `None`]]]) – A callable used to produce an ordering of the nodes to minimize the number of blocks needed. If not provided, `block_order_op_nodes()` will be used. + + **Raises** + + * **TranspilerError** – When invalid DD sequence is specified. + * **TranspilerError** – When pulse gate with the duration which is non-multiple of the alignment constraint value is found. + * **TranspilerError** – When the coupling map is not supported (i.e., if degree > 3) + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the padding pass on `dag`. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – DAG to be checked. + + **Returns** + + DAG with idle time filled with instructions. + + **Return type** + + DAGCircuit + + **Raises** + + **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx new file mode 100644 index 00000000000..20d03fee56e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx @@ -0,0 +1,372 @@ +--- +title: scheduling +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling +--- + + + + + +# Transpiler scheduling passes + +`qiskit_ibm_runtime.transpiler.passes.scheduling` + +A collection of scheduling passes for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical control-flow/feedback based off of measurement results. + + + You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.2)") or [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.2)"). + + +## Classes + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`BlockBasePadder`](qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder")(\[schedule\_idle\_qubits, ...]) | The base class of padding pass. | +| [`ALAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis")(durations\[, ...]) | Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. | +| [`ASAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis")(durations\[, ...]) | Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. | +| [`DynamicCircuitInstructionDurations`](qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations "qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations")(\[...]) | For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. | +| [`PadDelay`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay")(durations\[, fill\_very\_end, ...]) | Padding idle time with Delay instructions. | +| [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling")(durations, dd\_sequences) | Dynamical decoupling insertion pass for IBM dynamic circuit backends. | + +## Example usage + +Below we demonstrate how to schedule and pad a teleportation circuit with delays for a dynamic circuit backend’s execution model: + +```python +from qiskit.circuit import ClassicalRegister, QuantumCircuit, QuantumRegister +from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager +from qiskit.transpiler.passmanager import PassManager + +from qiskit_ibm_runtime.transpiler.passes.scheduling import DynamicCircuitInstructionDurations +from qiskit_ibm_runtime.transpiler.passes.scheduling import ALAPScheduleAnalysis +from qiskit_ibm_runtime.transpiler.passes.scheduling import PadDelay +from qiskit_ibm_runtime.fake_provider import FakeJakartaV2 + +backend = FakeJakartaV2() + +# Use this duration class to get appropriate durations for dynamic +# circuit backend scheduling +durations = DynamicCircuitInstructionDurations.from_backend(backend) +# Generate the main Qiskit transpile passes. +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +# Configure the as-late-as-possible scheduling pass +pm.scheduling = PassManager([ALAPScheduleAnalysis(durations), PadDelay(durations)]) + +qr = QuantumRegister(3) +crz = ClassicalRegister(1, name="crz") +crx = ClassicalRegister(1, name="crx") +result = ClassicalRegister(1, name="result") + +teleport = QuantumCircuit(qr, crz, crx, result, name="Teleport") + +teleport.h(qr[1]) +teleport.cx(qr[1], qr[2]) +teleport.cx(qr[0], qr[1]) +teleport.h(qr[0]) +teleport.measure(qr[0], crz) +teleport.measure(qr[1], crx) +with teleport.if_test((crz, 1)): + teleport.z(qr[2]) +with teleport.if_test((crx, 1)): + teleport.x(qr[2]) +teleport.measure(qr[2], result) + +# Transpile. +scheduled_teleport = pm.run(teleport) + +scheduled_teleport.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_0\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png) + +Instead of padding with delays we may also insert a dynamical decoupling sequence using the [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling") pass as shown below: + +```python +from qiskit.circuit.library import XGate + +from qiskit_ibm_runtime.transpiler.passes.scheduling import PadDynamicalDecoupling + + +dd_sequence = [XGate(), XGate()] + +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +pm.scheduling = PassManager( + [ + ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence), + ] +) + +dd_teleport = pm.run(teleport) + +dd_teleport.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_1\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png) + +When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.2)") function internally builds its pass set by using [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.2)"). This returns instances of [`StagedPassManager`](/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v1.2)"), which can be extended. + + + +## Scheduling old format c\_if conditioned gates + +Scheduling with old format `c_if` conditioned gates is not supported. + +```python +qc_c_if = QuantumCircuit(1, 1) +qc_c_if.x(0).c_if(0, 1) +qc_c_if.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_2\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png) + +The [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.2)"). This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification. + +```python +# Temporary workaround for mock backends. For real backends this is not required. +backend.get_translation_stage_plugin = lambda: "ibm_dynamic_circuits" + +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +pm.scheduling = PassManager( + [ + ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence), + ] +) + +qc_if_dd = pm.run(qc_c_if, backend) +qc_if_dd.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_3\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png) + +If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.2)") prior to your scheduling pass. + +```python +from qiskit.transpiler.passes import ConvertConditionsToIfOps + +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +pm.scheduling = PassManager( + [ + ConvertConditionsToIfOps(), + ALAPScheduleAnalysis(durations), + PadDelay(durations), + ] +) + +qc_if_dd = pm.run(qc_c_if) +qc_if_dd.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_4\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png) + + + +## Exploiting IBM backend’s local parallel “fast-path” + +IBM quantum hardware supports a localized “fast-path” which enables a block of gates applied to a *single qubit* that are conditional on an immediately predecessor measurement *of the same qubit* to be completed with lower latency. The hardware is also able to do this in *parallel* on disjoint qubits that satisfy this condition. + +For example, the conditional gates below are performed in parallel with lower latency as the measurements flow directly into the conditional blocks which in turn only apply gates to the same measurement qubit. + +```python +qc = QuantumCircuit(2, 2) +qc.measure(0, 0) +qc.measure(1, 1) +# Conditional blocks will be performed in parallel in the hardware +with qc.if_test((0, 1)): + qc.x(0) +with qc.if_test((1, 1)): + qc.x(1) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_5\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png) + +The circuit below will not use the fast-path as the conditional gate is on a different qubit than the measurement qubit. + +```python +qc = QuantumCircuit(2, 2) +qc.measure(0, 0) +with qc.if_test((0, 1)): + qc.x(1) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_6\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png) + +Similarly, the circuit below contains gates on multiple qubits and will not be performed using the fast-path. + +```python +qc = QuantumCircuit(2, 2) +qc.measure(0, 0) +with qc.if_test((0, 1)): + qc.x(0) + qc.x(1) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_7\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png) + +A fast-path block may contain multiple gates as long as they are on the fast-path qubit. If there are multiple fast-path blocks being performed in parallel each block will be padded out to the duration of the longest block. + +```python +qc = QuantumCircuit(2, 2) +qc.measure(0, 0) +qc.measure(1, 1) +# Conditional blocks will be performed in parallel in the hardware +with qc.if_test((0, 1)): + qc.x(0) + # Will be padded out to a duration of 1600 on the backend. +with qc.if_test((1, 1)): + qc.delay(1600, 1) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_8\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png) + +This behavior is also applied to the else condition of a fast-path eligible branch. + +```python +qc = QuantumCircuit(1, 1) +qc.measure(0, 0) +# Conditional blocks will be performed in parallel in the hardware +with qc.if_test((0, 1)) as else_: + qc.x(0) + # Will be padded out to a duration of 1600 on the backend. +with else_: + qc.delay(1600, 0) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_9\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png) + +If a single measurement result is used with several conditional blocks, if there is a fast-path eligible block it will be applied followed by the non-fast-path blocks which will execute with the standard higher latency conditional branch. + +```python +qc = QuantumCircuit(2, 2) +qc.measure(0, 0) +# Conditional blocks will be performed in parallel in the hardware +with qc.if_test((0, 1)): + # Uses fast-path + qc.x(0) +with qc.if_test((0, 1)): + # Does not use fast-path + qc.x(1) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_10\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png) + +If you wish to prevent the usage of the fast-path you may insert a barrier between the measurement and the conditional branch. + +```python +qc = QuantumCircuit(1, 2) +qc.measure(0, 0) +# Barrier prevents the fast-path. +qc.barrier() +with qc.if_test((0, 1)): + qc.x(0) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_11\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png) + +Conditional measurements are not eligible for the fast-path. + +```python +qc = QuantumCircuit(1, 2) +qc.measure(0, 0) +with qc.if_test((0, 1)): + # Does not use the fast-path + qc.measure(0, 1) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_12\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png) + +Similarly nested control-flow is not eligible. + +```python +qc = QuantumCircuit(1, 1) +qc.measure(0, 0) +with qc.if_test((0, 1)): + # Does not use the fast-path + qc.x(0) + with qc.if_test((0, 1)): + qc.x(0) + +qc.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_13\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png) + +The scheduler is aware of the fast-path behavior and will not insert delays on idle qubits in blocks that satisfy the fast-path conditions so as to avoid preventing the backend compiler from performing the necessary optimizations to utilize the fast-path. If there are fast-path blocks that will be performed in parallel they currently *will not* be padded out by the scheduler to ensure they are of the same duration in Qiskit + +```python +dd_sequence = [XGate(), XGate()] + +pm = PassManager( + [ + ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence), + ] +) + +qc = QuantumCircuit(2, 2) +qc.measure(0, 0) +qc.measure(1, 1) +with qc.if_test((0, 1)): + qc.x(0) + # Is currently not padded to ensure + # a duration of 1000. If you desire + # this you would need to manually add + # qc.delay(840, 0) +with qc.if_test((1, 1)): + qc.delay(1000, 0) + + +qc.draw(output="mpl", style="iqp") + +qc_dd = pm.run(qc) + +qc_dd.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_14\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png) + + + If there are qubits that are *not* involved in a fast-path decision it is not currently possible to use them in a fast-path branch in parallel with the fast-path qubits resulting from a measurement. This will be revised in the future as we further improve these capabilities. + + For example: + + ```python + qc = QuantumCircuit(3, 2) + qc.x(1) + qc.measure(0, 0) + with qc.if_test((0, 1)): + qc.x(0) + # Qubit 1 sits idle throughout the fast-path decision + with qc.if_test((1, 0)): + # Qubit 2 is idle but there is no measurement + # to make it fast-path eligible. This will + # however avoid a communication event in the hardware + # since the condition is compile time evaluated. + qc.x(2) + + qc.draw(output="mpl", style="iqp") + ``` + + ![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_15\_0.png](/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png) + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx new file mode 100644 index 00000000000..58f7eb6f2c3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx @@ -0,0 +1,110 @@ +--- +title: LayerError +description: API reference for qiskit_ibm_runtime.utils.noise_learner_result.LayerError +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.LayerError +--- + +# LayerError + + + The error channel (in Pauli-Lindblad format) of a single layer of instructions. + + **Parameters** + + * **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – A circuit whose noise has been learnt. + * **qubits** (`Sequence`\[`int`]) – The labels of the qubits in the `circuit`. + * **error** (`Optional`\[[`PauliLindbladError`](qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError")]) – The Pauli Lindblad error channel affecting the `circuit`, or `None` if the error channel is either unknown or explicitly disabled. + + **Raises** + + **ValueError** – If `circuit`, `qubits`, and `error` have mismatching number of qubits. + + ## Attributes + + ### circuit + + + The circuit in this `LayerError`. + + **Return type** + + [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") + + + ### error + + + The error channel in this `LayerError`, or `None` if the error channel is either unknown or explicitly disabled. + + **Return type** + + `Optional`\[[`PauliLindbladError`](qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError")] + + + ### generators + + + (DEPRECATED) The Pauli Lindblad generators of the error channel in this `LayerError`. + + **Return type** + + [`PauliList`](/api/qiskit/qiskit.quantum_info.PauliList "(in Qiskit v1.2)") + + + ### num\_qubits + + + The number of qubits in this [`LayerError`](#qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError"). + + **Return type** + + `int` + + + ### qubits + + + The qubits in this `LayerError`. + + **Return type** + + `list`\[`int`] + + + ### rates + + + (DEPRECATED) The Lindblad generator rates of the error channel in this `LayerError`. + + **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)")\[`float64`]] + + + ## Methods + + ### draw\_map + + + Draw a map view of a this layer error. + + **Parameters** + + * **embedding** (`Union`\[`Embedding`, [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")]) – An `Embedding` object containing the coordinates and coupling map to draw the layer error on, or a backend to generate an `Embedding` for. + * **colorscale** (`str`) – The colorscale used to show the rates of this layer error. + * **color\_no\_data** (`str`) – The color used for qubits and edges for which no data is available. + * **num\_edge\_segments** (`int`) – The number of equal-sized segments that edges are made of. + * **edge\_width** (`float`) – The line width of the edges in pixels. + * **height** (`int`) – The height of the returned figure. + * **background\_color** (`str`) – The background color. + * **radius** (`float`) – The radius of the pie charts representing the qubits. + * **width** (`int`) – The width of the returned figure. + + **Return type** + + `Figure` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.mdx new file mode 100644 index 00000000000..9017c52773b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.mdx @@ -0,0 +1,96 @@ +--- +title: PauliLindbladError +description: API reference for qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError +--- + +# PauliLindbladError + + + A Pauli error channel generated by a Pauli Lindblad dissipators. + + This operator represents an N-qubit quantum error channel $E(\rho) = e^{\sum_j r_j D_{P_j}}(\rho)$ generated by Pauli Lindblad dissipators $D_P(\rho) = P \rho P - \rho$, where $P_j$ are N-qubit `Pauli` operators. + + The list of Pauli generator terms are stored as a `PauliList` and can be accessed via the [`generators`](#qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.generators "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.generators") attribute. The array of dissipator rates $r_j$ can be accessed via the [`rates`](#qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.rates "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.rates") attribute. + + The equivalent Pauli error channel can be constructed as a composition of single-Pauli channel terms + +$$ +E = e^{\sum_j r_j D_{P_j}} = \prod_j e^{r_j D_{P_j}} += prod_j \left( (1 - p_j) S_I + p_j S_{P_j} \right) +$$ + + where $p_j = \frac12 - \frac12 e^{-2 r_j}$ \[1]. + + **Parameters** + + * **generators** ([`PauliList`](/api/qiskit/qiskit.quantum_info.PauliList "(in Qiskit v1.2)")) – A list of the Pauli Lindblad generators for the error channel. + * **rates** (`Sequence`\[`float`]) – A list of the rates for the Pauli-Lindblad `generators`. + + **Raises** + + **ValueError** – If `generators` and `rates` have different lengths. + + **References** + + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + + ## Attributes + + ### generators + + + The Pauli Lindblad generators of this [`PauliLindbladError`](#qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError"). + + **Return type** + + [`PauliList`](/api/qiskit/qiskit.quantum_info.PauliList "(in Qiskit v1.2)") + + + ### num\_qubits + + + The number of qubits in this [`PauliLindbladError`](#qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError"). + + **Return type** + + `int` + + + ### rates + + + The Lindblad generator rates of this quantum error. + + **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)")\[`float64`]] + + + ## Methods + + ### restrict\_num\_bodies + + + The [`PauliLindbladError`](#qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError") containing only those terms acting on exactly `num_qubits` qubits. + + **Parameters** + + **num\_qubits** (`int`) – The number of qubits that the returned error acts on. + + **Return type** + + [`PauliLindbladError`](#qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError") + + **Returns** + + The error containing only those terms acting on exactly `num_qubits` qubits. + + **Raises** + + **ValueError** – If `num_qubits` is smaller than `0`. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx new file mode 100644 index 00000000000..d3c01120660 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx @@ -0,0 +1,39 @@ +--- +title: draw_layer_error_map +description: API reference for qiskit_ibm_runtime.visualization.draw_layer_error_map +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit_ibm_runtime.visualization.draw_layer_error_map +--- + + + +# draw\_layer\_error\_map + + + Draw a map view of a [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError"). + + **Parameters** + + * **layer\_error** ([`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError")) – The [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError") to draw. + * **embedding** (`Union`\[`Embedding`, [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")]) – An `Embedding` object containing the coordinates and coupling map to draw the layer error on, or a backend to generate an `Embedding` for. + * **colorscale** (`str`) – The colorscale used to show the rates of `layer_error`. + * **color\_no\_data** (`str`) – The color used for qubits and edges for which no data is available. + * **num\_edge\_segments** (`int`) – The number of equal-sized segments that edges are made of. + * **edge\_width** (`float`) – The line width of the edges in pixels. + * **height** (`int`) – The height of the returned figure. + * **background\_color** (`str`) – The background color. + * **radius** (`float`) – The radius of the pie charts representing the qubits. + * **width** (`int`) – The width of the returned figure. + + **Raises** + + * **ValueError** – If the given coordinates are incompatible with the specified backend. + * **ValueError** – If `backend` has no coupling map. + * **ModuleNotFoundError** – If the required `plotly` dependencies cannot be imported. + + **Return type** + + `Figure` + + diff --git a/docs/api/qiskit-ibm-runtime/0.31/runtime_service.mdx b/docs/api/qiskit-ibm-runtime/0.31/runtime_service.mdx new file mode 100644 index 00000000000..2bec2ee8b14 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/runtime_service.mdx @@ -0,0 +1,168 @@ +--- +title: qiskit_ibm_runtime +description: API reference for qiskit_ibm_runtime +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime +--- + + + + + +# Qiskit Runtime + +`qiskit_ibm_runtime` + +Modules related to Qiskit Runtime IBM Client. + +Qiskit Runtime is a new architecture that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. + +## Primitives and sessions + +Qiskit Runtime has two predefined primitives: `Sampler` and `Estimator`. These primitives provide a simplified interface for performing foundational quantum computing tasks while also accounting for the latest developments in quantum hardware and software. + +Qiskit Runtime also has the concept of a session. Jobs submitted within a session are prioritized by the scheduler. A session allows you to make iterative calls to the quantum computer more efficiently. + +Below is an example of using primitives within a session: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, Session +from qiskit_ibm_runtime import SamplerV2 as Sampler +from qiskit_ibm_runtime import EstimatorV2 as Estimator +from qiskit.circuit.library import RealAmplitudes +from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister +from qiskit.quantum_info import SparsePauliOp +from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + +# Initialize account. +service = QiskitRuntimeService() + +# Prepare inputs. +psi = RealAmplitudes(num_qubits=2, reps=2) +H1 = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) +theta = [0, 1, 1, 2, 3, 5] +# Bell Circuit +qr = QuantumRegister(2, name="qr") +cr = ClassicalRegister(2, name="cr") +qc = QuantumCircuit(qr, cr, name="bell") +qc.h(qr[0]) +qc.cx(qr[0], qr[1]) +qc.measure(qr, cr) + +backend = service.least_busy(operational=True, simulator=False) +pm = generate_preset_pass_manager(target=backend.target, optimization_level=1) + +bell_isa_circuit = pm.run(qc) +psi_isa_circuit = pm.run(psi) +isa_observables = H1.apply_layout(psi_isa_circuit.layout) + +with Session(service=service, backend=backend) as session: + # Submit a request to the Sampler primitive within the session. + sampler = Sampler(session=session) + job = sampler.run([bell_isa_circuit]) + pub_result = job.result()[0] + print(f"Counts: {pub_result.data.cr.get_counts()}") + + # Submit a request to the Estimator primitive within the session. + estimator = Estimator(session=session) + estimator.options.resilience_level = 1 # Set options. + job = estimator.run( + [(psi_isa_circuit, isa_observables, theta)] + ) + pub_result = job.result()[0] + print(f"Expectation values: {pub_result.data.evs}") +``` + +## Local testing mode + +You can validate your quantum programs before sending them to a physical system using the local testing mode. The local testing mode is activated if one of the fake backends in `qiskit_ibm_runtime.fake_provider` or a Qiskit Aer backend instance is used when instantiating a primitive or a session. For example: + +```python +from qiskit_aer import AerSimulator +from qiskit.circuit.library import RealAmplitudes +from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister +from qiskit.quantum_info import SparsePauliOp +from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + +from qiskit_ibm_runtime import Session +from qiskit_ibm_runtime import SamplerV2 as Sampler +from qiskit_ibm_runtime.fake_provider import FakeManilaV2 + +# Bell Circuit +qc = QuantumCircuit(2) +qc.h(0) +qc.cx(0, 1) +qc.measure_all() + +# Run the sampler job locally using FakeManilaV2 +fake_manila = FakeManilaV2() +pm = generate_preset_pass_manager(backend=fake_manila, optimization_level=1) +isa_qc = pm.run(qc) +sampler = Sampler(backend=fake_manila) +result = sampler.run([isa_qc]).result() + +# Run the sampler job locally using AerSimulator. +# Session syntax is supported but ignored. +aer_sim = AerSimulator() +pm = generate_preset_pass_manager(backend=aer_sim, optimization_level=1) +isa_qc = pm.run(qc) +with Session(backend=aer_sim) as session: + sampler = Sampler(session=session) + result = sampler.run([isa_qc]).result() +``` + +## Backend data + +[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") also has methods, such as `backend()`, `backends()`, and `least_busy()`, that allow you to query for a target backend to use. These methods return one or more [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instances that contains methods and attributes describing the backend. + +## Supplementary Information + +### Account initialization + +You need to initialize your account before you can start using the Qiskit Runtime service. This is done by initializing a [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") instance with your account credentials. If you don’t want to pass in the credentials each time, you can use the [`QiskitRuntimeService.save_account()`](qiskit_ibm_runtime.QiskitRuntimeService#save_account "qiskit_ibm_runtime.QiskitRuntimeService.save_account") method to save the credentials on disk. + +Qiskit Runtime is available on both IBM Cloud and IBM Quantum, and you can specify `channel="ibm_cloud"` for IBM Cloud and `channel="ibm_quantum"` for IBM Quantum. The default is IBM Cloud. + +### Runtime Jobs + +When you use the `run()` method of the [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") or [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") to invoke the primitive, a [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") instance is returned. This class has all the basic job methods, such as [`RuntimeJob.status()`](qiskit_ibm_runtime.RuntimeJob#status "qiskit_ibm_runtime.RuntimeJob.status"), [`RuntimeJob.result()`](qiskit_ibm_runtime.RuntimeJob#result "qiskit_ibm_runtime.RuntimeJob.result"), and [`RuntimeJob.cancel()`](qiskit_ibm_runtime.RuntimeJob#cancel "qiskit_ibm_runtime.RuntimeJob.cancel"). + +### Logging + +`qiskit-ibm-runtime` uses the `qiskit_ibm_runtime` logger. + +Two environment variables can be used to control the logging: + +> * **`QISKIT_IBM_RUNTIME_LOG_LEVEL`: Specifies the log level to use.** +> +> If an invalid level is set, the log level defaults to `WARNING`. The valid log levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL` (case-insensitive). If the environment variable is not set, then the parent logger’s level is used, which also defaults to `WARNING`. +> +> * **`QISKIT_IBM_RUNTIME_LOG_FILE`: Specifies the name of the log file to use. If specified,** +> +> messages will be logged to the file only. Otherwise messages will be logged to the standard error (usually the screen). + +For more advanced use, you can modify the logger itself. For example, to manually set the level to `WARNING`: + +```python +import logging +logging.getLogger('qiskit_ibm_runtime').setLevel(logging.WARNING) +``` + +## Classes + +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService")(\[channel, token, url, ...]) | Class for interacting with the Qiskit Runtime service. | +| [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") | alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2") | +| [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.EstimatorV2")(\[mode, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | +| [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") | alias of [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.sampler.SamplerV2") | +| [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.SamplerV2")(\[mode, options]) | Class for interacting with Qiskit Runtime Sampler primitive service. | +| [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session")(\[service, backend, max\_time]) | Class for creating a Qiskit Runtime session. | +| [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")(\[service, backend, max\_time]) | Class for running jobs in batch execution mode. | +| [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend")(configuration, service, api\_client) | Backend class interfacing with an IBM Quantum backend. | +| [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob")(backend, api\_client, ...\[, ...]) | Representation of a runtime primitive execution. | +| [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")(backend, api\_client, ...\[, ...]) | Representation of a runtime V2 primitive exeuction. | +| [`RuntimeEncoder`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, ...]) | JSON Encoder used by runtime service. | +| [`RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | + diff --git a/docs/api/qiskit-ibm-runtime/0.31/transpiler.mdx b/docs/api/qiskit-ibm-runtime/0.31/transpiler.mdx new file mode 100644 index 00000000000..51eda4fd58d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/transpiler.mdx @@ -0,0 +1,25 @@ +--- +title: passes +description: API reference for qiskit_ibm_runtime.transpiler.passes +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler.passes +--- + + + + + +# Transpiler passes + +`qiskit_ibm_runtime.transpiler.passes` + +A collection of transpiler passes. Refer to [guides/transpile](/guides/transpile) to learn more about transpilation and passes. + +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| [`ConvertIdToDelay`](qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay "qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay")(durations\[, gate]) | Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. | +| [`ConvertISAToClifford`](qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford "qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford")(\*args, \*\*kwargs) | Convert the gates of an ISA circuit to Clifford gates. | + +See [`qiskit_ibm_runtime.transpiler.passes.scheduling`](qiskit_ibm_runtime.transpiler.passes.scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") for a collection of scheduling passes. + diff --git a/docs/api/qiskit-ibm-runtime/0.31/visualization.mdx b/docs/api/qiskit-ibm-runtime/0.31/visualization.mdx new file mode 100644 index 00000000000..25faf46d415 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.31/visualization.mdx @@ -0,0 +1,24 @@ +--- +title: visualization +description: API reference for qiskit_ibm_runtime.visualization +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.visualization +--- + + + + + +# Visualization + +`qiskit_ibm_runtime.visualization` + +A suite of functions for visualizing qiskit-ibm-runtime’s objects. + +## Functions + +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`draw_layer_error_map`](qiskit_ibm_runtime.visualization.draw_layer_error_map "qiskit_ibm_runtime.visualization.draw_layer_error_map")(layer\_error, embedding) | Draw a map view of a [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError"). | + diff --git a/docs/api/qiskit-ibm-runtime/_package.json b/docs/api/qiskit-ibm-runtime/_package.json index becbcc5520c..3fba361ca7f 100644 --- a/docs/api/qiskit-ibm-runtime/_package.json +++ b/docs/api/qiskit-ibm-runtime/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit-ibm-runtime", - "version": "0.31.0" + "version": "0.32.0" } diff --git a/docs/api/qiskit-ibm-runtime/_toc.json b/docs/api/qiskit-ibm-runtime/_toc.json index 3eed46cb896..3c9aea17d9e 100644 --- a/docs/api/qiskit-ibm-runtime/_toc.json +++ b/docs/api/qiskit-ibm-runtime/_toc.json @@ -90,6 +90,10 @@ "title": "Module overview", "url": "/api/qiskit-ibm-runtime/execution_span" }, + { + "title": "DoubleSliceSpan", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.DoubleSliceSpan" + }, { "title": "ExecutionSpan", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpan" @@ -501,6 +505,10 @@ "title": "Module overview", "url": "/api/qiskit-ibm-runtime/visualization" }, + { + "title": "draw_execution_spans", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_execution_spans" + }, { "title": "draw_layer_error_map", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_layer_error_map" diff --git a/docs/api/qiskit-ibm-runtime/dev/_package.json b/docs/api/qiskit-ibm-runtime/dev/_package.json index 85ad945d4b2..c6e2fc87eee 100644 --- a/docs/api/qiskit-ibm-runtime/dev/_package.json +++ b/docs/api/qiskit-ibm-runtime/dev/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit-ibm-runtime", - "version": "0.32.0-dev" + "version": "0.33.0-dev" } diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json index c9033005ab9..8af1c7ff65f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/_toc.json +++ b/docs/api/qiskit-ibm-runtime/dev/_toc.json @@ -90,6 +90,10 @@ "title": "Module overview", "url": "/api/qiskit-ibm-runtime/dev/execution_span" }, + { + "title": "DoubleSliceSpan", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.DoubleSliceSpan" + }, { "title": "ExecutionSpan", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpan" @@ -501,6 +505,10 @@ "title": "Module overview", "url": "/api/qiskit-ibm-runtime/dev/visualization" }, + { + "title": "draw_execution_spans", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_execution_spans" + }, { "title": "draw_layer_error_map", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map" diff --git a/docs/api/qiskit-ibm-runtime/dev/execution_span.mdx b/docs/api/qiskit-ibm-runtime/dev/execution_span.mdx index 9d0cf9f8970..6f3ce48bde1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/execution_span.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/execution_span.mdx @@ -20,10 +20,11 @@ An [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_i ## Classes -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`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. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`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. | diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx index adcff6a2993..685a8827417 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx index aed60da8c32..08c6f91859f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. @@ -97,6 +97,16 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 ## Methods + ### backend + + + Return the backend the primitive query will be run on. + + **Return type** + + BackendV1 | BackendV2 + + ### run diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx index 740ed6b7de4..14359853c99 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. @@ -343,7 +343,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### \_\_call\_\_ - + Call self as a function. **Return type** @@ -353,7 +353,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### acquire\_channel - + Return the acquisition channel for the given qubit. **Returns** @@ -367,7 +367,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### cancel\_session - + Cancel session. All pending jobs will be cancelled. **Return type** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -395,7 +395,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### close\_session - + Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs. **Return type** @@ -405,7 +405,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### configuration - + Return the backend configuration. Backend configuration contains fixed information about the backend, such as its name, number of qubits, basis gates, coupling map, quantum volume, etc. @@ -435,7 +435,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -455,7 +455,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### defaults - + Return the pulse defaults for the backend. The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas/default\_pulse\_configuration](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json). @@ -475,7 +475,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### drive\_channel - + Return the drive channel for the given qubit. **Returns** @@ -489,7 +489,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### get\_translation\_stage\_plugin - + Return the default translation stage plugin name for IBM backends. **Return type** @@ -499,7 +499,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### measure\_channel - + Return the measure stimulus channel for the given qubit. **Returns** @@ -513,7 +513,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### open\_session - + Open session **Return type** @@ -523,7 +523,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### properties - + Return the backend properties, subject to optional filtering. This data describes qubits properties (such as T1 and T2), gates properties (such as gate length and error), and other general properties of the backend. @@ -573,9 +573,19 @@ python_api_name: qiskit_ibm_runtime.IBMBackend **NotImplementedError** – if the backend doesn’t support querying the qubit properties + ### refresh + + + Retrieve the newest backend configuration and refresh the current backend target. + + **Return type** + + `None` + + ### run - + Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. **Parameters** @@ -664,7 +674,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### status - + Return the backend status. @@ -686,7 +696,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### target\_history - + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx index 5e9bade5953..0e7e10a79fc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + 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). @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder ### object\_hook - + Called to decode object. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx index e656717827e..7f703310b5e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. @@ -43,7 +43,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder ### default - + Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). For example, to support arbitrary iterators, you could implement default like this: diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx index ffd1f3aaf1d..85ce97942d9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + 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. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob print("Job failed!: {}".format(ex)) ``` - If the primitive has any interim results, you can use the `callback` parameter of the `run()` method to stream the interim results along with the final result. Alternatively, you can use the [`stream_results()`](#qiskit_ibm_runtime.RuntimeJob.stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes. + If the primitive has any interim results, you can use the `callback` parameter of the `run()` method to stream the interim results along with the final result. Alternatively, you can use the `stream_results()` method to stream the results at a later time, but before the job finishes. RuntimeJob constructor. @@ -256,28 +256,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob `bool` - ### interim\_results - - - (DEPRECATED) Return the interim results of the job. - - **Parameters** - - **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode interim results. - - **Return type** - - `Any` - - **Returns** - - Runtime job interim results. - - **Raises** - - **RuntimeJobFailureError** – If the job failed. - - ### job\_id @@ -441,31 +419,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob Status of this job. - ### stream\_results - - - (DEPRECATED) Start streaming job results. - - **Parameters** - - * **callback** (`Callable`) – - - Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: - - > 1. Job ID - > 2. Job result. - - * **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results. - - **Raises** - - **RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished. - - **Return type** - - `None` - - ### submit diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx index ba4430c0ead..5250e83f9c1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 # RuntimeJobV2 - + Representation of a runtime V2 primitive exeuction. RuntimeJob constructor. @@ -234,28 +234,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 `bool` - ### interim\_results - - - (DEPRECATED) Return the interim results of the job. - - **Parameters** - - **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode interim results. - - **Return type** - - `Any` - - **Returns** - - Runtime job interim results. - - **Raises** - - **RuntimeJobFailureError** – If the job failed. - - ### job\_id @@ -377,31 +355,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 Status of this job. - ### stream\_results - - - (DEPRECATED) Start streaming job results. - - **Parameters** - - * **callback** (`Callable`) – - - Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: - - > 1. Job ID - > 2. Job result. - - * **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results. - - **Raises** - - **RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished. - - **Return type** - - `None` - - ### update\_tags diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx index ee08e49434a..801bad97ba4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx @@ -65,6 +65,16 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 ## Methods + ### backend + + + Return the backend the primitive query will be run on. + + **Return type** + + BackendV1 | BackendV2 + + ### run diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.DoubleSliceSpan.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.DoubleSliceSpan.mdx new file mode 100644 index 00000000000..8bbc2273314 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.DoubleSliceSpan.mdx @@ -0,0 +1,128 @@ +--- +title: DoubleSliceSpan +description: API reference for qiskit_ibm_runtime.execution_span.DoubleSliceSpan +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.execution_span.DoubleSliceSpan +--- + +# DoubleSliceSpan + + + 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, slice, slice)`. + + ## Attributes + + ### duration + + + The duration of this span, in seconds. + + **Return type** + + `float` + + + ### pub\_idxs + + + **Return type** + + `list`\[`int`] + + + ### size + + + **Return type** + + `int` + + + ### start + + + The start time of the span, in UTC. + + **Return type** + + `datetime` + + + ### stop + + + The stop time of the span, in UTC. + + **Return type** + + `datetime` + + + ## Methods + + ### contains\_pub + + + Return whether the pub with the given index has data with dependence on this span. + + **Parameters** + + **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. + + + ### filter\_by\_pub + + + Return a new span whose slices are filtered to the provided pub indices. + + For example, if this span contains slice information for pubs with indices 1, 3, 4 and `[1, 4]` is provided, then the span returned by this method will contain slice information for only those two indices, but be identical otherwise. + + **Parameters** + + **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. + + + ### mask + + + Return an array-valued mask specifying which parts of a pub result depend on this span. + + **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)")]] + + **Returns** + + An array with the same shape as the pub data. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx index a660abf081a..250fa1a6386 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans # ExecutionSpans - + 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. @@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans ### \_\_getitem\_\_ - + **Return type** [ExecutionSpan](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") | ‘ExecutionSpans @@ -69,15 +69,39 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans ### \_\_len\_\_ - + **Return type** `int` + ### draw + + + Draw these execution spans. + + + To draw multiple sets of execution spans at once, for example coming from multiple jobs, consider calling [`draw_execution_spans()`](qiskit_ibm_runtime.visualization.draw_execution_spans "qiskit_ibm_runtime.visualization.draw_execution_spans") directly. + + + **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` + + **Returns** + + A plotly figure. + + ### filter\_by\_pub - + Return a new set of spans where each one has been filtered to the specified pubs. See also :meth:\~.ExecutionSpan.filter\_by\_pub\`. @@ -93,7 +117,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans ### sort - + Return the same execution spans, sorted. Sorting is done by the [`start`](qiskit_ibm_runtime.execution_span.ExecutionSpan#start "qiskit_ibm_runtime.execution_span.ExecutionSpan.start") timestamp of each execution span. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx index f58ee995ea9..897c6b417d4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner # NoiseLearner - + Class for executing noise learning experiments. @@ -73,7 +73,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner **References** - 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages 1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) ## Attributes @@ -89,6 +89,16 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner ## Methods + ### backend + + + Return the backend the primitive query will be run on. + + **Return type** + + [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") + + ### run diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx index b84bf338c86..7641c4b9a0a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions # EstimatorOptions - + Options for V2 Estimator. ## Attributes @@ -63,17 +63,6 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions - ### optimization\_level - - - (DEPRECATED) How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times. - - * 0: no optimization - * 1: light optimization - - Default: 0. - - ### resilience diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx index 02412c1e3df..c425da072e8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -8,13 +8,23 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions # LayerNoiseLearningOptions - + Options for learning layer noise. This is only used by V2 Estimator. These options are only used when the resilience level or options specify a technique that requires layer noise learning. + + The total number of unique circuits implemented to learn the noise of a single layer depends solely on [`layer_pair_depths`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.layer_pair_depths "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.layer_pair_depths") and [`num_randomizations`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.num_randomizations "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.num_randomizations"). For example, if `layer_pair_depths` contains six depths and `num_randomizations` is set to `32`, the noise learning stage executes a total of `6 * 9` unique circuits per layer, each one with `32` randomizations (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each). + + The number `9` above is the number of unique circuits that need to be implemented to learn the noise for all the two-qubit subsystem in the given layer by performing local measurements. Indeed, learning the noise for a single one of these subsystems requires measuring all the `16` two-qubit Paulis on that subsystem. Taking advantage of commutation relations to measure more than one of these Paulis (for example, `XI`, `IX`, and `XX`) with a single circuit, it is possible to measure all these `16` Paulis by implementing only `9` circuits. Parallelizing these measurement tasks in the optimal way allows then measuring the `16` Paulis for all of the layer’s two-qubit subsystems with only `9` circuits. More details in Ref. \[1]. + + + **References** + + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages 1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + ## Attributes ### layer\_pair\_depths @@ -36,7 +46,7 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions ### num\_randomizations - The number of random circuits to use per learning circuit configuration. A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, and nine required measurement bases, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each). + The number of random circuits to use per learning circuit configuration. A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (where `9` is the number of circuits that need to be implemented to measure all the required observables, see the note in the docstring for [`LayerNoiseLearningOptions`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for mode details), at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each. Default: 32. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx index 5ac19ec8a47..235068acef7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx @@ -8,9 +8,19 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions # NoiseLearnerOptions - + Options for [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner"). + + The total number of unique circuits implemented to learn the noise of a single layer depends solely on [`layer_pair_depths`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.layer_pair_depths "qiskit_ibm_runtime.options.NoiseLearnerOptions.layer_pair_depths") and [`num_randomizations`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.num_randomizations "qiskit_ibm_runtime.options.NoiseLearnerOptions.num_randomizations"). For example, if `layer_pair_depths` contains six depths and `num_randomizations` is set to `32`, the noise learning stage executes a total of `6 * 9` unique circuits per layer, each one with `32` randomizations (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization "qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization") each). + + The number `9` above is the number of unique circuits that need to be implemented to learn the noise for all the two-qubit subsystem in the given layer by performing local measurements. Indeed, learning the noise for a single one of these subsystems requires measuring all the `16` two-qubit Paulis on that subsystem. Taking advantage of commutation relations to measure more than one of these Paulis (for example, `XI`, `IX`, and `XX`) with a single circuit, it is possible to measure all these `16` Paulis by implementing only `9` circuits. Parallelizing these measurement tasks in the optimal way allows then measuring the `16` Paulis for all of the layer’s two-qubit subsystems with only `9` circuits. More details in Ref. \[1]. + + + **References** + + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages 1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + ## Attributes ### environment @@ -30,7 +40,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions The circuit depths (measured in number of pairs) to use in learning experiments. - Pairs are used as the unit because we exploit the order-2 nature of our entangling gates in the noise learning implementation. A value of `3` would correspond to 6 layers of the layer of interest, for example. Default: (0, 1, 2, 4, 16, 32). + Pairs are used as the unit because we exploit the order-2 nature of our entangling gates in the noise learning implementation. For example, a value of `3` corresponds to 6 repetitions of the layer of interest. Default: (0, 1, 2, 4, 16, 32). ### max\_execution\_time @@ -50,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions The number of random circuits to use per learning circuit configuration. - A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, and nine required measurement bases, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization "qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization") each). Default: 32. + A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (where `9` is the number of circuits that need to be implemented to measure all the required observables, see the note in the docstring for [`NoiseLearnerOptions`](#qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.NoiseLearnerOptions") for mode details), at [`shots_per_randomization`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization "qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization") each. ### shots\_per\_randomization diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx index 178693d70fa..e91489d97ab 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -22,7 +22,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions 2. `pub_result.data.evs_noise_factors`, `pub_result.data.stds_noise_factors`, and `ensemble_stds_noise_factors` all have shape `(*shape, num_noise_factors)` where `num_noise_factors` is the length of `options.resilience.zne.noise_factors`. These values provide evaluations of the best-fit model at each of the noise amplifications. In the case of no twirling, both `*stds*` arrays will be equal, otherwise, `stds_noise_factors` is derived from the spread over twirling samples, whereas `ensemble_stds_noise_factors` assumes only shot noise and no drift. - Technical note: for single observables with multiple basis terms it might turn out that multiple extrapolation methods are used in *the same* expectation value, for example, `XX` gets linearly extrapolated but `XY` gets exponentially extrapolated in the observable `{"XX": 0.5, "XY": 0.5}`. Let’s call this a *hetergeneous fit*. The data from (2) is evaluated from heterogeneous fits by selecting the best fit for every individual distinct term, whereas data from (1) is evaluated from forced homogenous fits, one for each provided extrapolator. If your work requires a nuanced distinction in this regard, we presently recommend that you use single-term observables in addition to your multi-term observables. + Technical note: for single observables with multiple basis terms it might turn out that multiple extrapolation methods are used in *the same* expectation value, for example, `XX` gets linearly extrapolated but `XY` gets exponentially extrapolated in the observable `{"XX": 0.5, "XY": 0.5}`. Let’s call this a *heterogeneous fit*. The data from (2) is evaluated from heterogeneous fits by selecting the best fit for every individual distinct term, whereas data from (1) is evaluated from forced homogenous fits, one for each provided extrapolator. If your work requires a nuanced distinction in this regard, we presently recommend that you use single-term observables in addition to your multi-term observables. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_execution_spans.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_execution_spans.mdx new file mode 100644 index 00000000000..383a364923c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_execution_spans.mdx @@ -0,0 +1,33 @@ +--- +title: draw_execution_spans +description: API reference for qiskit_ibm_runtime.visualization.draw_execution_spans +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit_ibm_runtime.visualization.draw_execution_spans +--- + + + +# draw\_execution\_spans + + + Draw one or more [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") on a bar plot. + + **Parameters** + + * **spans** ([*ExecutionSpans*](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")) – One or more [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans"). + * **names** (*str | Iterable\[str] | None*) – Name or names to assign to respective `spans`. + * **common\_start** (*bool*) – Whether to shift all collections of spans so that their first span’s start is at $t=0$. + * **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. + * **show\_legend** (*bool*) – Whether to show a legend. By default, this choice is automatic. + + **Return type** + + PlotlyFigure + + **Returns** + + A plotly figure. + + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx index 1ed7b7ddc88..91a37007fd0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.visualization.draw_layer_error_map # draw\_layer\_error\_map - + Draw a map view of a [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError"). **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/visualization.mdx b/docs/api/qiskit-ibm-runtime/dev/visualization.mdx index 25faf46d415..e1f16ffd8ce 100644 --- a/docs/api/qiskit-ibm-runtime/dev/visualization.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/visualization.mdx @@ -20,5 +20,6 @@ A suite of functions for visualizing qiskit-ibm-runtime’s objects. | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`draw_execution_spans`](qiskit_ibm_runtime.visualization.draw_execution_spans "qiskit_ibm_runtime.visualization.draw_execution_spans")(\*spans\[, names, ...]) | Draw one or more [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") on a bar plot. | | [`draw_layer_error_map`](qiskit_ibm_runtime.visualization.draw_layer_error_map "qiskit_ibm_runtime.visualization.draw_layer_error_map")(layer\_error, embedding) | Draw a map view of a [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError"). | diff --git a/docs/api/qiskit-ibm-runtime/execution_span.mdx b/docs/api/qiskit-ibm-runtime/execution_span.mdx index 9d0cf9f8970..6f3ce48bde1 100644 --- a/docs/api/qiskit-ibm-runtime/execution_span.mdx +++ b/docs/api/qiskit-ibm-runtime/execution_span.mdx @@ -20,10 +20,11 @@ An [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_i ## Classes -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`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. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`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. | diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx index 99cc487da48..5cb5926d950 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Batch # Batch - + Class for running jobs in batch execution mode. The `batch` mode is designed to efficiently perform experiments that comprise multiple independent jobs. @@ -108,7 +108,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### backend - + Return backend for this session. **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### cancel - + Cancel all pending jobs in a session. **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### 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** @@ -142,7 +142,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### details - + Return session details. **Return type** @@ -171,7 +171,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### from\_id - + Construct a Session object with a given session\_id **Parameters** @@ -197,7 +197,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### status - + Return current session status. **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.mdx index 0ff89fcbd70..7c37e2a83e4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2") diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.mdx index 997a7f76fcd..ccb122a84df 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. @@ -65,10 +65,6 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 * **options** (`Union`\[`Dict`, [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – Estimator options, see `EstimatorOptions` for detailed description. - **Raises** - - **NotImplementedError** – If “q-ctrl” channel strategy is used. - ## Attributes ### mode @@ -101,9 +97,19 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 ## Methods + ### backend + + + Return the backend the primitive query will be run on. + + **Return type** + + BackendV1 | BackendV2 + + ### run - + Submit a request to the estimator primitive. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.mdx index 25ce5498e74..ef0722e1e82 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - + Backend class interfacing with an IBM Quantum backend. @@ -343,7 +343,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### \_\_call\_\_ - + Call self as a function. **Return type** @@ -353,7 +353,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### acquire\_channel - + Return the acquisition channel for the given qubit. **Returns** @@ -367,7 +367,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### cancel\_session - + Cancel session. All pending jobs will be cancelled. **Return type** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -395,7 +395,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### close\_session - + Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs. **Return type** @@ -405,7 +405,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### configuration - + Return the backend configuration. Backend configuration contains fixed information about the backend, such as its name, number of qubits, basis gates, coupling map, quantum volume, etc. @@ -435,7 +435,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -455,7 +455,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### defaults - + Return the pulse defaults for the backend. The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas/default\_pulse\_configuration](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json). @@ -475,7 +475,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### drive\_channel - + Return the drive channel for the given qubit. **Returns** @@ -489,7 +489,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### get\_translation\_stage\_plugin - + Return the default translation stage plugin name for IBM backends. **Return type** @@ -499,7 +499,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### measure\_channel - + Return the measure stimulus channel for the given qubit. **Returns** @@ -513,7 +513,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### open\_session - + Open session **Return type** @@ -523,7 +523,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### properties - + Return the backend properties, subject to optional filtering. This data describes qubits properties (such as T1 and T2), gates properties (such as gate length and error), and other general properties of the backend. @@ -573,9 +573,19 @@ python_api_name: qiskit_ibm_runtime.IBMBackend **NotImplementedError** – if the backend doesn’t support querying the qubit properties + ### refresh + + + Retrieve the newest backend configuration and refresh the current backend target. + + **Return type** + + `None` + + ### run - + Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. **Parameters** @@ -664,7 +674,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### status - + Return the backend status. @@ -686,7 +696,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### target\_history - + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 454df61c788..06f5c79eb14 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. QiskitRuntimeService constructor @@ -35,7 +35,6 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService * **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. - * **channel\_strategy** (`Optional`\[`str`]) – (DEPRECATED) Error mitigation strategy. * **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. @@ -71,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### active\_account - + Return the IBM Quantum account currently in use for the session. **Return type** @@ -85,7 +84,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backend - + Return a single backend matching the specified filtering. **Parameters** @@ -109,7 +108,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backends - + Return all backends accessible via this account, subject to optional filtering. **Parameters** @@ -170,7 +169,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### 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** @@ -180,7 +179,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -200,7 +199,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_job - + Delete a runtime job. Note that this operation cannot be reversed. @@ -221,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### instances - + Return the IBM Quantum instances list currently in use for the session. **Return type** @@ -235,7 +234,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### job - + Retrieve a runtime job. **Parameters** @@ -258,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### jobs - + Retrieve all runtime jobs, subject to optional filtering. **Parameters** @@ -290,7 +289,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### least\_busy - + Return the least busy available backend. **Parameters** @@ -322,7 +321,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -336,7 +335,6 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService * **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. - * **channel\_strategy** (`Optional`\[`str`]) – (DEPRECATED) Error mitigation strategy. * **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. @@ -347,7 +345,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** @@ -372,7 +370,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### usage - + Return monthly open plan usage information. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx index 8ff0f862699..8945d3f5a49 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + 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). @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder ### object\_hook - + Called to decode object. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.mdx index 12811df1999..fae39afaee2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. @@ -43,7 +43,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder ### default - + Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). For example, to support arbitrary iterators, you could implement default like this: diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx index b88bfd635be..25c0b1376f1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + 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. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob print("Job failed!: {}".format(ex)) ``` - If the primitive has any interim results, you can use the `callback` parameter of the `run()` method to stream the interim results along with the final result. Alternatively, you can use the [`stream_results()`](#qiskit_ibm_runtime.RuntimeJob.stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes. + If the primitive has any interim results, you can use the `callback` parameter of the `run()` method to stream the interim results along with the final result. Alternatively, you can use the `stream_results()` method to stream the results at a later time, but before the job finishes. RuntimeJob constructor. @@ -165,7 +165,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### backend - + Return the backend where this job was executed. Retrieve data again if backend is None. **Raises** @@ -179,7 +179,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### cancel - + Cancel the job. **Raises** @@ -194,7 +194,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### cancel\_result\_streaming - + Cancel result streaming. **Return type** @@ -224,7 +224,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### error\_message - + Returns the reason if the job failed. **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### errored - + Return whether the job has failed. **Return type** @@ -248,7 +248,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### in\_final\_state - + Return whether the job is in a final job state such as `DONE` or `ERROR`. **Return type** @@ -256,28 +256,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob `bool` - ### interim\_results - - - (DEPRECATED) Return the interim results of the job. - - **Parameters** - - **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode interim results. - - **Return type** - - `Any` - - **Returns** - - Runtime job interim results. - - **Raises** - - **RuntimeJobFailureError** – If the job failed. - - ### job\_id @@ -290,7 +268,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### logs - + Return job logs. @@ -312,7 +290,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### metrics - + Return job metrics. **Returns** @@ -334,7 +312,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### properties - + Return the backend properties for this job. **Parameters** @@ -352,7 +330,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### queue\_info - + Return queue information for this job. The queue information may include queue position, estimated start and end time, and dynamic priorities for the hub, group, and project. See `QueueInfo` for more information. @@ -372,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### queue\_position - + Return the position of the job in the server queue. @@ -394,7 +372,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### result - + Return the results of the job. **Parameters** @@ -429,7 +407,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### status - + Return the status of the job. **Return type** @@ -441,34 +419,9 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob Status of this job. - ### stream\_results - - - (DEPRECATED) Start streaming job results. - - **Parameters** - - * **callback** (`Callable`) – - - Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: - - > 1. Job ID - > 2. Job result. - - * **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results. - - **Raises** - - **RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished. - - **Return type** - - `None` - - ### submit - + Unsupported method. .. note: ```python @@ -488,7 +441,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### update\_tags - + Update the tags associated with this job. **Parameters** @@ -510,7 +463,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### usage - + Return job usage in seconds. **Return type** @@ -520,7 +473,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### wait\_for\_final\_state - + Poll for the job status from the API until the status is in a final state. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx index c4347d7223b..b8243c3892f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 # RuntimeJobV2 - + Representation of a runtime V2 primitive exeuction. RuntimeJob constructor. @@ -143,7 +143,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### backend - + Return the backend where this job was executed. Retrieve data again if backend is None. **Raises** @@ -157,7 +157,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancel - + Cancel the job. **Raises** @@ -172,7 +172,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancel\_result\_streaming - + Cancel result streaming. **Return type** @@ -182,7 +182,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancelled - + Return whether the job has been cancelled. **Return type** @@ -192,7 +192,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### done - + Return whether the job has successfully run. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### error\_message - + Returns the reason if the job failed. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### errored - + Return whether the job has failed. **Return type** @@ -226,7 +226,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### in\_final\_state - + Return whether the job is in a final job state such as `DONE` or `ERROR`. **Return type** @@ -234,28 +234,6 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 `bool` - ### interim\_results - - - (DEPRECATED) Return the interim results of the job. - - **Parameters** - - **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode interim results. - - **Return type** - - `Any` - - **Returns** - - Runtime job interim results. - - **Raises** - - **RuntimeJobFailureError** – If the job failed. - - ### job\_id @@ -268,7 +246,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### logs - + Return job logs. @@ -290,7 +268,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### metrics - + Return job metrics. **Returns** @@ -312,7 +290,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### properties - + Return the backend properties for this job. **Parameters** @@ -330,7 +308,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### result - + Return the results of the job. **Parameters** @@ -355,7 +333,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### running - + Return whether the job is actively running. **Return type** @@ -365,7 +343,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### status - + Return the status of the job. **Return type** @@ -377,34 +355,9 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 Status of this job. - ### stream\_results - - - (DEPRECATED) Start streaming job results. - - **Parameters** - - * **callback** (`Callable`) – - - Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: - - > 1. Job ID - > 2. Job result. - - * **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A `ResultDecoder` subclass used to decode job results. - - **Raises** - - **RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished. - - **Return type** - - `None` - - ### update\_tags - + Update the tags associated with this job. **Parameters** @@ -426,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### usage - + Return job usage in seconds. **Return type** @@ -436,7 +389,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### wait\_for\_final\_state - + Poll for the job status from the API until the status is in a final state. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.mdx index 9c08360a745..f16ca006718 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + alias of [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.sampler.SamplerV2") diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.mdx index e906e9e6537..9788f0f780b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 # SamplerV2 - + 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. @@ -33,10 +33,6 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 * **options** (`Union`\[`Dict`, [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.sampler_options.SamplerOptions"), `None`]) – Sampler options, see `SamplerOptions` for detailed description. - **Raises** - - **NotImplementedError** – If “q-ctrl” channel strategy is used. - ## Attributes ### mode @@ -69,9 +65,19 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 ## Methods + ### backend + + + Return the backend the primitive query will be run on. + + **Return type** + + BackendV1 | BackendV2 + + ### run - + Submit a request to the sampler primitive. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.mdx index dc5416a8ecb..588624e551b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Session # Session - + 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. @@ -90,7 +90,7 @@ python_api_name: qiskit_ibm_runtime.Session ### backend - + Return backend for this session. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_runtime.Session ### cancel - + Cancel all pending jobs in a session. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit_ibm_runtime.Session ### 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** @@ -124,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.Session ### details - + Return session details. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** @@ -179,7 +179,7 @@ python_api_name: qiskit_ibm_runtime.Session ### status - + Return current session status. **Return type** @@ -199,7 +199,7 @@ python_api_name: qiskit_ibm_runtime.Session ### 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat.mdx index 42088766f7a..6f6633ffc02 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat # Neat - + 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. @@ -34,7 +34,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat ### backend - + The backend used by this analyzer tool. **Return type** @@ -44,7 +44,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat ### ideal\_sim - + Perform an ideal, noiseless simulation of the estimator task specified by `pubs`. This function uses `qiskit-aer`’s `Estimator` class to simulate the estimation task classically. @@ -71,7 +71,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat ### noisy\_sim - + Perform a noisy simulation of the estimator task specified by `pubs`. This function uses `qiskit-aer`’s `Estimator` class to simulate the estimation task classically. @@ -98,7 +98,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat ### to\_clifford - + Return the cliffordized version of the given `pubs`. This convenience method runs the `ConvertISAToClifford` transpiler pass on the PUBs’ circuits. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx index 544ead60137..385e146dc08 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult # NeatPubResult - + 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. @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult ### \_\_mul\_\_ - + **Return type** [`NeatPubResult`](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult.mdx index c5f6bd9daec..c5cda4833b3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatResult # NeatResult - + A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. **Parameters** @@ -19,7 +19,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatResult ### \_\_getitem\_\_ - + **Return type** [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatResult ### \_\_len\_\_ - + **Return type** `int` diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.DoubleSliceSpan.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.DoubleSliceSpan.mdx new file mode 100644 index 00000000000..6eff76aafd6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.DoubleSliceSpan.mdx @@ -0,0 +1,128 @@ +--- +title: DoubleSliceSpan +description: API reference for qiskit_ibm_runtime.execution_span.DoubleSliceSpan +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.execution_span.DoubleSliceSpan +--- + +# DoubleSliceSpan + + + 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, slice, slice)`. + + ## Attributes + + ### duration + + + The duration of this span, in seconds. + + **Return type** + + `float` + + + ### pub\_idxs + + + **Return type** + + `list`\[`int`] + + + ### size + + + **Return type** + + `int` + + + ### start + + + The start time of the span, in UTC. + + **Return type** + + `datetime` + + + ### stop + + + The stop time of the span, in UTC. + + **Return type** + + `datetime` + + + ## Methods + + ### contains\_pub + + + Return whether the pub with the given index has data with dependence on this span. + + **Parameters** + + **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. + + + ### filter\_by\_pub + + + Return a new span whose slices are filtered to the provided pub indices. + + For example, if this span contains slice information for pubs with indices 1, 3, 4 and `[1, 4]` is provided, then the span returned by this method will contain slice information for only those two indices, but be identical otherwise. + + **Parameters** + + **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. + + + ### mask + + + Return an array-valued mask specifying which parts of a pub result depend on this span. + + **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)")]] + + **Returns** + + An array with the same shape as the pub data. + + + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx index d225a962fb3..d9d66f13e59 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan # ExecutionSpan - + 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. @@ -84,7 +84,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan ### contains\_pub - + Return whether the pub with the given index has data with dependence on this span. **Parameters** @@ -102,7 +102,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan ### filter\_by\_pub - + Return a new span whose slices are filtered to the provided pub indices. For example, if this span contains slice information for pubs with indices 1, 3, 4 and `[1, 4]` is provided, then the span returned by this method will contain slice information for only those two indices, but be identical otherwise. @@ -122,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpan ### mask - + Return an array-valued mask specifying which parts of a pub result depend on this span. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx index f8c3cc4ad89..b83deca36a0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.ExecutionSpans.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans # ExecutionSpans - + 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. @@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans ### \_\_getitem\_\_ - + **Return type** [ExecutionSpan](qiskit_ibm_runtime.execution_span.ExecutionSpan "qiskit_ibm_runtime.execution_span.ExecutionSpan") | ‘ExecutionSpans @@ -69,15 +69,39 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans ### \_\_len\_\_ - + **Return type** `int` + ### draw + + + Draw these execution spans. + + + To draw multiple sets of execution spans at once, for example coming from multiple jobs, consider calling [`draw_execution_spans()`](qiskit_ibm_runtime.visualization.draw_execution_spans "qiskit_ibm_runtime.visualization.draw_execution_spans") directly. + + + **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` + + **Returns** + + A plotly figure. + + ### filter\_by\_pub - + Return a new set of spans where each one has been filtered to the specified pubs. See also :meth:\~.ExecutionSpan.filter\_by\_pub\`. @@ -93,7 +117,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.ExecutionSpans ### sort - + Return the same execution spans, sorted. Sorting is done by the [`start`](qiskit_ibm_runtime.execution_span.ExecutionSpan#start "qiskit_ibm_runtime.execution_span.ExecutionSpan.start") timestamp of each execution span. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.SliceSpan.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.SliceSpan.mdx index 61d5b35a550..6b2996dcbfa 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.SliceSpan.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.execution_span.SliceSpan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan # SliceSpan - + 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. @@ -71,7 +71,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan ### contains\_pub - + Return whether the pub with the given index has data with dependence on this span. **Parameters** @@ -89,7 +89,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan ### filter\_by\_pub - + Return a new span whose slices are filtered to the provided pub indices. For example, if this span contains slice information for pubs with indices 1, 3, 4 and `[1, 4]` is provided, then the span returned by this method will contain slice information for only those two indices, but be identical otherwise. @@ -109,7 +109,7 @@ python_api_name: qiskit_ibm_runtime.execution_span.SliceSpan ### mask - + Return an array-valued mask specifying which parts of a pub result depend on this span. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx index c32045eb8bb..4875a93dfa6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers # FakeAlgiers - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 8022c3e591d..565a633110e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 07110a2a402..f7c6c099db3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python @@ -213,7 +213,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -229,7 +229,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### configuration - + Return the backend configuration. **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -279,7 +279,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -314,7 +314,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -330,7 +330,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### properties - + Return the backend properties **Parameters** @@ -373,7 +373,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -398,7 +398,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -443,7 +443,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index c75f05f41ac..8d1abdd63e2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index 3ed88fdd8e1..05abd1441f9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index ca168c10b43..0b4358a4ae9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 5d81f536d7c..283dd0341ab 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index 5e43b960539..e004ebd2b21 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx index 021c2847210..5590da57066 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane # FakeBrisbane - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index 336893a30e4..c673c47f9bd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index 6aa31b665f8..dd0a2cfdc3d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index b08db244ec1..2193401e88c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index 5876f4f0c60..e96eebe81e8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python @@ -221,7 +221,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -237,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### configuration - + Return the backend configuration. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -287,7 +287,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -306,7 +306,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -322,7 +322,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -338,7 +338,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### properties - + Return the backend properties **Parameters** @@ -381,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -406,7 +406,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -451,7 +451,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index 3200dccd376..03d7d3e5a88 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx index 8fdc03729c5..f59caae607b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco # FakeCusco - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index 42ceff241dc..f5100111307 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx index 2cf022e9536..7870c2643a6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend # FakeFractionalBackend - + A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima. This backend include following features. @@ -216,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -232,7 +232,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### configuration - + Return the backend configuration. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -282,7 +282,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -301,7 +301,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -317,7 +317,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -333,7 +333,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### properties - + Return the backend properties **Parameters** @@ -376,7 +376,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -401,7 +401,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -446,7 +446,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index 01fdfcce0fe..162a102c7d2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index 15c0e866261..be26b0e8212 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index ab96df41c4d..e810fa03cbd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index cb03b8dc162..73bcf6234f7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index 70d39f63125..d14fac42f11 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx index 3649e87c980..a3f8bf37a72 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki # FakeKawasaki - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index bb01b7c20e9..3aa5146d2b2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx index 8dc985d2eab..92c6298c371 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv # FakeKyiv - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx index b8f745b7c6c..fda4f96e80e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto # FakeKyoto - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index 785308c0508..72b82918066 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index 2d0b2179389..b093fff8e90 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index c8265710a69..27bebc2fd4a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index 566e2f5a7d9..ca3043f7ac1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index d42d71fb2b6..583a2f624e4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index f987ea5b87a..acec5863cd4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index 124e32c77b5..545931feb28 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index f141e5ee473..0c0c0a8f38b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index ca7c9f1ead7..bf685aac9ac 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx index 4d2340a7295..347a72ce7ff 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka # FakeOsaka - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index 5a00c34d949..4ed893eed9c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index 660dd42ebef..722178bb390 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index 8071be20e3d..45cc41bd657 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python @@ -221,7 +221,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -237,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### configuration - + Return the backend configuration. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -287,7 +287,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -306,7 +306,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -322,7 +322,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -338,7 +338,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### properties - + Return the backend properties **Parameters** @@ -381,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -406,7 +406,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -451,7 +451,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx index 0bee3fd7398..3feddb0353a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill # FakePeekskill - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index 2c3b233bffd..7b918eaa813 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index 01a4f6c35ab..2f2923d729e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index bed93f13811..ee22661a2f8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx index 771050045a2..7f6ff1abf48 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + 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"). @@ -17,7 +17,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 ### backend - + Filter backends in provider by name. **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 ### backends - + Return all backends accessible via this account. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx index 0dd6397beb6..385c1cbc018 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec # FakeQuebec - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 8226331957a..364755185b2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index be2b9df06a3..ca31ad52116 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index 4ce5ef12271..2a3ec1b7b7c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index e084bbea270..04ef452058c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index 7f6bb665588..bb2cc408193 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index f62977bc9c1..7978f4d5221 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index 8c1f6dd4ebb..45fc6283a29 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx index 20b0538a6f9..31f712308bc 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino # FakeTorino - + A fake 133 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index 68a5a650a3e..e5a63f54fcb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 8a388446ee1..86f116fb817 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index 030237b25f1..bec84a3dc7b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index 8a6959ca804..323cae861ac 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index ca7d472bd98..1190c7ec145 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx index 108e9ee995f..dfcbb41336c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner # NoiseLearner - + Class for executing noise learning experiments. @@ -73,7 +73,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner **References** - 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages 1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) ## Attributes @@ -89,9 +89,19 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner ## Methods + ### backend + + + Return the backend the primitive query will be run on. + + **Return type** + + [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") + + ### run - + Submit a request to the noise learner program. This function breaks the given list of circuits into a list of unique layers, following the strategy set by the `twirling_strategy` field specified in the `options` (see `NoiseLearnerOptions` for more details) and sorting them based on the number of times they occur in the various circuits. Then, it runs the noise learning experiment for as many layers as specified by the `max_layers_to_learn` field in the `options`, prioritizing layers that occurr more frequently. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx index 7d027ba33ac..0f0e7b18fa3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions # DynamicalDecouplingOptions - + Options for dynamical decoupling (DD). ## Attributes @@ -59,6 +59,16 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions `tau/2 - (+X) - tau - (+Y) - tau (-X) - tau - (-Y) - tau/2` + ### skip\_reset\_qubits + + + Whether to insert DD on idle periods that immediately follow initialized/reset qubits. + + Since qubits in the ground state are less susceptible to decoherence, it can be beneficial to let them be while they are known to be in this state. + + Default: False. + + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.mdx index 91d916b9e7c..0b4ee76cfcb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions # EnvironmentOptions - + Options related to the execution environment. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.mdx index 8d56e9ab5bd..7e31314af2a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions # EstimatorOptions - + Options for V2 Estimator. ## Attributes @@ -63,17 +63,6 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions - ### optimization\_level - - - (DEPRECATED) How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times. - - * 0: no optimization - * 1: light optimization - - Default: 0. - - ### resilience @@ -120,7 +109,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions ### update - + Update the options. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx index 752c6842d5b..251aca6cb1d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2 # ExecutionOptionsV2 - + Execution options for V2 primitives. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx index eaeefa355ea..f048770e71a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -8,13 +8,23 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions # LayerNoiseLearningOptions - + Options for learning layer noise. This is only used by V2 Estimator. These options are only used when the resilience level or options specify a technique that requires layer noise learning. + + The total number of unique circuits implemented to learn the noise of a single layer depends solely on [`layer_pair_depths`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.layer_pair_depths "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.layer_pair_depths") and [`num_randomizations`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.num_randomizations "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.num_randomizations"). For example, if `layer_pair_depths` contains six depths and `num_randomizations` is set to `32`, the noise learning stage executes a total of `6 * 9` unique circuits per layer, each one with `32` randomizations (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each). + + The number `9` above is the number of unique circuits that need to be implemented to learn the noise for all the two-qubit subsystem in the given layer by performing local measurements. Indeed, learning the noise for a single one of these subsystems requires measuring all the `16` two-qubit Paulis on that subsystem. Taking advantage of commutation relations to measure more than one of these Paulis (for example, `XI`, `IX`, and `XX`) with a single circuit, it is possible to measure all these `16` Paulis by implementing only `9` circuits. Parallelizing these measurement tasks in the optimal way allows then measuring the `16` Paulis for all of the layer’s two-qubit subsystems with only `9` circuits. More details in Ref. \[1]. + + + **References** + + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages 1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + ## Attributes ### layer\_pair\_depths @@ -36,7 +46,7 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions ### num\_randomizations - The number of random circuits to use per learning circuit configuration. A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, and nine required measurement bases, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each). + The number of random circuits to use per learning circuit configuration. A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (where `9` is the number of circuits that need to be implemented to measure all the required observables, see the note in the docstring for [`LayerNoiseLearningOptions`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for mode details), at [`shots_per_randomization`](#qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization "qiskit_ibm_runtime.options.LayerNoiseLearningOptions.shots_per_randomization") each. Default: 32. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx index 956f9d0c9ce..75e01546158 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions # MeasureNoiseLearningOptions - + Options for measurement noise learning. This is only used by V2 Estimator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx index 6c35f2eabea..a3264c12bcd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.NoiseLearnerOptions.mdx @@ -8,9 +8,19 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions # NoiseLearnerOptions - + Options for [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner"). + + The total number of unique circuits implemented to learn the noise of a single layer depends solely on [`layer_pair_depths`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.layer_pair_depths "qiskit_ibm_runtime.options.NoiseLearnerOptions.layer_pair_depths") and [`num_randomizations`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.num_randomizations "qiskit_ibm_runtime.options.NoiseLearnerOptions.num_randomizations"). For example, if `layer_pair_depths` contains six depths and `num_randomizations` is set to `32`, the noise learning stage executes a total of `6 * 9` unique circuits per layer, each one with `32` randomizations (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization "qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization") each). + + The number `9` above is the number of unique circuits that need to be implemented to learn the noise for all the two-qubit subsystem in the given layer by performing local measurements. Indeed, learning the noise for a single one of these subsystems requires measuring all the `16` two-qubit Paulis on that subsystem. Taking advantage of commutation relations to measure more than one of these Paulis (for example, `XI`, `IX`, and `XX`) with a single circuit, it is possible to measure all these `16` Paulis by implementing only `9` circuits. Parallelizing these measurement tasks in the optimal way allows then measuring the `16` Paulis for all of the layer’s two-qubit subsystems with only `9` circuits. More details in Ref. \[1]. + + + **References** + + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages 1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + ## Attributes ### environment @@ -30,7 +40,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions The circuit depths (measured in number of pairs) to use in learning experiments. - Pairs are used as the unit because we exploit the order-2 nature of our entangling gates in the noise learning implementation. A value of `3` would correspond to 6 layers of the layer of interest, for example. Default: (0, 1, 2, 4, 16, 32). + Pairs are used as the unit because we exploit the order-2 nature of our entangling gates in the noise learning implementation. For example, a value of `3` corresponds to 6 repetitions of the layer of interest. Default: (0, 1, 2, 4, 16, 32). ### max\_execution\_time @@ -50,7 +60,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions The number of random circuits to use per learning circuit configuration. - A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, and nine required measurement bases, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (at [`shots_per_randomization`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization "qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization") each). Default: 32. + A configuration is a measurement basis and depth setting. For example, if your experiment has six depths, then setting this value to 32 will result in a total of `32 * 9 * 6` circuits that need to be executed (where `9` is the number of circuits that need to be implemented to measure all the required observables, see the note in the docstring for [`NoiseLearnerOptions`](#qiskit_ibm_runtime.options.NoiseLearnerOptions "qiskit_ibm_runtime.options.NoiseLearnerOptions") for mode details), at [`shots_per_randomization`](#qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization "qiskit_ibm_runtime.options.NoiseLearnerOptions.shots_per_randomization") each. ### shots\_per\_randomization @@ -95,7 +105,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions ### update - + Update the options. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx index 638891240ed..ef4274c1ba9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions # PecOptions - + Probabalistic error cancellation mitigation options. This is only used by V2 Estimator. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx index f8f7c85a424..448b69d7a79 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptionsV2 # ResilienceOptionsV2 - + Resilience options for V2 Estimator. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx index 38f13d7f87b..2fcafc58d9a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 # SamplerExecutionOptionsV2 - + Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx index 7b156e29866..d051ecde30e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions # SamplerOptions - + Options for V2 Sampler. ## Attributes @@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions ### update - + Update the options. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx index e6d6a917368..9932a29be80 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions # SimulatorOptions - + Simulator options. For best practice in simulating a backend make sure to pass the basis gates and coupling map of that backend. @@ -51,7 +51,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### set\_backend - + Set backend for simulation. This method changes noise\_model, coupling\_map, basis\_gates according to given backend. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx index 42be9a5ebeb..3e0a31e3ff2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions # TwirlingOptions - + Twirling options. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx index 70b47e566d2..ebc1aa366b7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions # ZneOptions - + Zero noise extrapolation mitigation options. This is only used by the V2 Estimator. @@ -22,7 +22,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions 2. `pub_result.data.evs_noise_factors`, `pub_result.data.stds_noise_factors`, and `ensemble_stds_noise_factors` all have shape `(*shape, num_noise_factors)` where `num_noise_factors` is the length of `options.resilience.zne.noise_factors`. These values provide evaluations of the best-fit model at each of the noise amplifications. In the case of no twirling, both `*stds*` arrays will be equal, otherwise, `stds_noise_factors` is derived from the spread over twirling samples, whereas `ensemble_stds_noise_factors` assumes only shot noise and no drift. - Technical note: for single observables with multiple basis terms it might turn out that multiple extrapolation methods are used in *the same* expectation value, for example, `XX` gets linearly extrapolated but `XY` gets exponentially extrapolated in the observable `{"XX": 0.5, "XY": 0.5}`. Let’s call this a *hetergeneous fit*. The data from (2) is evaluated from heterogeneous fits by selecting the best fit for every individual distinct term, whereas data from (1) is evaluated from forced homogenous fits, one for each provided extrapolator. If your work requires a nuanced distinction in this regard, we presently recommend that you use single-term observables in addition to your multi-term observables. + Technical note: for single observables with multiple basis terms it might turn out that multiple extrapolation methods are used in *the same* expectation value, for example, `XX` gets linearly extrapolated but `XY` gets exponentially extrapolated in the observable `{"XX": 0.5, "XY": 0.5}`. Let’s call this a *heterogeneous fit*. The data from (2) is evaluated from heterogeneous fits by selecting the best fit for every individual distinct term, whereas data from (1) is evaluated from forced homogenous fits, one for each provided extrapolator. If your work requires a nuanced distinction in this regard, we presently recommend that you use single-term observables in addition to your multi-term observables. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx index c88e83e4424..d118750d937 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford # ConvertISAToClifford - + Convert the gates of an ISA circuit to Clifford gates. ISA circuits only contain Clifford gates from a restricted set or [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.2)")s by arbitrary angles. To convert them to Clifford circuits, this pass rounds the angle of every [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.2)") to the closest multiple of pi/2 (or to a random multiple of pi/2 if the angle is unspecified), while it skips every Clifford gate, measurement, and barrier. @@ -111,7 +111,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx index 0ebb38050d3..e0c79f65741 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay # ConvertIdToDelay - + Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. Convert [`qiskit.circuit.library.IGate`](/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.2)") to a Convert [`qiskit.circuit.Delay`](/api/qiskit/circuit#qiskit.circuit.Delay "(in Qiskit v1.2)"). @@ -89,7 +89,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index ec57aa6fff4..6883a79de78 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. @@ -103,7 +103,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna ### run - + Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") :param dag: DAG to schedule. :type dag: DAGCircuit **Raises** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index 37f8703ae96..cf13e5de38c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. @@ -103,7 +103,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna ### run - + Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") :param dag: DAG to schedule. :type dag: DAGCircuit **Raises** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index c1e8b78ccee..c7426cedc08 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - + The base class of padding pass. This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. @@ -93,7 +93,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder ### run - + Run the padding pass on `dag`. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index bd160bb9dd4..59108504f16 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. :type backend: [`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)") :param backend: backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. :type target: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") :param target: target from which durations (gate lengths) and dt are extracted. **Returns** @@ -96,7 +96,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### update - + Update self with inst\_durations (inst\_durations overwrite self). Overrides the default durations for certain hardcoded instructions. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index 261c35f5685..47e0cbef5a2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. @@ -107,7 +107,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay ### run - + Run the padding pass on `dag`. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 1735443239d..bbead795405 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). @@ -244,7 +244,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec ### run - + Run the padding pass on `dag`. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx index 58f7eb6f2c3..8f67e16935d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.LayerError # LayerError - + The error channel (in Pauli-Lindblad format) of a single layer of instructions. **Parameters** @@ -87,21 +87,47 @@ python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.LayerError ### draw\_map - + Draw a map view of a this layer error. **Parameters** * **embedding** (`Union`\[`Embedding`, [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")]) – An `Embedding` object containing the coordinates and coupling map to draw the layer error on, or a backend to generate an `Embedding` for. + * **colorscale** (`str`) – The colorscale used to show the rates of this layer error. + * **color\_no\_data** (`str`) – The color used for qubits and edges for which no data is available. + + * **color\_out\_of\_scale** (`str`) – The color used for rates with value greater than `highest_rate`. + * **num\_edge\_segments** (`int`) – The number of equal-sized segments that edges are made of. + * **edge\_width** (`float`) – The line width of the edges in pixels. + * **height** (`int`) – The height of the returned figure. + + * **highest\_rate** (`Optional`\[`float`]) – The highest rate, used to normalize all other rates before choosing their colors. If `None`, it defaults to the highest value found in the `layer_error`. + * **background\_color** (`str`) – The background color. + * **radius** (`float`) – The radius of the pie charts representing the qubits. + * **width** (`int`) – The width of the returned figure. + * **code:** (*..*) – + + python: from qiskit import QuantumCircuit from qiskit.quantum\_info import PauliList from qiskit\_ibm\_runtime.utils.embeddings import Embedding from qiskit\_ibm\_runtime.utils.noise\_learner\_result import LayerError, PauliLindbladError + + \# A five-qubit 1-D embedding with nearest neighbouring connectivity coordinates1 = \[(0, 0), (0, 1), (0, 2), (0, 3), (0, 4), (0, 5)] coupling\_map1 = \[(0, 1), (1, 2), (2, 3), (3, 4), (4, 5)] embedding1 = Embedding(coordinates1, coupling\_map1) + + \# A six-qubit horseshoe-shaped embedding with nearest neighbouring connectivity coordinates2 = \[(0, 0), (0, 1), (0, 2), (1, 0), (1, 1), (1, 2)] coupling\_map2 = \[(0, 1), (1, 2), (0, 3), (3, 4), (4, 5)] embedding2 = Embedding(coordinates2, coupling\_map2) + + \# A LayerError object circuit = QuantumCircuit(4) qubits = \[1, 2, 3, 4] generators = PauliList(\[“IIIX”, “IIXI”, “IXII”, “YIII”, “ZIII”, “XXII”, “ZZII”]) rates = \[0.01, 0.01, 0.01, 0.005, 0.02, 0.01, 0.01] error = PauliLindbladError(generators, rates) layer\_error = LayerError(circuit, qubits, error) + + \# Draw the layer error on embedding1 layer\_error.draw\_map(embedding1) + + \# Draw the layer error on embedding2 layer\_error.draw\_map(embedding2) + **Return type** `Figure` diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.mdx index 9017c52773b..822b10ee1a2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladErro # PauliLindbladError - + A Pauli error channel generated by a Pauli Lindblad dissipators. This operator represents an N-qubit quantum error channel $E(\rho) = e^{\sum_j r_j D_{P_j}}(\rho)$ generated by Pauli Lindblad dissipators $D_P(\rho) = P \rho P - \rho$, where $P_j$ are N-qubit `Pauli` operators. @@ -73,7 +73,7 @@ $$ ### restrict\_num\_bodies - + The [`PauliLindbladError`](#qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError "qiskit_ibm_runtime.utils.noise_learner_result.PauliLindbladError") containing only those terms acting on exactly `num_qubits` qubits. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_execution_spans.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_execution_spans.mdx new file mode 100644 index 00000000000..efb1a045508 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_execution_spans.mdx @@ -0,0 +1,33 @@ +--- +title: draw_execution_spans +description: API reference for qiskit_ibm_runtime.visualization.draw_execution_spans +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit_ibm_runtime.visualization.draw_execution_spans +--- + + + +# draw\_execution\_spans + + + Draw one or more [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") on a bar plot. + + **Parameters** + + * **spans** ([*ExecutionSpans*](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans")) – One or more [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans"). + * **names** (*str | Iterable\[str] | None*) – Name or names to assign to respective `spans`. + * **common\_start** (*bool*) – Whether to shift all collections of spans so that their first span’s start is at $t=0$. + * **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. + * **show\_legend** (*bool*) – Whether to show a legend. By default, this choice is automatic. + + **Return type** + + PlotlyFigure + + **Returns** + + A plotly figure. + + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx index d3c01120660..3838724c013 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.visualization.draw_layer_error_map # draw\_layer\_error\_map - + Draw a map view of a [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError"). **Parameters** @@ -19,9 +19,11 @@ python_api_name: qiskit_ibm_runtime.visualization.draw_layer_error_map * **embedding** (`Union`\[`Embedding`, [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")]) – An `Embedding` object containing the coordinates and coupling map to draw the layer error on, or a backend to generate an `Embedding` for. * **colorscale** (`str`) – The colorscale used to show the rates of `layer_error`. * **color\_no\_data** (`str`) – The color used for qubits and edges for which no data is available. + * **color\_out\_of\_scale** (`str`) – The color used for rates with value greater than `highest_rate`. * **num\_edge\_segments** (`int`) – The number of equal-sized segments that edges are made of. * **edge\_width** (`float`) – The line width of the edges in pixels. * **height** (`int`) – The height of the returned figure. + * **highest\_rate** (`Optional`\[`float`]) – The highest rate, used to normalize all other rates before choosing their colors. If `None`, it defaults to the highest value found in the `layer_error`. * **background\_color** (`str`) – The background color. * **radius** (`float`) – The radius of the pie charts representing the qubits. * **width** (`int`) – The width of the returned figure. diff --git a/docs/api/qiskit-ibm-runtime/release-notes.mdx b/docs/api/qiskit-ibm-runtime/release-notes.mdx index 0a7c3865d45..3d2f557c734 100644 --- a/docs/api/qiskit-ibm-runtime/release-notes.mdx +++ b/docs/api/qiskit-ibm-runtime/release-notes.mdx @@ -10,8 +10,48 @@ in_page_toc_max_heading_level: 2 +## 0.32.0 (2024-10-30) + +### New Features + +* Added [`draw_execution_spans()`](qiskit_ibm_runtime.visualization.draw_execution_spans "qiskit_ibm_runtime.visualization.draw_execution_spans"), a function for creating a Plotly figure that visualizes one or more [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") objects. Also added the convenience method [`draw()`](qiskit_ibm_runtime.execution_span.ExecutionSpans#draw "qiskit_ibm_runtime.execution_span.ExecutionSpans.draw") to invoke the drawing function on a particular instance. ([1923](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1923)) + + ```python + from qiskit_ibm_runtime.visualization import draw_execution_spans + + # use the drawing function on spans from sampler job data + spans1 = sampler_job1.result().metadata["execution"]["execution_spans"] + spans2 = sampler_job2.result().metadata["execution"]["execution_spans"] + draw_execution_spans(spans1, spans2) + + # convenience to plot just spans1 + spans1.draw() + ``` + +* Added a new method, `backend.refresh()` that refreshes the current backend target with the latest updates from the server. ([1955](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1955)) + +* Added [`DoubleSliceSpan`](qiskit_ibm_runtime.execution_span.DoubleSliceSpan "qiskit_ibm_runtime.execution_span.DoubleSliceSpan"), an `ExecutionSpan` for batching with two slices. ([1982](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1982)) + +* Each of [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.SamplerV2"), [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.EstimatorV2"), and [`noise_learner.NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner") now has a `backend()` method that returns the backend that the class is configured with. ([1995](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1995)) + +### Other Notes + +* Deprecations from the `0.25.0` release have been removed. + + > * `optimization_level` is no longer a valid option for `EstimatorV2`. + > * Job methods `interim_results()` and `stream_results()` have been removed. ([1965](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1965)) + +* The `channel_strategy` parameter in `QiskitRuntimeService` has been removed. To continue using Q-CTRL in your workflow, please explore the following options: + + > * If your organization has an existing IBM Quantum Premium Plan instance: migrate to the Q-CTRL Performance Management Function, found in the [Qiskit Functions Catalog](https://quantum.ibm.com/functions). + > * To continue using Qiskit Runtime with IBM Cloud: migrate to Q-CTRL Fire Opal, the same performance management product accessible directly through Q-CTRL. You can [connect your IBM Cloud API key and Qiskit Runtime CRN](https://docs.q-ctrl.com/fire-opal/discover/hardware-providers/how-to-authenticate-with-ibm-credentials) to Fire Opal. ([1966](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1966)) + + + ## 0.31.0 (2024-10-15) + + ### New Features * Added Noisy Estimator Analyzer Tool (NEAT), a class to help understand the expected performance of Estimator jobs. ([1950](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1950)) @@ -21,11 +61,13 @@ in_page_toc_max_heading_level: 2 * Fixed an issue with ISA validation where a change related to connectivity inside control operations was not applied correctly. ([1954](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1954)) + + ### Other Notes * Fake V1 backends have been removed. ([1946](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1946)) - + ## 0.30.0 (2024-09-23) @@ -40,7 +82,7 @@ in_page_toc_max_heading_level: 2 * In a future release, `RuntimeJob.status()` will be returned as a string instead of an instance of `JobStatus`. ([1933](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1933)) - + ### New Features @@ -63,13 +105,13 @@ in_page_toc_max_heading_level: 2 * The `use_fractional_gates` flag for `QiskitRuntimeService.backend()` and `QiskitRuntimeService.backends()` can now be `None`. When set to `None`, no instruction filtering is done, and the returned backend target may contain both fractional gates and control flow operations. ([1938](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1938)) - + ### Bug Fixes * Fixed a bug where primitives could not be run in the session context with fractional gates. ([1922](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1922)) - + ### Other Notes @@ -83,27 +125,27 @@ in_page_toc_max_heading_level: 2 * In `Service.backend()`, “name” is now a required parameter * `Service.get_backend()` has been removed and replaced with `backend()` ([1907](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1907)) - + ## 0.29.1 (2024-09-17) - + ### New Features * Added logic to encode and decode `NoiseLearnerResult`. ([1908](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1908)) - + ## 0.29.0 (2024-09-04) - + ### Deprecation Notes * The simulator option `noise_model` is now deprecated for jobs running on real devices. `noise_model` will still be an acceptable option when using the local testing mode. ([1892](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1892)) - + ### New Features @@ -111,7 +153,7 @@ in_page_toc_max_heading_level: 2 * Added a new `private` option under `EnvironmentOptions`. ([1888](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1888)) * Added `fallback` option to ZNE extrapolators. ([1902](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1902)) - + ### Bug Fixes @@ -119,54 +161,54 @@ in_page_toc_max_heading_level: 2 * Revert a previous change to `backend.target` where the target was no longer being cached. ([1891](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1891)) * Fixed an issue where `Session.from_id()` would create a new empty session. ([1896](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1896)) - + ## 0.28.0 (2024-08-15) - + ### New Features * `ResilienceOptionsV2` has a new field `layer_noise_model`. When this field is set, all the mitigation strategies that require noise data skip the noise learning stage, and instead gather the required information from `layer_noise_model`. ([1858](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1858)) - + ### Other Notes * The V1 Primitives `SamplerV1` and `EstimatorV1` have been completely removed. Please see the [migration guide](/migration-guides/v2-primitives) and use the V2 Primitives instead. ([1857](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1857)) * The `service` parameter is now required in `Session.from_id()`. ([1868](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1868)) - + ## 0.27.1 (2024-08-12) - + ### New Features * Added logic to encode and decode `PauliLindbladError` and `LayerError`. ([1853](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1853)) - + ## 0.27.0 (2024-08-08) - + ### New Features * Added `PauliLindbladError` and `LayerError` classes to represent layers noise processes. ([1844](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1844)) - + ### Bug Fixes * Fixed an issue with using the aer simulator and local service mode with sessions. ([1838](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1838)) - + ## 0.26.0 (2024-07-31) - + ### Deprecation Notes @@ -175,7 +217,7 @@ in_page_toc_max_heading_level: 2 * Passing in `service` in `Session`, `Batch` has been deprecated. The `service` parameter is no longer necessary because the service can be extracted from the backend. ([1826](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1826)) * Since backend modules from `qiskit.providers.models` including `BackendProperties` and `BackendConfiguration` are deprecated in Qiskit 1.2, they have been copied into `qiskit-ibm-runtime`. Make sure to upgrade to the latest version, `0.26.0`, to use these classes. ([1803](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1803)) - + ### New Features @@ -197,7 +239,7 @@ in_page_toc_max_heading_level: 2 * Added `NoiseLearner` and related functionality, such as `NoiseLearnerOptions` and `NoiseLearnerResults`. ([1805](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1805)) - + ### Bug Fixes @@ -206,18 +248,18 @@ in_page_toc_max_heading_level: 2 * The options validation for checking if `zne_mitigation` or `pec_mitigation` are set to `True` when using other related options has been removed. ([1792](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1792)) * Fixed an issue where users were unable to retrieve job results if the python library `simplejson` was installed in their environment. ([1800](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1800)) - + ## 0.25.0 (2024-07-02) - + ### Deprecation Notes * The `optimization_level` option in `EstimatorV2` is deprecated. Instead, you can perform circuit optimization using the Qiskit transpiler or Qiskit transpiler service. ([1748](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1748)) -* [`qiskit_ibm_runtime.RuntimeJobV2.interim_results()`](qiskit_ibm_runtime.RuntimeJobV2#interim_results "qiskit_ibm_runtime.RuntimeJobV2.interim_results"), [`qiskit_ibm_runtime.RuntimeJobV2.stream_results()`](qiskit_ibm_runtime.RuntimeJobV2#stream_results "qiskit_ibm_runtime.RuntimeJobV2.stream_results"), [`qiskit_ibm_runtime.RuntimeJob.interim_results()`](qiskit_ibm_runtime.RuntimeJob#interim_results "qiskit_ibm_runtime.RuntimeJob.interim_results"), and [`qiskit_ibm_runtime.RuntimeJob.stream_results()`](qiskit_ibm_runtime.RuntimeJob#stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") are now all deprecated. ([1776](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1776)) +* `qiskit_ibm_runtime.RuntimeJobV2.interim_results()`, `qiskit_ibm_runtime.RuntimeJobV2.stream_results()`, `qiskit_ibm_runtime.RuntimeJob.interim_results()`, and `qiskit_ibm_runtime.RuntimeJob.stream_results()` are now all deprecated. ([1776](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1776)) - + ### New Features @@ -225,21 +267,21 @@ in_page_toc_max_heading_level: 2 * Added an `instance` property to `BaseRuntimeJob` which returns the instance where the job was run. ([1771](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1771)) * `default_shots` are now a supported option when using `EstimatorV2` in local testing mode. ([1773](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1773)) - + ## 0.24.1 (2024-06-18) - + ### Bug Fixes * Disallowing fractional gates by default, so backend target would not exclude control flow. ([1755](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1755)) - + ## 0.24.0 (2024-06-10) - + ### Deprecation Notes @@ -257,7 +299,7 @@ in_page_toc_max_heading_level: 2 * Specifying options without the full dictionary structure is deprecated. Instead, pass in a fully structured dictionary. For example, use `{'environment': {'log_level': 'INFO'}}` instead of `{'log_level': 'INFO'}`. ([1731](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1731)) - + ### New Features @@ -296,7 +338,7 @@ in_page_toc_max_heading_level: 2 * [`QiskitRuntimeService.backends()`](qiskit_ibm_runtime.QiskitRuntimeService#backends "qiskit_ibm_runtime.QiskitRuntimeService.backends") now always returns a new `IBMBackend` instance even when the same query is used. The backend properties and defaults data are retrieved from the server for every instance when they are accessed for the first time, while the configuration data is cached internally in the service instance. ([1732](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1732)) - + ### Bug Fixes @@ -308,18 +350,18 @@ in_page_toc_max_heading_level: 2 * Fixed nested experimental suboptions override non-experimental suboptions. ([1731](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1731)) * The backend utils method `convert_to_target` has been replaced with the [convert\_to\_target](/api/qiskit/qiskit.providers.convert_to_target) method from Qiskit. This fixes some issues related to target generation and calibration data. ([1600](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1600)) - + ## 0.23.0 (2024-04-15) - + ### Deprecation Notes * [backend.run()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#run) has been deprecated. Please use the primitives instead. More details can be found in the [migration guide](/migration-guides/qiskit-runtime) . ([1561](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1561)) * In a future release, the `service` parameter in [from\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#from_id) will be required. ([1311](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1311)) - + ### New Features @@ -329,7 +371,7 @@ in_page_toc_max_heading_level: 2 * [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.SamplerV2") now supports twirling. Twirling will only be applied to those measurement registers not involved within a conditional logic. ([1557](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1557)) * Session [details()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#details) now includes a new field, `usage_time`. Usage is defined as the time a quantum system is committed to complete a job. ([1567](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1567)) - + ### Bug Fixes @@ -338,59 +380,59 @@ in_page_toc_max_heading_level: 2 * Fixed a bug with encoding/decoding `ParameterExpression`. ([1521](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1521)) * Fixed an issue where the [in\_final\_state()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2#in_final_state) method in [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2") would not update the status when called. ([1547](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1547)) - + ## 0.22.0 (2024-03-21) - + ### Upgrade Notes * Modify `skip_reset_qubits` optional flag to the constructor for [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling"). If `False`, dynamical decoupling is applied on qubits regardless of their state, even on delays that are at the beginning of a circuit. This option now matches the behavior in Qiskit. ([1409](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1409)) - + ### New Features * A new local testing mode is added. It allows you to validate your quantum prorams before sending them to a physical system. The local testing mode is activated if one of the fake backends in `qiskit_ibm_runtime.fake_provider` or a Qiskit Aer backend instance is used when instantiating a primitive or a session. ([1495](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1495)) - + ### Bug Fixes * Fix a bug that caused setting of `resilience_level=0` in `EstimatorV2` to be ignored (and the default value used instead). ([1541](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1541)) - + ## 0.21.2 (2024-03-18) - + ### Bug Fixes * Fixed a bug where `RuntimeDecoder` could import arbitrary classes. ([1527](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1527)) - + ## 0.21.1 - + ### Bug Fixes * Fixed a bug where `SamplerV1` and `EstimatorV1` could not be imported because of an issue with how the aliases were defined. - + ## 0.21.0 - + ### Upgrade Notes * Circuits that do not match the target hardware definition are no longer supported by Qiskit Runtime primitives, unless `channel_strategy="q-ctrl"` is used. See the transpilation documentation ([transpile](/guides/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/guides/primitives-examples)) to see this coupled with operator transformations. - + ### Deprecation Notes @@ -398,7 +440,7 @@ in_page_toc_max_heading_level: 2 It will also be a required parameter for `qiskit_ibm_runtime.Session` and `qiskit_ibm_runtime.Batch`. - + ### Bug Fixes @@ -406,11 +448,11 @@ in_page_toc_max_heading_level: 2 * Fixed a bug where retrieving a fake backend through `FakeProviderForBackendV2.backend()` would result in a type error. * Fixes the check for ISA circuits to allow pulse gates and circuits that don’t have layout. - + ## 0.20.0 - + ### New Features @@ -428,57 +470,57 @@ in_page_toc_max_heading_level: 2 The sessions functionality will not change but note that `backend.run()` sessions prior to this release will no longer be supported after March 31, 2024. Please update your `qiskit-ibm-runtime` version as soon as possible before this date. - + ### Deprecation Notes * Circuits that do not match the target hardware definition will no longer be supported after March 1, 2024. See the transpilation documentation ([transpile](/guides/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/guides/primitives-examples)) to see this coupled with operator transformations. - + ### Bug Fixes * Fix assignment of instruction durations when scheduling circuits with control flow. Prior to this fix, the indices for instructions on inner blocks were not mapped to the physical indices in the outer dag. - + ### Other Notes * The `InstructionDurations` durations input is now also required for the constructor of `PadDelay`. - + ## 0.19.1 - + ### Upgrade Notes * Extend `DynamicCircuitInstructions.from_backend()` to extract and patch durations from both `BackendV1` and `BackendV2` objects. Also add `DynamicCircuitInstructions.from_target()` to use a `Target` object instead. - + ### Bug Fixes * Fix the patching of `DynamicCircuitInstructions` for instructions with durations that are not in units of `dt`. * Fixed an issue with the `qpy.dump()` function, when the `use_symengine` flag was set to a truthy object that evaluated to `True` but was not actually the boolean `True` the generated QPY payload would be corrupt. - + ## 0.19.0 - + ### Upgrade Notes * qiskit-ibm-provider is pending deprecation, and therefore will no longer be a dependency for qiskit-ibm-runtime. * qiskit-ibm-runtime is now compatible with Qiskit versions >= 0.45, including 1.0.0. - + ## 0.18.0 - + ### New Features @@ -486,30 +528,30 @@ in_page_toc_max_heading_level: 2 * Added `max_time` parameter to `IBMBackend.open_session()`. * Added a method `RuntimeJob.queue_info()` to get the queue information from the backend. This feature was transferred from `qiskit_ibm_provider`. - + ### Deprecation Notes * [runtime()](/api/qiskit-ibm-runtime/0.21/qiskit_ibm_runtime.QiskitRuntimeService#runtime) has been deprecated. - + ### Bug Fixes * Many methods in [RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) require retrieving the job data from the API with `job_get()`. This API call will now exclude the `params` field by default because they are only necessary in [qiskit\_ibm\_runtime.RuntimeJob.inputs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#inputs). - + ## 0.17.0 - + ### New Features * Added a new method [properties()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#properties) which returns the backend properties of the job at the time the job was run. * [details()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#details) has a new field, activated\_at, which is the timestamp of when the session was changed to active. - + ### Bug Fixes @@ -527,7 +569,7 @@ in_page_toc_max_heading_level: 2 * Fixed an issue where retrieving the coupling\_map of some backends would result in a NameError. - + ## 0.16.0 @@ -535,39 +577,39 @@ in_page_toc_max_heading_level: 2 Sessions are now thread-safe and allow for multiple concurrent interactive experiments. - + ### New Features * Sessions are now thread-safe. - + ### Upgrade Notes * Methods related to using custom programs are removed. - + ### Bug Fixes * If a cloud instance that is `q-ctrl` enabled is used while `q-ctrl` is not passed in as the `channel_strategy`, an error will be raised. - + ## 0.15.1 - + ### Bug Fixes * Reverting 0.15.0 changes to [from\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#from_id) because it was a breaking change without proper deprecation. - + ## 0.15.0 - + ### New Features @@ -604,13 +646,13 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Removed storing result in `RuntimeJob._results`. Instead retrieve results every time the `results()` method is called. - + ### Deprecation Notes * Usage of the `~/.qiskit/qiskitrc.json` file for account information has been deprecated. Use `~/.qiskit/qiskit-ibm.json` instead. - + ### Bug Fixes @@ -619,34 +661,34 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * The `backend` parameter in [from\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#from_id) is being deprecated because sessions do not support multiple backends. Additionally, the `service` parameter is no longer optional. * The `circuit_indices` and `observable_indices` run inputs for [Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) and [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) have been completely removed. - + ### Other Notes * Added migration code for running `backend.run` in qiskit\_ibm\_runtime instead of in qiskit\_ibm\_provider. - + ## 0.14.0 - + ### New Features * There is a new class, `qiskit_ibm_runtime.Batch` that currently works the same way as [qiskit\_ibm\_runtime.Session](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session) but will later be updated to better support submitting multiple jobs at once. * Arbitrary keys and values are no longer allowed in `Options`. - + ### Deprecation Notes * Custom programs are being deprecated as of qiskit-ibm-runtime 0.14.0 and will be removed on November 27, 2023. Users can instead convert their custom programs to use Qiskit Runtime primitives with Qiskit Serverless. Refer to the migration guide for instructions: [https://qiskit.github.io/qiskit-serverless/migration/migration\_from\_qiskit\_runtime\_programs.html](https://qiskit.github.io/qiskit-serverless/migration/migration_from_qiskit_runtime_programs.html) - + ## 0.13.0 - + ### New Features @@ -656,7 +698,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * At initialization, if not passed in directly, the default `instance` selected by the provider will be logged at the “INFO” level. When running a job, if the backend selected is not in the default instance but in a different instance the user also has access to, that instance will also be logged. - + ### Upgrade Notes @@ -664,18 +706,18 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper The old close method behavior has been moved to a new method, [qiskit\_ibm\_runtime.Session.cancel()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#cancel), where all queued jobs within a session are cancelled and terminated. - + ### Bug Fixes * Fixed a bug where `shots` passed in as a numpy type were not being serialized correctly. * Fixed a bug in [target\_history()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#target_history) where the datetime parameter was not being used to retrieve backend properties from the specified date. - + ## 0.12.2 - + ### New Features @@ -684,17 +726,17 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Added new method `Session.from_id` which creates a new session with a given id. * There will now be a warning if a user submits a job that is predicted to exceed their system execution time monthly quota of 10 minutes. This only applies to jobs run on real hardware in the instance `ibm-q/open/main`. If the job does end up exceeding the quota, it will be canceled. - + ### Upgrade Notes * Job error messages now include the error code. Error codes can be found in [errors](/errors). - + ## 0.12.1 - + ### New Features @@ -702,7 +744,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Users can now pass in a value of `default` to the `channel_strategy` parameter in [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService). Now, if an account is configured with a certain channel strategy, the user can override it by passing in `default`. * The Sampler and Estimator primitives have been enhanced to incorporate custom validation procedures when the channel\_strategy property within the :class:qiskit\_ibm\_runtime.QiskitRuntimeService is configured as “q-ctrl.” This customized validation logic effectively rectifies incorrect input options and safeguards users against inadvertently disabling Q-CTRL’s performance enhancements. - + ### Bug Fixes @@ -711,11 +753,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Job error messages will no longer be returned in all uppercase. * The max\_execution\_time option is now based on system execution time instead of wall clock time. System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - + ## 0.12.0 - + ### New Features @@ -734,19 +776,19 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * There is a new parameter, `channel_strategy` that can be set in the initialization of [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) or saved in [qiskit\_ibm\_runtime.QiskitRuntimeService.save\_account()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#save_account). If `channel_strategy` is set to `q-ctrl`, all jobs within the service will use the Q-CTRL error mitigation strategy. - + ### Upgrade Notes * Circuits and other input parameters will no longer be automatically stored in runtime jobs. They can still be retrieved with [qiskit\_ibm\_runtime.RuntimeJob.inputs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#inputs). - + ### Deprecation Notes * The `noise_amplifier` resilience options is deprecated. After the deprecation period, only local folding amplification will be supported. Refer to [https://github.com/qiskit-community/prototype-zne](https://github.com/qiskit-community/prototype-zne) for global folding amplification. - + ### Bug Fixes @@ -754,11 +796,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Fixes a race condition in the test test\_cancel\_running\_job() in test\_job.py where job cancellation could not be performed. Refer to #1019 \<[https://github.com/Qiskit/qiskit-ibm-runtime/issues/1019](https://github.com/Qiskit/qiskit-ibm-runtime/issues/1019)>\_ for more details. * Previously we added validation when jobs were run to make sure the number of circuits was not greater than the maximum for that backend, `backend.max_circuits`. This limit isn’t actually necessary for primtives run from within a session. - + ## 0.11.3 - + ### New Features @@ -768,11 +810,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * There is a new method [update\_tags()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#update_tags) that can be used to update the `job_tags` of a job. * If `instance` is provided as parameter to [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService), then this is used as a filter in `QiskitRuntimeService.backends()`. If `instance` is not recognized as one of the provider instances, an exception will be raised. Previously, we only issued a warning. - + ## 0.11.2 - + ### New Features @@ -793,28 +835,28 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper options.simulator.seed_simulator = 42 ``` - + ### Bug Fixes * Fixed infinite recursion when attempting to deepcopy an IBMBackend. Added a method `qiskit_ibm_runtime.IBMBackend.deepcopy()`. * Fixed an issue where circuit metadata was not being serialized correctly resulting in a type error. - + ## 0.11.1 - + ### Deprecation Notes * In [qiskit\_ibm\_runtime.RuntimeJob.metrics()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#metrics), the bss field will be replaced by usage. - + ## 0.11.0 - + ### New Features @@ -834,59 +876,59 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper options.simulator = {"coupling_map": CouplingMap.from_line(10)} ``` - + ### Upgrade Notes * A default session is no longer open for you if you pass a backend name or backend instance to [qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) or [qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) constructors. The primitive will instead run without a session. In addition, you should now use the `backend` parameter to pass a backend name or instance instead of the `session` parameter (which can continue to be used to pass a session). * The first parameter of the [qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) and [qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) constructors is now `backend` instead of `session`. - + ### Deprecation Notes * Passing a backend name or backend instance to the `session` parameter when initializing a [qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) or [qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) has been deprecated. Please use the `backend` parameter instead. You can continue to pass a session using the `session` parameter. - + ## 0.10.0 - + ### New Features * Python 3.11 is now supported. - + ### Upgrade Notes * Added error messages in case the user defines unsupported values for ‘max\_execution\_time’. Previously, this validation was done on the server side. - + ### Bug Fixes * Added deserialization of the params of RuntimeJob.inputs. Previously, the circuits were returned in serialized format. Fixes issue [#829](https://github.com/Qiskit/qiskit-ibm-runtime/issues/829). * Allow for users to retrieve all backends even if one of the backends has a missing configuration. The backend without a configuration will not be returned. - + ## 0.9.4 - + ### New Features * Added methods to validate input options to `transpilation` and `environment` options. - + ### Upgrade Notes * When constructing a backend `qiskit.transpiler.Target`, faulty qubits and gates from the backend configuration will be filtered out. - + ### Deprecation Notes @@ -898,41 +940,41 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper Within [RuntimeOptions](/api/qiskit-ibm-runtime/0.25/qiskit_ibm_runtime.RuntimeOptions), `backend_name` is no longer supported. Please use `backend` instead. - + ### Bug Fixes * Fixed a bug where retrieving a job from a backend without `noise_model` or `seed_simulator` options would result in a key error. - + ## 0.9.3 - + ### Upgrade Notes * Added error messages in case the user defines unsupported values for ‘optimization\_level’ or for ‘resilience\_level’. Added validation checking for options given as input to `resilience`. Previously, this validation was done on the server side. By adding them on the client side, response will be much faster upon failure. The environment variable `QISKIT_RUNTIME_SKIP_OPTIONS_VALIDATION` is used to control validation. If set, validation will be skipped. * Backend configurations are no longer loaded when [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) is initialized. Instead, the configuration is only loaded and cached during [get\_backend()](/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.QiskitRuntimeService#get_backend) and [backends()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#backends). - + ### Bug Fixes * When creating an Option object and passing an input option to `resilience_options`, this option was included in `resilience_options`, but the other, default options were removed. This was fixed, so now inputs are handled correctly, like other option types. - + ## 0.9.2 - + ### New Features * Added a new argument called `session_time` to the program\_run method and [qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/0.25/qiskit_ibm_runtime.RuntimeOptions). Now values entered by the user for session `max_time` will be sent to the server side as `session_time`. This allows users to specify different values for session `max_time` and `max_execution_time`. * Added the method [target\_history()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#target_history). This method is similar to [target()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#target). The difference is that the new method enables the user to pass a datetime parameter, to retrieve historical data from the backend. - + ### Upgrade Notes @@ -940,7 +982,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * If a job is returned without a backend, retrieving the backend through [qiskit\_ibm\_runtime.RuntimeJob.backend()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#backend) will re-retrieve data from the server and attempt to update the backend. Additionally, `job_id` and `backend`, which were deprecated attributes of [qiskit\_ibm\_runtime.RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) have now been removed. * Added a user warning when the user passes an option that is not supported in Options. - + ### Bug Fixes @@ -949,11 +991,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * If an instance is passed in to [qiskit\_ibm\_runtime.QiskitRuntimeService.get\_backend()](/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.QiskitRuntimeService#get_backend) and then the backend is used in a session, all jobs within the session will be run from the original instance passed in. * Removed additional decomposition of `BlueprintCircuit`s in the JSON encoder. This was introduced as a bugfix, but has since been fixed. Still doing the decomposition led to possible problems if the decomposed circuit was not in the correct basis set of the backend anymore. - + ## 0.9.1 - + ### Upgrade Notes @@ -971,47 +1013,47 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper name = "my_account",) ``` - + ### Deprecation Notes * `backend` is no longer a supported option when using [qiskit\_ibm\_runtime.Session.run()](/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Session#run). Sessions do not support multiple cross backends. Additionally, an exception will be raised if a backend passed in through options does not match the original session backend in an active session. - + ### Bug Fixes * `ECRGate` and `CZGate` mappings have been added to the `Target` constructor to fix a tranpile bug. - + ### Other Notes * Since error messages from a failing job may be long, we shortened them so that they begin from the last `Traceback` in the message. - + ## 0.9.0 - + ### Upgrade Notes * Changed the default values for `optimization_level` and for `resilience_level` in `qiskit_ibm_runtime.Options`. If their values are defined by the user, they are not modified. If not set, if the backend is a noiseless simulator then `optimization_level` is set to 1 and `resilience_level` is set to 0; Otherwise, they are be set to 3 and 1 respectively. * [session\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#session_id) and [tags()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#tags) were added for an easy way to return the session\_id and job\_tags of a job. - + ### Bug Fixes * Fixed a bug where jobs that did not run before a session closes are not actually run as a part of that session. Jobs should run as a part of a session even if that session is closed by the exit of the context manager. * Fixes the issue wherein submitting a large job fails due to write operation timeout. - + ## 0.8.0 - + ### New Features @@ -1019,29 +1061,29 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Advanced resilience options can now be set under `options.resilience`. See [qiskit\_ibm\_runtime.options.ResilienceOptions](/api/qiskit-ibm-runtime/0.27/qiskit_ibm_runtime.options.ResilienceOptions) for all available options. * You can now specify a pair of result decoders for the `result_decoder` parameter of [qiskit\_ibm\_runtime.QiskitRuntimeService.run()](/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.QiskitRuntimeService#run) method. If a pair is specified, the first one is used to decode interim results and the second the final results. - + ### Upgrade Notes * The default `resilience_level` option for has been changed from 0 to 1. In addition, the default `optimization_level` option has been changed from 1 to 3. - + ### Deprecation Notes * The transpilation options `translation_method` and `timing_constraints` have been deprecated. - + ### Bug Fixes * If a [qiskit\_ibm\_runtime.IBMBackend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend) instance is passed to the [qiskit\_ibm\_runtime.Session](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session) constructor, the service used to initialize the `IBMBackend` instance is used for the session instead of the default account service. - + ## 0.7.0 - + ### New Features @@ -1049,13 +1091,13 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * The [qiskit\_ibm\_runtime.options.EnvironmentOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) class now accepts a `callback` parameter. This parameter can be used to stream the interim and final results of the primitives. * The `qiskit_ibm_runtime.Options` class now accepts `max_execution_time` as a first level option and `job_tags` as an option under `environment`. [qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/0.25/qiskit_ibm_runtime.RuntimeOptions) has also been updated to include these two parameters. - + ### Upgrade Notes * This version of qiskit-ibm-runtime requires qiskit-terra version 0.22 or higher. The `requirements.txt` file has been updated accordingly. - + ### Deprecation Notes @@ -1063,7 +1105,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Passing `instance` parameter to the [qiskit\_ibm\_runtime.QiskitRuntimeService.run()](/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.QiskitRuntimeService#run) has been deprecated. Instead, you can pass the `instance` parameter inside the `options` parameter. * Passing `job_tags` and `max_execution_time` as parameters to [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) has been deprecated. Please pass them inside `options`. - + ### Bug Fixes @@ -1073,7 +1115,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper ## 0.7.0rc2 - + ### Upgrade Notes @@ -1081,7 +1123,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) is updated to return `SamplerResult` with `SamplerResult.quasi_dists` as a list of `QuasiDistrbution`. It used to set a list of `dict` as `SamplerResult.quasi_dists`, but it did not follow the design of `SamplerResult`. * The [RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) class is now a subclass of `qiskit.providers.Job`. - + ### Deprecation Notes @@ -1092,13 +1134,13 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper ## 0.7.0rc1 - + ### Prelude There are significant changes to how primitives are invoked within a session, and the options available to the primitives. Please review the rest of the release notes and the tutorials for full information. - + ### New Features @@ -1157,7 +1199,7 @@ There are significant changes to how primitives are invoked within a session, an * The [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) `channel` can now be stored as an environment variable, `QISKIT_IBM_CHANNEL`. This way, when using Runtime Primitives, the service does not have to be instantiated manually and can instead be created directly from environment variables. - + ### Upgrade Notes @@ -1180,7 +1222,7 @@ There are significant changes to how primitives are invoked within a session, an * Since some accounts have many runtime programs, caching a list of all programs on the first call of `programs()` has been removed. Instead, programs will only be cached up to the `limit` given, which has a default value of 20. - + ### Deprecation Notes @@ -1198,17 +1240,17 @@ There are significant changes to how primitives are invoked within a session, an options.transpilation.skip_transpilation = True ``` - + ### Bug Fixes * Fixes issue [#428](https://github.com/Qiskit/qiskit-ibm-runtime/issues/428) by raising the minimum required `qiskit-terra` version to `0.21.0`, since latest version of `qiskit-ibm-runtime` is not compatible with `0.20.0` or earlier of `qiskit-terra`. - + ## 0.6.0 - + ### Upgrade Notes @@ -1225,17 +1267,17 @@ There are significant changes to how primitives are invoked within a session, an * `IBMRuntimeService` class which was deprecated earlier is now removed. Use [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) class going forward. - + ## 0.5.0 - + ### Prelude This release leverages the API and Queue enhancements to become more runtime session aware. As a result when using the primitives (sampler and estimator), runtime jobs in the same session will skip to the front of the queue, thereby speeding up the runtime session, once it has started. - + ### New Features @@ -1248,7 +1290,7 @@ This release leverages the API and Queue enhancements to become more runtime ses backend.service # QiskitRuntimeService instance used to instantiate the backend ``` - + ### Upgrade Notes @@ -1305,11 +1347,11 @@ This release leverages the API and Queue enhancements to become more runtime ses * [qubit\_properties()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#qubit_properties) will now return a sub class of `QubitProperties` called `IBMQubitProperties` and will expose anharmonicity in addition to the t1, t2 and frequency already exposed by the `QubitProperties` class. - + ## 0.4.0 - + ### Upgrade Notes @@ -1394,55 +1436,55 @@ This release leverages the API and Queue enhancements to become more runtime ses result = sampler(circuit_indices=[0], ...) ``` - + ### Deprecation Notes * `IBMRuntimeService`, `IBMEstimator` and `IBMSampler` classes have been deprecated and will be removed in a future release. Use [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService), [Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) and [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) classes instead. See upgrade notes section for a detailed explanation with examples. - + ## 0.3.0 - + ### Upgrade Notes * A new parameter `channel` has now been added to `qiskit_ibm_runtime.IBMRuntimeService` class and also to methods like `save_account()`, `saved_accounts()` and `delete_account()`. It can be set to `ibm_quantum` or `ibm_cloud` to authenticate to either of the two different channels through which Qiskit Runtime service is currently offered. `channel` replaces the `auth` parameter which has now been deprecated. - + ### Deprecation Notes * The `auth` parameter to `qiskit_ibm_runtime.IBMRuntimeService` class and also to methods like `save_account()`, `saved_accounts()` and `delete_account()` has now been deprecated and will be removed in a future release. Please use the new `channel` parameter instead. - + ### Bug Fixes * Fixed [#291](https://github.com/Qiskit/qiskit-ibm-runtime/issues/219) where passing a single `QuantumCircuit` to sampler or estimator primitives was throwing an error. - + ## 0.2.0 - + ### New Features * `qiskit_ibm_runtime.IBMEstimator` and `qiskit_ibm_runtime.IBMSampler` classes now allow you to easily interact with the `estimator` and `sampler` primitive programs. Refer to the examples in the respective class doc strings to learn more about how to use them. - + ### Bug Fixes * Fixed a bug where [qiskit\_ibm\_runtime.RuntimeJob.wait\_for\_final\_state()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#wait_for_final_state) would result in a NoneType error if the job already completed and [qiskit\_ibm\_runtime.RuntimeJob.status()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#status) was called beforehand. - + ## 0.1.0 - + ### Prelude @@ -1452,13 +1494,13 @@ This new package is built upon the work already done in qiskit.providers.ibmq.ru qiskit-ibm-runtime is not included as part of Qiskit meta package and thereby you have to install it separately using `pip install qiskit-ibm-runtime`. - + ### New Features * `qiskit_ibm_runtime.IBMRuntimeService.least_busy()` will now allow you find the least busy backend. - + ### Upgrade Notes @@ -1517,37 +1559,37 @@ qiskit-ibm-runtime is not included as part of Qiskit meta package and thereby yo * `qiskit_ibm_runtime.IBMRuntimeService.run()` method now accepts runtime execution options as [qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/0.25/qiskit_ibm_runtime.RuntimeOptions) class in addition to already supported Dict. backend\_name, image and log\_level are the currently available options. -* Final result is also streamed now after interim results when you specify a `callback` to `qiskit_ibm_runtime.IBMRuntimeService.run()` or [qiskit\_ibm\_runtime.RuntimeJob.stream\_results()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#stream_results). +* Final result is also streamed now after interim results when you specify a `callback` to `qiskit_ibm_runtime.IBMRuntimeService.run()` or [qiskit\_ibm\_runtime.RuntimeJob.stream\_results()](/api/qiskit-ibm-runtime/0.30/qiskit_ibm_runtime.RuntimeJob#stream_results). - + ## 0.1.0rc2 - + ### New Features * For convenience, you can now set the `IBM Cloud service name` as a value for the account `instance` parameter. If you choose to set the name instead of the `CRN`, the initialization time of the `qiskit_ibm_runtime.IBMRuntimeService` class is slightly higher because the required `CRN` value is internally resolved via IBM Cloud APIs. - + ### Bug Fixes * [qiskit\_ibm\_runtime.utils.json.RuntimeEncoder](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder) and [qiskit\_ibm\_runtime.utils.json.RuntimeDecoder](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder) have been updated to handle instances of the Instruction class. * Fixed an issue where numpy ndarrays with object types could not be serialized. [qiskit\_ibm\_runtime.utils.json.RuntimeEncoder](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder) and [qiskit\_ibm\_runtime.utils.json.RuntimeDecoder](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder) have been updated to handle these ndarrays. - + ## 0.1.0rc1 - + ### New Features * You can now pass `instance` parameter in the hub/group/project format to `qiskit_ibm_runtime.IBMRuntimeService.jobs()` to filter jobs. Currently only supported for legacy authentication. -* You can now use the [qiskit\_ibm\_runtime.RuntimeJob.interim\_results()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#interim_results) method to retrieve runtime program interim results. Note that interim results will only be available for up to two days. +* You can now use the [qiskit\_ibm\_runtime.RuntimeJob.interim\_results()](/api/qiskit-ibm-runtime/0.30/qiskit_ibm_runtime.RuntimeJob#interim_results) method to retrieve runtime program interim results. Note that interim results will only be available for up to two days. - + ### Upgrade Notes @@ -1555,7 +1597,7 @@ qiskit-ibm-runtime is not included as part of Qiskit meta package and thereby yo * When uploading a program with `qiskit_ibm_runtime.IBMRuntimeService.upload_program()`, the program description is now optional. * When printing programs with `qiskit_ibm_runtime.IBMRuntimeService.pprint_programs()`, `backend_requirements` will now be listed. - + ### Bug Fixes diff --git a/docs/api/qiskit-ibm-runtime/visualization.mdx b/docs/api/qiskit-ibm-runtime/visualization.mdx index 25faf46d415..e1f16ffd8ce 100644 --- a/docs/api/qiskit-ibm-runtime/visualization.mdx +++ b/docs/api/qiskit-ibm-runtime/visualization.mdx @@ -20,5 +20,6 @@ A suite of functions for visualizing qiskit-ibm-runtime’s objects. | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`draw_execution_spans`](qiskit_ibm_runtime.visualization.draw_execution_spans "qiskit_ibm_runtime.visualization.draw_execution_spans")(\*spans\[, names, ...]) | Draw one or more [`ExecutionSpans`](qiskit_ibm_runtime.execution_span.ExecutionSpans "qiskit_ibm_runtime.execution_span.ExecutionSpans") on a bar plot. | | [`draw_layer_error_map`](qiskit_ibm_runtime.visualization.draw_layer_error_map "qiskit_ibm_runtime.visualization.draw_layer_error_map")(layer\_error, embedding) | Draw a map view of a [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError"). | diff --git a/public/api/qiskit-ibm-runtime/0.31/objects.inv b/public/api/qiskit-ibm-runtime/0.31/objects.inv new file mode 100644 index 00000000000..a31b4e334a7 Binary files /dev/null and b/public/api/qiskit-ibm-runtime/0.31/objects.inv differ diff --git a/public/api/qiskit-ibm-runtime/dev/objects.inv b/public/api/qiskit-ibm-runtime/dev/objects.inv index e802273f965..ebdda379cb3 100644 Binary files a/public/api/qiskit-ibm-runtime/dev/objects.inv and b/public/api/qiskit-ibm-runtime/dev/objects.inv differ diff --git a/public/api/qiskit-ibm-runtime/objects.inv b/public/api/qiskit-ibm-runtime/objects.inv index a31b4e334a7..383dc392550 100644 Binary files a/public/api/qiskit-ibm-runtime/objects.inv and b/public/api/qiskit-ibm-runtime/objects.inv differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_00.png b/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_00.png new file mode 100644 index 00000000000..525727b96c4 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_00.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_01.png b/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_01.png new file mode 100644 index 00000000000..ddcdc81a90a Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_01.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_02.png new file mode 100644 index 00000000000..8257ae55c65 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png new file mode 100644 index 00000000000..e8bb0d80c69 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png new file mode 100644 index 00000000000..16eeb863365 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png new file mode 100644 index 00000000000..ac133e52341 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png new file mode 100644 index 00000000000..94435917b97 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png new file mode 100644 index 00000000000..cea5147eb1c Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png new file mode 100644 index 00000000000..2727f8b7b36 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png new file mode 100644 index 00000000000..510bb446283 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png new file mode 100644 index 00000000000..52168651d54 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png new file mode 100644 index 00000000000..f3d635d0ba5 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png new file mode 100644 index 00000000000..ec9c1acfb64 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png new file mode 100644 index 00000000000..ec9c1acfb64 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png new file mode 100644 index 00000000000..98ce16c3a34 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png new file mode 100644 index 00000000000..c03b8120549 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png new file mode 100644 index 00000000000..a5ea96531d6 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png new file mode 100644 index 00000000000..7e240ab6236 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png new file mode 100644 index 00000000000..4c719a051af Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.31/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png index 49b830f0736..87c9014140d 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png index 8257ae55c65..d8038dd69d7 100644 Binary files a/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png differ diff --git a/scripts/config/api-html-artifacts.json b/scripts/config/api-html-artifacts.json index 1d1c508b001..e50b8d08850 100644 --- a/scripts/config/api-html-artifacts.json +++ b/scripts/config/api-html-artifacts.json @@ -29,7 +29,8 @@ "0.19": "https://ibm.box.com/shared/static/wjoea4x5tnxd0l4lgo2v3kxnx6btxvvl.zip" }, "qiskit-ibm-runtime": { - "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/2082018988/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/2128611480/zip", + "0.32": "https://ibm.box.com/shared/static/enr0tnwaxzpvrypzjav4f1vjip3yfqcy.zip", "0.31": "https://ibm.box.com/shared/static/z19dt14je6cz69oi4knraitjglzo29w7.zip", "0.30": "https://ibm.box.com/shared/static/f950vkx3uq13o8g017bazpm4o9bcei2i.zip", "0.29": "https://ibm.box.com/shared/static/9n6xf8gkh24xpft2e7zrwgme7jzkh6nu.zip", diff --git a/scripts/config/historical-pages-to-latest.json b/scripts/config/historical-pages-to-latest.json index 519c8265483..212b42e3bf0 100644 --- a/scripts/config/historical-pages-to-latest.json +++ b/scripts/config/historical-pages-to-latest.json @@ -19220,6 +19220,7 @@ "qiskit_ibm_runtime.fake_provider.FakeWashington": "/", "qiskit_ibm_runtime.fake_provider.FakeYorktown": "/" }, + "0.31": {}, "dev": {} }, "qiskit-ibm-transpiler": { diff --git a/scripts/js/commands/checkInternalLinks.ts b/scripts/js/commands/checkInternalLinks.ts index 8db6bb331ec..e17a93aeba7 100644 --- a/scripts/js/commands/checkInternalLinks.ts +++ b/scripts/js/commands/checkInternalLinks.ts @@ -189,6 +189,7 @@ async function determineCurrentDocsFileBatch( "docs/api/qiskit-ibm-runtime/0.27/qiskit_ibm_runtime.options.ResilienceOptions.mdx", "docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.QiskitRuntimeService.mdx", "docs/api/qiskit-ibm-runtime/0.29/qiskit_ibm_runtime.Session.mdx", + "docs/api/qiskit-ibm-runtime/0.30/qiskit_ibm_runtime.RuntimeJob.mdx", ]; if (args.currentApis) {