diff --git a/docs/api/qiskit-ibm-runtime/0.22/_package.json b/docs/api/qiskit-ibm-runtime/0.22/_package.json new file mode 100644 index 00000000000..f1b30547572 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/_package.json @@ -0,0 +1,4 @@ +{ + "name": "qiskit-ibm-runtime", + "version": "0.22.0" +} diff --git a/docs/api/qiskit-ibm-runtime/0.22/_toc.json b/docs/api/qiskit-ibm-runtime/0.22/_toc.json new file mode 100644 index 00000000000..c7a6b2c16fb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/_toc.json @@ -0,0 +1,609 @@ +{ + "title": "Qiskit Runtime IBM Client", + "children": [ + { + "title": "qiskit_ibm_runtime", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.22/runtime_service" + }, + { + "title": "EstimatorV1", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV1" + }, + { + "title": "EstimatorV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV2" + }, + { + "title": "IBMBackend", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.IBMBackend" + }, + { + "title": "QiskitRuntimeService", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.QiskitRuntimeService" + }, + { + "title": "RuntimeDecoder", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeDecoder" + }, + { + "title": "RuntimeEncoder", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeEncoder" + }, + { + "title": "RuntimeJob", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJob" + }, + { + "title": "RuntimeJobV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJobV2" + }, + { + "title": "RuntimeOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeOptions" + }, + { + "title": "SamplerV1", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV1" + }, + { + "title": "SamplerV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV2" + }, + { + "title": "Session", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Session" + } + ] + }, + { + "title": "qiskit_ibm_runtime.fake_provider", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.22/fake_provider" + }, + { + "title": "FakeAlgiers", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlgiers" + }, + { + "title": "FakeAlmaden", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmaden" + }, + { + "title": "FakeAlmadenV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2" + }, + { + "title": "FakeArmonk", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonk" + }, + { + "title": "FakeArmonkV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonkV2" + }, + { + "title": "FakeAthens", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthens" + }, + { + "title": "FakeAthensV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthensV2" + }, + { + "title": "FakeAuckland", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAuckland" + }, + { + "title": "FakeBelem", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelem" + }, + { + "title": "FakeBelemV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelemV2" + }, + { + "title": "FakeBoeblingen", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingen" + }, + { + "title": "FakeBoeblingenV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2" + }, + { + "title": "FakeBogota", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogota" + }, + { + "title": "FakeBogotaV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogotaV2" + }, + { + "title": "FakeBrisbane", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrisbane" + }, + { + "title": "FakeBrooklyn", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklyn" + }, + { + "title": "FakeBrooklynV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2" + }, + { + "title": "FakeBurlington", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlington" + }, + { + "title": "FakeBurlingtonV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2" + }, + { + "title": "FakeCairo", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairo" + }, + { + "title": "FakeCairoV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairoV2" + }, + { + "title": "FakeCambridge", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridge" + }, + { + "title": "FakeCambridgeV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2" + }, + { + "title": "FakeCasablanca", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablanca" + }, + { + "title": "FakeCasablancaV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2" + }, + { + "title": "FakeCusco", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCusco" + }, + { + "title": "FakeEssex", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssex" + }, + { + "title": "FakeEssexV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssexV2" + }, + { + "title": "FakeGeneva", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGeneva" + }, + { + "title": "FakeGuadalupe", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupe" + }, + { + "title": "FakeGuadalupeV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2" + }, + { + "title": "FakeHanoi", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoi" + }, + { + "title": "FakeHanoiV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoiV2" + }, + { + "title": "FakeJakarta", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakarta" + }, + { + "title": "FakeJakartaV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakartaV2" + }, + { + "title": "FakeJohannesburg", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburg" + }, + { + "title": "FakeJohannesburgV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2" + }, + { + "title": "FakeKawasaki", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKawasaki" + }, + { + "title": "FakeKolkata", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkata" + }, + { + "title": "FakeKolkataV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkataV2" + }, + { + "title": "FakeKyiv", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyiv" + }, + { + "title": "FakeKyoto", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyoto" + }, + { + "title": "FakeLagos", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagos" + }, + { + "title": "FakeLagosV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagosV2" + }, + { + "title": "FakeLima", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLima" + }, + { + "title": "FakeLimaV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLimaV2" + }, + { + "title": "FakeLondon", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondon" + }, + { + "title": "FakeLondonV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondonV2" + }, + { + "title": "FakeManhattan", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattan" + }, + { + "title": "FakeManhattanV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattanV2" + }, + { + "title": "FakeManila", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManila" + }, + { + "title": "FakeManilaV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManilaV2" + }, + { + "title": "FakeMelbourne", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourne" + }, + { + "title": "FakeMelbourneV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2" + }, + { + "title": "FakeMontreal", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontreal" + }, + { + "title": "FakeMontrealV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontrealV2" + }, + { + "title": "FakeMumbai", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbai" + }, + { + "title": "FakeMumbaiV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2" + }, + { + "title": "FakeNairobi", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobi" + }, + { + "title": "FakeNairobiV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobiV2" + }, + { + "title": "FakeOsaka", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOsaka" + }, + { + "title": "FakeOslo", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOslo" + }, + { + "title": "FakeOurense", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurense" + }, + { + "title": "FakeOurenseV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurenseV2" + }, + { + "title": "FakeParis", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParis" + }, + { + "title": "FakeParisV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParisV2" + }, + { + "title": "FakePeekskill", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePeekskill" + }, + { + "title": "FakePerth", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePerth" + }, + { + "title": "FakePoughkeepsie", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie" + }, + { + "title": "FakePoughkeepsieV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2" + }, + { + "title": "FakePrague", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePrague" + }, + { + "title": "FakeProvider", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProvider" + }, + { + "title": "FakeProviderForBackendV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2" + }, + { + "title": "FakeQuebec", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuebec" + }, + { + "title": "FakeQuito", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuito" + }, + { + "title": "FakeQuitoV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuitoV2" + }, + { + "title": "FakeRochester", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochester" + }, + { + "title": "FakeRochesterV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochesterV2" + }, + { + "title": "FakeRome", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRome" + }, + { + "title": "FakeRomeV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRomeV2" + }, + { + "title": "FakeRueschlikon", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRueschlikon" + }, + { + "title": "FakeSantiago", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiago" + }, + { + "title": "FakeSantiagoV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2" + }, + { + "title": "FakeSherbrooke", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSherbrooke" + }, + { + "title": "FakeSingapore", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingapore" + }, + { + "title": "FakeSingaporeV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2" + }, + { + "title": "FakeSydney", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydney" + }, + { + "title": "FakeSydneyV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydneyV2" + }, + { + "title": "FakeTenerife", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTenerife" + }, + { + "title": "FakeTokyo", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTokyo" + }, + { + "title": "FakeTorino", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorino" + }, + { + "title": "FakeToronto", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeToronto" + }, + { + "title": "FakeTorontoV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorontoV2" + }, + { + "title": "FakeValencia", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValencia" + }, + { + "title": "FakeValenciaV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValenciaV2" + }, + { + "title": "FakeVigo", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigo" + }, + { + "title": "FakeVigoV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigoV2" + }, + { + "title": "FakeWashington", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashington" + }, + { + "title": "FakeWashingtonV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2" + }, + { + "title": "FakeYorktown", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktown" + }, + { + "title": "FakeYorktownV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktownV2" + } + ] + }, + { + "title": "qiskit_ibm_runtime.options", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.22/options" + }, + { + "title": "DynamicalDecouplingOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.DynamicalDecouplingOptions" + }, + { + "title": "EnvironmentOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EnvironmentOptions" + }, + { + "title": "EstimatorOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EstimatorOptions" + }, + { + "title": "ExecutionOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptions" + }, + { + "title": "ExecutionOptionsV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptionsV2" + }, + { + "title": "LayerNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.LayerNoiseLearningOptions" + }, + { + "title": "MeasureNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions" + }, + { + "title": "Options", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.Options" + }, + { + "title": "PecOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.PecOptions" + }, + { + "title": "ResilienceOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptions" + }, + { + "title": "ResilienceOptionsV2", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptionsV2" + }, + { + "title": "SamplerOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SamplerOptions" + }, + { + "title": "SimulatorOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SimulatorOptions" + }, + { + "title": "TranspilationOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TranspilationOptions" + }, + { + "title": "TwirlingOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TwirlingOptions" + }, + { + "title": "ZneOptions", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ZneOptions" + } + ] + }, + { + "title": "qiskit_ibm_runtime.transpiler", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.22/transpiler" + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes" + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes.basis", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.basis" + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes.scheduling", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling" + }, + { + "title": "ALAPScheduleAnalysis", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis" + }, + { + "title": "ASAPScheduleAnalysis", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis" + }, + { + "title": "BlockBasePadder", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder" + }, + { + "title": "DynamicCircuitInstructionDurations", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations" + }, + { + "title": "PadDelay", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay" + }, + { + "title": "PadDynamicalDecoupling", + "url": "/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling" + } + ] + } + ] + } + ] + }, + { + "title": "Release notes", + "url": "/api/qiskit-ibm-runtime/release-notes" + } + ], + "collapsed": true +} + diff --git a/docs/api/qiskit-ibm-runtime/0.22/fake_provider.mdx b/docs/api/qiskit-ibm-runtime/0.22/fake_provider.mdx new file mode 100644 index 00000000000..9df30624292 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/fake_provider.mdx @@ -0,0 +1,199 @@ +--- +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.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 +job = backend.run(transpiled_circuit) +counts = job.result().get_counts() +plot_histogram(counts) +``` + +![../\_images/fake\_provider-1\_00.png](/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_00.png) + +![../\_images/fake\_provider-1\_01.png](/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_01.png) + +![../\_images/fake\_provider-1\_02.png](/images/api/qiskit-ibm-runtime/0.22/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.get_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. | +| [`FakeProvider`](qiskit_ibm_runtime.fake_provider.FakeProvider "qiskit_ibm_runtime.fake_provider.FakeProvider")() | Fake provider containing fake V1 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. | +| [`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. | + +### Fake V1 Backends + +Fake V1 backends are fake backends with IBM Quantum systems snapshots implemented with `BackendV1` interface. + +| | | +| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| [`FakeAlmaden`](qiskit_ibm_runtime.fake_provider.FakeAlmaden "qiskit_ibm_runtime.fake_provider.FakeAlmaden")() | A fake Almaden backend. | +| [`FakeArmonk`](qiskit_ibm_runtime.fake_provider.FakeArmonk "qiskit_ibm_runtime.fake_provider.FakeArmonk")() | A fake 1 qubit backend. | +| [`FakeAthens`](qiskit_ibm_runtime.fake_provider.FakeAthens "qiskit_ibm_runtime.fake_provider.FakeAthens")() | A fake 5 qubit backend. | +| [`FakeBelem`](qiskit_ibm_runtime.fake_provider.FakeBelem "qiskit_ibm_runtime.fake_provider.FakeBelem")() | A fake 5 qubit backend. | +| [`FakeBoeblingen`](qiskit_ibm_runtime.fake_provider.FakeBoeblingen "qiskit_ibm_runtime.fake_provider.FakeBoeblingen")() | A fake Boeblingen backend. | +| [`FakeBogota`](qiskit_ibm_runtime.fake_provider.FakeBogota "qiskit_ibm_runtime.fake_provider.FakeBogota")() | A fake 5 qubit backend. | +| [`FakeBrooklyn`](qiskit_ibm_runtime.fake_provider.FakeBrooklyn "qiskit_ibm_runtime.fake_provider.FakeBrooklyn")() | A fake Brooklyn backend. | +| [`FakeBurlington`](qiskit_ibm_runtime.fake_provider.FakeBurlington "qiskit_ibm_runtime.fake_provider.FakeBurlington")() | A fake 5 qubit backend. | +| [`FakeCairo`](qiskit_ibm_runtime.fake_provider.FakeCairo "qiskit_ibm_runtime.fake_provider.FakeCairo")() | A fake 27 qubit backend. | +| [`FakeCambridge`](qiskit_ibm_runtime.fake_provider.FakeCambridge "qiskit_ibm_runtime.fake_provider.FakeCambridge")() | A fake Cambridge backend. | +| [`FakeCasablanca`](qiskit_ibm_runtime.fake_provider.FakeCasablanca "qiskit_ibm_runtime.fake_provider.FakeCasablanca")() | A fake 7 qubit backend. | +| [`FakeEssex`](qiskit_ibm_runtime.fake_provider.FakeEssex "qiskit_ibm_runtime.fake_provider.FakeEssex")() | A fake 5 qubit backend. | +| [`FakeGuadalupe`](qiskit_ibm_runtime.fake_provider.FakeGuadalupe "qiskit_ibm_runtime.fake_provider.FakeGuadalupe")() | A fake 16 qubit backend. | +| [`FakeHanoi`](qiskit_ibm_runtime.fake_provider.FakeHanoi "qiskit_ibm_runtime.fake_provider.FakeHanoi")() | A fake 27 qubit backend. | +| [`FakeJakarta`](qiskit_ibm_runtime.fake_provider.FakeJakarta "qiskit_ibm_runtime.fake_provider.FakeJakarta")() | A fake 7 qubit backend. | +| [`FakeJohannesburg`](qiskit_ibm_runtime.fake_provider.FakeJohannesburg "qiskit_ibm_runtime.fake_provider.FakeJohannesburg")() | A fake Johannesburg backend. | +| [`FakeKolkata`](qiskit_ibm_runtime.fake_provider.FakeKolkata "qiskit_ibm_runtime.fake_provider.FakeKolkata")() | A fake 27 qubit backend. | +| [`FakeLagos`](qiskit_ibm_runtime.fake_provider.FakeLagos "qiskit_ibm_runtime.fake_provider.FakeLagos")() | A fake 7 qubit backend. | +| [`FakeLima`](qiskit_ibm_runtime.fake_provider.FakeLima "qiskit_ibm_runtime.fake_provider.FakeLima")() | A fake 5 qubit backend. | +| [`FakeLondon`](qiskit_ibm_runtime.fake_provider.FakeLondon "qiskit_ibm_runtime.fake_provider.FakeLondon")() | A fake 5 qubit backend. | +| [`FakeManhattan`](qiskit_ibm_runtime.fake_provider.FakeManhattan "qiskit_ibm_runtime.fake_provider.FakeManhattan")() | A fake Manhattan backend. | +| [`FakeManila`](qiskit_ibm_runtime.fake_provider.FakeManila "qiskit_ibm_runtime.fake_provider.FakeManila")() | A fake 5 qubit backend. | +| [`FakeMelbourne`](qiskit_ibm_runtime.fake_provider.FakeMelbourne "qiskit_ibm_runtime.fake_provider.FakeMelbourne")() | A fake 14 qubit backend. | +| [`FakeMontreal`](qiskit_ibm_runtime.fake_provider.FakeMontreal "qiskit_ibm_runtime.fake_provider.FakeMontreal")() | A fake 27 qubit backend. | +| [`FakeMumbai`](qiskit_ibm_runtime.fake_provider.FakeMumbai "qiskit_ibm_runtime.fake_provider.FakeMumbai")() | A fake 27 qubit backend. | +| [`FakeNairobi`](qiskit_ibm_runtime.fake_provider.FakeNairobi "qiskit_ibm_runtime.fake_provider.FakeNairobi")() | A fake 7 qubit backend. | +| [`FakeOurense`](qiskit_ibm_runtime.fake_provider.FakeOurense "qiskit_ibm_runtime.fake_provider.FakeOurense")() | A fake 5 qubit backend. | +| [`FakeParis`](qiskit_ibm_runtime.fake_provider.FakeParis "qiskit_ibm_runtime.fake_provider.FakeParis")() | A fake Paris backend. | +| [`FakePoughkeepsie`](qiskit_ibm_runtime.fake_provider.FakePoughkeepsie "qiskit_ibm_runtime.fake_provider.FakePoughkeepsie")() | A fake Poughkeepsie backend. | +| [`FakeQuito`](qiskit_ibm_runtime.fake_provider.FakeQuito "qiskit_ibm_runtime.fake_provider.FakeQuito")() | A fake 5 qubit backend. | +| [`FakeRochester`](qiskit_ibm_runtime.fake_provider.FakeRochester "qiskit_ibm_runtime.fake_provider.FakeRochester")() | A fake Rochester backend. | +| [`FakeRome`](qiskit_ibm_runtime.fake_provider.FakeRome "qiskit_ibm_runtime.fake_provider.FakeRome")() | A fake 5 qubit backend. | +| [`FakeRueschlikon`](qiskit_ibm_runtime.fake_provider.FakeRueschlikon "qiskit_ibm_runtime.fake_provider.FakeRueschlikon")() | A fake 16 qubit backend. | +| [`FakeSantiago`](qiskit_ibm_runtime.fake_provider.FakeSantiago "qiskit_ibm_runtime.fake_provider.FakeSantiago")() | A fake Santiago backend. | +| [`FakeSingapore`](qiskit_ibm_runtime.fake_provider.FakeSingapore "qiskit_ibm_runtime.fake_provider.FakeSingapore")() | A fake Singapore backend. | +| [`FakeSydney`](qiskit_ibm_runtime.fake_provider.FakeSydney "qiskit_ibm_runtime.fake_provider.FakeSydney")() | A fake 27 qubit backend. | +| [`FakeTenerife`](qiskit_ibm_runtime.fake_provider.FakeTenerife "qiskit_ibm_runtime.fake_provider.FakeTenerife")() | A fake 5 qubit backend. | +| [`FakeTokyo`](qiskit_ibm_runtime.fake_provider.FakeTokyo "qiskit_ibm_runtime.fake_provider.FakeTokyo")() | A fake 20 qubit backend. | +| [`FakeToronto`](qiskit_ibm_runtime.fake_provider.FakeToronto "qiskit_ibm_runtime.fake_provider.FakeToronto")() | A fake 27 qubit backend. | +| [`FakeValencia`](qiskit_ibm_runtime.fake_provider.FakeValencia "qiskit_ibm_runtime.fake_provider.FakeValencia")() | A fake 5 qubit backend. | +| [`FakeVigo`](qiskit_ibm_runtime.fake_provider.FakeVigo "qiskit_ibm_runtime.fake_provider.FakeVigo")() | A fake 5 qubit backend. | +| [`FakeWashington`](qiskit_ibm_runtime.fake_provider.FakeWashington "qiskit_ibm_runtime.fake_provider.FakeWashington")() | A fake 127 qubit backend. | +| [`FakeYorktown`](qiskit_ibm_runtime.fake_provider.FakeYorktown "qiskit_ibm_runtime.fake_provider.FakeYorktown")() | A fake 5 qubit backend. | + diff --git a/docs/api/qiskit-ibm-runtime/0.22/index.mdx b/docs/api/qiskit-ibm-runtime/0.22/index.mdx new file mode 100644 index 00000000000..71a9da5c99c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/index.mdx @@ -0,0 +1,12 @@ +--- +title: Qiskit Runtime IBM Client API Docs +description: API documentation for qiskit-ibm-runtime +--- + +# qiskit-ibm-runtime API reference + +* [Qiskit Runtime (`qiskit_ibm_runtime`)](runtime_service) +* [Primitive options (`qiskit_ibm_runtime.options`)](options) +* [IBM Backend Transpiler Tools (`qiskit_ibm_runtime.transpiler`)](transpiler) +* [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider) + diff --git a/docs/api/qiskit-ibm-runtime/0.22/options.mdx b/docs/api/qiskit-ibm-runtime/0.22/options.mdx new file mode 100644 index 00000000000..e911039d33e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/options.mdx @@ -0,0 +1,90 @@ +--- +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 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(backend=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(backend=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. See the [API Reference](/api/qiskit-ibm-runtime/0.22/options) for the most up-to-date default values. + + +**V1 Primitives** + +The [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options") class encapsulates all the options you can specify when invoking a V1 primitive. It includes frequently used options, such as `optimization_level` and `resilience_level` as well as sub-categories, such as `transpilation` and `execution`. You can use auto-complete to easily find the options inside each sub-category, for example: + +```python +from qiskit_ibm_runtime.options import Options + +options = Options() +options.transpilation.initial_layout = [0, 1, 2, 3] # This an be done using auto-complete +``` + +You can also pass dictionaries to each sub-category, for example: + +```python +from qiskit_ibm_runtime.options import Options + +options = Options(transpilation={"initial_layout": [0, 1, 2, 3]}) +``` + +## Classes + +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| [`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. | +| [`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. | +| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for the primitives, used by V1 primitives. | +| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\*args, \*\*kwargs) | Transpilation options. | +| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\*args, \*\*kwargs) | Resilience options for V1 primitives. | +| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\*args, \*\*kwargs) | Execution options for V1 primitives. | +| [`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.22/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Estimator.mdx new file mode 100644 index 00000000000..942cd8cf879 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/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 [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1") + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV1.mdx new file mode 100644 index 00000000000..6a12be03aa4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV1.mdx @@ -0,0 +1,135 @@ +--- +title: EstimatorV1 +description: API reference for qiskit_ibm_runtime.EstimatorV1 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.EstimatorV1 +--- + +# EstimatorV1 + + + 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.EstimatorV1.run "qiskit_ibm_runtime.EstimatorV1.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. + + You are encouraged to use [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") to open a session, during which you can invoke one or more primitives. Jobs submitted within a session are prioritized by the scheduler. + + Example: + + ```python + from qiskit.circuit.library import RealAmplitudes + from qiskit.quantum_info import SparsePauliOp + + from qiskit_ibm_runtime import QiskitRuntimeService, Estimator + + service = QiskitRuntimeService(channel="ibm_cloud") + + psi1 = RealAmplitudes(num_qubits=2, reps=2) + + H1 = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) + H2 = SparsePauliOp.from_list([("IZ", 1)]) + H3 = SparsePauliOp.from_list([("ZI", 1), ("ZZ", 1)]) + + with Session(service=service, backend="ibmq_qasm_simulator") as session: + estimator = Estimator(session=session) + + theta1 = [0, 1, 1, 2, 3, 5] + + # calculate [ ] + psi1_H1 = estimator.run(circuits=[psi1], observables=[H1], parameter_values=[theta1]) + print(psi1_H1.result()) + + # calculate [ , ] + psi1_H23 = estimator.run( + circuits=[psi1, psi1], + observables=[H2, H3], + parameter_values=[theta1]*2 + ) + print(psi1_H23.result()) + ``` + + Initializes the Estimator primitive. + + **Parameters** + + * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + + * **session** (`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")]) – + + Session in which to call the primitive. + + If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected. + + * **options** (`Union`\[`Dict`, [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.options.Options"), `None`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + + ## Attributes + + ### options + + + Return options values for the sampler. :rtype: `Options` :returns: options + + + ### session + + + Return session used by this primitive. + + **Return type** + + `Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + + **Returns** + + Session used by this primitive, or `None` if session is not used. + + + ### version + + + + ## Methods + + ### run + + + Submit a request to the estimator primitive. + + **Parameters** + + * **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – a (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. + * **observables** (*Sequence\[BaseOperator | str] | BaseOperator | str*) – Observable objects. + * **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. + * **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). + + **Return type** + + [RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") + + **Returns** + + Submitted job. The result of the job is an instance of `qiskit.primitives.EstimatorResult`. + + **Raises** + + **ValueError** – Invalid arguments are given. + + + ### set\_options + + + Set options values for the sampler. + + **Parameters** + + **\*\*fields** – The fields to update the options + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV2.mdx new file mode 100644 index 00000000000..3b72cd4a836 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.EstimatorV2.mdx @@ -0,0 +1,121 @@ +--- +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`, 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(backend=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** + + * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + + * **session** (`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")]) – + + Session in which to call the primitive. + + If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected. + + * **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 + + ### options + + + Return options + + **Return type** + + `TypeVar`(`OptionsT`, bound= `BaseOptions`) + + + ### session + + + Return session used by this primitive. + + **Return type** + + `Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + + **Returns** + + Session used by this primitive, or `None` if session is not used. + + + ### 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. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.IBMBackend.mdx new file mode 100644 index 00000000000..cd78298b973 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.IBMBackend.mdx @@ -0,0 +1,671 @@ +--- +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` object for the backend. + > + > * basis\_gates: list of basis gates names on the backend. + > + > * gates: list of basis gates on the backend. + > + > * local: backend is local or remote. + > + > * simulator: backend is a simulator. + > + > * conditional: backend supports conditional operations. + > + > * open\_pulse: backend supports open pulse. + > + > * memory: backend supports memory. + > + > * max\_shots: maximum number of shots supported. + > + > * coupling\_map (list): The coupling map for the device + > + > * supported\_instructions (List\[str]): Instructions supported by the backend. + > + > * dynamic\_reprate\_enabled (bool): whether delay between programs can be set dynamically (ie via `rep_delay`). Defaults to False. + > + > * rep\_delay\_range (List\[float]): 2d list defining supported range of repetition delays for backend in μs. First entry is lower end of the range, second entry is higher end of the range. Optional, but will be specified when `dynamic_reprate_enabled=True`. + > + > * default\_rep\_delay (float): Value of `rep_delay` if not specified by user and `dynamic_reprate_enabled=True`. + > + > * n\_uchannels: Number of u-channels. + > + > * u\_channel\_lo: U-channel relationship on device los. + > + > * meas\_levels: Supported measurement levels. + > + > * qubit\_lo\_range: Qubit lo ranges for each qubit with form (min, max) in GHz. + > + > * meas\_lo\_range: Measurement lo ranges for each qubit with form (min, max) in GHz. + > + > * dt: Qubit drive channel timestep in nanoseconds. + > + > * dtm: Measurement drive channel timestep in nanoseconds. + > + > * rep\_times: Supported repetition times (program execution time) for backend in μs. + > + > * meas\_kernels: Supported measurement kernels. + > + > * discriminators: Supported discriminators. + > + > * hamiltonian: An optional dictionary with fields characterizing the system hamiltonian. + > + > * channel\_bandwidth (list): Bandwidth of all channels (qubit, measurement, and U) + > + > * acquisition\_latency (list): Array of dimension n\_qubits x n\_registers. Latency (in units of dt) to write a measurement result from qubit n into register slot m. + > + > * conditional\_latency (list): Array of dimension n\_channels \[d->u->m] x n\_registers. Latency (in units of dt) to do a conditional operation on channel n from register slot m + > + > * meas\_map (list): Grouping of measurement which are multiplexed + > + > * max\_circuits (int): The maximum number of experiments per job + > + > * sample\_name (str): Sample name for the backend + > + > * n\_registers (int): Number of register slots available for feedback (if conditional is True) + > + > * register\_map (list): An array of dimension n\_qubits X n\_registers that specifies whether a qubit can store a measurement in a certain register slot. + > + > * configurable (bool): True if the backend is configurable, if the backend is a simulator + > + > * credits\_required (bool): True if backend requires credits to run a job. + > + > * online\_date (datetime): The date that the device went online + > + > * display\_name (str): Alternate name field for the backend + > + > * description (str): A description for the backend + > + > * tags (list): A list of string tags to describe the backend + > + > * version: version of `Backend` class (Ex: 1, 2) + > + > * channels: An optional dictionary containing information of each channel – their purpose, type, and qubits operated on. + > + > * parametric\_pulses (list): A list of pulse shapes which are supported on the backend. For example: `['gaussian', 'constant']` + > + > * processor\_type (dict): Processor type for this backend. A dictionary of the form `{"family": , "revision": , segment: }` such as `{"family": "Canary", "revision": "1.0", segment: "A"}`. + > + > > * family: Processor family of this backend. + > > * revision: Revision version of this processor. + > > * segment: Segment this processor belongs to within a larger chip. + + IBMBackend constructor. + + **Parameters** + + * **configuration** (`Union`\[`QasmBackendConfiguration`, `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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` object for the backend. + + **Return type** + + `Target` + + **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`) – 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). + + **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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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`, `str`, `List`\[`Union`\[`QuantumCircuit`, `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`]) – 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 programs in seconds. Only supported on certain backends (if `backend.configuration().dynamic_reprate_enabled=True`). If supported, `rep_delay` must be from the range supplied by the backend (`backend.configuration().rep_delay_range`). Default is given by `backend.configuration().default_rep_delay`. 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` object for the backend. :rtype: `Target` :returns: Target with properties found on datetime + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.QiskitRuntimeService.mdx new file mode 100644 index 00000000000..298751c04e9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -0,0 +1,423 @@ +--- +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’]]) – Channel type. `ibm_cloud` or `ibm_quantum`. + * **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`]) – Error mitigation strategy. + + **Returns** + + An instance of QiskitRuntimeService. + + **Raises** + + **IBMInputValueError** – If an input is invalid. + + ## Attributes + + ### channel + + + Return the channel type used. + + **Return type** + + `str` + + **Returns** + + The channel type used. + + + ### global\_service + + + + ### version + + + + ## Methods + + ### active\_account + + + Return the IBM Quantum account currently in use for the session. + + **Return type** + + `Optional`\[`Dict`\[`str`, `str`]] + + **Returns** + + A dictionary with information about the account currently in the session. + + + ### backend + + + Return a single backend matching the specified filtering. + + **Parameters** + + * **name** (`Optional`\[`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. + + **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`\[\[`List`\[[`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 ) + ``` + + * **\*\*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. + + + ### 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’]]) – 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` + + + ### get\_backend + + + Return a single backend matching the specified filtering. + + **Parameters** + + * **name** (*str*) – name of the backend. + * **\*\*kwargs** – dict used for filtering. + + **Returns** + + a backend matching the filtering. + + **Return type** + + Backend + + **Raises** + + **QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria. + + + ### 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`\[\[`List`\[[`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. + + + ### run + + + Execute the runtime program. + + **Parameters** + + * **program\_id** (`str`) – Program ID. + + * **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program. + + * **options** (`Union`\[[`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.runtime_options.RuntimeOptions"), `Dict`, `None`]) – Runtime options that control the execution environment. See [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") for all available options. + + * **callback** (`Optional`\[`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. + + * **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results. If more than one decoder is specified, the first is used for interim results and the second final results. If not specified, a program-specific decoder or the default `ResultDecoder` is used. + + * **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session. + + * **start\_session** (`Optional`\[`bool`]) – Set to True to explicitly start a runtime session. Defaults to False. + + **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** + + A `RuntimeJob` instance representing the execution. + + **Raises** + + * **IBMInputValueError** – If input is invalid. + * **RuntimeProgramNotFound** – If the program cannot be found. + * **IBMRuntimeError** – An error occurred running the program. + + + ### 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’]]) – 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`]) – Error mitigation strategy. + * **set\_as\_default** (`Optional`\[`bool`]) – If `True`, the account is saved in filename, as the default account. + + **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’]]) – 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. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeDecoder.mdx new file mode 100644 index 00000000000..3f578131f2b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/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.22/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeEncoder.mdx new file mode 100644 index 00000000000..24eeb268911 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/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.22/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJob.mdx new file mode 100644 index 00000000000..5e1e3c44c5c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJob.mdx @@ -0,0 +1,518 @@ +--- +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 program execution. + + A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. + + If the program 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` 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 program has any interim results, you can use the `callback` parameter of the [`run()`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.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`) – 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. + * **params** (`Optional`\[`Dict`]) – Job parameters. + * **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 + + ### 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. + + + ### program\_id + + + Program ID. + + **Return type** + + `str` + + **Returns** + + ID of the program 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`] + + + ### 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 + + + 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. + + **Return type** + + `Dict`\[`str`, `Any`] + + **Returns** + + Job metrics, which includes timestamp information. + + **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` + + **Returns** + + Status of this job. + + + ### stream\_results + + + 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. + + + ### wait\_for\_final\_state + + + Use the websocket server to wait for the final the state of a job. + + The server will remain open if the job is still running and the connection will be terminated once the job completes. Then update and return the status of the job. + + **Parameters** + + **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + + **Raises** + + **RuntimeJobTimeoutError** – If the job does not complete within given timeout. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJobV2.mdx new file mode 100644 index 00000000000..ca6248335fe --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -0,0 +1,434 @@ +--- +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`) – 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. + * **params** (`Optional`\[`Dict`]) – Job parameters. + * **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 + + ### 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. + + + ### program\_id + + + Program ID. + + **Return type** + + `str` + + **Returns** + + ID of the program 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`] + + + ### 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 + + + 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. + + **Return type** + + `Dict`\[`str`, `Any`] + + **Returns** + + Job metrics, which includes timestamp information. + + **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 + + + 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. + + + ### wait\_for\_final\_state + + + Use the websocket server to wait for the final the state of a job. + + The server will remain open if the job is still running and the connection will be terminated once the job completes. Then update and return the status of the job. + + **Parameters** + + **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + + **Raises** + + **RuntimeJobTimeoutError** – If the job does not complete within given timeout. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeOptions.mdx new file mode 100644 index 00000000000..ae55fac4974 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -0,0 +1,86 @@ +--- +title: RuntimeOptions +description: API reference for qiskit_ibm_runtime.RuntimeOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.RuntimeOptions +--- + +# RuntimeOptions + + + Class for representing generic runtime execution options. + + RuntimeOptions constructor. + + **Parameters** + + * **backend** (*Optional\[str | Backend]*) – target backend to run on. This is required for `ibm_quantum` channel. + * **image** (*Optional\[str]*) – the runtime image used to execute the program, specified in the form of `image_name:tag`. Not all accounts are authorized to select a different image. + * **log\_level** (*Optional\[str]*) – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. The default level is `WARNING`. + * **instance** (*Optional\[str]*) – The hub/group/project to use, in that format. This is only supported for `ibm_quantum` channel. If `None`, a hub/group/project that provides access to the target backend is randomly selected. + * **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. + * **max\_execution\_time** (*Optional\[int]*) – Maximum execution time in seconds, which is based on system execution time (not 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. + * **session\_time** (*Optional\[int]*) – Length of session in seconds. + + ## Attributes + + ### backend + + + + ### image + + + + ### instance + + + + ### job\_tags + + + + ### log\_level + + + + ### max\_execution\_time + + + + ### session\_time + + + + ## Methods + + ### get\_backend\_name + + + Get backend name. + + **Return type** + + `str` + + + ### validate + + + Validate options. + + **Parameters** + + **channel** (`str`) – channel type. + + **Raises** + + **IBMInputValueError** – If one or more option is invalid. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Sampler.mdx new file mode 100644 index 00000000000..59ff022b26a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/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 [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.sampler.SamplerV1") + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV1.mdx new file mode 100644 index 00000000000..7740dc8f30d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV1.mdx @@ -0,0 +1,126 @@ +--- +title: SamplerV1 +description: API reference for qiskit_ibm_runtime.SamplerV1 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.SamplerV1 +--- + +# SamplerV1 + + + Class for interacting with Qiskit Runtime Sampler primitive service. + + Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. + + The [`run()`](#qiskit_ibm_runtime.SamplerV1.run "qiskit_ibm_runtime.SamplerV1.run") method can be used to submit circuits and parameters to the Sampler primitive. + + You are encouraged to use [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") to open a session, during which you can invoke one or more primitives. Jobs submitted within a session are prioritized by the scheduler. + + Example: + + ```python + from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister + from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler + + service = QiskitRuntimeService(channel="ibm_cloud") + + # 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) + + with Session(service, backend="ibmq_qasm_simulator") as session: + sampler = Sampler(session=session) + + job = sampler.run(qc, shots=1024) + print(f"Job ID: {job.job_id()}") + print(f"Job result: {job.result()}") + + # You can run more jobs inside the session + ``` + + Initializes the Sampler primitive. + + **Parameters** + + * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + + * **session** (`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")]) – + + Session in which to call the primitive. + + If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected. + + * **options** (`Union`\[`Dict`, [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.options.Options"), `None`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + + ## Attributes + + ### options + + + Return options values for the sampler. :rtype: `Options` :returns: options + + + ### session + + + Return session used by this primitive. + + **Return type** + + `Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + + **Returns** + + Session used by this primitive, or `None` if session is not used. + + + ### version + + + + ## Methods + + ### run + + + Submit a request to the sampler primitive. + + **Parameters** + + * **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – A (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. + * **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. + * **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). + + **Return type** + + [RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") + + **Returns** + + Submitted job. The result of the job is an instance of `qiskit.primitives.SamplerResult`. + + **Raises** + + **ValueError** – Invalid arguments are given. + + + ### set\_options + + + Set options values for the sampler. + + **Parameters** + + **\*\*fields** – The fields to update the options + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV2.mdx new file mode 100644 index 00000000000..3a289b34587 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.SamplerV2.mdx @@ -0,0 +1,93 @@ +--- +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** + + * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + + * **session** (`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")]) – + + Session in which to call the primitive. + + If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected. + + * **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 + + ### options + + + Return options + + **Return type** + + `TypeVar`(`OptionsT`, bound= `BaseOptions`) + + + ### session + + + Return session used by this primitive. + + **Return type** + + `Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + + **Returns** + + Session used by this primitive, or `None` if session is not used. + + + ### 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.22/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Session.mdx new file mode 100644 index 00000000000..a9a102a2dfe --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.Session.mdx @@ -0,0 +1,194 @@ +--- +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")]) – 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`, `BackendV2`, `None`]) – Optional instance of `Backend` class or string name of backend. If not specified, a backend will be selected automatically (IBM Cloud channel only). + * **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](/run/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. + + **Returns** + + 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. + + **Return type** + + A dictionary with the sessions details, including + + + ### 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** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – instance of the `QiskitRuntimeService` class. + * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. + + **Return type** + + [`Session`](#qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session") + + **Returns** + + A new Session with the given `session_id` + + + ### run + + + Run a program in the session. + + **Parameters** + + * **program\_id** (`str`) – Program ID. + * **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program. + * **options** (`Optional`\[`Dict`]) – Runtime options that control the execution environment. See [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") for all available options. + * **callback** (`Optional`\[`Callable`]) – Callback function to be invoked for any interim results and final result. + + **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** + + Submitted job. + + + ### status + + + Return current session status. + + **Returns** + + 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. + + **Return type** + + The current status of the session, including + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx new file mode 100644 index 00000000000..04678931d40 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx new file mode 100644 index 00000000000..00ac40bda99 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -0,0 +1,151 @@ +--- +title: FakeAlmaden +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlmaden +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden +--- + +# FakeAlmaden + + + A fake Almaden backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeAlmaden.run "qiskit_ibm_runtime.fake_provider.FakeAlmaden.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx new file mode 100644 index 00000000000..c43feb1b2bd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -0,0 +1,359 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx new file mode 100644 index 00000000000..bb4ab17e49b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -0,0 +1,159 @@ +--- +title: FakeArmonk +description: API reference for qiskit_ibm_runtime.fake_provider.FakeArmonk +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk +--- + +# FakeArmonk + + + A fake 1 qubit backend. + + ```python + 0 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeArmonk.run "qiskit_ibm_runtime.fake_provider.FakeArmonk.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx new file mode 100644 index 00000000000..dbbe1d9d124 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -0,0 +1,353 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx new file mode 100644 index 00000000000..b5638abee18 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -0,0 +1,155 @@ +--- +title: FakeAthens +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAthens +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens +--- + +# FakeAthens + + + A fake 5 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeAthens.run "qiskit_ibm_runtime.fake_provider.FakeAthens.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx new file mode 100644 index 00000000000..f02a0938782 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx new file mode 100644 index 00000000000..63b09349b16 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx new file mode 100644 index 00000000000..25e83401f8f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -0,0 +1,155 @@ +--- +title: FakeBelem +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBelem +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem +--- + +# FakeBelem + + + A fake 5 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeBelem.run "qiskit_ibm_runtime.fake_provider.FakeBelem.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx new file mode 100644 index 00000000000..2d75b03bb69 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx new file mode 100644 index 00000000000..c10455cb307 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -0,0 +1,165 @@ +--- +title: FakeBoeblingen +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBoeblingen +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen +--- + +# FakeBoeblingen + + + A fake Boeblingen backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeBoeblingen.run "qiskit_ibm_runtime.fake_provider.FakeBoeblingen.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx new file mode 100644 index 00000000000..7dbbc0d41a2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -0,0 +1,359 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx new file mode 100644 index 00000000000..d65d0011087 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -0,0 +1,155 @@ +--- +title: FakeBogota +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBogota +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota +--- + +# FakeBogota + + + A fake 5 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeBogota.run "qiskit_ibm_runtime.fake_provider.FakeBogota.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx new file mode 100644 index 00000000000..e6a2b0e5fc3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx new file mode 100644 index 00000000000..877a268df3d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx new file mode 100644 index 00000000000..57db5dd62a7 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -0,0 +1,155 @@ +--- +title: FakeBrooklyn +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrooklyn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn +--- + +# FakeBrooklyn + + + A fake Brooklyn backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeBrooklyn.run "qiskit_ibm_runtime.fake_provider.FakeBrooklyn.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx new file mode 100644 index 00000000000..da84dc0a151 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx new file mode 100644 index 00000000000..fa2ddf87796 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -0,0 +1,147 @@ +--- +title: FakeBurlington +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBurlington +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington +--- + +# FakeBurlington + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeBurlington.run "qiskit_ibm_runtime.fake_provider.FakeBurlington.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx new file mode 100644 index 00000000000..c914042ac9c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -0,0 +1,355 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx new file mode 100644 index 00000000000..3abad7c3ef9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -0,0 +1,155 @@ +--- +title: FakeCairo +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCairo +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo +--- + +# FakeCairo + + + A fake 27 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeCairo.run "qiskit_ibm_runtime.fake_provider.FakeCairo.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx new file mode 100644 index 00000000000..738d3deaeda --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx new file mode 100644 index 00000000000..9c75a1b2f44 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -0,0 +1,153 @@ +--- +title: FakeCambridge +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCambridge +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge +--- + +# FakeCambridge + + + 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 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeCambridge.run "qiskit_ibm_runtime.fake_provider.FakeCambridge.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx new file mode 100644 index 00000000000..522be2e7014 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -0,0 +1,361 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx new file mode 100644 index 00000000000..40fc7e3ada9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -0,0 +1,155 @@ +--- +title: FakeCasablanca +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCasablanca +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca +--- + +# FakeCasablanca + + + A fake 7 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeCasablanca.run "qiskit_ibm_runtime.fake_provider.FakeCasablanca.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx new file mode 100644 index 00000000000..d8fe16b5e5c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx new file mode 100644 index 00000000000..6148fde566b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx new file mode 100644 index 00000000000..ec4a7324ad5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -0,0 +1,149 @@ +--- +title: FakeEssex +description: API reference for qiskit_ibm_runtime.fake_provider.FakeEssex +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex +--- + +# FakeEssex + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 2 + ↕ + 3 + ↕ + 4 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeEssex.run "qiskit_ibm_runtime.fake_provider.FakeEssex.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx new file mode 100644 index 00000000000..7de3dac77b4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -0,0 +1,357 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx new file mode 100644 index 00000000000..9172157c241 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx new file mode 100644 index 00000000000..1662e5542b6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -0,0 +1,155 @@ +--- +title: FakeGuadalupe +description: API reference for qiskit_ibm_runtime.fake_provider.FakeGuadalupe +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe +--- + +# FakeGuadalupe + + + A fake 16 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeGuadalupe.run "qiskit_ibm_runtime.fake_provider.FakeGuadalupe.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx new file mode 100644 index 00000000000..d6254c911cc --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx new file mode 100644 index 00000000000..4b1e5ac7ba5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -0,0 +1,155 @@ +--- +title: FakeHanoi +description: API reference for qiskit_ibm_runtime.fake_provider.FakeHanoi +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi +--- + +# FakeHanoi + + + A fake 27 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeHanoi.run "qiskit_ibm_runtime.fake_provider.FakeHanoi.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx new file mode 100644 index 00000000000..af470a249fc --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx new file mode 100644 index 00000000000..9588446be7f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -0,0 +1,155 @@ +--- +title: FakeJakarta +description: API reference for qiskit_ibm_runtime.fake_provider.FakeJakarta +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta +--- + +# FakeJakarta + + + A fake 7 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeJakarta.run "qiskit_ibm_runtime.fake_provider.FakeJakarta.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx new file mode 100644 index 00000000000..3ff7c0fa027 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx new file mode 100644 index 00000000000..973c07f22d9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -0,0 +1,151 @@ +--- +title: FakeJohannesburg +description: API reference for qiskit_ibm_runtime.fake_provider.FakeJohannesburg +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg +--- + +# FakeJohannesburg + + + A fake Johannesburg backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeJohannesburg.run "qiskit_ibm_runtime.fake_provider.FakeJohannesburg.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx new file mode 100644 index 00000000000..c79a0c24feb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -0,0 +1,359 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx new file mode 100644 index 00000000000..09eec9ff6ca --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx new file mode 100644 index 00000000000..482cdc4da8d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -0,0 +1,155 @@ +--- +title: FakeKolkata +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKolkata +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata +--- + +# FakeKolkata + + + A fake 27 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeKolkata.run "qiskit_ibm_runtime.fake_provider.FakeKolkata.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx new file mode 100644 index 00000000000..8393b0453ae --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx new file mode 100644 index 00000000000..f3ddc3cbae2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx new file mode 100644 index 00000000000..8897fec3932 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx new file mode 100644 index 00000000000..e079ed37495 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -0,0 +1,155 @@ +--- +title: FakeLagos +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLagos +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos +--- + +# FakeLagos + + + A fake 7 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeLagos.run "qiskit_ibm_runtime.fake_provider.FakeLagos.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx new file mode 100644 index 00000000000..17ebe637b23 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLima.mdx new file mode 100644 index 00000000000..988d352b407 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -0,0 +1,155 @@ +--- +title: FakeLima +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLima +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima +--- + +# FakeLima + + + A fake 5 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeLima.run "qiskit_ibm_runtime.fake_provider.FakeLima.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx new file mode 100644 index 00000000000..af4ae889db8 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx new file mode 100644 index 00000000000..5716674afe4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -0,0 +1,149 @@ +--- +title: FakeLondon +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLondon +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon +--- + +# FakeLondon + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 2 + ↕ + 3 + ↕ + 4 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeLondon.run "qiskit_ibm_runtime.fake_provider.FakeLondon.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx new file mode 100644 index 00000000000..4537cfdd44e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -0,0 +1,357 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx new file mode 100644 index 00000000000..d3887c03cae --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -0,0 +1,155 @@ +--- +title: FakeManhattan +description: API reference for qiskit_ibm_runtime.fake_provider.FakeManhattan +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan +--- + +# FakeManhattan + + + A fake Manhattan backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeManhattan.run "qiskit_ibm_runtime.fake_provider.FakeManhattan.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx new file mode 100644 index 00000000000..7c768ce26a9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManila.mdx new file mode 100644 index 00000000000..a73f13f77fd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -0,0 +1,155 @@ +--- +title: FakeManila +description: API reference for qiskit_ibm_runtime.fake_provider.FakeManila +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila +--- + +# FakeManila + + + A fake 5 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeManila.run "qiskit_ibm_runtime.fake_provider.FakeManila.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx new file mode 100644 index 00000000000..02b1bdb0990 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx new file mode 100644 index 00000000000..9e58711da0b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -0,0 +1,124 @@ +--- +title: FakeMelbourne +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMelbourne +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne +--- + +# FakeMelbourne + + + A fake 14 qubit backend. + + ```python + 0 ← 1 → 2 → 3 ← 4 ← 5 → 6 + ↑ ↑ ↑ ↓ ↓ ↓ + 13 → 12 ← 11 → 10 ← 9 → 8 ← 7 + ``` + + ## Attributes + + ### 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.FakeMelbourne.run "qiskit_ibm_runtime.fake_provider.FakeMelbourne.run") method. + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx new file mode 100644 index 00000000000..7fb37632e11 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx new file mode 100644 index 00000000000..0d0ff6332c9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -0,0 +1,155 @@ +--- +title: FakeMontreal +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMontreal +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal +--- + +# FakeMontreal + + + A fake 27 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeMontreal.run "qiskit_ibm_runtime.fake_provider.FakeMontreal.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx new file mode 100644 index 00000000000..6483fadcf47 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx new file mode 100644 index 00000000000..b13ee4138c5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -0,0 +1,155 @@ +--- +title: FakeMumbai +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMumbai +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai +--- + +# FakeMumbai + + + A fake 27 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeMumbai.run "qiskit_ibm_runtime.fake_provider.FakeMumbai.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx new file mode 100644 index 00000000000..d4b5a37e960 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx new file mode 100644 index 00000000000..7e2072553dd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -0,0 +1,155 @@ +--- +title: FakeNairobi +description: API reference for qiskit_ibm_runtime.fake_provider.FakeNairobi +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi +--- + +# FakeNairobi + + + A fake 7 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeNairobi.run "qiskit_ibm_runtime.fake_provider.FakeNairobi.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx new file mode 100644 index 00000000000..aa2abb9d562 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx new file mode 100644 index 00000000000..c27f84438f3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx new file mode 100644 index 00000000000..7dfb5a4830b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx new file mode 100644 index 00000000000..5fc251a4b48 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -0,0 +1,147 @@ +--- +title: FakeOurense +description: API reference for qiskit_ibm_runtime.fake_provider.FakeOurense +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense +--- + +# FakeOurense + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeOurense.run "qiskit_ibm_runtime.fake_provider.FakeOurense.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx new file mode 100644 index 00000000000..730ac47b239 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -0,0 +1,355 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParis.mdx new file mode 100644 index 00000000000..7448658b2d3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -0,0 +1,167 @@ +--- +title: FakeParis +description: API reference for qiskit_ibm_runtime.fake_provider.FakeParis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis +--- + +# FakeParis + + + 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 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeParis.run "qiskit_ibm_runtime.fake_provider.FakeParis.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx new file mode 100644 index 00000000000..92e92c2edd0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -0,0 +1,361 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx new file mode 100644 index 00000000000..52edb4f5ece --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePerth.mdx new file mode 100644 index 00000000000..e557eeb02b4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx new file mode 100644 index 00000000000..1fdb3e890a3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -0,0 +1,128 @@ +--- +title: FakePoughkeepsie +description: API reference for qiskit_ibm_runtime.fake_provider.FakePoughkeepsie +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie +--- + +# FakePoughkeepsie + + + A fake Poughkeepsie backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + ## Attributes + + ### 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.FakePoughkeepsie.run "qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.run") method. + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx new file mode 100644 index 00000000000..c8bc1be1195 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePrague.mdx new file mode 100644 index 00000000000..3d11314bdfb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx new file mode 100644 index 00000000000..fdc62c98ff3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -0,0 +1,68 @@ +--- +title: FakeProvider +description: API reference for qiskit_ibm_runtime.fake_provider.FakeProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider +--- + +# FakeProvider + + + Fake provider containing fake V1 backends. + + Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). + + ## Attributes + + ### version + + + + ## Methods + + ### backends + + + Return a list of backends matching the specified filtering. + + **Parameters** + + * **name** (*str*) – name of the backend. + * **\*\*kwargs** – dict used for filtering. + + **Returns** + + **a list of Backends that match the filtering** + + criteria. + + **Return type** + + list\[Backend] + + + ### get\_backend + + + Return a single backend matching the specified filtering. + + **Parameters** + + * **name** (*str*) – name of the backend. + * **\*\*kwargs** – dict used for filtering. + + **Returns** + + a backend matching the filtering. + + **Return type** + + Backend + + **Raises** + + **QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx new file mode 100644 index 00000000000..a334d54bd3f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -0,0 +1,74 @@ +--- +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"). + + ## Attributes + + ### version + + + + ## Methods + + ### backend + + + Filter backends in provider by name. + + + ### backends + + + Return a list of backends matching the specified filtering. + + **Parameters** + + * **name** (*str*) – name of the backend. + * **\*\*kwargs** – dict used for filtering. + + **Returns** + + **a list of Backends that match the filtering** + + criteria. + + **Return type** + + list\[Backend] + + + ### get\_backend + + + Return a single backend matching the specified filtering. + + **Parameters** + + * **name** (*str*) – name of the backend. + * **\*\*kwargs** – dict used for filtering. + + **Returns** + + a backend matching the filtering. + + **Return type** + + Backend + + **Raises** + + **QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx new file mode 100644 index 00000000000..22579b6cd28 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx new file mode 100644 index 00000000000..bcbfceda95a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -0,0 +1,155 @@ +--- +title: FakeQuito +description: API reference for qiskit_ibm_runtime.fake_provider.FakeQuito +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito +--- + +# FakeQuito + + + A fake 5 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeQuito.run "qiskit_ibm_runtime.fake_provider.FakeQuito.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx new file mode 100644 index 00000000000..992a23ef4c8 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx new file mode 100644 index 00000000000..cbec9ee89ca --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -0,0 +1,141 @@ +--- +title: FakeRochester +description: API reference for qiskit_ibm_runtime.fake_provider.FakeRochester +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester +--- + +# FakeRochester + + + A fake Rochester backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeRochester.run "qiskit_ibm_runtime.fake_provider.FakeRochester.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx new file mode 100644 index 00000000000..46650e32a27 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRome.mdx new file mode 100644 index 00000000000..dcfeeb17e18 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -0,0 +1,155 @@ +--- +title: FakeRome +description: API reference for qiskit_ibm_runtime.fake_provider.FakeRome +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome +--- + +# FakeRome + + + A fake 5 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeRome.run "qiskit_ibm_runtime.fake_provider.FakeRome.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx new file mode 100644 index 00000000000..8cee17f8839 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx new file mode 100644 index 00000000000..0d9940f290c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -0,0 +1,120 @@ +--- +title: FakeRueschlikon +description: API reference for qiskit_ibm_runtime.fake_provider.FakeRueschlikon +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon +--- + +# FakeRueschlikon + + + A fake 16 qubit backend. + + ```python + 1 → 2 → 3 → 4 ← 5 ← 6 → 7 ← 8 + ↓ ↑ ↓ ↓ ↑ ↓ ↓ ↑ + 0 ← 15 → 14 ← 13 ← 12 → 11 → 10 ← 9 + ``` + + ## Attributes + + ### 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.FakeRueschlikon.run "qiskit_ibm_runtime.fake_provider.FakeRueschlikon.run") method. + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Return backend properties + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx new file mode 100644 index 00000000000..5599ae46eaf --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -0,0 +1,155 @@ +--- +title: FakeSantiago +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSantiago +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago +--- + +# FakeSantiago + + + A fake Santiago backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeSantiago.run "qiskit_ibm_runtime.fake_provider.FakeSantiago.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx new file mode 100644 index 00000000000..546dcd5e4b7 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx new file mode 100644 index 00000000000..3aee457dc03 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx new file mode 100644 index 00000000000..627e16561d9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -0,0 +1,151 @@ +--- +title: FakeSingapore +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSingapore +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore +--- + +# FakeSingapore + + + 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 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeSingapore.run "qiskit_ibm_runtime.fake_provider.FakeSingapore.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx new file mode 100644 index 00000000000..3d03539a22e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -0,0 +1,359 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx new file mode 100644 index 00000000000..f09b9ff48a8 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -0,0 +1,155 @@ +--- +title: FakeSydney +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSydney +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney +--- + +# FakeSydney + + + A fake 27 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeSydney.run "qiskit_ibm_runtime.fake_provider.FakeSydney.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx new file mode 100644 index 00000000000..dff33e6c5b1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx new file mode 100644 index 00000000000..005b81cb2ab --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -0,0 +1,126 @@ +--- +title: FakeTenerife +description: API reference for qiskit_ibm_runtime.fake_provider.FakeTenerife +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife +--- + +# FakeTenerife + + + A fake 5 qubit backend. + + ```python + 1 + ↙ ↑ + 0 ← 2 ← 3 + ↑ ↙ + 4 + ``` + + ## Attributes + + ### 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.FakeTenerife.run "qiskit_ibm_runtime.fake_provider.FakeTenerife.run") method. + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties as recorded on 8/30/19. + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx new file mode 100644 index 00000000000..3a0a382e3d0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -0,0 +1,128 @@ +--- +title: FakeTokyo +description: API reference for qiskit_ibm_runtime.fake_provider.FakeTokyo +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo +--- + +# FakeTokyo + + + A fake 20 qubit backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ ↕ ↕ ⤫ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ⤫ ↕ ↕ ⤫ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ ⤫ ↕ ⤫ ↕ + 15 ↔ 16 ↔ 17 18 19 + ``` + + ## Attributes + + ### 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.FakeTokyo.run "qiskit_ibm_runtime.fake_provider.FakeTokyo.run") method. + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties as recorded on 8/30/19. + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx new file mode 100644 index 00000000000..85ddf469335 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx new file mode 100644 index 00000000000..324c24e044f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -0,0 +1,155 @@ +--- +title: FakeToronto +description: API reference for qiskit_ibm_runtime.fake_provider.FakeToronto +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto +--- + +# FakeToronto + + + A fake 27 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeToronto.run "qiskit_ibm_runtime.fake_provider.FakeToronto.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx new file mode 100644 index 00000000000..13f3a746b0e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx new file mode 100644 index 00000000000..67d1b522429 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -0,0 +1,155 @@ +--- +title: FakeValencia +description: API reference for qiskit_ibm_runtime.fake_provider.FakeValencia +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia +--- + +# FakeValencia + + + A fake 5 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeValencia.run "qiskit_ibm_runtime.fake_provider.FakeValencia.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx new file mode 100644 index 00000000000..7880b846421 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx new file mode 100644 index 00000000000..e5b8b83a29d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -0,0 +1,147 @@ +--- +title: FakeVigo +description: API reference for qiskit_ibm_runtime.fake_provider.FakeVigo +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo +--- + +# FakeVigo + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeVigo.run "qiskit_ibm_runtime.fake_provider.FakeVigo.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx new file mode 100644 index 00000000000..7d92612d640 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -0,0 +1,355 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx new file mode 100644 index 00000000000..3c0da1d48ea --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -0,0 +1,155 @@ +--- +title: FakeWashington +description: API reference for qiskit_ibm_runtime.fake_provider.FakeWashington +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington +--- + +# FakeWashington + + + A fake 127 qubit backend. + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### defs\_filename + + + + ### dirname + + + + ### 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.FakeWashington.run "qiskit_ibm_runtime.fake_provider.FakeWashington.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### defaults + + + Returns a snapshot of device defaults + + **Return type** + + `PulseDefaults` + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx new file mode 100644 index 00000000000..ad8459fe67f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -0,0 +1,349 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx new file mode 100644 index 00000000000..f12e71a9603 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -0,0 +1,149 @@ +--- +title: FakeYorktown +description: API reference for qiskit_ibm_runtime.fake_provider.FakeYorktown +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown +--- + +# FakeYorktown + + + A fake 5 qubit backend. + + ```python + 1 + / | + 0 - 2 - 3 + | / + 4 + ``` + + FakeBackend initializer. + + **Parameters** + + * **configuration** (*BackendConfiguration*) – backend configuration + * **time\_alive** (*int*) – time to wait before returning result + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### dirname + + + + ### 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.FakeYorktown.run "qiskit_ibm_runtime.fake_provider.FakeYorktown.run") method. + + + ### props\_filename + + + + ### version + + + + ## Methods + + ### configuration + + + Return the backend configuration. + + **Returns** + + the configuration for the backend. + + **Return type** + + BackendConfiguration + + + ### name + + + Return the backend name. + + **Returns** + + the name of the backend. + + **Return type** + + str + + + ### properties + + + Returns a snapshot of device properties + + **Return type** + + `BackendProperties` + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### run + + + Main job in simulator + + + ### 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. + + **Returns** + + the status of the backend. + + **Return type** + + BackendStatus + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx new file mode 100644 index 00000000000..d4af88a029c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -0,0 +1,357 @@ +--- +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` 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` object. + + + ### instruction\_schedule\_map + + + Return the `InstructionScheduleMap` 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`, `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` instances that the backend supports. + + **Return type** + + `List`\[`Instruction`] + + + ### 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` 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 + + + ### 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] + + + ### 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 + + + ### 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`, `List`\[`QubitProperties`]] + + **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 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` 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 BasicAer simulator/ BasicSimulator simulator 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`, `ScheduleBlock`, or `Schedule` 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 + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx new file mode 100644 index 00000000000..0245fdf5e74 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -0,0 +1,55 @@ +--- +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). + + **Parameters** + + * **enable** – Whether to enable DD as specified by the other options in this class. Default: False. + + * **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` + + * **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”. + + ## Attributes + + ### enable + + + + ### extra\_slack\_distribution + + + + ### scheduling\_method + + + + ### sequence\_type + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EnvironmentOptions.mdx new file mode 100644 index 00000000000..039c8141252 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -0,0 +1,43 @@ +--- +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. + + **Parameters** + + * **log\_level** – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. Default: `WARNING`. + + * **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. + + * **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. + + ## Attributes + + ### callback + + + + ### job\_tags + + + + ### log\_level + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EstimatorOptions.mdx new file mode 100644 index 00000000000..bdd0d7805eb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -0,0 +1,133 @@ +--- +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. + + **Parameters** + + * **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`. + + * **optimization\_level** – + + 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 + + Refer to the [Configure runtime compilation for Qiskit Runtime](/run/configure-runtime-compilation). for more information about the optimization levels. + + Default: 1. + + * **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](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + + Default: 1. + + * **seed\_estimator** – Seed used to control sampling. + + * **dynamical\_decoupling** – Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. + + * **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. + + * **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + + * **twirling** – Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. + + * **experimental** – Experimental options. + + ## Attributes + + ### default\_precision + + + + ### default\_shots + + + + ### dynamical\_decoupling + + + + ### environment + + + + ### execution + + + + ### experimental + + + + ### max\_execution\_time + + + + ### optimization\_level + + + + ### resilience + + + + ### resilience\_level + + + + ### seed\_estimator + + + + ### simulator + + + + ### twirling + + + + ## Methods + + ### update + + + Update the options. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptions.mdx new file mode 100644 index 00000000000..6ae2bc9c2a2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -0,0 +1,31 @@ +--- +title: ExecutionOptions +description: API reference for qiskit_ibm_runtime.options.ExecutionOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.ExecutionOptions +--- + +# ExecutionOptions + + + Execution options for V1 primitives. + + **Parameters** + + * **shots** – Number of repetitions of each circuit, for sampling. Default: 4000. + * **init\_qubits** – Whether to reset the qubits to the ground state for each shot. Default: `True`. + + ## Attributes + + ### init\_qubits + + + + ### shots + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx new file mode 100644 index 00000000000..d0b591d6e6a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -0,0 +1,31 @@ +--- +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. + + **Parameters** + + * **init\_qubits** – Whether to reset the qubits to the ground state for each shot. Default: `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`. + + ## Attributes + + ### init\_qubits + + + + ### rep\_delay + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx new file mode 100644 index 00000000000..1ea4e29ec99 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx @@ -0,0 +1,45 @@ +--- +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. + + + These options are only used when the resilience level or options specify a technique that requires layer noise learning. + + + **Parameters** + + * **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. + * **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. + * **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. + * **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). + + ## Attributes + + ### layer\_pair\_depths + + + + ### max\_layers\_to\_learn + + + + ### num\_randomizations + + + + ### shots\_per\_randomization + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx new file mode 100644 index 00000000000..26201d8cc59 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -0,0 +1,35 @@ +--- +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. + + + These options are only used when the resilience level or options specify a technique that requires measurement noise learning. + + + **Parameters** + + * **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”. + + ## Attributes + + ### num\_randomizations + + + + ### shots\_per\_randomization + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.Options.mdx new file mode 100644 index 00000000000..86aedb3c5dd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.Options.mdx @@ -0,0 +1,98 @@ +--- +title: Options +description: API reference for qiskit_ibm_runtime.options.Options +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.Options +--- + +# Options + + + Options for the primitives, used by V1 primitives. + + **Parameters** + + * **optimization\_level** (`Optional`\[`int`]) – + + How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer transpilation times. This is based on the `optimization_level` parameter in qiskit-terra but may include backend-specific optimization. Default: 3. + + * 0: no optimization + * 1: light optimization + * 2: heavy optimization + * 3: even heavier optimization + + * **resilience\_level** (`Optional`\[`int`]) – + + How much resilience to build against errors. Higher levels generate more accurate results, at the expense of longer processing times. Default: 1. + + * 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. Only applies to estimator. + * 3: Heavy mitigation with layer sampling. Theoretically expected to deliver zero bias estimators. Only applies to estimator. + + Refer to the [Qiskit Runtime documentation](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + + * **max\_execution\_time** (`Optional`\[`int`]) – + + Maximum execution time in seconds, which is based on system execution time (not 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. + + Refer to the [Max execution time documentation](/run/max-execution-time). for more information. + + * **transpilation** (`Union`\[[`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.transpilation_options.TranspilationOptions"), `Dict`]) – Transpilation options. See [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions") for all available options. + + * **resilience** (`Union`\[[`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.resilience_options.ResilienceOptions"), `Dict`]) – Advanced resilience options to fine tune the resilience strategy. See [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions") for all available options. + + * **execution** (`Union`\[[`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.execution_options.ExecutionOptions"), `Dict`]) – Execution time options. See [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions") for all available options. + + * **environment** (`Union`\[[`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions"), `Dict`]) – Options related to the execution environment. See [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions") for all available options. + + * **simulator** (`Union`\[[`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions"), `Dict`]) – Simulator options. See [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions") for all available options. + + ## Attributes + + ### max\_execution\_time + + + + ### optimization\_level + + + + ### resilience\_level + + + + ### transpilation + + + + ### resilience + + + + ### execution + + + + ### environment + + + + ### simulator + + + + ## Methods + + ### validate\_options + + + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.PecOptions.mdx new file mode 100644 index 00000000000..bac0d85fced --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.PecOptions.mdx @@ -0,0 +1,40 @@ +--- +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. + + **Parameters** + + * **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 one corresponds to attempting to remove all of the noise. + * A value greater than one corresponds to injecting noise. + * A value between 0 and 1 corresponds to partially removing the noise. + + If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + + ## Attributes + + ### max\_overhead + + + + ### noise\_gain + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptions.mdx new file mode 100644 index 00000000000..b24175e3bba --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -0,0 +1,37 @@ +--- +title: ResilienceOptions +description: API reference for qiskit_ibm_runtime.options.ResilienceOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.ResilienceOptions +--- + +# ResilienceOptions + + + Resilience options for V1 primitives. + + **Parameters** + + * **noise\_factors** – An list of real valued noise factors that determine by what amount the circuits’ noise is amplified. Only applicable for `resilience_level=2`. Default: `None`, and (1, 3, 5) if resilience level is 2. + * **noise\_amplifier** – A noise amplification strategy. Currently only + * **resilience\_level=2.** (*"LocalFoldingAmplifier" is supported Only applicable for*) – Default: “LocalFoldingAmplifier”. + * **extrapolator** – An extrapolation strategy. One of `"LinearExtrapolator"`, `"QuadraticExtrapolator"`, `"CubicExtrapolator"`, `"QuarticExtrapolator"`. Note that `"CubicExtrapolator"` and `"QuarticExtrapolator"` require more noise factors than the default. Only applicable for `resilience_level=2`. Default: `None`, and `LinearExtrapolator` if resilience level is 2. + + ## Attributes + + ### extrapolator + + + + ### noise\_amplifier + + + + ### noise\_factors + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx new file mode 100644 index 00000000000..84786a4212d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx @@ -0,0 +1,56 @@ +--- +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. + + **Parameters** + + * **measure\_mitigation** – Whether to enable measurement error mitigation method. Further suboptions are available in [`measure_noise_learning`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning "qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning"). 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. + * **zne\_mitigation** – Whether to turn on Zero Noise Extrapolation error mitigation method. Further suboptions are available in [`zne`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.zne "qiskit_ibm_runtime.options.ResilienceOptionsV2.zne"). Default: False. + * **zne** – Additional zero noise extrapolation mitigation options. See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for all options. + * **pec\_mitigation** – Whether to turn on Probabilistic Error Cancellation error mitigation method. Further suboptions are available in [`pec`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.pec "qiskit_ibm_runtime.options.ResilienceOptionsV2.pec"). Default: False. + * **pec** – Additional probabalistic error cancellation mitigation options. See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for all options. + * **layer\_noise\_learning** – Layer noise learning options. See [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for all options. + + ## Attributes + + ### layer\_noise\_learning + + + + ### measure\_mitigation + + + + ### measure\_noise\_learning + + + + ### pec + + + + ### pec\_mitigation + + + + ### zne + + + + ### zne\_mitigation + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SamplerOptions.mdx new file mode 100644 index 00000000000..d26ff34faa3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -0,0 +1,63 @@ +--- +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. + + **Parameters** + + * **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. + * **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + * **experimental** – Experimental options. + + ## Attributes + + ### default\_shots + + + + ### dynamical\_decoupling + + + + ### environment + + + + ### execution + + + + ### experimental + + + + ### max\_execution\_time + + + + ### simulator + + + + ## Methods + + ### update + + + Update the options. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SimulatorOptions.mdx new file mode 100644 index 00000000000..7488419c1e9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -0,0 +1,61 @@ +--- +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. + + **Parameters** + + * **noise\_model** – Noise model for the simulator. + * **seed\_simulator** – Random seed to control sampling. + * **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 interactions, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` + * **basis\_gates** – List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set. + + ## Attributes + + ### basis\_gates + + + + ### coupling\_map + + + + ### noise\_model + + + + ### seed\_simulator + + + + ## Methods + + ### set\_backend + + + Set backend for simulation. This method changes noise\_model, coupling\_map, basis\_gates according to given backend. + + **Parameters** + + **backend** (`Union`\[`BackendV1`, `BackendV2`]) – backend to be set. + + **Raises** + + **MissingOptionalLibraryError** – if qiskit-aer is not found. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TranspilationOptions.mdx new file mode 100644 index 00000000000..e23d311d1fb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -0,0 +1,46 @@ +--- +title: TranspilationOptions +description: API reference for qiskit_ibm_runtime.options.TranspilationOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.TranspilationOptions +--- + +# TranspilationOptions + + + Transpilation options. + + **Parameters** + + * **skip\_transpilation** – Whether to skip transpilation. Default is False. + * **initial\_layout** – Initial position of virtual qubits on physical qubits. See `qiskit.compiler.transpile` for more information. + * **layout\_method** – Name of layout selection pass. One of ‘trivial’, ‘dense’, ‘noise\_adaptive’, ‘sabre’. + * **routing\_method** – Name of routing pass. One of ‘basic’, ‘lookahead’, ‘stochastic’, ‘sabre’, ‘none’. + * **approximation\_degree** – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) + + ## Attributes + + ### approximation\_degree + + + + ### initial\_layout + + + + ### layout\_method + + + + ### routing\_method + + + + ### skip\_transpilation + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TwirlingOptions.mdx new file mode 100644 index 00000000000..f3c80d170fd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -0,0 +1,59 @@ +--- +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. + + **Parameters** + + * **enable\_gates** – Whether to apply 2-qubit gate twirling. Default: False. + + * **enable\_measure** – Whether to enable twirling of expectation value measurements in Estimator. Default: True. + + * **num\_randomizations** – The number of random samples to use when twirling or peforming sampled mitigation. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + + * **shots\_per\_randomization** – The number of shots to run for each random sample. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + + * **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”. + + ## Attributes + + ### enable\_gates + + + + ### enable\_measure + + + + ### num\_randomizations + + + + ### shots\_per\_randomization + + + + ### strategy + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ZneOptions.mdx new file mode 100644 index 00000000000..6c622a8415b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -0,0 +1,41 @@ +--- +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. + + **Parameters** + + * **noise\_factors** – Noise factors to use for noise amplification. Default: (1, 3, 5). + + * **extrapolator** – + + Extrapolator(s) to try (in order) for extrapolating to zero noise. One or more of: + + * ”linear” + * ”exponential” + * ”double\_exponential” + * ”polynomial\_degree\_(1 \<= k \<= 7)” + + Default: (“exponential”, “linear”). + + ## Attributes + + ### extrapolator + + + + ### noise\_factors + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.basis.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.basis.mdx new file mode 100644 index 00000000000..eaa6e82ebe1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.basis.mdx @@ -0,0 +1,22 @@ +--- +title: basis +description: API reference for qiskit_ibm_runtime.transpiler.passes.basis +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler.passes.basis +--- + + + +# basis + + + +## Basis + + + +`qiskit_ibm_runtime.transpiler.passes.basis` + +Passes to layout circuits to IBM backend’s instruction sets. + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.mdx new file mode 100644 index 00000000000..f8a5717abc4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.mdx @@ -0,0 +1,29 @@ +--- +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 +--- + + + + + +# qiskit\_ibm\_runtime.transpiler.passes + + + +## Transpiler Passes + + + +`qiskit_ibm_runtime.transpiler.passes` + +A collection of transpiler passes for IBM backends. + +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | +| [`basis`](qiskit_ibm_runtime.transpiler.passes.basis#module-qiskit_ibm_runtime.transpiler.passes.basis "qiskit_ibm_runtime.transpiler.passes.basis") | Basis (qiskit\_ibm\_runtime.transpiler.passes.basis) | +| [`scheduling`](qiskit_ibm_runtime.transpiler.passes.scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") | Scheduling (qiskit\_ibm\_runtime.transpiler.passes.scheduling) | + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx new file mode 100644 index 00000000000..5bcd98f6ef8 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -0,0 +1,141 @@ +--- +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`) – Durations of instructions to be used in scheduling. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** (`PassManagerState`) – 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`] + + **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` :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`) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + `PassManagerState` + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx new file mode 100644 index 00000000000..89f97bfe4eb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -0,0 +1,141 @@ +--- +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`) – Durations of instructions to be used in scheduling. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** (`PassManagerState`) – 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`] + + **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` :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` + + **Returns** + + The scheduled DAGCircuit. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** (`PassManagerState`) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + `PassManagerState` + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx new file mode 100644 index 00000000000..ac67fe83e5e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/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`) – 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`] + + **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`) – 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`) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + `PassManagerState` + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx new file mode 100644 index 00000000000..fa0e1b5eea2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/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` :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` :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*) – 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`, `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.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx new file mode 100644 index 00000000000..1b473f1786a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -0,0 +1,148 @@ +--- +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`) – 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. + + ## 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`) – 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`] + + **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`) – 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`) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + `PassManagerState` + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx new file mode 100644 index 00000000000..658d6f46bd4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -0,0 +1,284 @@ +--- +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`) – Durations of instructions to be used in scheduling. + + * **dd\_sequences** (`Union`\[`List`\[`Gate`], `List`\[`List`\[`Gate`]]]) – 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`]) – 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 + + **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`) – 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`] + + **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`) – 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`) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + `PassManagerState` + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx new file mode 100644 index 00000000000..c683df2ad6c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx @@ -0,0 +1,380 @@ +--- +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 +--- + + + +# scheduling + + + +## Scheduling + + + +`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()` or `generate_preset_pass_manager()`. + + +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 FakeJakarta + +backend = FakeJakarta() + +# Temporary workaround for mock backends. For real backends this is not required. +backend.configuration().basis_gates.append("if_else") + + +# Use this duration class to get appropriate durations for dynamic +# circuit backend scheduling +durations = DynamicCircuitInstructionDurations.from_backend(backend) +# Generate the main Qiskit transpile passes. +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +# Configure the as-late-as-possible scheduling pass +pm.scheduling = PassManager([ALAPScheduleAnalysis(durations), PadDelay(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.22/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.22/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()` function internally builds its pass set by using `generate_preset_pass_manager()`. This returns instances of `StagedPassManager`, 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.22/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()`. 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.22/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` 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.22/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.22/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.22/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.22/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.22/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.22/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.22/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.22/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.22/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.22/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.22/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.22/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png) + + + + +#### Scheduling & Dynamical Decoupling + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`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. | + diff --git a/docs/api/qiskit-ibm-runtime/0.22/runtime_service.mdx b/docs/api/qiskit-ibm-runtime/0.22/runtime_service.mdx new file mode 100644 index 00000000000..fc5883de13f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/runtime_service.mdx @@ -0,0 +1,172 @@ +--- +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 [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1") | +| [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.EstimatorV1")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | +| [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.EstimatorV2")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | +| [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") | alias of [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.sampler.SamplerV1") | +| [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.SamplerV1")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Sampler primitive service. | +| [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.SamplerV2")(\[backend, session, 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. | +| [`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 program execution. | +| [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")(backend, api\_client, ...\[, ...]) | Representation of a runtime V2 primitive exeuction. | +| [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions")(\[backend, image, log\_level, ...]) | Class for representing generic runtime execution options. | +| [`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.22/transpiler.mdx b/docs/api/qiskit-ibm-runtime/0.22/transpiler.mdx new file mode 100644 index 00000000000..adebb057e81 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.22/transpiler.mdx @@ -0,0 +1,26 @@ +--- +title: transpiler +description: API reference for qiskit_ibm_runtime.transpiler +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler +--- + + + + + +# IBM Backend Transpiler Tools + + + +`qiskit_ibm_runtime.transpiler` + +A collection of transpiler tools for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical compute and control-flow/feedback based off of measurement results. + +## Transpiler Passes + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | +| [`passes`](qiskit_ibm_runtime.transpiler.passes#module-qiskit_ibm_runtime.transpiler.passes "qiskit_ibm_runtime.transpiler.passes") | Transpiler Passes (qiskit\_ibm\_runtime.transpiler.passes) | + diff --git a/docs/api/qiskit-ibm-runtime/_package.json b/docs/api/qiskit-ibm-runtime/_package.json index f1b30547572..8b978fa3f06 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.22.0" + "version": "0.23.0" } diff --git a/docs/api/qiskit-ibm-runtime/_toc.json b/docs/api/qiskit-ibm-runtime/_toc.json index d28bb137b2f..b50cf89b90b 100644 --- a/docs/api/qiskit-ibm-runtime/_toc.json +++ b/docs/api/qiskit-ibm-runtime/_toc.json @@ -8,6 +8,10 @@ "title": "Overview", "url": "/api/qiskit-ibm-runtime/runtime_service" }, + { + "title": "Batch", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch" + }, { "title": "EstimatorV1", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1" diff --git a/docs/api/qiskit-ibm-runtime/dev/_package.json b/docs/api/qiskit-ibm-runtime/dev/_package.json index 9cfe4576e84..ef1aeb77d7a 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.23.0-dev" + "version": "0.24.0-dev" } diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx index a7effe81bfe..79bf63cdcb6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx @@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### backend - + Return backend for this session. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### cancel - + Cancel all pending jobs in a session. **Return type** @@ -119,7 +119,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** @@ -129,12 +129,12 @@ python_api_name: qiskit_ibm_runtime.Batch ### details - + Return session details. **Returns** - 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. + 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. **Return type** @@ -143,14 +143,22 @@ python_api_name: qiskit_ibm_runtime.Batch ### 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** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – instance of the `QiskitRuntimeService` class. - * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. + + * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – + + **instance of the `QiskitRuntimeService` class.** + + If `None`, `QiskitRuntimeService()` is used to initialize your default saved account. + + **Raises:** + + IBMInputValueError: If given session\_id does not exist. **Return type** @@ -163,7 +171,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### run - + Run a program in the session. **Parameters** @@ -184,7 +192,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### status - + Return current session status. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx index 6bf70ae5c14..4fa49a94b96 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.mdx @@ -120,7 +120,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 ### set\_options - + Set options values for the sampler. **Parameters** 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 d487e7113ec..324e02ec4ff 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. @@ -423,7 +423,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. @@ -443,7 +443,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). @@ -463,7 +463,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### drive\_channel - + Return the drive channel for the given qubit. **Returns** @@ -477,7 +477,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### measure\_channel - + Return the measure stimulus channel for the given qubit. **Returns** @@ -491,7 +491,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### open\_session - + Open session **Return type** @@ -501,7 +501,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. @@ -553,7 +553,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### run - + Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. **Parameters** @@ -642,7 +642,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### status - + Return the backend status. @@ -664,8 +664,16 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### target\_history - - A `qiskit.transpiler.Target` object for the backend. :rtype: `Target` :returns: Target with properties found on datetime + + A `qiskit.transpiler.Target` object for the backend. + + **Return type** + + `Target` + + **Returns** + + Target with properties found on datetime 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 f159bfa1ec6..a2542670f82 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.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx index 2596998b8b2..dc9813fc996 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx @@ -111,7 +111,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 ### set\_options - + Set options values for the sampler. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx index d8e518df85c..2a77c197c1b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/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,12 +124,12 @@ python_api_name: qiskit_ibm_runtime.Session ### details - + Return session details. **Returns** - 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. + 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. **Return type** @@ -138,14 +138,22 @@ python_api_name: qiskit_ibm_runtime.Session ### 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** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – instance of the `QiskitRuntimeService` class. - * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. + + * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – + + **instance of the `QiskitRuntimeService` class.** + + If `None`, `QiskitRuntimeService()` is used to initialize your default saved account. + + **Raises:** + + IBMInputValueError: If given session\_id does not exist. **Return type** @@ -158,7 +166,7 @@ python_api_name: qiskit_ibm_runtime.Session ### run - + Run a program in the session. **Parameters** @@ -179,7 +187,7 @@ python_api_name: qiskit_ibm_runtime.Session ### status - + Return current session status. **Returns** 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 5161ba0ac02..5fbe7b6b90e 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 @@ -122,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions ### update - + Update the options. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.mdx index b1b9cbee3b1..216bf386d66 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives, used by V1 primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx index eb64b391e19..f433c0c92a6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions # SamplerOptions - + Options for V2 Sampler. **Parameters** @@ -16,6 +16,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions * **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. * **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + * **twirling** – Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. * **experimental** – Experimental options. ## Attributes @@ -34,7 +35,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions ### execution - + ### experimental @@ -48,11 +49,15 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions + ### twirling + + + ## Methods ### update - + Update the options. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx index 9ce95f1d4fd..11a77397db9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -15,7 +15,7 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions * **enable\_gates** – Whether to apply 2-qubit gate twirling. Default: False. - * **enable\_measure** – Whether to enable twirling of expectation value measurements in Estimator. Default: True. + * **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. * **num\_randomizations** – The number of random samples to use when twirling or peforming sampled mitigation. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. 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 df08c1f5156..adb95f62e37 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 @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions # ZneOptions - + Zero noise extrapolation mitigation options. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx new file mode 100644 index 00000000000..d6a93ae21bb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx @@ -0,0 +1,207 @@ +--- +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. + + Similar to a `session`, a Qiskit Runtime `batch` groups a collection of iterative calls to the quantum computer. Batch mode can shorten processing time if all jobs can be provided at the outset. To submit iterative jobs, use sessions instead. + + **Using batch mode has these 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 minimal delay between job, which can help avoid drift. + + You can open a Qiskit Runtime batch by using this `Batch` class, then 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 Batch, 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 Batch(backend=backend) as batch: + sampler = Sampler(batch) + 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()}") + ``` + + Batch constructor. + + **Parameters** + + * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – 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`, `BackendV2`, `None`]) – Optional instance of `Backend` class or backend string name. + * **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](/run/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. + + **Returns** + + 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. + + **Return type** + + A dictionary with the sessions details, including + + + ### 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** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – + + **instance of the `QiskitRuntimeService` class.** + + If `None`, `QiskitRuntimeService()` is used to initialize your default saved account. + + **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` + + + ### run + + + Run a program in the session. + + **Parameters** + + * **program\_id** (`str`) – Program ID. + * **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program. + * **options** (`Optional`\[`Dict`]) – Runtime options that control the execution environment. See [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") for all available options. + * **callback** (`Optional`\[`Callable`]) – Callback function to be invoked for any interim results and final result. + + **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** + + Submitted job. + + + ### status + + + Return current session status. + + **Returns** + + 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. + + **Return type** + + The current status of the session, including + + + 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 942cd8cf879..cacb3d63954 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 [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1") diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx index 6a12be03aa4..0432e11a432 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 # EstimatorV1 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. @@ -95,7 +95,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 ### run - + Submit a request to the estimator primitive. **Parameters** @@ -120,7 +120,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 ### set\_options - + Set options values for the sampler. **Parameters** 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 3b72cd4a836..b6b76f36981 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. @@ -101,7 +101,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 ### 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 cd78298b973..17518000177 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. @@ -423,7 +423,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. @@ -443,7 +443,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). @@ -463,7 +463,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### drive\_channel - + Return the drive channel for the given qubit. **Returns** @@ -477,7 +477,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### measure\_channel - + Return the measure stimulus channel for the given qubit. **Returns** @@ -491,7 +491,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### open\_session - + Open session **Return type** @@ -501,7 +501,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. @@ -553,7 +553,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### run - + Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. **Parameters** @@ -642,7 +642,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### status - + Return the backend status. @@ -664,8 +664,16 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### target\_history - - A `qiskit.transpiler.Target` object for the backend. :rtype: `Target` :returns: Target with properties found on datetime + + A `qiskit.transpiler.Target` object for the backend. + + **Return type** + + `Target` + + **Returns** + + Target with properties found on datetime 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 298751c04e9..dcdf47b02de 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 @@ -73,7 +73,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### active\_account - + Return the IBM Quantum account currently in use for the session. **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backend - + Return a single backend matching the specified filtering. **Parameters** @@ -110,7 +110,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backends - + Return all backends accessible via this account, subject to optional filtering. **Parameters** @@ -167,7 +167,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -187,7 +187,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_job - + Delete a runtime job. Note that this operation cannot be reversed. @@ -208,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### get\_backend - + Return a single backend matching the specified filtering. **Parameters** @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### instances - + Return the IBM Quantum instances list currently in use for the session. **Return type** @@ -245,7 +245,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### job - + Retrieve a runtime job. **Parameters** @@ -268,7 +268,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### jobs - + Retrieve all runtime jobs, subject to optional filtering. **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### least\_busy - + Return the least busy available backend. **Parameters** @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### run - + Execute the runtime program. **Parameters** @@ -373,7 +373,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -397,7 +397,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** 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 3f578131f2b..5d4262b3bb9 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 24eeb268911..c7f6bad78b0 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 5e1e3c44c5c..ff979dfaa50 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 program execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. @@ -50,6 +50,14 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ## Attributes + ### ERROR + + + + ### JOB\_FINAL\_STATES + + + ### creation\_date @@ -156,7 +164,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** @@ -170,7 +178,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### cancel - + Cancel the job. **Raises** @@ -185,7 +193,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### cancel\_result\_streaming - + Cancel result streaming. **Return type** @@ -215,7 +223,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### error\_message - + Returns the reason if the job failed. **Return type** @@ -229,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### errored - + Return whether the job has failed. **Return type** @@ -239,7 +247,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** @@ -249,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### interim\_results - + Return the interim results of the job. **Parameters** @@ -281,7 +289,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### logs - + Return job logs. @@ -303,7 +311,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### metrics - + Return job metrics. **Return type** @@ -321,7 +329,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### properties - + Return the backend properties for this job. **Parameters** @@ -339,7 +347,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. @@ -359,7 +367,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### queue\_position - + Return the position of the job in the server queue. @@ -381,7 +389,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### result - + Return the results of the job. **Parameters** @@ -416,7 +424,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### status - + Return the status of the job. **Return type** @@ -430,7 +438,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### stream\_results - + Start streaming job results. **Parameters** @@ -455,7 +463,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### submit - + Unsupported method. .. note: ```python @@ -475,7 +483,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### update\_tags - + Update the tags associated with this job. **Parameters** @@ -497,7 +505,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### wait\_for\_final\_state - + Use the websocket server to wait for the final the state of a job. The server will remain open if the job is still running and the connection will be terminated once the job completes. Then update and return the status of the job. 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 ca6248335fe..19783af6c94 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. @@ -32,6 +32,14 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ## Attributes + ### ERROR + + + + ### JOB\_FINAL\_STATES + + + ### creation\_date @@ -134,7 +142,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** @@ -148,7 +156,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancel - + Cancel the job. **Raises** @@ -163,7 +171,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancel\_result\_streaming - + Cancel result streaming. **Return type** @@ -173,7 +181,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancelled - + Return whether the job has been cancelled. **Return type** @@ -183,7 +191,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### done - + Return whether the job has successfully run. **Return type** @@ -193,7 +201,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### error\_message - + Returns the reason if the job failed. **Return type** @@ -207,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### errored - + Return whether the job has failed. **Return type** @@ -217,7 +225,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** @@ -227,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### interim\_results - + Return the interim results of the job. **Parameters** @@ -259,7 +267,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### logs - + Return job logs. @@ -281,7 +289,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### metrics - + Return job metrics. **Return type** @@ -299,7 +307,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### properties - + Return the backend properties for this job. **Parameters** @@ -317,7 +325,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### result - + Return the results of the job. **Parameters** @@ -342,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### running - + Return whether the job is actively running. **Return type** @@ -352,7 +360,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### status - + Return the status of the job. **Return type** @@ -366,7 +374,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### stream\_results - + Start streaming job results. **Parameters** @@ -391,7 +399,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### update\_tags - + Update the tags associated with this job. **Parameters** @@ -413,7 +421,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### wait\_for\_final\_state - + Use the websocket server to wait for the final the state of a job. The server will remain open if the job is still running and the connection will be terminated once the job completes. Then update and return the status of the job. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.mdx index ae55fac4974..37c4ea271eb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions # RuntimeOptions - + Class for representing generic runtime execution options. RuntimeOptions constructor. @@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions ### get\_backend\_name - + Get backend name. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions ### validate - + Validate options. **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 59ff022b26a..8f339f42132 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 [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.sampler.SamplerV1") diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx index 7740dc8f30d..dda4396238b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 # SamplerV1 - + Class for interacting with Qiskit Runtime Sampler primitive service. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 ### run - + Submit a request to the sampler primitive. **Parameters** @@ -111,7 +111,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 ### set\_options - + Set options values for the sampler. **Parameters** 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 3a289b34587..84b51b5548a 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. @@ -69,7 +69,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 ### 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 a9a102a2dfe..3f787a4c0a0 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,12 +124,12 @@ python_api_name: qiskit_ibm_runtime.Session ### details - + Return session details. **Returns** - 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. + 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. **Return type** @@ -138,14 +138,22 @@ python_api_name: qiskit_ibm_runtime.Session ### 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** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – instance of the `QiskitRuntimeService` class. - * **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. + + * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – + + **instance of the `QiskitRuntimeService` class.** + + If `None`, `QiskitRuntimeService()` is used to initialize your default saved account. + + **Raises:** + + IBMInputValueError: If given session\_id does not exist. **Return type** @@ -158,7 +166,7 @@ python_api_name: qiskit_ibm_runtime.Session ### run - + Run a program in the session. **Parameters** @@ -179,7 +187,7 @@ python_api_name: qiskit_ibm_runtime.Session ### status - + Return current session status. **Returns** 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 04678931d40..443c61ef698 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index 00ac40bda99..159923a1313 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden # FakeAlmaden - + A fake Almaden backend. ```python @@ -90,7 +90,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden ### properties - + Returns a snapshot of device properties **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden ### run - + Main job in simulator 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 c43feb1b2bd..293eb9442e1 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 ### 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. @@ -257,7 +257,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. @@ -273,7 +273,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. @@ -313,12 +313,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index bb4ab17e49b..70e6daec402 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk # FakeArmonk - + A fake 1 qubit backend. ```python @@ -74,7 +74,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk ### defaults - + Returns a snapshot of device defaults **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk ### properties - + Returns a snapshot of device properties **Return type** @@ -122,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk ### run - + Main job in simulator 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 dbbe1d9d124..6b337d0ec29 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 ### 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. @@ -251,7 +251,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. @@ -267,7 +267,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. @@ -307,12 +307,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index b5638abee18..52d44740fd4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens # FakeAthens - + A fake 5 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens ### run - + Main job in simulator 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 f02a0938782..d1801c84f8d 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 63b09349b16..90f3d02f998 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index 25e83401f8f..4a919c10a14 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem # FakeBelem - + A fake 5 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem ### run - + Main job in simulator 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 2d75b03bb69..c8559ce2ee4 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index c10455cb307..d34d7d0e7e8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen # FakeBoeblingen - + A fake Boeblingen backend. ```python @@ -80,7 +80,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen ### defaults - + Returns a snapshot of device defaults **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen ### properties - + Returns a snapshot of device properties **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen ### run - + Main job in simulator 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 7dbbc0d41a2..70e3484e494 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 ### 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. @@ -257,7 +257,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. @@ -273,7 +273,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. @@ -313,12 +313,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index d65d0011087..590b27c768f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota # FakeBogota - + A fake 5 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota ### run - + Main job in simulator 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 e6a2b0e5fc3..033bfcd68ff 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 877a268df3d..407739d50a3 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index 57db5dd62a7..99f993648ff 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn # FakeBrooklyn - + A fake Brooklyn backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn ### run - + Main job in simulator 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 da84dc0a151..47bf94e4e84 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index fa2ddf87796..62ef7a5fde3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington # FakeBurlington - + A fake 5 qubit backend. ```python @@ -86,7 +86,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington ### properties - + Returns a snapshot of device properties **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington ### run - + Main job in simulator 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 c914042ac9c..ae643ac22e8 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 ### 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. @@ -253,7 +253,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. @@ -269,7 +269,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. @@ -309,12 +309,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index 3abad7c3ef9..f8fb623e30c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo # FakeCairo - + A fake 27 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo ### run - + Main job in simulator 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 738d3deaeda..ebec5d9c58a 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index 9c75a1b2f44..b8dc998b4c6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge # FakeCambridge - + A fake Cambridge backend. ```python @@ -92,7 +92,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge ### properties - + Returns a snapshot of device properties **Return type** @@ -116,7 +116,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge ### run - + Main job in simulator 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 522be2e7014..1f28714a760 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 ### 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. @@ -259,7 +259,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. @@ -275,7 +275,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. @@ -315,12 +315,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index 40fc7e3ada9..84625285716 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca # FakeCasablanca - + A fake 7 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca ### run - + Main job in simulator 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 d8fe16b5e5c..af46c323d15 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 6148fde566b..006e1a5524f 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index ec4a7324ad5..ef152722d06 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex # FakeEssex - + A fake 5 qubit backend. ```python @@ -88,7 +88,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex ### properties - + Returns a snapshot of device properties **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex ### run - + Main job in simulator 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 7de3dac77b4..64660f65110 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 ### 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. @@ -255,7 +255,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. @@ -271,7 +271,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. @@ -311,12 +311,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 9172157c241..f7ca8af8900 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index 1662e5542b6..479b20f1413 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe # FakeGuadalupe - + A fake 16 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe ### run - + Main job in simulator 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 d6254c911cc..4c5b4ccf46d 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index 4b1e5ac7ba5..20fdbaeb41b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi # FakeHanoi - + A fake 27 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi ### run - + Main job in simulator 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 af470a249fc..79cd411690a 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index 9588446be7f..2dc4c665011 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta # FakeJakarta - + A fake 7 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta ### run - + Main job in simulator 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 3ff7c0fa027..45b8d7b7c43 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index 973c07f22d9..dd7ecace1eb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg # FakeJohannesburg - + A fake Johannesburg backend. ```python @@ -90,7 +90,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg ### properties - + Returns a snapshot of device properties **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg ### run - + Main job in simulator 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 c79a0c24feb..8752aee897c 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 ### 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. @@ -257,7 +257,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. @@ -273,7 +273,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. @@ -313,12 +313,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 09eec9ff6ca..db662435723 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index 482cdc4da8d..b3224879bf0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata # FakeKolkata - + A fake 27 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata ### run - + Main job in simulator 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 8393b0453ae..f2d4f41cca0 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 f3ddc3cbae2..3ee5fb2e88f 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 8897fec3932..577de1a26b6 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index e079ed37495..2ddcdfb7195 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos # FakeLagos - + A fake 7 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos ### run - + Main job in simulator 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 17ebe637b23..30bf0e58b32 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index 988d352b407..7d3d5d4a7eb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima # FakeLima - + A fake 5 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima ### run - + Main job in simulator 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 af4ae889db8..5cec0432d14 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index 5716674afe4..3118c240073 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon # FakeLondon - + A fake 5 qubit backend. ```python @@ -88,7 +88,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon ### properties - + Returns a snapshot of device properties **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon ### run - + Main job in simulator 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 4537cfdd44e..a5c40f689a5 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 ### 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. @@ -255,7 +255,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. @@ -271,7 +271,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. @@ -311,12 +311,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index d3887c03cae..6c3fb3d47c5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan # FakeManhattan - + A fake Manhattan backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan ### run - + Main job in simulator 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 7c768ce26a9..27af18cedf4 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index a73f13f77fd..ac1acd5f6a6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila # FakeManila - + A fake 5 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila ### run - + Main job in simulator 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 02b1bdb0990..cfcf015bae2 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index 9e58711da0b..1a6bc2b7e92 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne # FakeMelbourne - + A fake 14 qubit backend. ```python @@ -63,7 +63,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne ### properties - + Returns a snapshot of device properties **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 7fb37632e11..71da11f4d56 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index 0d0ff6332c9..2a703b4cd6b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal # FakeMontreal - + A fake 27 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal ### run - + Main job in simulator 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 6483fadcf47..9e38b81e95b 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index b13ee4138c5..9193f1363b9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai # FakeMumbai - + A fake 27 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai ### run - + Main job in simulator 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 d4b5a37e960..cfd5db781c3 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index 7e2072553dd..37c0ab23968 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi # FakeNairobi - + A fake 7 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi ### run - + Main job in simulator 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 aa2abb9d562..13484b2e02b 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 c27f84438f3..da8e653a7e9 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 7dfb5a4830b..4802aba912b 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index 5fc251a4b48..f895765ee41 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense # FakeOurense - + A fake 5 qubit backend. ```python @@ -86,7 +86,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense ### properties - + Returns a snapshot of device properties **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense ### run - + Main job in simulator 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 730ac47b239..b51bf08b4b0 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 ### 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. @@ -253,7 +253,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. @@ -269,7 +269,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. @@ -309,12 +309,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index 7448658b2d3..15060ce1bd1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis # FakeParis - + A fake Paris backend. ```python @@ -82,7 +82,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis ### defaults - + Returns a snapshot of device defaults **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis ### properties - + Returns a snapshot of device properties **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis ### run - + Main job in simulator 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 92e92c2edd0..600220f01ba 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 ### 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. @@ -259,7 +259,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. @@ -275,7 +275,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. @@ -315,12 +315,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 52edb4f5ece..7853a63b3ae 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 e557eeb02b4..2c9dc2f261e 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index 1fdb3e890a3..14ea321fdd1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie # FakePoughkeepsie - + A fake Poughkeepsie backend. ```python @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie ### properties - + Returns a snapshot of device properties **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 c8bc1be1195..71d6452da6d 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 3d11314bdfb..b82d9431289 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index fdc62c98ff3..e46aebc578c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider # FakeProvider - + Fake provider containing fake V1 backends. Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). @@ -23,7 +23,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** @@ -44,7 +44,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider ### get\_backend - + Return a single backend matching the specified filtering. **Parameters** 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 a334d54bd3f..63bf277838f 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"). @@ -23,13 +23,13 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 ### backend - + Filter backends in provider by name. ### backends - + Return a list of backends matching the specified filtering. **Parameters** 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 22579b6cd28..41388134d47 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index bcbfceda95a..667f138528e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito # FakeQuito - + A fake 5 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito ### run - + Main job in simulator 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 992a23ef4c8..7a7fd6aa704 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index cbec9ee89ca..024b0138b84 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester # FakeRochester - + A fake Rochester backend. FakeBackend initializer. @@ -80,7 +80,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester ### properties - + Returns a snapshot of device properties **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester ### run - + Main job in simulator 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 46650e32a27..06f0699bfae 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index dcfeeb17e18..b60d8e9ada9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome # FakeRome - + A fake 5 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome ### run - + Main job in simulator 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 8cee17f8839..67a40966dc5 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index 0d9940f290c..eecbc409c49 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon # FakeRueschlikon - + A fake 16 qubit backend. ```python diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx index 5599ae46eaf..471c8be3b70 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago # FakeSantiago - + A fake Santiago backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago ### run - + Main job in simulator 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 546dcd5e4b7..bc2e462c6c9 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 3aee457dc03..10458bf4958 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index 627e16561d9..0364d978eb9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore # FakeSingapore - + A fake Singapore backend. ```python @@ -90,7 +90,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore ### properties - + Returns a snapshot of device properties **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore ### run - + Main job in simulator 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 3d03539a22e..daf9e68f378 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 ### 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. @@ -257,7 +257,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. @@ -273,7 +273,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. @@ -313,12 +313,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index f09b9ff48a8..e484636833a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney # FakeSydney - + A fake 27 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney ### run - + Main job in simulator 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 dff33e6c5b1..35c3156b6d3 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index 005b81cb2ab..5f34e53c415 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife # FakeTenerife - + A fake 5 qubit backend. ```python @@ -65,7 +65,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife ### properties - + Returns a snapshot of device properties as recorded on 8/30/19. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx index 3a0a382e3d0..83c1e3a8825 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo # FakeTokyo - + A fake 20 qubit backend. ```python @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo ### properties - + Returns a snapshot of device properties as recorded on 8/30/19. **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 85ddf469335..8328ebc7450 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index 324c24e044f..bb3d7ae470f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto # FakeToronto - + A fake 27 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto ### run - + Main job in simulator 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 13f3a746b0e..1659276d73b 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index 67d1b522429..9995f2d7d8b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia # FakeValencia - + A fake 5 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia ### run - + Main job in simulator 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 7880b846421..89059eadc41 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index e5b8b83a29d..ff8badac7aa 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo # FakeVigo - + A fake 5 qubit backend. ```python @@ -86,7 +86,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo ### properties - + Returns a snapshot of device properties **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo ### run - + Main job in simulator 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 7d92612d640..38431418a2c 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 ### 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. @@ -253,7 +253,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. @@ -269,7 +269,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. @@ -309,12 +309,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index 3c0da1d48ea..07906b2f8a3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington # FakeWashington - + A fake 127 qubit backend. FakeBackend initializer. @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington ### defaults - + Returns a snapshot of device defaults **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington ### properties - + Returns a snapshot of device properties **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington ### run - + Main job in simulator 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 ad8459fe67f..7bc1a879ea5 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 ### 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. @@ -247,7 +247,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. @@ -263,7 +263,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. @@ -303,12 +303,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index f12e71a9603..4040b121a40 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown # FakeYorktown - + A fake 5 qubit backend. ```python @@ -88,7 +88,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown ### properties - + Returns a snapshot of device properties **Return type** @@ -112,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown ### run - + Main job in simulator 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 d4af88a029c..46f0f4a4ec3 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 ### 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. @@ -255,7 +255,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. @@ -271,7 +271,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. @@ -311,12 +311,12 @@ 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 BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + 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` 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 BasicAer simulator/ BasicSimulator simulator without noise. + 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. 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 0245fdf5e74..00f351af884 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). **Parameters** 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 039c8141252..9a56d457a97 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. **Parameters** 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 bdd0d7805eb..0a270329ff0 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. **Parameters** @@ -122,7 +122,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.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.mdx index 6ae2bc9c2a2..4b15b3a2d17 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions # ExecutionOptions - + Execution options for V1 primitives. **Parameters** 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 d0b591d6e6a..d3fd2659258 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. **Parameters** 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 1ea4e29ec99..d3c5f557ec4 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,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.LayerNoiseLearningOptions # LayerNoiseLearningOptions - + Options for learning layer noise. 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 26201d8cc59..021518dfa8b 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx index 86aedb3c5dd..fef87cdb1a6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.Options # Options - + Options for the primitives, used by V1 primitives. **Parameters** @@ -87,7 +87,7 @@ python_api_name: qiskit_ibm_runtime.options.Options ### validate\_options - + Validate that program inputs (options) are valid :raises ValueError: if optimization\_level is outside the allowed range. :raises ValueError: if max\_execution\_time is outside the allowed range. **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 bac0d85fced..5803e4eb721 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. **Parameters** @@ -19,11 +19,12 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions The amount by which to scale the noise, where: - * A value of one corresponds to attempting to remove all of the noise. - * A value greater than one corresponds to injecting noise. - * A value between 0 and 1 corresponds to partially removing the noise. + * 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 will be chosen automatically based on the input PUBs. Default: “auto”. + 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”. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.mdx index b24175e3bba..c59bf04d33a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions # ResilienceOptions - + Resilience options for V1 primitives. **Parameters** 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 84786a4212d..c7c62680a23 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. **Parameters** 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 d26ff34faa3..1db8ed9ed16 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. **Parameters** @@ -16,6 +16,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions * **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. * **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + * **twirling** – Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. * **experimental** – Experimental options. ## Attributes @@ -34,7 +35,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions ### execution - + ### experimental @@ -48,11 +49,15 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions + ### twirling + + + ## Methods ### 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 7488419c1e9..fcd3b39925a 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. @@ -42,7 +42,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.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.mdx index e23d311d1fb..1d60e1b9eb1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions # TranspilationOptions - + Transpilation options. **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 f3c80d170fd..9889c0e8682 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,14 +8,14 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions # TwirlingOptions - + Twirling options. **Parameters** * **enable\_gates** – Whether to apply 2-qubit gate twirling. Default: False. - * **enable\_measure** – Whether to enable twirling of expectation value measurements in Estimator. Default: True. + * **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. * **num\_randomizations** – The number of random samples to use when twirling or peforming sampled mitigation. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. 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 6c622a8415b..d214628e1f6 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. **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 5bcd98f6ef8..25e80747e54 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. @@ -29,7 +29,8 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna **Parameters** - **durations** (`InstructionDurations`) – Durations of instructions to be used in scheduling. + * **durations** (`InstructionDurations`) – Durations of instructions to be used in scheduling. + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[`DAGCircuit`], `Generator`\[`DAGOpNode`, `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 @@ -102,7 +103,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna ### run - + Run the ASAPSchedule pass on dag. :type dag: `DAGCircuit` :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 89f97bfe4eb..b9c4bb2d8f8 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. @@ -29,7 +29,8 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna **Parameters** - **durations** (`InstructionDurations`) – Durations of instructions to be used in scheduling. + * **durations** (`InstructionDurations`) – Durations of instructions to be used in scheduling. + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[`DAGCircuit`], `Generator`\[`DAGOpNode`, `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 @@ -102,7 +103,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna ### run - + Run the ALAPSchedule pass on dag. :type dag: `DAGCircuit` :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 ac67fe83e5e..68052974143 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 fa0e1b5eea2..f9d37f2f432 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` :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` :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 1b473f1786a..83a345c1f80 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. @@ -34,6 +34,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay * **durations** (`InstructionDurations`) – 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`], `Generator`\[`DAGOpNode`, `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 @@ -106,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 658d6f46bd4..233560b5d35 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). @@ -165,6 +165,8 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec * **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`], `Generator`\[`DAGOpNode`, `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. @@ -242,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.transpiler.passes.scheduling.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx index e02ab02b3d4..e50851442b5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx @@ -371,9 +371,9 @@ qc_dd.draw(output="mpl", style="iqp") | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`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. | +| [`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. | diff --git a/docs/api/qiskit-ibm-runtime/release-notes.mdx b/docs/api/qiskit-ibm-runtime/release-notes.mdx index 53f43339cdb..df48387dbda 100644 --- a/docs/api/qiskit-ibm-runtime/release-notes.mdx +++ b/docs/api/qiskit-ibm-runtime/release-notes.mdx @@ -6,61 +6,91 @@ in_page_toc_max_heading_level: 2 -# Qiskit Runtime IBM Client 0.22 release notes +# Qiskit Runtime IBM Client 0.23 release notes +## 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](/api/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 + +* Printing Options and OptionsV2 will now be formatted as a table. ([1490](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1490)) +* Add block\_ordering\_callable: Optional\[BlockOrderingCallableType] argument to BlockBasePadder, PadDynamicalDecoupling, PadDelay\`, and BaseDynamicCircuitAnalysis. This allows the user to construct blocks using an algorithm of their choosing. No assumptions or checks are made on the validity of the output that the block\_ordering\_callable produces. The motivation for this argument is that for some families of circuits, the existing function block\_order\_op\_nodes can be very slow. ([1531](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1531)) +* The Sampler and Estimator V2 Primitives have been enhanced to incorporate custom validation procedures when the channel\_strategy property is set as “q-ctrl.” This customized validation logic effectively rectifies incorrect input options and safeguards users against inadvertently disabling Q-CTRL’s performance enhancements. ([1550](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1550)) +* 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 + +* [`qiskit_ibm_runtime.RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2") will no longer error when the API returns an unknown status. Instead, the status from the API will directly be returned. ([1476](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1476)) +* Fixed a bug where custom headers were not being sent in the /jobs request. ([1508](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1508)) +* 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() method in 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](/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/run/primitives-examples)) to see this coupled with operator transformations. + + ### Deprecation Notes * In a future release, `backend` will be a required parameter for `qiskit_ibm_runtime.Sampler`, and `qiskit_ibm_runtime.Estimator` if `session` is not specified, even when using the `ibm_cloud` channel. It will also be a required parameter for `qiskit_ibm_runtime.Session` and `qiskit_ibm_runtime.Batch`. - + ### Bug Fixes @@ -68,35 +98,35 @@ 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 -* Add `dd_barrier` optional input to `` `PadDynamicalDecoupling `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling)>\`\_\_ constructor to identify portions of the circuit to apply dynamical decoupling (dd) on selectively. If this string is contained in the label of a barrier in the circuit, dd is applied on the delays ending with it (on the same qubits); otherwise, it is not applied. +* Add `dd_barrier` optional input to [PadDynamicalDecoupling](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling) constructor to identify portions of the circuit to apply dynamical decoupling (dd) on selectively. If this string is contained in the label of a barrier in the circuit, dd is applied on the delays ending with it (on the same qubits); otherwise, it is not applied. * Python 3.12 is now supported. -* Sessions will now be started with a new `/sessions` endpoint that allows for different execution modes. Batch mode is now supported through `Batch`, and `` `Session `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Session](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session)>\`\_\_ will work the same as way as before. Please see [run/sessions](/run/sessions) for more information. +* Sessions will now be started with a new `/sessions` endpoint that allows for different execution modes. Batch mode is now supported through `Batch`, and [Session](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session) will work the same as way as before. Please see [run/sessions](/run/sessions) for more information. Note that `Session` and `Batch` created from `qiskit-ibm-runtime` 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. Also note that using simulators with sessions is no longer supported. Users can still start sessions with simulators without any issues but a session will not actually be created. There will be no session ID. -* Sessions started with `` `qiskit_ibm_runtime.IBMBackend.open_session() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.IBMBackend#open\_session](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#open_session)>\`\_\_ will use the new `/sessions` endpoint. +* Sessions started with [qiskit\_ibm\_runtime.IBMBackend.open\_session()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#open_session) will use the new `/sessions` endpoint. 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](/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/run/primitives-examples)) to see this coupled with operator transformations. - + ### Bug Fixes @@ -106,70 +136,70 @@ in_page_toc_max_heading_level: 2 * 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 -* Added a new parameter, dynamic\_circuits to `` `backends() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#backends](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#backends)>\`\_\_ to allow filtering of backends that support dynamic circuits. +* Added a new parameter, dynamic\_circuits to [backends()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#backends) to allow filtering of backends that support dynamic circuits. * 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/qiskit\_ibm\_runtime.QiskitRuntimeService#runtime](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#runtime)>\`\_\_ has been deprecated. +* [runtime()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#runtime) has been deprecated. - + ### Bug Fixes -* Many methods in `` `RuntimeJob `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#inputs)>\`\_\_. +* 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](/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](/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. +* 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 @@ -187,7 +217,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 @@ -195,43 +225,43 @@ 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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#from_id)>\`\_\_ because it was a breaking change without proper deprecation. +* 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 -* A new module `` `qiskit_ibm_runtime.fake_provider `` \\`\_\_, has been added to provide access to a series of fake backends derived from snapshots of IBM Quantum devices. This functionality was originally provided by the `qiskit.providers.fake_provider` module, but will soon be deprecated in favor of `` `qiskit_ibm_runtime.fake_provider `` \\`\_\_. +* A new module [qiskit\_ibm\_runtime.fake\_provider](fake_provider#module-qiskit_ibm_runtime.fake_provider), has been added to provide access to a series of fake backends derived from snapshots of IBM Quantum devices. This functionality was originally provided by the `qiskit.providers.fake_provider` module, but will soon be deprecated in favor of [qiskit\_ibm\_runtime.fake\_provider](fake_provider#module-qiskit_ibm_runtime.fake_provider). The snapshots provided by the fake backends are useful for local testing of the transpiler and performing local noisy simulations of the system before running on real devices. Here is an example of using a fake backend for transpilation and simulation: @@ -264,78 +294,78 @@ 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 * Fixed an issue where canceled and failed jobs would return an invalid result that resulted in a type error, preventing the actual error from being returned to the user. * A warning will be raised at initialization if the DE environment is being used since not all features are supported there. -* The `backend` parameter in `` `from_id() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Session#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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_ and `` `Sampler `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler)>\`\_\_ have been completely removed. +* 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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session)>\`\_\_ but will later be updated to better support submitting multiple jobs at once. +* 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 Quantum Serverless. Refer to the migration guide for instructions: [https://qiskit-extensions.github.io/quantum-serverless/migration/migration\_from\_qiskit\_runtime\_programs.html](https://qiskit-extensions.github.io/quantum-serverless/migration/migration_from_qiskit_runtime_programs.html) - + ## 0.13.0 - + ### New Features -* Added a new method, `` `details() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Session#details](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#details)>\`\_\_ that returns information about a session, including: maximum session time, active time remaining, the current state, and whether or not the session is accepting jobs. +* Added a new method, [details()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#details) that returns information about a session, including: maximum session time, active time remaining, the current state, and whether or not the session is accepting jobs. - Also added `` `status() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Session#status](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#status)>\`\_\_, which returns the current status of the session. + Also added [status()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#status), which returns the current status of the session. * 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 -* `` `qiskit_ibm_runtime.Session.close() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Session#close](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#close)>\`\_\_ has been updated to mark a `Session` as no longer accepting new jobs. The session won’t accept more jobs but it will continue to run any queued jobs until they are done or the max time expires. This will also happen automatically when the session context manager is exited. When a session that is not accepting jobs has run out of jobs to run, it’s immediately closed, freeing up the backend to run more jobs rather than wait for the interactive timeout. +* [qiskit\_ibm\_runtime.Session.close()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#close) has been updated to mark a `Session` as no longer accepting new jobs. The session won’t accept more jobs but it will continue to run any queued jobs until they are done or the max time expires. This will also happen automatically when the session context manager is exited. When a session that is not accepting jobs has run out of jobs to run, it’s immediately closed, freeing up the backend to run more jobs rather than wait for the interactive timeout. - 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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#cancel)>\`\_\_, where all queued jobs within a session are cancelled and terminated. + 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](/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. +* 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 @@ -344,38 +374,38 @@ 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 * Users can use a new environment variable, `USAGE_DATA_OPT_OUT` to opt out of user module usage tracking by setting this value to `True`. Additionally, only certain qiskit modules will be tracked instead of all modules that begin with qiskit or qiskit\_. -* 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](/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`. +* 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 -* Retrieving backend properties with `` `properties() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.IBMBackend#properties](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#properties)>\`\_\_ now supports passing a `datetime` parameter to retrieve properties from a past date. -* The `noise_factors` and `extrapolator` options in `` `qiskit_ibm_runtime.options.ResilienceOptions `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.options.ResilienceOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions)>\`\_\_ will now default to `None` unless `resilience_level` is set to 2. Only options relevant to the resilience level will be set, so when using `resilience_level` 2, `noise_factors` will still default to `(1, 3, 5)` and `extrapolator` will default to `LinearExtrapolator`. Additionally, options with a value of `None` will no longer be sent to the server. +* Retrieving backend properties with [properties()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#properties) now supports passing a `datetime` parameter to retrieve properties from a past date. +* The `noise_factors` and `extrapolator` options in [qiskit\_ibm\_runtime.options.ResilienceOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions) will now default to `None` unless `resilience_level` is set to 2. Only options relevant to the resilience level will be set, so when using `resilience_level` 2, `noise_factors` will still default to `(1, 3, 5)` and `extrapolator` will default to `LinearExtrapolator`. Additionally, options with a value of `None` will no longer be sent to the server. * 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 @@ -388,25 +418,25 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper sampler = Sampler(backend="ibmq_qasm_simulator") ``` -* Added a new method, `` `qiskit_ibm_runtime.QiskitRuntimeService.instances() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#instances](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#instances)>\`\_\_ that returns all instances(hub/group/project) the user is in. This is only for the `ibm_quantum` channel since the `ibm_cloud` channel does not have multiple instances. +* Added a new method, [qiskit\_ibm\_runtime.QiskitRuntimeService.instances()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#instances) that returns all instances(hub/group/project) the user is in. This is only for the `ibm_quantum` channel since the `ibm_cloud` channel does not have multiple instances. * Added validations for options on the second level of the dict, i.e., for each of resilience, simulator, execution, and transpilation, check that their options are supported. Otherwise throw an exception. -* 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](/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](/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. +* 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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#inputs)>\`\_\_. +* 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 @@ -414,31 +444,31 @@ 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 -* Added reason for failure when invoking the method `` `error_message() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#error\_message](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#error_message)>\`\_\_. -* Added a new property, `` `usage_estimation() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#usage\_estimation](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#usage_estimation)>\`\_\_ that returns the estimated system execution time, `quantum_seconds`. System execution time represents the amount of time that the system is dedicated to processing your job. +* Added reason for failure when invoking the method [error\_message()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#error_message). +* Added a new property, [usage\_estimation()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#usage_estimation) that returns the estimated system execution time, `quantum_seconds`. System execution time represents the amount of time that the system is dedicated to processing your job. * Raise an exception if the number of circuits passed to `_run_primitive()` exceeds the number of circuits supported on the backend. -* There is a new method `` `update_tags() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#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](/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. +* 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 * If a job has been cancelled, and job.result() is requested, throw an exception rather than returning None. -* A new method, `` `qiskit_ibm_runtime.options.SimulatorOptions.set_backend() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.options.SimulatorOptions#set\_backend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#set_backend)>\`\_\_, allows users to more easily set simulator options for a backend. +* A new method, [qiskit\_ibm\_runtime.options.SimulatorOptions.set\_backend()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions#set_backend), allows users to more easily set simulator options for a backend. ```python from qiskit.providers.fake_provider import FakeManila @@ -453,32 +483,32 @@ 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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#metrics)>\`\_\_, the bss field will be replaced by usage. +* 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 -* When retrieving a job with `qiskit_ibm_runtime.IBMRuntimeService.job()` the `params` will no longer be returned from the API. They will instead be loaded loazily when they are actually needed in `` `qiskit_ibm_runtime.RuntimeJob.inputs() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#inputs](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#inputs)>\`\_\_. +* When retrieving a job with `qiskit_ibm_runtime.IBMRuntimeService.job()` the `params` will no longer be returned from the API. They will instead be loaded loazily when they are actually needed in [qiskit\_ibm\_runtime.RuntimeJob.inputs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#inputs). * Added warning when the backend is not active in QiskitRuntimeService.run. @@ -494,130 +524,130 @@ 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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler)>\`\_\_ or `` `qiskit_ibm_runtime.Estimator `` \<[api/qiskit-ibm-runtime/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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler)>\`\_\_ and `` `qiskit_ibm_runtime.Estimator `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_ constructors is now `backend` instead of `session`. +* 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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler)>\`\_\_ or `` `qiskit_ibm_runtime.Estimator `` \<[api/qiskit-ibm-runtime/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. +* 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 -* The deprecated arguments `circuits`, `parameters`, `service`, and `skip_transpilation` have been removed from `` `Sampler `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler)>\`\_\_. +* The deprecated arguments `circuits`, `parameters`, `service`, and `skip_transpilation` have been removed from [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler). - Similarly, the deprecated arguments `circuits`, `observables`, `parameters`, `service`, and `skip_transpilation` have been removed from `` `Estimator `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_. + Similarly, the deprecated arguments `circuits`, `observables`, `parameters`, `service`, and `skip_transpilation` have been removed from [Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator). - In `` `QiskitRuntimeService `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService)>\`\_\_, the `auth` parameter has been removed. Additionally, the `instance`, `job_tags`, and `max_execution_time` paramters have been removed from `` `qiskit_ibm_runtime.QiskitRuntimeService.run() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#run](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#run)>\`\_\_. They can be passed in through `` `RuntimeOptions `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions)>\`\_\_ instead. + In [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService), the `auth` parameter has been removed. Additionally, the `instance`, `job_tags`, and `max_execution_time` paramters have been removed from [qiskit\_ibm\_runtime.QiskitRuntimeService.run()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#run). They can be passed in through [RuntimeOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions) instead. - Within `` `RuntimeOptions `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions)>\`\_\_, `backend_name` is no longer supported. Please use `backend` instead. + Within [RuntimeOptions](/api/qiskit-ibm-runtime/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](/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/qiskit\_ibm\_runtime.QiskitRuntimeService#get\_backend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#get_backend)>\`\_\_ and `` `backends() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#backends](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#backends)>\`\_\_. +* 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/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/qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/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](/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](/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. +* Added a new argument called `session_time` to the program\_run method and [qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/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 * Accept all options on given on level 1 and assign them to the appropriate hierarchical option type. For example, if the user provides `options = {"shots": 10}` as input to Sampler/Estimator, this will be interpreted as `options = {"execution: {"shots": 10}}`. -* 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](/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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob)>\`\_\_ have now been removed. +* 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 * Fixed a bug where the default values for `optimization_level` and for `resilience_level` were not being set correctly. * Fixed an issue where if no backend was selected, `optimization_level` and `resilience_level` would default to `None`, causing the job to fail. -* If an instance is passed in to `` `qiskit_ibm_runtime.QiskitRuntimeService.get_backend() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#get\_backend](/api/qiskit-ibm-runtime/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. +* If an instance is passed in to [qiskit\_ibm\_runtime.QiskitRuntimeService.get\_backend()](/api/qiskit-ibm-runtime/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 -* `` `qiskit_ibm_runtime.QiskitRuntimeService.jobs() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#jobs](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs)>\`\_\_ now has a `backend_name` parameter that can be used to only return jobs run with the specified backend. +* [qiskit\_ibm\_runtime.QiskitRuntimeService.jobs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs) now has a `backend_name` parameter that can be used to only return jobs run with the specified backend. * Allow the user to store account details in a file specified by the user in the parameter. `filename`. The default remains \~/.qiskit/qiskit-ibm.json. Example of usage: Ex: @@ -631,99 +661,99 @@ 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/qiskit\_ibm\_runtime.Session#run](/api/qiskit-ibm-runtime/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. +* `backend` is no longer a supported option when using [qiskit\_ibm\_runtime.Session.run()](/api/qiskit-ibm-runtime/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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#session_id)>\`\_\_ and `` `tags() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#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. +* [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 * Python 3.10 is now supported. -* Advanced resilience options can now be set under `options.resilience`. See `` `qiskit_ibm_runtime.options.ResilienceOptions `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.options.ResilienceOptions](/api/qiskit-ibm-runtime/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/qiskit\_ibm\_runtime.QiskitRuntimeService#run](/api/qiskit-ibm-runtime/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. +* Advanced resilience options can now be set under `options.resilience`. See [qiskit\_ibm\_runtime.options.ResilienceOptions](/api/qiskit-ibm-runtime/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/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](/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](/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. +* 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 * `qiskit_ibm_runtime.Options` class now accepts arbitrary keyword arguments. This allows users to specify new options to the primitive programs without upgrading `qiskit_ibm_runtime`. These arbitrary keyword arguments, however, are not validated. -* The `` `qiskit_ibm_runtime.options.EnvironmentOptions `` \<[api/qiskit-ibm-runtime/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/qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions)>\`\_\_ has also been updated to include these two parameters. +* 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/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 * Qiskit Runtime programs `torch-train`, `torch-infer`, `sample-expval`, `sample-program`, and `quantum_kernal_alignment` have been deprecated due to low usage. -* Passing `instance` parameter to the `` `qiskit_ibm_runtime.QiskitRuntimeService.run() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#run](/api/qiskit-ibm-runtime/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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService)>\`\_\_ has been deprecated. Please pass them inside `options`. +* Passing `instance` parameter to the [qiskit\_ibm\_runtime.QiskitRuntimeService.run()](/api/qiskit-ibm-runtime/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 @@ -733,32 +763,32 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper ## 0.7.0rc2 - + ### Upgrade Notes -* Added a validation check to `` `run() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Sampler#run](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler#run)>\`\_\_. It raises an error if there is no classical bit. -* `` `Sampler `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob)>\`\_\_ class is now a subclass of `qiskit.providers.Job`. +* Added a validation check to [run()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler#run). It raises an error if there is no classical bit. +* [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 -* `job_id` and `backend` attributes of `` `qiskit_ibm_runtime.RuntimeJob `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob)>\`\_\_ have been deprecated. Please use `` `qiskit_ibm_runtime.RuntimeJob.job_id() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#job\_id](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#job_id)>\`\_\_ and `` `qiskit_ibm_runtime.RuntimeJob.backend() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#backend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#backend)>\`\_\_ methods instead. -* The `backend_name` attribute in `` `qiskit_ibm_runtime.RuntimeOptions `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions)>\`\_\_ is deprecated and replaced by `backend`. +* `job_id` and `backend` attributes of [qiskit\_ibm\_runtime.RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) have been deprecated. Please use [qiskit\_ibm\_runtime.RuntimeJob.job\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#job_id) and [qiskit\_ibm\_runtime.RuntimeJob.backend()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#backend) methods instead. +* The `backend_name` attribute in [qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions) is deprecated and replaced by `backend`. ## 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 @@ -813,17 +843,17 @@ There are significant changes to how primitives are invoked within a session, an job = sampler.run(circuits=ReferenceCircuits.bell(), shots=4000) ``` -* `` `qiskit_ibm_runtime.RuntimeJob `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob)>\`\_\_ has a new method `` `metrics() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#metrics](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#metrics)>\`\_\_. This method returns the metrics of a job, which includes timestamp information. +* [qiskit\_ibm\_runtime.RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) has a new method [metrics()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#metrics). This method returns the metrics of a job, which includes timestamp information. -* The `` `qiskit_ibm_runtime.QiskitRuntimeService `` \<[api/qiskit-ibm-runtime/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. +* 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 * Raise `RuntimeJobMaxTimeoutError` when a job runs for too long so that it can be handled appropriately by programs. -* The experimental parameters `transpilation_settings`, `resilience_settings`, and `max_time` to the :class:\`qiskit\_ibm\_runtime.Sampler and `` `qiskit_ibm_runtime.Estimator `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_ constructors have been removed. You can instead use the `qiskit_ibm_runtime.Options` class to specify the settings, and `max_time` can be specified when starting a new session. For example: +* The experimental parameters `transpilation_settings`, `resilience_settings`, and `max_time` to the :class:\`qiskit\_ibm\_runtime.Sampler and [qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) constructors have been removed. You can instead use the `qiskit_ibm_runtime.Options` class to specify the settings, and `max_time` can be specified when starting a new session. For example: ```python from qiskit_ibm_runtime import Session, Sampler, Options @@ -840,15 +870,15 @@ 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 -* Invoking `` `qiskit_ibm_runtime.Sampler `` \<[api/qiskit-ibm-runtime/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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_ as context managers has been deprecated. You can instead use the qiskit\_ibm\_runtime.Session class to create a new session and invoke one or more primitives within the session. +* Invoking [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) as context managers has been deprecated. You can instead use the qiskit\_ibm\_runtime.Session class to create a new session and invoke one or more primitives within the session. - As a result, passing input parameters, such as `circuits`, `observables`, and `parameter_values`, as well as `service` to the constructors of `Sampler` and `Estimator` has also been deprecated. The inputs can now be passed to the `run()` method of the primitive classes, and `service` can be passed to `` `qiskit_ibm_runtime.Session `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Session](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session)>\`\_\_ when starting a new session. + As a result, passing input parameters, such as `circuits`, `observables`, and `parameter_values`, as well as `service` to the constructors of `Sampler` and `Estimator` has also been deprecated. The inputs can now be passed to the `run()` method of the primitive classes, and `service` can be passed to [qiskit\_ibm\_runtime.Session](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session) when starting a new session. -* Passing `skip_transpilation` to the :class:\`qiskit\_ibm\_runtime.Sampler and `` `qiskit_ibm_runtime.Estimator `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_ constructors has been deprecated. You can instead use the `qiskit_ibm_runtime.Options` class to specify this option. For example: +* Passing `skip_transpilation` to the :class:\`qiskit\_ibm\_runtime.Sampler and [qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) constructors has been deprecated. You can instead use the `qiskit_ibm_runtime.Options` class to specify this option. For example: ```python from qiskit_ibm_runtime import Options @@ -858,21 +888,21 @@ 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 -* When migrating from `qiskit-ibmq-provider` your `ibm_quantum` channel credentials will get automatically copied over from the qiskitrc file and a qiskit-ibm.json file will get created if one doesn’t exist. You have to just initialize `` `QiskitRuntimeService `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService)>\`\_\_ class without passing any parameters to use this copied over default `ibm_quantum` account. +* When migrating from `qiskit-ibmq-provider` your `ibm_quantum` channel credentials will get automatically copied over from the qiskitrc file and a qiskit-ibm.json file will get created if one doesn’t exist. You have to just initialize [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) class without passing any parameters to use this copied over default `ibm_quantum` account. Ex: @@ -881,25 +911,25 @@ There are significant changes to how primitives are invoked within a session, an service = QiskitRuntimeService() ``` -* `IBMEstimator` class which was deprecated earlier is now removed. Use `` `Estimator `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_ class going forward. +* `IBMEstimator` class which was deprecated earlier is now removed. Use [Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) class going forward. -* `IBMRuntimeService` class which was deprecated earlier is now removed. Use `` `QiskitRuntimeService `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService)>\`\_\_ class going forward. +* `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 -* The `service` object which is an instance of `` `QiskitRuntimeService `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService)>\`\_\_ class can now be accessed from `` `IBMBackend `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.IBMBackend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend)>\`\_\_ class using the `service` property. +* The `service` object which is an instance of [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) class can now be accessed from [IBMBackend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend) class using the `service` property. Ex: @@ -908,11 +938,11 @@ This release leverages the API and Queue enhancements to become more runtime ses backend.service # QiskitRuntimeService instance used to instantiate the backend ``` - + ### Upgrade Notes -* `` `jobs() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#jobs](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs)>\`\_\_ has two new parameters, `created_after` and `created_before`. These can be used to filter jobs by creation date in local time. +* [jobs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs) has two new parameters, `created_after` and `created_before`. These can be used to filter jobs by creation date in local time. * The parameters `circuit_indices` and `observable_indices` when calling `estimator` are now deprecated and will be removed in a future release. You can now pass either indices or objects using the `circuits` and `observables` parameters. @@ -949,27 +979,27 @@ This release leverages the API and Queue enhancements to become more runtime ses result = sampler(circuits=[qc1, qc2], parameter_values=[theta2, theta3]) ``` -* The `session_id`, which is the Job ID of the first job in a runtime session can now be used as a filter in `` `jobs() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#jobs](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs)>\`\_\_ with the parameter `session_id`. +* The `session_id`, which is the Job ID of the first job in a runtime session can now be used as a filter in [jobs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs) with the parameter `session_id`. -* `` `run() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#run](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#run)>\`\_\_ now supports a new parameter, `job_tags`. These tags can be used when filtering jobs with `` `jobs() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#jobs](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs)>\`\_\_. +* [run()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#run) now supports a new parameter, `job_tags`. These tags can be used when filtering jobs with [jobs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs). -* `` `run() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#run](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#run)>\`\_\_ now supports a new parameter, `max_execution_time`, which can be used to override the default program maximum execution time. It should be less than or equal to the program maximum execution time. +* [run()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#run) now supports a new parameter, `max_execution_time`, which can be used to override the default program maximum execution time. It should be less than or equal to the program maximum execution time. -* `` `jobs() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService#jobs](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs)>\`\_\_ has a new parameter, `descending`. This parameter defaults to `True`, where jobs will be returned in descending order based on creation date. +* [jobs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#jobs) has a new parameter, `descending`. This parameter defaults to `True`, where jobs will be returned in descending order based on creation date. -* `RuntimeJobTimeoutError` is now raised when the `timeout` set in `` `result() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#result](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#result)>\`\_\_ or `` `wait_for_final_state() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob#wait\_for\_final\_state](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#wait_for_final_state)>\`\_\_ expires. +* `RuntimeJobTimeoutError` is now raised when the `timeout` set in [result()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#result) or [wait\_for\_final\_state()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#wait_for_final_state) expires. -* When initializing `` `QiskitRuntimeService `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService)>\`\_\_ and an invalid token is used, `IBMNotAuthorizedError` will be raised instead of `RequestsApiError`. +* When initializing [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) and an invalid token is used, `IBMNotAuthorizedError` will be raised instead of `RequestsApiError`. -* `IBMSampler` class which was deprecated earlier is now removed. Use `` `Sampler `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler)>\`\_\_ class going forward. +* `IBMSampler` class which was deprecated earlier is now removed. Use [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) class going forward. -* `` `qubit_properties() `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.IBMBackend#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. +* [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 @@ -991,7 +1021,7 @@ This release leverages the API and Queue enhancements to become more runtime ses service = QiskitRuntimeService(channel="ibm_cloud", token="...", instance="...") ``` -* `IBMEstimator` class is now deprecated and will be removed in a future release. Use `` `Estimator `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_ class going forward. +* `IBMEstimator` class is now deprecated and will be removed in a future release. Use [Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) class going forward. Example: @@ -1023,7 +1053,7 @@ This release leverages the API and Queue enhancements to become more runtime ses result = estimator(circuit_indices=[0], ...) ``` -* `IBMSampler` class is now deprecated and will be removed in a future release. Use `` `Sampler `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler)>\`\_\_ class going forward. +* `IBMSampler` class is now deprecated and will be removed in a future release. Use [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) class going forward. Example: @@ -1054,55 +1084,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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService)>\`\_\_, `` `Estimator `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator)>\`\_\_ and `` `Sampler `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler)>\`\_\_ classes instead. See upgrade notes section for a detailed explanation with examples. +* `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](/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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#status)>\`\_\_ was called beforehand. +* 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 @@ -1112,13 +1142,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 @@ -1138,7 +1168,7 @@ qiskit-ibm-runtime is not included as part of Qiskit meta package and thereby yo service = IBMRuntimeService(auth="cloud", token="abc", instance="IBM Cloud CRN or Service instance name") ``` -* `` `qiskit_ibm_runtime.IBMBackend `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.IBMBackend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend)>\`\_\_ class now implements the `qiskit.providers.BackendV2` interface and provides flatter access to the configuration of a backend, for example: +* [qiskit\_ibm\_runtime.IBMBackend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend) class now implements the `qiskit.providers.BackendV2` interface and provides flatter access to the configuration of a backend, for example: ```python # BackendV1: @@ -1150,7 +1180,7 @@ qiskit-ibm-runtime is not included as part of Qiskit meta package and thereby yo Only breaking change when compared to BackendV1 is backend.name is now an attribute instead of a method. - Refer to the `` `qiskit_ibm_runtime.IBMBackend `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.IBMBackend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend)>\`\_\_ class doc string for a list of all available attributes. + Refer to the [qiskit\_ibm\_runtime.IBMBackend](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend) class doc string for a list of all available attributes. * If you used qiskit.providers.ibmq.AccountProvider.get\_backend method (for example, `provider.get_backend("ibmq_qasm_simulator")`) in the qiskit-ibmq-provider package, it’s equivalent method in this new package is `qiskit_ibm_runtime.IBMRuntimeService.backend()`: @@ -1175,47 +1205,47 @@ qiskit-ibm-runtime is not included as part of Qiskit meta package and thereby yo * qiskit.providers.ibmq.runtime.IBMRuntimeService.run\_circuits method in qiskit-ibmq-provider has been removed and will be replaced by the `Sampler` primitive program. -* `qiskit_ibm_runtime.IBMRuntimeService.run()` method now accepts runtime execution options as `` `qiskit_ibm_runtime.RuntimeOptions `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions)>\`\_\_ class in addition to already supported Dict. backend\_name, image and log\_level are the currently available options. +* `qiskit_ibm_runtime.IBMRuntimeService.run()` method now accepts runtime execution options as [qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/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](/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/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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder)>\`\_\_ and `` `qiskit_ibm_runtime.utils.json.RuntimeDecoder `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.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](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder)>\`\_\_ and `` `qiskit_ibm_runtime.utils.json.RuntimeDecoder `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeDecoder](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder)>\`\_\_ have been updated to handle these ndarrays. +* [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](/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/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 -* In order to be consistent with other properties in `` `qiskit_ibm_runtime.RuntimeJob `` \<[api/qiskit-ibm-runtime/qiskit\_ibm\_runtime.RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob)>\`\_\_ class the job\_id and backend methods have been converted to properties. +* In order to be consistent with other properties in [qiskit\_ibm\_runtime.RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) class the job\_id and backend methods have been converted to properties. * 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/runtime_service.mdx b/docs/api/qiskit-ibm-runtime/runtime_service.mdx index fc5883de13f..323e7cfe157 100644 --- a/docs/api/qiskit-ibm-runtime/runtime_service.mdx +++ b/docs/api/qiskit-ibm-runtime/runtime_service.mdx @@ -163,6 +163,7 @@ logging.getLogger('qiskit_ibm_runtime').setLevel(logging.WARNING) | [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.SamplerV1")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Sampler primitive service. | | [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.SamplerV2")(\[backend, session, 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 program execution. | | [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")(backend, api\_client, ...\[, ...]) | Representation of a runtime V2 primitive exeuction. | diff --git a/public/api/qiskit-ibm-runtime/0.22/objects.inv b/public/api/qiskit-ibm-runtime/0.22/objects.inv new file mode 100644 index 00000000000..b8adde286ab Binary files /dev/null and b/public/api/qiskit-ibm-runtime/0.22/objects.inv differ diff --git a/public/api/qiskit-ibm-runtime/dev/objects.inv b/public/api/qiskit-ibm-runtime/dev/objects.inv index a0a77487cf0..1abc047c03c 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 b8adde286ab..1abc047c03c 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.22/fake_provider-1_00.png b/public/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_00.png new file mode 100644 index 00000000000..69d83403d08 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_00.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_01.png b/public/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_01.png new file mode 100644 index 00000000000..ac2dad8b727 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_01.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_02.png new file mode 100644 index 00000000000..524e6de5182 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png new file mode 100644 index 00000000000..a26eed7507a Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png new file mode 100644 index 00000000000..0db7b6b93f0 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png new file mode 100644 index 00000000000..47ff556d048 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png new file mode 100644 index 00000000000..5fbd33ac650 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png new file mode 100644 index 00000000000..118ec8d280d Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png new file mode 100644 index 00000000000..677d65078bf Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png new file mode 100644 index 00000000000..5968bd240a1 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png new file mode 100644 index 00000000000..d044d67d611 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png new file mode 100644 index 00000000000..6669b990a37 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png new file mode 100644 index 00000000000..0b66792a672 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png new file mode 100644 index 00000000000..0b66792a672 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png new file mode 100644 index 00000000000..4b07ea377c8 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png new file mode 100644 index 00000000000..bc63d5d05e5 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png new file mode 100644 index 00000000000..38e621e254a Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png new file mode 100644 index 00000000000..b015c553886 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png b/public/images/api/qiskit-ibm-runtime/0.22/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png new file mode 100644 index 00000000000..5c8b49fcadc Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.22/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 536a2eb84b4..f101a2bbf5c 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_00.png b/public/images/api/qiskit-ibm-runtime/fake_provider-1_00.png index 69d83403d08..119c30485d0 100644 Binary files a/public/images/api/qiskit-ibm-runtime/fake_provider-1_00.png and b/public/images/api/qiskit-ibm-runtime/fake_provider-1_00.png differ diff --git a/public/images/api/qiskit-ibm-runtime/fake_provider-1_01.png b/public/images/api/qiskit-ibm-runtime/fake_provider-1_01.png index ac2dad8b727..d46e09211bb 100644 Binary files a/public/images/api/qiskit-ibm-runtime/fake_provider-1_01.png and b/public/images/api/qiskit-ibm-runtime/fake_provider-1_01.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 524e6de5182..623d044e1d6 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/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png index a26eed7507a..83f34aeac4f 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png index 0db7b6b93f0..7116587fde9 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png index 47ff556d048..b7c34798baf 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png index 5fbd33ac650..e817838751d 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png index 118ec8d280d..ea70adfae4e 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png index 677d65078bf..85294414e7e 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png index 5968bd240a1..da95e66a18f 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png index d044d67d611..97d36a6afda 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png index 6669b990a37..d2793280fa4 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png index 0b66792a672..9ecb9b01f0a 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png index 0b66792a672..9ecb9b01f0a 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png index 4b07ea377c8..82fbabcaaf1 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png index bc63d5d05e5..51d82866fef 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png index 38e621e254a..02f9be73643 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png index b015c553886..1aacb47a844 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png index 5c8b49fcadc..4b43228aee3 100644 Binary files a/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png and b/public/images/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png differ diff --git a/scripts/api-html-artifacts.json b/scripts/api-html-artifacts.json index 72837d3d284..16b052b7f08 100644 --- a/scripts/api-html-artifacts.json +++ b/scripts/api-html-artifacts.json @@ -33,7 +33,8 @@ "0.7": "https://ibm.box.com/shared/static/t2vuik7bqboata3i34r4a83baabo95xn.zip" }, "qiskit-ibm-runtime": { - "dev": "https://ibm.box.com/shared/static/y6zyxlu2hm7xu84z4ijivi5ic9impuua.zip", + "dev": "https://ibm.box.com/shared/static/bi5ycdvfcgvssm1ytyj0ussopxl8dlhh.zip", + "0.23": "https://ibm.box.com/shared/static/joc6jets564509v4vn0ls0dfiy9zokwq.zip", "0.22": "https://ibm.box.com/shared/static/97jzr5seqpevhnepyslx8xol5fcbm2aq.zip", "0.21": "https://ibm.box.com/shared/static/p5nc95ypavdaq3sk8g1ebm3h4bc1a846.zip", "0.20": "https://ibm.box.com/shared/static/0bcr09epud50i3czdx791iagumrf5bjz.zip", diff --git a/scripts/commands/checkOrphanPages.ts b/scripts/commands/checkOrphanPages.ts index 7e8a03efcff..e3cdaf86920 100644 --- a/scripts/commands/checkOrphanPages.ts +++ b/scripts/commands/checkOrphanPages.ts @@ -151,6 +151,7 @@ function apiDocsIgnores(): string[] { "0.19/", "0.20/", "0.21/", + "0.22/", "0.24/", "0.25/", "0.26/", diff --git a/scripts/lib/links/ignores.ts b/scripts/lib/links/ignores.ts index 1d39700c851..eedd272fd83 100644 --- a/scripts/lib/links/ignores.ts +++ b/scripts/lib/links/ignores.ts @@ -64,16 +64,24 @@ type FilesToIgnores = { [id: string]: string[] }; const _QPY_IGNORES = ["#f1", "#f2", "#f3", "#id2", "#id4", "#id6", "#id8"]; const _RUNTIME_OBJECT_INV = Object.fromEntries( - ["", "dev/", "0.16/", "0.17/", "0.18/", "0.19/", "0.20/", "0.21/"].map( - (vers) => [ - `public/api/qiskit-ibm-runtime/${vers}objects.inv`, - [ - `/api/qiskit-ibm-runtime/${vers}qiskit_ibm_runtime.RuntimeEncoder#key_separator`, - `/api/qiskit-ibm-runtime/${vers}index#next-steps`, - `/api/qiskit-ibm-runtime/${vers}index#qiskit-runtime-version-api-docs-preview`, - ], + [ + "", + "dev/", + "0.16/", + "0.17/", + "0.18/", + "0.19/", + "0.20/", + "0.21/", + "0.22/", + ].map((vers) => [ + `public/api/qiskit-ibm-runtime/${vers}objects.inv`, + [ + `/api/qiskit-ibm-runtime/${vers}qiskit_ibm_runtime.RuntimeEncoder#key_separator`, + `/api/qiskit-ibm-runtime/${vers}index#next-steps`, + `/api/qiskit-ibm-runtime/${vers}index#qiskit-runtime-version-api-docs-preview`, ], - ), + ]), ); const FILES_TO_IGNORES__EXPECTED: FilesToIgnores = {};