diff --git a/docs/api/qiskit-ibm-runtime/0.26/_package.json b/docs/api/qiskit-ibm-runtime/0.26/_package.json new file mode 100644 index 00000000000..df74448165f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/_package.json @@ -0,0 +1,4 @@ +{ + "name": "qiskit-ibm-runtime", + "version": "0.26.0" +} diff --git a/docs/api/qiskit-ibm-runtime/0.26/_toc.json b/docs/api/qiskit-ibm-runtime/0.26/_toc.json new file mode 100644 index 00000000000..8b5cb9529a5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/_toc.json @@ -0,0 +1,625 @@ +{ + "title": "Qiskit Runtime IBM Client", + "children": [ + { + "title": "API index", + "url": "/api/qiskit-ibm-runtime/0.26" + }, + { + "title": "qiskit_ibm_runtime", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.26/runtime_service" + }, + { + "title": "Batch", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Batch" + }, + { + "title": "EstimatorV1", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.EstimatorV1" + }, + { + "title": "EstimatorV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.EstimatorV2" + }, + { + "title": "IBMBackend", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.IBMBackend" + }, + { + "title": "QiskitRuntimeService", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.QiskitRuntimeService" + }, + { + "title": "RuntimeDecoder", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeDecoder" + }, + { + "title": "RuntimeEncoder", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeEncoder" + }, + { + "title": "RuntimeJob", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeJob" + }, + { + "title": "RuntimeJobV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeJobV2" + }, + { + "title": "SamplerV1", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.SamplerV1" + }, + { + "title": "SamplerV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.SamplerV2" + }, + { + "title": "Session", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Session" + } + ] + }, + { + "title": "qiskit_ibm_runtime.fake_provider", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.26/fake_provider" + }, + { + "title": "FakeAlgiers", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlgiers" + }, + { + "title": "FakeAlmaden", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlmaden" + }, + { + "title": "FakeAlmadenV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2" + }, + { + "title": "FakeArmonk", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeArmonk" + }, + { + "title": "FakeArmonkV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeArmonkV2" + }, + { + "title": "FakeAthens", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAthens" + }, + { + "title": "FakeAthensV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAthensV2" + }, + { + "title": "FakeAuckland", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAuckland" + }, + { + "title": "FakeBelem", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBelem" + }, + { + "title": "FakeBelemV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBelemV2" + }, + { + "title": "FakeBoeblingen", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBoeblingen" + }, + { + "title": "FakeBoeblingenV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2" + }, + { + "title": "FakeBogota", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBogota" + }, + { + "title": "FakeBogotaV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBogotaV2" + }, + { + "title": "FakeBrisbane", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrisbane" + }, + { + "title": "FakeBrooklyn", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrooklyn" + }, + { + "title": "FakeBrooklynV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2" + }, + { + "title": "FakeBurlington", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBurlington" + }, + { + "title": "FakeBurlingtonV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2" + }, + { + "title": "FakeCairo", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCairo" + }, + { + "title": "FakeCairoV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCairoV2" + }, + { + "title": "FakeCambridge", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCambridge" + }, + { + "title": "FakeCambridgeV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2" + }, + { + "title": "FakeCasablanca", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCasablanca" + }, + { + "title": "FakeCasablancaV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2" + }, + { + "title": "FakeCusco", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCusco" + }, + { + "title": "FakeEssex", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeEssex" + }, + { + "title": "FakeEssexV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeEssexV2" + }, + { + "title": "FakeFractionalBackend", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend" + }, + { + "title": "FakeGeneva", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGeneva" + }, + { + "title": "FakeGuadalupe", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGuadalupe" + }, + { + "title": "FakeGuadalupeV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2" + }, + { + "title": "FakeHanoi", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeHanoi" + }, + { + "title": "FakeHanoiV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeHanoiV2" + }, + { + "title": "FakeJakarta", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJakarta" + }, + { + "title": "FakeJakartaV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJakartaV2" + }, + { + "title": "FakeJohannesburg", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJohannesburg" + }, + { + "title": "FakeJohannesburgV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2" + }, + { + "title": "FakeKawasaki", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKawasaki" + }, + { + "title": "FakeKolkata", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKolkata" + }, + { + "title": "FakeKolkataV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKolkataV2" + }, + { + "title": "FakeKyiv", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKyiv" + }, + { + "title": "FakeKyoto", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKyoto" + }, + { + "title": "FakeLagos", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLagos" + }, + { + "title": "FakeLagosV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLagosV2" + }, + { + "title": "FakeLima", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLima" + }, + { + "title": "FakeLimaV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLimaV2" + }, + { + "title": "FakeLondon", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLondon" + }, + { + "title": "FakeLondonV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLondonV2" + }, + { + "title": "FakeManhattan", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManhattan" + }, + { + "title": "FakeManhattanV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManhattanV2" + }, + { + "title": "FakeManila", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManila" + }, + { + "title": "FakeManilaV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManilaV2" + }, + { + "title": "FakeMelbourne", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMelbourne" + }, + { + "title": "FakeMelbourneV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2" + }, + { + "title": "FakeMontreal", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMontreal" + }, + { + "title": "FakeMontrealV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMontrealV2" + }, + { + "title": "FakeMumbai", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMumbai" + }, + { + "title": "FakeMumbaiV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2" + }, + { + "title": "FakeNairobi", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeNairobi" + }, + { + "title": "FakeNairobiV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeNairobiV2" + }, + { + "title": "FakeOsaka", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOsaka" + }, + { + "title": "FakeOslo", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOslo" + }, + { + "title": "FakeOurense", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOurense" + }, + { + "title": "FakeOurenseV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOurenseV2" + }, + { + "title": "FakeParis", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeParis" + }, + { + "title": "FakeParisV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeParisV2" + }, + { + "title": "FakePeekskill", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePeekskill" + }, + { + "title": "FakePerth", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePerth" + }, + { + "title": "FakePoughkeepsie", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie" + }, + { + "title": "FakePoughkeepsieV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2" + }, + { + "title": "FakePrague", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePrague" + }, + { + "title": "FakeProvider", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeProvider" + }, + { + "title": "FakeProviderForBackendV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2" + }, + { + "title": "FakeQuebec", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuebec" + }, + { + "title": "FakeQuito", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuito" + }, + { + "title": "FakeQuitoV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuitoV2" + }, + { + "title": "FakeRochester", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRochester" + }, + { + "title": "FakeRochesterV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRochesterV2" + }, + { + "title": "FakeRome", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRome" + }, + { + "title": "FakeRomeV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRomeV2" + }, + { + "title": "FakeRueschlikon", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRueschlikon" + }, + { + "title": "FakeSantiago", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSantiago" + }, + { + "title": "FakeSantiagoV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2" + }, + { + "title": "FakeSherbrooke", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSherbrooke" + }, + { + "title": "FakeSingapore", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSingapore" + }, + { + "title": "FakeSingaporeV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2" + }, + { + "title": "FakeSydney", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSydney" + }, + { + "title": "FakeSydneyV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSydneyV2" + }, + { + "title": "FakeTenerife", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTenerife" + }, + { + "title": "FakeTokyo", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTokyo" + }, + { + "title": "FakeTorino", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTorino" + }, + { + "title": "FakeToronto", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeToronto" + }, + { + "title": "FakeTorontoV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTorontoV2" + }, + { + "title": "FakeValencia", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeValencia" + }, + { + "title": "FakeValenciaV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeValenciaV2" + }, + { + "title": "FakeVigo", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeVigo" + }, + { + "title": "FakeVigoV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeVigoV2" + }, + { + "title": "FakeWashington", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeWashington" + }, + { + "title": "FakeWashingtonV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2" + }, + { + "title": "FakeYorktown", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeYorktown" + }, + { + "title": "FakeYorktownV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeYorktownV2" + } + ] + }, + { + "title": "qiskit_ibm_runtime.noise_learner", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.26/noise_learner" + }, + { + "title": "NoiseLearner", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.noise_learner.NoiseLearner" + } + ] + }, + { + "title": "qiskit_ibm_runtime.options", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.26/options" + }, + { + "title": "DynamicalDecouplingOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.DynamicalDecouplingOptions" + }, + { + "title": "EnvironmentOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.EnvironmentOptions" + }, + { + "title": "EstimatorOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.EstimatorOptions" + }, + { + "title": "ExecutionOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ExecutionOptions" + }, + { + "title": "ExecutionOptionsV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ExecutionOptionsV2" + }, + { + "title": "LayerNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.LayerNoiseLearningOptions" + }, + { + "title": "MeasureNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions" + }, + { + "title": "Options", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.Options" + }, + { + "title": "PecOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.PecOptions" + }, + { + "title": "ResilienceOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ResilienceOptions" + }, + { + "title": "ResilienceOptionsV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ResilienceOptionsV2" + }, + { + "title": "SamplerExecutionOptionsV2", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2" + }, + { + "title": "SamplerOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SamplerOptions" + }, + { + "title": "SimulatorOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SimulatorOptions" + }, + { + "title": "TranspilationOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.TranspilationOptions" + }, + { + "title": "TwirlingOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.TwirlingOptions" + }, + { + "title": "ZneOptions", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ZneOptions" + } + ] + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.26/transpiler" + }, + { + "title": "ConvertIdToDelay", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay" + } + ] + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes.scheduling", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling" + }, + { + "title": "ALAPScheduleAnalysis", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis" + }, + { + "title": "ASAPScheduleAnalysis", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis" + }, + { + "title": "BlockBasePadder", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder" + }, + { + "title": "DynamicCircuitInstructionDurations", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations" + }, + { + "title": "PadDelay", + "url": "/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay" + }, + { + "title": "PadDynamicalDecoupling", + "url": "/api/qiskit-ibm-runtime/0.26/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.26/fake_provider.mdx b/docs/api/qiskit-ibm-runtime/0.26/fake_provider.mdx new file mode 100644 index 00000000000..d1cc26d4cfd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/fake_provider.mdx @@ -0,0 +1,203 @@ +--- +title: fake_provider +description: API reference for qiskit_ibm_runtime.fake_provider +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.fake_provider +--- + + + + + +# Fake Provider + + + +`qiskit_ibm_runtime.fake_provider` + +## Overview + +The fake provider module contains fake providers and fake backends classes. The fake backends are built to mimic the behaviors of IBM Quantum systems using system snapshots. The system snapshots contain important information about the quantum system such as coupling map, basis gates, qubit properties (T1, T2, error rate, etc.) which are useful for testing the transpiler and performing noisy simulations of the system. + +## Example Usage + +Here is an example of using a fake backend for transpilation and simulation. + +```python +from qiskit import QuantumCircuit +from qiskit import transpile +from qiskit.visualization import plot_histogram +from qiskit_ibm_runtime import SamplerV2 +from qiskit_ibm_runtime.fake_provider import FakeManilaV2 + +# Get a fake backend from the fake provider +backend = FakeManilaV2() + +# Create a simple circuit +circuit = QuantumCircuit(3) +circuit.h(0) +circuit.cx(0,1) +circuit.cx(0,2) +circuit.measure_all() +circuit.draw('mpl', style="iqp") + +# Transpile the ideal circuit to a circuit that can be directly executed by the backend +transpiled_circuit = transpile(circuit, backend) +transpiled_circuit.draw('mpl', style="iqp") + +# Run the transpiled circuit using the simulated fake backend +sampler = SamplerV2(backend) +job = sampler.run([transpiled_circuit]) +pub_result = job.result()[0] +counts = pub_result.data.meas.get_counts() +plot_histogram(counts) +``` + +![../\_images/fake\_provider-1\_00.png](/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_00.png) + +![../\_images/fake\_provider-1\_01.png](/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_01.png) + +![../\_images/fake\_provider-1\_02.png](/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_02.png) + + + Please note that the simulation is done using a noise model generated from system snapshots obtained in the past (sometimes a few years ago) and the results are not representative of the latest behaviours of the real quantum system which the fake backend is mimicking. If you want to run noisy simulations to compare with the real quantum system, you should use the `qiskit_aer` library. After installation, you can follow the steps below to generate a simulator that mimics a real quantum system with the latest calibration results. + + ```python + from qiskit_ibm_runtime import QiskitRuntimeService + from qiskit_aer import AerSimulator + + # get a real backend from the runtime service + service = QiskitRuntimeService() + backend = service.backend('ibmq_manila') + + # generate a simulator that mimics the real quantum system with the latest calibration results + backend_sim = AerSimulator.from_backend(backend) + ``` + + +## Fake Providers + +Fake providers provide access to a list of fake backends. + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | +| [`FakeProviderForBackendV2`](qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 "qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2")() | Fake provider containing fake V2 backends. | +| [`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. | +| [`FakeFractionalBackend`](qiskit_ibm_runtime.fake_provider.FakeFractionalBackend "qiskit_ibm_runtime.fake_provider.FakeFractionalBackend")() | A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima. | +| [`FakeLondonV2`](qiskit_ibm_runtime.fake_provider.FakeLondonV2 "qiskit_ibm_runtime.fake_provider.FakeLondonV2")() | A fake 5 qubit backend. | +| [`FakeManhattanV2`](qiskit_ibm_runtime.fake_provider.FakeManhattanV2 "qiskit_ibm_runtime.fake_provider.FakeManhattanV2")() | A fake Manhattan backend. | +| [`FakeManilaV2`](qiskit_ibm_runtime.fake_provider.FakeManilaV2 "qiskit_ibm_runtime.fake_provider.FakeManilaV2")() | A fake 5 qubit backend. | +| [`FakeMelbourneV2`](qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2")() | A fake 14 qubit backend. | +| [`FakeMontrealV2`](qiskit_ibm_runtime.fake_provider.FakeMontrealV2 "qiskit_ibm_runtime.fake_provider.FakeMontrealV2")() | A fake 27 qubit backend. | +| [`FakeMumbaiV2`](qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2")() | A fake 27 qubit backend. | +| [`FakeNairobiV2`](qiskit_ibm_runtime.fake_provider.FakeNairobiV2 "qiskit_ibm_runtime.fake_provider.FakeNairobiV2")() | A fake 7 qubit backend. | +| [`FakeOsaka`](qiskit_ibm_runtime.fake_provider.FakeOsaka "qiskit_ibm_runtime.fake_provider.FakeOsaka")() | A fake 127 qubit backend. | +| [`FakeOslo`](qiskit_ibm_runtime.fake_provider.FakeOslo "qiskit_ibm_runtime.fake_provider.FakeOslo")() | A fake 7 qubit backend. | +| [`FakeOurenseV2`](qiskit_ibm_runtime.fake_provider.FakeOurenseV2 "qiskit_ibm_runtime.fake_provider.FakeOurenseV2")() | A fake 5 qubit backend. | +| [`FakeParisV2`](qiskit_ibm_runtime.fake_provider.FakeParisV2 "qiskit_ibm_runtime.fake_provider.FakeParisV2")() | A fake Paris backend. | +| [`FakePeekskill`](qiskit_ibm_runtime.fake_provider.FakePeekskill "qiskit_ibm_runtime.fake_provider.FakePeekskill")() | A fake 27 qubit backend. | +| [`FakePerth`](qiskit_ibm_runtime.fake_provider.FakePerth "qiskit_ibm_runtime.fake_provider.FakePerth")() | A fake 7 qubit backend. | +| [`FakePrague`](qiskit_ibm_runtime.fake_provider.FakePrague "qiskit_ibm_runtime.fake_provider.FakePrague")() | A fake 33 qubit backend. | +| [`FakePoughkeepsieV2`](qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 "qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2")() | A fake Poughkeepsie backend. | +| [`FakeQuebec`](qiskit_ibm_runtime.fake_provider.FakeQuebec "qiskit_ibm_runtime.fake_provider.FakeQuebec")() | A fake 127 qubit backend. | +| [`FakeQuitoV2`](qiskit_ibm_runtime.fake_provider.FakeQuitoV2 "qiskit_ibm_runtime.fake_provider.FakeQuitoV2")() | A fake 5 qubit backend. | +| [`FakeRochesterV2`](qiskit_ibm_runtime.fake_provider.FakeRochesterV2 "qiskit_ibm_runtime.fake_provider.FakeRochesterV2")() | A fake Rochester backend. | +| [`FakeRomeV2`](qiskit_ibm_runtime.fake_provider.FakeRomeV2 "qiskit_ibm_runtime.fake_provider.FakeRomeV2")() | A fake 5 qubit backend. | +| [`FakeSantiagoV2`](qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 "qiskit_ibm_runtime.fake_provider.FakeSantiagoV2")() | A fake Santiago backend. | +| [`FakeSherbrooke`](qiskit_ibm_runtime.fake_provider.FakeSherbrooke "qiskit_ibm_runtime.fake_provider.FakeSherbrooke")() | A fake 127 qubit backend. | +| [`FakeSingaporeV2`](qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 "qiskit_ibm_runtime.fake_provider.FakeSingaporeV2")() | A fake Singapore backend. | +| [`FakeSydneyV2`](qiskit_ibm_runtime.fake_provider.FakeSydneyV2 "qiskit_ibm_runtime.fake_provider.FakeSydneyV2")() | A fake 27 qubit backend. | +| [`FakeTorino`](qiskit_ibm_runtime.fake_provider.FakeTorino "qiskit_ibm_runtime.fake_provider.FakeTorino")() | A fake 133 qubit backend. | +| [`FakeTorontoV2`](qiskit_ibm_runtime.fake_provider.FakeTorontoV2 "qiskit_ibm_runtime.fake_provider.FakeTorontoV2")() | A fake 27 qubit backend. | +| [`FakeValenciaV2`](qiskit_ibm_runtime.fake_provider.FakeValenciaV2 "qiskit_ibm_runtime.fake_provider.FakeValenciaV2")() | A fake 5 qubit backend. | +| [`FakeVigoV2`](qiskit_ibm_runtime.fake_provider.FakeVigoV2 "qiskit_ibm_runtime.fake_provider.FakeVigoV2")() | A fake 5 qubit backend. | +| [`FakeWashingtonV2`](qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 "qiskit_ibm_runtime.fake_provider.FakeWashingtonV2")() | A fake 127 qubit backend. | +| [`FakeYorktownV2`](qiskit_ibm_runtime.fake_provider.FakeYorktownV2 "qiskit_ibm_runtime.fake_provider.FakeYorktownV2")() | A fake 5 qubit backend. | + +### 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.26/index.mdx b/docs/api/qiskit-ibm-runtime/0.26/index.mdx new file mode 100644 index 00000000000..d1ea67f60e3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/index.mdx @@ -0,0 +1,14 @@ +--- +title: Qiskit Runtime IBM Client API Docs +description: API documentation for the qiskit-ibm-runtime client +--- + +# qiskit-ibm-runtime API reference + +* [Qiskit Runtime (`qiskit_ibm_runtime`)](runtime_service) +* [Noise learner (`qiskit_ibm_runtime.noise_learner.NoiseLearner`)](noise_learner) +* [Primitive options (`qiskit_ibm_runtime.options`)](options) +* [Transpiler passes (`qiskit_ibm_runtime.transpiler.passes`)](transpiler) +* [Transpiler scheduling passes (`qiskit_ibm_runtime.transpiler.passes.scheduling`)](qiskit_ibm_runtime.transpiler.passes.scheduling) +* [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider) + diff --git a/docs/api/qiskit-ibm-runtime/0.26/noise_learner.mdx b/docs/api/qiskit-ibm-runtime/0.26/noise_learner.mdx new file mode 100644 index 00000000000..a9ba3de57a0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/noise_learner.mdx @@ -0,0 +1,26 @@ +--- +title: noise_learner +description: API reference for qiskit_ibm_runtime.noise_learner +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.noise_learner +--- + + + + + +# Noise learner + + + +`qiskit_ibm_runtime.noise_learner.NoiseLearner` + +The tools to characterize the noise processes affecting the gates in noisy quantum circuits. + +## Classes + +| | | +| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| [`NoiseLearner`](qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner")(\[mode, options]) | Class for executing noise learning experiments. | + diff --git a/docs/api/qiskit-ibm-runtime/0.26/options.mdx b/docs/api/qiskit-ibm-runtime/0.26/options.mdx new file mode 100644 index 00000000000..1619e0043d1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/options.mdx @@ -0,0 +1,108 @@ +--- +title: options +description: API reference for qiskit_ibm_runtime.options +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.options +--- + + + + + +# Primitive options + + + +`qiskit_ibm_runtime.options` + +Options that can be passed to the Qiskit Runtime primitives. + +## V2 Primitives + +`SamplerV2` and `EstimatorV2` each have their own options. You can use the `options` attribute to set the options. For example: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) +estimator = EstimatorV2(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. Refer to this current module’s documentation for the latest defaults. + + +## 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 + +### Base primitive options + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | +| [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions")(\*args, \*\*kwargs) | Options for V2 Estimator. | +| [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions")(\*args, \*\*kwargs) | Options for V2 Sampler. | +| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for V1 primitives. | + +### Suboptions for V2 primitives only + +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\*args, \*\*kwargs) | Options for dynamical decoupling (DD). | +| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\*args, \*\*kwargs) | Resilience options for V2 Estimator. | +| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\*args, \*\*kwargs) | Options for learning layer noise. | +| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\*args, \*\*kwargs) | Options for measurement noise learning. | +| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\*args, \*\*kwargs) | Probabalistic error cancellation mitigation options. | +| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\*args, \*\*kwargs) | Zero noise extrapolation mitigation options. | +| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\*args, \*\*kwargs) | Twirling options. | +| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\*args, \*\*kwargs) | Execution options for V2 primitives. | +| [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2")(\*args, \*\*kwargs) | Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. | + +### Suboptions for both V1 and V2 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. | + +### Suboptions for V1 primitives only + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\*args, \*\*kwargs) | Transpilation options. | +| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\*args, \*\*kwargs) | Execution options for V1 primitives. | +| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\*args, \*\*kwargs) | Resilience options for V1 primitives. | + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Batch.mdx new file mode 100644 index 00000000000..9650f307780 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Batch.mdx @@ -0,0 +1,232 @@ +--- +title: Batch +description: API reference for qiskit_ibm_runtime.Batch +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.Batch +--- + +# Batch + + + Class for running jobs in batch execution mode. + + The `batch` mode is designed to efficiently perform experiments that comprise multiple independent jobs. + + **Using the `batch` mode provides the following benefits:** + + * The jobs’ classical computation, such as compilation, is run in parallel. Thus, running multiple jobs in a batch is significantly faster than running them serially. + * There is usually minimal delay between job, which can help avoid drift. + * If you partition your workload into multiple jobs and run them in `batch` mode, you can get results from individual jobs, which makes them more flexible to work with. For example, if a job’s results do not meet your expectations, you can cancel the remaining jobs, or simply re-submit that individual job and avoid re-running the entire workload. + + All jobs need to be provided at the outset. To submit iterative jobs, use the `session` mode instead. + + You can open a Qiskit Runtime batch by using this `Batch` class, then submit jobs to one or more primitives. + + For example: + + ```python + from qiskit.circuit.random import random_circuit + from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + from qiskit_ibm_runtime import Batch, SamplerV2 as Sampler, QiskitRuntimeService + + service = QiskitRuntimeService() + backend = service.least_busy(operational=True, simulator=False) + pm = generate_preset_pass_manager(backend=backend, optimization_level=1) + + # generate fifty unique three-qubit random circuits + circuits = [pm.run(random_circuit(3, 2, measure=True)) for _ in range(50)] + + # split up the list of circuits into partitions + max_circuits = 10 + partitions = [circuits[i : i + max_circuits] for i in range(0, len(circuits), max_circuits)] + + # run the circuits in batched mode + with Batch(backend=backend): + sampler = Sampler() + for partition in partitions: + job = sampler.run(partition) + pub_result = job.result()[0] + print(f"Sampler job ID: {job.job_id()}") + print(f"Counts for the first PUB: {pub_result.data.cr.get_counts()}") + ``` + + For more details, check the “[Run jobs in a batch](/run/run-jobs-batch)” tutorial. + + Batch constructor. + + **Parameters** + + * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. + * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – Instance of `Backend` class or backend string name. Note that passing a backend name is deprecated. + * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/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. + + **Return type** + + `Optional`\[`Dict`\[`str`, `Any`]] + + **Returns** + + A dictionary with the sessions details. + + * `id`: id of the session. + * `backend_name`: backend used for the session. + * `interactive_timeout`: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated. + * `max_time`: Maximum allowed time (in seconds) for the session, subject to plan limits. + * `active_timeout`: The maximum time (in seconds) a session can stay active. + * `state`: State of the session - open, active, inactive, or closed. + * `accepting_jobs`: Whether or not the session is accepting jobs. + * `last_job_started`: Timestamp of when the last job in the session started. + * `last_job_completed`: Timestamp of when the last job in the session completed. + * `started_at`: Timestamp of when the session was started. + * `closed_at`: Timestamp of when the session was closed. + * `activated_at`: Timestamp of when the session state was changed to active. + * `mode`: Execution mode of the session. + * `usage_time`: The usage time, in seconds, of this Session or Batch. Usage is defined as the time a quantum system is committed to complete a job. + + + ### from\_id + + + Construct a Session object with a given session\_id + + **Parameters** + + * **session\_id** (`str`) – the id of the session to be created. This must be an already existing session id. + + * **service** (`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. + * **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. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Session status as a string. + + * `Pending`: Session is created but not active. It will become active when the next job of this session is dequeued. + * `In progress, accepting new jobs`: session is active and accepting new jobs. + * `In progress, not accepting new jobs`: session is active and not accepting new jobs. + * `Closed`: max\_time expired or session was explicitly closed. + * `None`: status details are not available. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Estimator.mdx new file mode 100644 index 00000000000..6f7f53bcf81 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.EstimatorV1.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.EstimatorV1.mdx new file mode 100644 index 00000000000..b0de857f90f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.EstimatorV1.mdx @@ -0,0 +1,139 @@ +--- +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. + + + The `EstimatorV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/api/migration-guides/v2-primitives). for more details. The `EstimatorV1` support will be removed no earlier than July 15, 2024. + + + 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`](/api/qiskit/qiskit.providers.Options "(in Qiskit v1.1)") :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`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)") or a list of (parameterized) [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"). + * **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. + + **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`](/api/qiskit/qiskit.primitives.EstimatorResult "(in Qiskit v1.1)"). + + **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.26/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.EstimatorV2.mdx new file mode 100644 index 00000000000..a6a082f5102 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.EstimatorV2.mdx @@ -0,0 +1,145 @@ +--- +title: EstimatorV2 +description: API reference for qiskit_ibm_runtime.EstimatorV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.EstimatorV2 +--- + +# EstimatorV2 + + + Class for interacting with Qiskit Runtime Estimator primitive service. + + Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. + + The [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. + + Following construction, an estimator is used by calling its [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") method with a list of PUBs (Primitive Unified Blocs). Each PUB contains four values that, together, define a computation unit of work for the estimator to complete: + + * a single [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), 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** + + * **mode** (`Union`\[[`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.batch.Batch"), `str`, `None`]) – + + The execution mode used to make the primitive query. It can be: + + * A `Backend` if you are using job mode. + * A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode. + * A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode. + + Refer to the [Qiskit Runtime documentation](/run). for more information about the `Execution modes`. + + * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – (DEPRECATED) 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")]) – + + (DEPRECATED) 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 + + ### mode + + + Return the execution mode used by this primitive. + + **Return type** + + Optional\[[Session](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") | [Batch](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")] + + **Returns** + + Mode used by this primitive, or `None` if an execution mode is not used. + + + ### options + + + Return options + + **Return type** + + `TypeVar`(`OptionsT`, bound= `BaseOptions`) + + + ### 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.26/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.IBMBackend.mdx new file mode 100644 index 00000000000..2eec9c000e0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.IBMBackend.mdx @@ -0,0 +1,689 @@ +--- +title: IBMBackend +description: API reference for qiskit_ibm_runtime.IBMBackend +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.IBMBackend +--- + +# IBMBackend + + + Backend class interfacing with an IBM Quantum backend. + + + * You should not instantiate the `IBMBackend` class directly. Instead, use the methods provided by an [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") instance to retrieve and handle backends. + + + This class represents an IBM Quantum backend. Its attributes and methods provide information about the backend. For example, the [`status()`](#qiskit_ibm_runtime.IBMBackend.status "qiskit_ibm_runtime.IBMBackend.status") method returns a `BackendStatus` instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: + + ```python + status = backend.status() + is_operational = status.operational + jobs_in_queue = status.pending_jobs + ``` + + Here is list of attributes available on the `IBMBackend` class: + + > * name: backend name. + > + > * backend\_version: backend version in the form X.Y.Z. + > + > * num\_qubits: number of qubits. + > + > * target: A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + > + > * basis\_gates: list of basis gates names on the backend. + > + > * gates: list of basis gates on the backend. + > + > * local: backend is local or remote. + > + > * simulator: backend is a simulator. + > + > * conditional: backend supports conditional operations. + > + > * open\_pulse: backend supports open pulse. + > + > * memory: backend supports memory. + > + > * max\_shots: maximum number of shots supported. + > + > * coupling\_map (list): The coupling map for the device + > + > * supported\_instructions (List\[str]): Instructions supported by the backend. + > + > * dynamic\_reprate\_enabled (bool): whether delay between primitives can be set dynamically (ie via `rep_delay`). Defaults to False. + > + > * rep\_delay\_range (List\[float]): 2d list defining supported range of repetition delays for backend in μs. First entry is lower end of the range, second entry is higher end of the range. Optional, but will be specified when `dynamic_reprate_enabled=True`. + > + > * default\_rep\_delay (float): Value of `rep_delay` if not specified by user and `dynamic_reprate_enabled=True`. + > + > * n\_uchannels: Number of u-channels. + > + > * u\_channel\_lo: U-channel relationship on device los. + > + > * meas\_levels: Supported measurement levels. + > + > * qubit\_lo\_range: Qubit lo ranges for each qubit with form (min, max) in GHz. + > + > * meas\_lo\_range: Measurement lo ranges for each qubit with form (min, max) in GHz. + > + > * dt: Qubit drive channel timestep in nanoseconds. + > + > * dtm: Measurement drive channel timestep in nanoseconds. + > + > * rep\_times: Supported repetition times (program execution time) for backend in μs. + > + > * meas\_kernels: Supported measurement kernels. + > + > * discriminators: Supported discriminators. + > + > * hamiltonian: An optional dictionary with fields characterizing the system hamiltonian. + > + > * channel\_bandwidth (list): Bandwidth of all channels (qubit, measurement, and U) + > + > * acquisition\_latency (list): Array of dimension n\_qubits x n\_registers. Latency (in units of dt) to write a measurement result from qubit n into register slot m. + > + > * conditional\_latency (list): Array of dimension n\_channels \[d->u->m] x n\_registers. Latency (in units of dt) to do a conditional operation on channel n from register slot m + > + > * meas\_map (list): Grouping of measurement which are multiplexed + > + > * max\_circuits (int): The maximum number of experiments per job + > + > * sample\_name (str): Sample name for the backend + > + > * n\_registers (int): Number of register slots available for feedback (if conditional is True) + > + > * register\_map (list): An array of dimension n\_qubits X n\_registers that specifies whether a qubit can store a measurement in a certain register slot. + > + > * configurable (bool): True if the backend is configurable, if the backend is a simulator + > + > * credits\_required (bool): True if backend requires credits to run a job. + > + > * online\_date (datetime): The date that the device went online + > + > * display\_name (str): Alternate name field for the backend + > + > * description (str): A description for the backend + > + > * tags (list): A list of string tags to describe the backend + > + > * version: version of `Backend` class (Ex: 1, 2) + > + > * channels: An optional dictionary containing information of each channel – their purpose, type, and qubits operated on. + > + > * parametric\_pulses (list): A list of pulse shapes which are supported on the backend. For example: `['gaussian', 'constant']` + > + > * processor\_type (dict): Processor type for this backend. A dictionary of the form `{"family": , "revision": , segment: }` such as `{"family": "Canary", "revision": "1.0", segment: "A"}`. + > + > > * family: Processor family of this backend. + > > * revision: Revision version of this processor. + > > * segment: Segment this processor belongs to within a larger chip. + + IBMBackend constructor. + + **Parameters** + + * **configuration** (`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]) – Backend configuration. + * **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Instance of QiskitRuntimeService. + * **api\_client** (`RuntimeClient`) – IBM client used to communicate with the server. + + ## Attributes + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Returns** + + The output signal timestep in seconds. + + **Return type** + + dtm + + + ### id\_warning\_issued + + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + The maximum number of circuits + + The maximum number of circuits (or Pulse schedules) that can be run in a single job. If there is no limit this will return None. + + **Return type** + + `int` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The grouping of measurements which are multiplexed + + **Return type** + + meas\_map + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.IBMBackend.run "qiskit_ibm_runtime.IBMBackend.run") method. + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### service + + + Return the `service` object + + **Returns** + + instance of QiskitRuntimeService + + **Return type** + + service + + + ### session + + + Return session + + **Return type** + + `Session` + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") + + **Returns** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### \_\_call\_\_ + + + Call self as a function. + + **Return type** + + [`IBMBackend`](#qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend") + + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### cancel\_session + + + Cancel session. All pending jobs will be cancelled. + + **Return type** + + `None` + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – 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 + + + ### get\_translation\_stage\_plugin + + + Return the default translation stage plugin name for IBM backends. + + **Return type** + + `str` + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### open\_session + + + Open session + + **Return type** + + `Session` + + + ### properties + + + Return the backend properties, subject to optional filtering. + + This data describes qubits properties (such as T1 and T2), gates properties (such as gate length and error), and other general properties of the backend. + + The schema for backend properties can be found in [Qiskit/ibm-quantum-schemas/backend\_properties](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_properties_schema.json). + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version. + * **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the `BackendProperties` whose timestamp is closest to, but older than, the specified datetime. Note that this is only supported using `ibm_quantum` runtime. + + **Return type** + + `Optional`\[`BackendProperties`] + + **Returns** + + The backend properties or `None` if the backend properties are not currently available. + + **Raises** + + * **TypeError** – If an input argument is not of the correct type. + * **NotImplementedError** – If datetime is specified when cloud runtime is used. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### run + + + Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. + + **Parameters** + + * **circuits** (`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), `str`, `List`\[`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), `str`]]]) – An individual or a list of `QuantumCircuit`. + + * **dynamic** (`Optional`\[`bool`]) – Whether the circuit is dynamic (uses in-circuit conditionals) + + * **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call. + + * **init\_circuit** (`Optional`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")]) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified. + + * **init\_num\_resets** (`Optional`\[`int`]) – The number of qubit resets to insert before each circuit execution. + + * **header** (`Optional`\[`Dict`]) – User input that will be attached to the job and will be copied to the corresponding result header. Headers do not affect the run. This replaces the old `Qobj` header. This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **shots** (`Union`\[`int`, `float`, `None`]) – Number of repetitions of each circuit, for sampling. Default: 4000 or `max_shots` from the backend configuration, whichever is smaller. This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **memory** (`Optional`\[`bool`]) – If `True`, per-shot measurement bitstrings are returned as well (provided the backend supports it). For OpenPulse jobs, only measurement level 2 supports this option. This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) – + + Level of the measurement output for pulse experiments. See [OpenPulse specification](https://arxiv.org/pdf/1809.03452.pdf) for details: + + * `0`, measurements of the raw signal (the measurement output pulse envelope) + * `1`, measurement kernel is selected (a complex number obtained after applying the measurement kernel to the measurement output signal) + * `2` (default), a discriminator is selected and the qubit state is stored (0 or 1) + + This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **meas\_return** (`Union`\[`str`, `MeasReturnType`, `None`]) – + + Level of measurement data for the backend to return. For `meas_level` 0 and 1: + + * `single` returns information from every shot. + * `avg` returns average measurement output (averaged over number of shots). + + This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **rep\_delay** (`Optional`\[`float`]) – Delay between primitives in seconds. Only supported on certain backends (if `backend.configuration().dynamic_reprate_enabled=True`). If supported, `rep_delay` must be from the range supplied by the backend (`backend.configuration().rep_delay_range`). Default is given by `backend.configuration().default_rep_delay`. This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **init\_qubits** (`Optional`\[`bool`]) – Whether to reset the qubits to the ground state for each shot. Default: `True`. This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **use\_measure\_esp** (`Optional`\[`bool`]) – Whether to use excited state promoted (ESP) readout for measurements which are the terminal instruction to a qubit. ESP readout can offer higher fidelity than standard measurement sequences. See [here](https://arxiv.org/pdf/2008.08571.pdf). Default: `True` if backend supports ESP readout, else `False`. Backend support for ESP readout is determined by the flag `measure_esp_enabled` in `backend.configuration()`. This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **noise\_model** (`Optional`\[`Any`]) – Noise model (Simulators only). This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **seed\_simulator** (`Optional`\[`int`]) – Random seed to control sampling (Simulators only). This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + * **\*\*run\_config** – Extra arguments used to configure the run. This parameter is applicable only if `dynamic=False` is specified or defaulted to. + + **Return type** + + [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") + + **Returns** + + The job to be executed. + + **Raises** + + * **IBMBackendApiError** – If an unexpected error occurred while submitting the job. + + * **IBMBackendApiProtocolError** – If an unexpected value received from the server. + + * **IBMBackendValueError** – + + * If an input parameter value is not valid. - If ESP readout is used and the backend does not support this. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + + If the returned `BackendStatus` instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them. + + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + **Raises** + + **IBMBackendApiProtocolError** – If the status for the backend cannot be formatted properly. + + + ### target\_history + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") + + **Returns** + + Target with properties found on datetime + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.QiskitRuntimeService.mdx new file mode 100644 index 00000000000..647d600ee63 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -0,0 +1,441 @@ +--- +title: QiskitRuntimeService +description: API reference for qiskit_ibm_runtime.QiskitRuntimeService +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.QiskitRuntimeService +--- + +# QiskitRuntimeService + + + Class for interacting with the Qiskit Runtime service. + + QiskitRuntimeService constructor + + An account is selected in the following order: + + > * Account with the input name, if specified. + > * Default account for the channel type, if channel is specified but token is not. + > * Account defined by the input channel and token, if specified. + > * Account defined by the default\_channel if defined in filename + > * Account defined by the environment variables, if defined. + > * Default account for the `ibm_cloud` account, if one is available. + > * Default account for the `ibm_quantum` account, if one is available. + + instance, proxies, and verify can be used to overwrite corresponding values in the loaded account. + + **Parameters** + + * **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type. `ibm_cloud`, `ibm_quantum` or `local`. If `local` is selected, the local testing mode will be used, and primitive queries will run on a local simulator. For more details, check the [Qiskit Runtime local testing mode](/guides/local-testing-mode) documentation. + * **token** (`Optional`\[`str`]) – IBM Cloud API key or IBM Quantum API token. + * **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum). + * **filename** (`Optional`\[`str`]) – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE + * **name** (`Optional`\[`str`]) – Name of the account to load. + * **instance** (`Optional`\[`str`]) – The service instance to use. For `ibm_cloud` runtime, this is the Cloud Resource Name (CRN) or the service name. For `ibm_quantum` runtime, this is the hub/group/project in that format. + * **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication) + * **verify** (`Optional`\[`bool`]) – Whether to verify the server’s TLS certificate. + * **channel\_strategy** (`Optional`\[`str`]) – Error mitigation strategy. + * **private\_endpoint** (`Optional`\[`bool`]) – Connect to private API URL. + + **Returns** + + An instance of QiskitRuntimeService or QiskitRuntimeLocalService for local channel. + + **Raises** + + **IBMInputValueError** – If an input is invalid. + + ## Attributes + + ### channel + + + Return the channel type used. + + **Return type** + + `str` + + **Returns** + + The channel type used. + + + ### global\_service + + + + ## Methods + + ### active\_account + + + Return the IBM Quantum account currently in use for the session. + + **Return type** + + `Optional`\[`Dict`\[`str`, `str`]] + + **Returns** + + A dictionary with information about the account currently in the session. + + + ### backend + + + Return a single backend matching the specified filtering. + + **Parameters** + + * **name** (`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. + * **use\_fractional\_gates** (`bool`) – Set True to allow for the backends to include fractional gates in target. Currently this feature cannot be used simulataneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend target. When you use the dynamic circuits feature (e.g. if\_else) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. + + **Returns** + + A backend matching the filtering. + + **Return type** + + Backend + + **Raises** + + **QiskitBackendNotFoundError** – if no backend could be found. + + + ### backends + + + Return all backends accessible via this account, subject to optional filtering. + + **Parameters** + + * **name** (`Optional`\[`str`]) – Backend name to filter by. + + * **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have. + + * **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. + + * **dynamic\_circuits** (`Optional`\[`bool`]) – Filter by whether the backend supports dynamic circuits. + + * **filters** (`Optional`\[`Callable`\[\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")], `bool`]]) – + + More complex filters, such as lambda functions. For example: + + ```python + QiskitRuntimeService.backends( + filters=lambda b: b.max_shots > 50000 + ) + QiskitRuntimeService.backends( + filters=lambda x: ("rz" in x.basis_gates ) + ) + ``` + + * **use\_fractional\_gates** (`bool`) – Set True to allow for the backends to include fractional gates in target. Currently this feature cannot be used simulataneously with dynamic circuits, PEC, PEA, or gate twirling. When this flag is set, control flow instructions are automatically removed from the backend target. When you use the dynamic circuits feature (e.g. if\_else) in your algorithm, you must disable this flag to create executable ISA circuits. This flag might be modified or removed when our backend supports dynamic circuits and fractional gates simultaneously. + + * **\*\*kwargs** – + + Simple filters that require a specific value for an attribute in backend configuration or status. Examples: + + ```python + # Get the operational real backends + QiskitRuntimeService.backends(simulator=False, operational=True) + + # Get the backends with at least 127 qubits + QiskitRuntimeService.backends(min_num_qubits=127) + + # Get the backends that support OpenPulse + QiskitRuntimeService.backends(open_pulse=True) + ``` + + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> + + **Return type** + + `List`\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")] + + **Returns** + + The list of available backends that match the filter. + + **Raises** + + * **IBMInputValueError** – If an input is invalid. + * **QiskitBackendNotFoundError** – If the backend is not in any instance. + + + ### check\_pending\_jobs + + + Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached. + + **Return type** + + `None` + + + ### delete\_account + + + Delete a saved account from disk. + + **Parameters** + + * **filename** (`Optional`\[`str`]) – Name of file from which to delete the account. + * **name** (`Optional`\[`str`]) – Name of the saved account to delete. + * **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type of the default account to delete. Ignored if account name is provided. + + **Return type** + + `bool` + + **Returns** + + True if the account was deleted. False if no account was found. + + + ### delete\_job + + + Delete a runtime job. + + Note that this operation cannot be reversed. + + **Parameters** + + **job\_id** (`str`) – ID of the job to delete. + + **Raises** + + * **RuntimeJobNotFound** – If the job doesn’t exist. + * **IBMRuntimeError** – If the request failed. + + **Return type** + + `None` + + + ### get\_backend + + + Return a single backend matching the specified filtering. + + **Return type** + + [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)") + + + ### instances + + + Return the IBM Quantum instances list currently in use for the session. + + **Return type** + + `List`\[`str`] + + **Returns** + + A list with instances currently in the session. + + + ### job + + + Retrieve a runtime job. + + **Parameters** + + **job\_id** (`str`) – Job ID. + + **Return type** + + `Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")] + + **Returns** + + Runtime job retrieved. + + **Raises** + + * **RuntimeJobNotFound** – If the job doesn’t exist. + * **IBMRuntimeError** – If the request failed. + + + ### jobs + + + Retrieve all runtime jobs, subject to optional filtering. + + **Parameters** + + * **limit** (`Optional`\[`int`]) – Number of jobs to retrieve. `None` means no limit. + * **skip** (`int`) – Starting index for the job retrieval. + * **backend\_name** (`Optional`\[`str`]) – Name of the backend to retrieve jobs from. + * **pending** (`Optional`\[`bool`]) – Filter by job pending state. If `True`, ‘QUEUED’ and ‘RUNNING’ jobs are included. If `False`, ‘DONE’, ‘CANCELLED’ and ‘ERROR’ jobs are included. + * **program\_id** (`Optional`\[`str`]) – Filter by Program ID. + * **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. + * **job\_tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to jobs. Matched jobs are associated with all tags. + * **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session. + * **created\_after** (`Optional`\[`datetime`]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time. + * **created\_before** (`Optional`\[`datetime`]) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time. + * **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached. + + **Return type** + + `List`\[`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2")]] + + **Returns** + + A list of runtime jobs. + + **Raises** + + **IBMInputValueError** – If an input value is invalid. + + + ### least\_busy + + + Return the least busy available backend. + + **Parameters** + + * **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have. + + * **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. + + * **filters** (`Optional`\[`Callable`\[\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")], `bool`]]) – + + Filters can be defined as for the [`backends()`](#qiskit_ibm_runtime.QiskitRuntimeService.backends "qiskit_ibm_runtime.QiskitRuntimeService.backends") method. An example to get the operational backends with 5 qubits: + + ```python + QiskitRuntimeService.least_busy(n_qubits=5, operational=True) + ``` + + **Return type** + + [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend") + + **Returns** + + The backend with the fewest number of pending jobs. + + **Raises** + + **QiskitBackendNotFoundError** – If no backend matches the criteria. + + + ### 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`, `Dict`, `None`]) – Runtime options that control the execution environment. + + * **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’, ‘local’]]) – Channel type. ibm\_cloud or ibm\_quantum. + * **filename** (`Optional`\[`str`]) – Full path of the file where the account is saved. + * **name** (`Optional`\[`str`]) – Name of the account to save. + * **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication) + * **verify** (`Optional`\[`bool`]) – Verify the server’s TLS certificate. + * **overwrite** (`Optional`\[`bool`]) – `True` if the existing account is to be overwritten. + * **channel\_strategy** (`Optional`\[`str`]) – Error mitigation strategy. + * **set\_as\_default** (`Optional`\[`bool`]) – If `True`, the account is saved in filename, as the default account. + * **private\_endpoint** (`Optional`\[`bool`]) – Connect to private API URL. + + **Return type** + + `None` + + + ### saved\_accounts + + + List the accounts saved on disk. + + **Parameters** + + * **default** (`Optional`\[`bool`]) – If set to True, only default accounts are returned. + * **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’, ‘local’]]) – Channel type. ibm\_cloud or ibm\_quantum. + * **filename** (`Optional`\[`str`]) – Name of file whose accounts are returned. + * **name** (`Optional`\[`str`]) – If set, only accounts with the given name are returned. + + **Return type** + + `dict` + + **Returns** + + A dictionary with information about the accounts saved on disk. + + **Raises** + + **ValueError** – If an invalid account is found on disk. + + + ### usage + + + Return monthly open plan usage information. + + **Return type** + + `Dict`\[`str`, `Any`] + + **Returns** + + Dict with usage details. + + **Raises** + + **IBMInputValueError** – If method is called when using the ibm\_cloud channel + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeDecoder.mdx new file mode 100644 index 00000000000..462bdb4a27a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeEncoder.mdx new file mode 100644 index 00000000000..d562873421f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeJob.mdx new file mode 100644 index 00000000000..388acfbc3c7 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeJob.mdx @@ -0,0 +1,539 @@ +--- +title: RuntimeJob +description: API reference for qiskit_ibm_runtime.RuntimeJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.RuntimeJob +--- + +# RuntimeJob + + + Representation of a runtime primitive execution. + + A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime primitive, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. + + If the primitive execution is successful, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_runtime.RuntimeJob.status "qiskit_ibm_runtime.RuntimeJob.status"). Job status can be one of the [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.1)") members. + + Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](#qiskit_ibm_runtime.RuntimeJob.result "qiskit_ibm_runtime.RuntimeJob.result") is an example of a blocking method: + + ```python + job = service.run(...) + + try: + job_result = job.result() # It will block until the job finishes. + print("The job finished with result {}".format(job_result)) + except RuntimeJobFailureError as ex: + print("Job failed!: {}".format(ex)) + ``` + + If the primitive has any interim results, you can use the `callback` parameter of the [`run()`](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`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.1)")) – The backend instance used to run this job. + * **api\_client** (`RuntimeClient`) – Object for connecting to the server. + * **client\_params** (`ClientParameters`) – Parameters used for server connection. + * **job\_id** (`str`) – Job ID. + * **program\_id** (`str`) – ID of the program this job is for. + * **creation\_date** (`Optional`\[`str`]) – Job creation date, in UTC. + * **user\_callback** (`Optional`\[`Callable`]) – User callback function. + * **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results. + * **image** (`Optional`\[`str`]) – Runtime image used for this job: image\_name:tag. + * **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service. + * **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session. + * **tags** (`Optional`\[`List`]) – Tags assigned to the job. + * **version** (`Optional`\[`int`]) – Primitive version. + + ## Attributes + + ### ERROR + + + + ### JOB\_FINAL\_STATES + + + + ### creation\_date + + + Job creation date in local time. + + **Return type** + + `Optional`\[`datetime`] + + **Returns** + + The job creation date as a datetime object, in local time, or `None` if creation date is not available. + + + ### image + + + Return the runtime image used for the job. + + **Returns** + + image\_name:tag or “” if the default image is used. + + **Return type** + + Runtime image + + + ### inputs + + + Job input parameters. + + **Return type** + + `Dict` + + **Returns** + + Input parameters used in this job. + + + ### instance + + + For ibm\_quantum channel jobs, return the instance where the job was run. For ibm\_cloud, None is returned. + + **Return type** + + `Optional`\[`str`] + + + ### primitive\_id + + + Primitive name. :rtype: `str` :returns: Primitive this job is for. + + + ### 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`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.1)")] + + + ### 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`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.1)") + + **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 + + + Poll for the job status from the API until the status is in a final state. + + **Parameters** + + **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + + **Raises** + + **RuntimeJobTimeoutError** – If the job does not complete within given timeout. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeJobV2.mdx new file mode 100644 index 00000000000..9cb951ad936 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -0,0 +1,455 @@ +--- +title: RuntimeJobV2 +description: API reference for qiskit_ibm_runtime.RuntimeJobV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.RuntimeJobV2 +--- + +# RuntimeJobV2 + + + Representation of a runtime V2 primitive exeuction. + + RuntimeJob constructor. + + **Parameters** + + * **backend** ([`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.1)")) – The backend instance used to run this job. + * **api\_client** (`RuntimeClient`) – Object for connecting to the server. + * **client\_params** (`ClientParameters`) – Parameters used for server connection. + * **job\_id** (`str`) – Job ID. + * **program\_id** (`str`) – ID of the program this job is for. + * **creation\_date** (`Optional`\[`str`]) – Job creation date, in UTC. + * **user\_callback** (`Optional`\[`Callable`]) – User callback function. + * **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results. + * **image** (`Optional`\[`str`]) – Runtime image used for this job: image\_name:tag. + * **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service. + * **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session. + * **tags** (`Optional`\[`List`]) – Tags assigned to the job. + * **version** (`Optional`\[`int`]) – Primitive version. + + ## Attributes + + ### ERROR + + + + ### JOB\_FINAL\_STATES + + + + ### creation\_date + + + Job creation date in local time. + + **Return type** + + `Optional`\[`datetime`] + + **Returns** + + The job creation date as a datetime object, in local time, or `None` if creation date is not available. + + + ### image + + + Return the runtime image used for the job. + + **Returns** + + image\_name:tag or “” if the default image is used. + + **Return type** + + Runtime image + + + ### inputs + + + Job input parameters. + + **Return type** + + `Dict` + + **Returns** + + Input parameters used in this job. + + + ### instance + + + For ibm\_quantum channel jobs, return the instance where the job was run. For ibm\_cloud, None is returned. + + **Return type** + + `Optional`\[`str`] + + + ### primitive\_id + + + Primitive name. :rtype: `str` :returns: Primitive this job is for. + + + ### 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`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.1)")] + + + ### 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 + + + Poll for the job status from the API until the status is in a final state. + + **Parameters** + + **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + + **Raises** + + **RuntimeJobTimeoutError** – If the job does not complete within given timeout. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Sampler.mdx new file mode 100644 index 00000000000..a52f4bbfe8b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.SamplerV1.mdx new file mode 100644 index 00000000000..e15fb7eccc9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.SamplerV1.mdx @@ -0,0 +1,130 @@ +--- +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. + + + The `SamplerV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/api/migration-guides/v2-primitives). for more details. The `SamplerV1` support will be removed no earlier than July 15, 2024. + + + 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`](/api/qiskit/qiskit.providers.Options "(in Qiskit v1.1)") :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`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)") or a list of (parameterized) [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"). + * **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. + * **\*\*kwargs** – Individual options to overwrite the default primitive options. + + **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`](/api/qiskit/qiskit.primitives.SamplerResult "(in Qiskit v1.1)"). + + **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.26/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.SamplerV2.mdx new file mode 100644 index 00000000000..2964a7fd0c4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.SamplerV2.mdx @@ -0,0 +1,117 @@ +--- +title: SamplerV2 +description: API reference for qiskit_ibm_runtime.SamplerV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.SamplerV2 +--- + +# SamplerV2 + + + Class for interacting with Qiskit Runtime Sampler primitive service. + + This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1. + + Qiskit Runtime Sampler primitive returns the sampled result according to the specified output type. For example, it returns a bitstring for each shot if measurement level 2 (bits) is requested. + + The [`run()`](#qiskit_ibm_runtime.SamplerV2.run "qiskit_ibm_runtime.SamplerV2.run") method can be used to submit circuits and parameters to the Sampler primitive. + + Initializes the Sampler primitive. + + **Parameters** + + * **mode** (`Union`\[[`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.batch.Batch"), `str`, `None`]) – + + The execution mode used to make the primitive query. It can be: + + * A `Backend` if you are using job mode. + * A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode. + * A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode. + + Refer to the [Qiskit Runtime documentation](/run). for more information about the `Execution modes`. + + * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – (DEPRECATED) 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")]) – + + (DEPRECATED) 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 + + ### mode + + + Return the execution mode used by this primitive. + + **Return type** + + Optional\[[Session](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") | [Batch](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch")] + + **Returns** + + Mode used by this primitive, or `None` if an execution mode is not used. + + + ### options + + + Return options + + **Return type** + + `TypeVar`(`OptionsT`, bound= `BaseOptions`) + + + ### 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.26/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Session.mdx new file mode 100644 index 00000000000..7f041807df8 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.Session.mdx @@ -0,0 +1,223 @@ +--- +title: Session +description: API reference for qiskit_ibm_runtime.Session +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.Session +--- + +# Session + + + Class for creating a Qiskit Runtime session. + + A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. + + You can open a Qiskit Runtime session using this `Session` class and submit jobs to one or more primitives. + + For example: + + ```python + from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister + from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + from qiskit_ibm_runtime import Session, SamplerV2 as Sampler + + service = QiskitRuntimeService() + backend = service.least_busy(operational=True, simulator=False) + + # Bell Circuit + qr = QuantumRegister(2, name="qr") + cr = ClassicalRegister(2, name="cr") + qc = QuantumCircuit(qr, cr, name="bell") + qc.h(qr[0]) + qc.cx(qr[0], qr[1]) + qc.measure(qr, cr) + + pm = generate_preset_pass_manager(backend=backend, optimization_level=1) + isa_circuit = pm.run(qc) + + with Session(backend=backend) as session: + sampler = Sampler(session=session) + job = sampler.run([isa_circuit]) + pub_result = job.result()[0] + print(f"Sampler job ID: {job.job_id()}") + print(f"Counts: {pub_result.data.cr.get_counts()}") + ``` + + Session constructor. + + **Parameters** + + * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. + * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – Instance of `Backend` class or string name of backend. Note that passing a backend name is deprecated. + * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/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. + + **Return type** + + `Optional`\[`Dict`\[`str`, `Any`]] + + **Returns** + + A dictionary with the sessions details. + + * `id`: id of the session. + * `backend_name`: backend used for the session. + * `interactive_timeout`: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated. + * `max_time`: Maximum allowed time (in seconds) for the session, subject to plan limits. + * `active_timeout`: The maximum time (in seconds) a session can stay active. + * `state`: State of the session - open, active, inactive, or closed. + * `accepting_jobs`: Whether or not the session is accepting jobs. + * `last_job_started`: Timestamp of when the last job in the session started. + * `last_job_completed`: Timestamp of when the last job in the session completed. + * `started_at`: Timestamp of when the session was started. + * `closed_at`: Timestamp of when the session was closed. + * `activated_at`: Timestamp of when the session state was changed to active. + * `mode`: Execution mode of the session. + * `usage_time`: The usage time, in seconds, of this Session or Batch. Usage is defined as the time a quantum system is committed to complete a job. + + + ### from\_id + + + Construct a Session object with a given session\_id + + **Parameters** + + * **session\_id** (`str`) – the id of the session to be created. This must be an already existing session id. + + * **service** (`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. + * **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. + + **Return type** + + `Optional`\[`str`] + + **Returns** + + Session status as a string. + + * `Pending`: Session is created but not active. It will become active when the next job of this session is dequeued. + * `In progress, accepting new jobs`: session is active and accepting new jobs. + * `In progress, not accepting new jobs`: session is active and not accepting new jobs. + * `Closed`: max\_time expired or session was explicitly closed. + * `None`: status details are not available. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx new file mode 100644 index 00000000000..8890ca55c0e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -0,0 +1,454 @@ +--- +title: FakeAlgiers +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlgiers +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers +--- + +# FakeAlgiers + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAlgiers.run "qiskit_ibm_runtime.fake_provider.FakeAlgiers.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx new file mode 100644 index 00000000000..7208c50e431 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx new file mode 100644 index 00000000000..c153acee9f5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -0,0 +1,464 @@ +--- +title: FakeAlmadenV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 +--- + +# FakeAlmadenV2 + + + A fake Almaden V2 backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run "qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx new file mode 100644 index 00000000000..f92c3b47768 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx new file mode 100644 index 00000000000..bd8c8f338f1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -0,0 +1,458 @@ +--- +title: FakeArmonkV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeArmonkV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 +--- + +# FakeArmonkV2 + + + A fake 1 qubit backend. + + ```python + 0 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeArmonkV2.run "qiskit_ibm_runtime.fake_provider.FakeArmonkV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx new file mode 100644 index 00000000000..a07f886c864 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx new file mode 100644 index 00000000000..3d573f2a09b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeAthensV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAthensV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 +--- + +# FakeAthensV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAthensV2.run "qiskit_ibm_runtime.fake_provider.FakeAthensV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx new file mode 100644 index 00000000000..01b715e64b7 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -0,0 +1,454 @@ +--- +title: FakeAuckland +description: API reference for qiskit_ibm_runtime.fake_provider.FakeAuckland +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland +--- + +# FakeAuckland + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAuckland.run "qiskit_ibm_runtime.fake_provider.FakeAuckland.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx new file mode 100644 index 00000000000..9bbffee75a6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx new file mode 100644 index 00000000000..d5332e3eecc --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeBelemV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBelemV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 +--- + +# FakeBelemV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBelemV2.run "qiskit_ibm_runtime.fake_provider.FakeBelemV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx new file mode 100644 index 00000000000..3525cc3a394 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx new file mode 100644 index 00000000000..5fd491bd689 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -0,0 +1,464 @@ +--- +title: FakeBoeblingenV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 +--- + +# FakeBoeblingenV2 + + + A fake Boeblingen V2 backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.run "qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx new file mode 100644 index 00000000000..31ee7aecf91 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx new file mode 100644 index 00000000000..df1c7cf744e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeBogotaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBogotaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 +--- + +# FakeBogotaV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBogotaV2.run "qiskit_ibm_runtime.fake_provider.FakeBogotaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx new file mode 100644 index 00000000000..0a2c5e44eab --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -0,0 +1,454 @@ +--- +title: FakeBrisbane +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrisbane +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane +--- + +# FakeBrisbane + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBrisbane.run "qiskit_ibm_runtime.fake_provider.FakeBrisbane.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx new file mode 100644 index 00000000000..c20fe347974 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx new file mode 100644 index 00000000000..e1bb59aa8e0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeBrooklynV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 +--- + +# FakeBrooklynV2 + + + A fake Brooklyn V2 backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.run "qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx new file mode 100644 index 00000000000..a9a21d266aa --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx new file mode 100644 index 00000000000..127a5a9d700 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -0,0 +1,460 @@ +--- +title: FakeBurlingtonV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 +--- + +# FakeBurlingtonV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.run "qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx new file mode 100644 index 00000000000..f7cf144706d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx new file mode 100644 index 00000000000..5fc9e89f0f3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeCairoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCairoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 +--- + +# FakeCairoV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCairoV2.run "qiskit_ibm_runtime.fake_provider.FakeCairoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx new file mode 100644 index 00000000000..1076dbffe39 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx new file mode 100644 index 00000000000..d7badebe8f3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -0,0 +1,466 @@ +--- +title: FakeCambridgeV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 +--- + +# FakeCambridgeV2 + + + A fake Cambridge backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 06 + ↕ ↕ + 07 ↔ 08 ↔ 09 ↔ 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 ↔ 15 + ↕ ↕ ↕ + 16 17 18 + ↕ ↕ ↕ + 19 ↔ 20 ↔ 21 ↔ 22 ↔ 23 ↔ 24 ↔ 25 ↔ 26 ↔ 27 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.run "qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx new file mode 100644 index 00000000000..d482fbaef46 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx new file mode 100644 index 00000000000..88bb1c79389 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeCasablancaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 +--- + +# FakeCasablancaV2 + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.run "qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx new file mode 100644 index 00000000000..37bf981685a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -0,0 +1,454 @@ +--- +title: FakeCusco +description: API reference for qiskit_ibm_runtime.fake_provider.FakeCusco +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco +--- + +# FakeCusco + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCusco.run "qiskit_ibm_runtime.fake_provider.FakeCusco.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx new file mode 100644 index 00000000000..30cbd86c1c5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx new file mode 100644 index 00000000000..6079d3f9702 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -0,0 +1,462 @@ +--- +title: FakeEssexV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeEssexV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 +--- + +# FakeEssexV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 2 + ↕ + 3 + ↕ + 4 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeEssexV2.run "qiskit_ibm_runtime.fake_provider.FakeEssexV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx new file mode 100644 index 00000000000..6cb37372fdf --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx @@ -0,0 +1,461 @@ +--- +title: FakeFractionalBackend +description: API reference for qiskit_ibm_runtime.fake_provider.FakeFractionalBackend +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend +--- + +# FakeFractionalBackend + + + A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima. + + This backend include following features. + + * Fractional gates (rx, rzx) in addition to the standard basis gates. + * Control flow operations (if\_else, while\_loop). + * Pulse calibrations (fractional gates don’t support calibration). + * Gate properties of all instructions. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.run "qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx new file mode 100644 index 00000000000..51f16b76d7c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -0,0 +1,454 @@ +--- +title: FakeGeneva +description: API reference for qiskit_ibm_runtime.fake_provider.FakeGeneva +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva +--- + +# FakeGeneva + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeGeneva.run "qiskit_ibm_runtime.fake_provider.FakeGeneva.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx new file mode 100644 index 00000000000..8f1a6834a32 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx new file mode 100644 index 00000000000..beb76493cda --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeGuadalupeV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 +--- + +# FakeGuadalupeV2 + + + A fake 16 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.run "qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx new file mode 100644 index 00000000000..8098ae34f32 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx new file mode 100644 index 00000000000..f3c313c8522 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeHanoiV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeHanoiV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 +--- + +# FakeHanoiV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeHanoiV2.run "qiskit_ibm_runtime.fake_provider.FakeHanoiV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx new file mode 100644 index 00000000000..79946b6f86c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx new file mode 100644 index 00000000000..d0c2a48553d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeJakartaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeJakartaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 +--- + +# FakeJakartaV2 + + + A fake 7 qubit V2 backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeJakartaV2.run "qiskit_ibm_runtime.fake_provider.FakeJakartaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx new file mode 100644 index 00000000000..3f30a5ce9af --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx new file mode 100644 index 00000000000..39e96448d97 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -0,0 +1,464 @@ +--- +title: FakeJohannesburgV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 +--- + +# FakeJohannesburgV2 + + + A fake Johannesburg V2 backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.run "qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx new file mode 100644 index 00000000000..ad313e3060e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -0,0 +1,454 @@ +--- +title: FakeKawasaki +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKawasaki +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki +--- + +# FakeKawasaki + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKawasaki.run "qiskit_ibm_runtime.fake_provider.FakeKawasaki.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx new file mode 100644 index 00000000000..b06c4a9a607 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx new file mode 100644 index 00000000000..c8ef0359185 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeKolkataV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKolkataV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 +--- + +# FakeKolkataV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKolkataV2.run "qiskit_ibm_runtime.fake_provider.FakeKolkataV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx new file mode 100644 index 00000000000..82951060f81 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -0,0 +1,454 @@ +--- +title: FakeKyiv +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKyiv +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv +--- + +# FakeKyiv + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKyiv.run "qiskit_ibm_runtime.fake_provider.FakeKyiv.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx new file mode 100644 index 00000000000..1c9e9c39f41 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -0,0 +1,454 @@ +--- +title: FakeKyoto +description: API reference for qiskit_ibm_runtime.fake_provider.FakeKyoto +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto +--- + +# FakeKyoto + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKyoto.run "qiskit_ibm_runtime.fake_provider.FakeKyoto.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx new file mode 100644 index 00000000000..dab07147397 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx new file mode 100644 index 00000000000..0ac27a26482 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeLagosV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLagosV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 +--- + +# FakeLagosV2 + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLagosV2.run "qiskit_ibm_runtime.fake_provider.FakeLagosV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLima.mdx new file mode 100644 index 00000000000..b9decbce941 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx new file mode 100644 index 00000000000..81c83d200a4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeLimaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLimaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 +--- + +# FakeLimaV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLimaV2.run "qiskit_ibm_runtime.fake_provider.FakeLimaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx new file mode 100644 index 00000000000..25a97233276 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx new file mode 100644 index 00000000000..387102b7f98 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -0,0 +1,462 @@ +--- +title: FakeLondonV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeLondonV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 +--- + +# FakeLondonV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 2 + ↕ + 3 + ↕ + 4 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLondonV2.run "qiskit_ibm_runtime.fake_provider.FakeLondonV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx new file mode 100644 index 00000000000..cf901c511da --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx new file mode 100644 index 00000000000..6234f348dd6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeManhattanV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeManhattanV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 +--- + +# FakeManhattanV2 + + + A fake Manhattan backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeManhattanV2.run "qiskit_ibm_runtime.fake_provider.FakeManhattanV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManila.mdx new file mode 100644 index 00000000000..8153afefb88 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx new file mode 100644 index 00000000000..ced90cc7dd5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeManilaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeManilaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 +--- + +# FakeManilaV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeManilaV2.run "qiskit_ibm_runtime.fake_provider.FakeManilaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx new file mode 100644 index 00000000000..276f6340147 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx new file mode 100644 index 00000000000..197bc00723c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeMelbourneV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 +--- + +# FakeMelbourneV2 + + + A fake 14 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.run "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx new file mode 100644 index 00000000000..30b41c42e8a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx new file mode 100644 index 00000000000..ebf64095f8e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeMontrealV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMontrealV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 +--- + +# FakeMontrealV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMontrealV2.run "qiskit_ibm_runtime.fake_provider.FakeMontrealV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx new file mode 100644 index 00000000000..0536fbc6b60 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx new file mode 100644 index 00000000000..26f5dedf437 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeMumbaiV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 +--- + +# FakeMumbaiV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.run "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx new file mode 100644 index 00000000000..7e91ccf5eab --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx new file mode 100644 index 00000000000..e443019cc17 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeNairobiV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeNairobiV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 +--- + +# FakeNairobiV2 + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeNairobiV2.run "qiskit_ibm_runtime.fake_provider.FakeNairobiV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx new file mode 100644 index 00000000000..db955c0a890 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -0,0 +1,454 @@ +--- +title: FakeOsaka +description: API reference for qiskit_ibm_runtime.fake_provider.FakeOsaka +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka +--- + +# FakeOsaka + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOsaka.run "qiskit_ibm_runtime.fake_provider.FakeOsaka.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx new file mode 100644 index 00000000000..4b0b244756f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -0,0 +1,454 @@ +--- +title: FakeOslo +description: API reference for qiskit_ibm_runtime.fake_provider.FakeOslo +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo +--- + +# FakeOslo + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOslo.run "qiskit_ibm_runtime.fake_provider.FakeOslo.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx new file mode 100644 index 00000000000..cb9e758d8cd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx new file mode 100644 index 00000000000..30ef015fac4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -0,0 +1,460 @@ +--- +title: FakeOurenseV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeOurenseV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 +--- + +# FakeOurenseV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOurenseV2.run "qiskit_ibm_runtime.fake_provider.FakeOurenseV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeParis.mdx new file mode 100644 index 00000000000..c26b1811f09 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx new file mode 100644 index 00000000000..2f2f9fdc206 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -0,0 +1,466 @@ +--- +title: FakeParisV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeParisV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 +--- + +# FakeParisV2 + + + A fake Paris backend. + + ```python + 06 17 + ↕ ↕ + 00 ↔ 01 ↔ 04 ↔ 07 ↔ 10 ↔ 12 ↔ 15 ↔ 18 ↔ 20 ↔ 23 + ↕ ↕ ↕ + 02 13 24 + ↕ ↕ ↕ + 03 ↔ 05 ↔ 08 ↔ 11 ↔ 14 ↔ 16 ↔ 19 ↔ 22 ↔ 25 ↔ 26 + ↕ ↕ + 09 20 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeParisV2.run "qiskit_ibm_runtime.fake_provider.FakeParisV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx new file mode 100644 index 00000000000..790e047cd9a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -0,0 +1,454 @@ +--- +title: FakePeekskill +description: API reference for qiskit_ibm_runtime.fake_provider.FakePeekskill +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill +--- + +# FakePeekskill + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePeekskill.run "qiskit_ibm_runtime.fake_provider.FakePeekskill.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePerth.mdx new file mode 100644 index 00000000000..ec3f6442416 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -0,0 +1,454 @@ +--- +title: FakePerth +description: API reference for qiskit_ibm_runtime.fake_provider.FakePerth +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth +--- + +# FakePerth + + + A fake 7 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePerth.run "qiskit_ibm_runtime.fake_provider.FakePerth.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx new file mode 100644 index 00000000000..33efb2c8967 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx new file mode 100644 index 00000000000..757aeea5151 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakePoughkeepsieV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 +--- + +# FakePoughkeepsieV2 + + + A fake Poughkeepsie backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.run "qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePrague.mdx new file mode 100644 index 00000000000..a4f9a3c0dc6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -0,0 +1,454 @@ +--- +title: FakePrague +description: API reference for qiskit_ibm_runtime.fake_provider.FakePrague +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague +--- + +# FakePrague + + + A fake 33 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePrague.run "qiskit_ibm_runtime.fake_provider.FakePrague.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx new file mode 100644 index 00000000000..02ffacde0b9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx @@ -0,0 +1,76 @@ +--- +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"). + + + The class `qiskit.providers.provider.Provider` is deprecated as of qiskit 1.1. It will be removed no earlier than 3 months after the release date. The abstract Provider and ProviderV1 classes are deprecated and will be removed in 2.0. You can just remove it as the parent class and a get\_backend method that returns the backends from self.backend. + + + ## 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. + + + The method `qiskit.providers.provider.ProviderV1.get_backend()` is deprecated as of qiskit 1.1. It will be removed no earlier than 3 months after the release date. The abstract Provider and ProviderV1 classes are deprecated and will be removed in 2.0. You can just remove it as the parent class and a get\_backend method that returns the backends from self.backend. + + + **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.26/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx new file mode 100644 index 00000000000..a129eae5b33 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -0,0 +1,48 @@ +--- +title: FakeProviderForBackendV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 +--- + +# FakeProviderForBackendV2 + + + Fake provider containing fake V2 backends. + + Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). + + ## Methods + + ### backend + + + Filter backends in provider by name. + + **Return type** + + `FakeBackendV2` + + + ### backends + + + Return all backends accessible via this account. + + **Return type** + + `List`\[`FakeBackendV2`] + + + ### get\_backend + + + Return a single backend matching the specified filtering. + + **Return type** + + `FakeBackendV2` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx new file mode 100644 index 00000000000..b3cc0d3f173 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -0,0 +1,454 @@ +--- +title: FakeQuebec +description: API reference for qiskit_ibm_runtime.fake_provider.FakeQuebec +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec +--- + +# FakeQuebec + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeQuebec.run "qiskit_ibm_runtime.fake_provider.FakeQuebec.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx new file mode 100644 index 00000000000..fb24d87ba65 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx new file mode 100644 index 00000000000..e88214373b9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeQuitoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeQuitoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 +--- + +# FakeQuitoV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeQuitoV2.run "qiskit_ibm_runtime.fake_provider.FakeQuitoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx new file mode 100644 index 00000000000..e0ee21fa05a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx new file mode 100644 index 00000000000..618eef229a3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeRochesterV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeRochesterV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 +--- + +# FakeRochesterV2 + + + A fake Rochester backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRochesterV2.run "qiskit_ibm_runtime.fake_provider.FakeRochesterV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRome.mdx new file mode 100644 index 00000000000..441203aceb3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx new file mode 100644 index 00000000000..b62a79d8796 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeRomeV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeRomeV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 +--- + +# FakeRomeV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRomeV2.run "qiskit_ibm_runtime.fake_provider.FakeRomeV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx new file mode 100644 index 00000000000..65c575472da --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSantiago.mdx new file mode 100644 index 00000000000..b057265d89b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx new file mode 100644 index 00000000000..3eb6fd49cc2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeSantiagoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 +--- + +# FakeSantiagoV2 + + + A fake Santiago backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.run "qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx new file mode 100644 index 00000000000..8dd897ab14a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -0,0 +1,454 @@ +--- +title: FakeSherbrooke +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSherbrooke +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke +--- + +# FakeSherbrooke + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSherbrooke.run "qiskit_ibm_runtime.fake_provider.FakeSherbrooke.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx new file mode 100644 index 00000000000..6b33d7469bb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx new file mode 100644 index 00000000000..627e277f655 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -0,0 +1,464 @@ +--- +title: FakeSingaporeV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 +--- + +# FakeSingaporeV2 + + + A fake Singapore backend. + + ```python + 00 ↔ 01 ↔ 02 ↔ 03 ↔ 04 + ↕ ↕ + 05 ↔ 06 ↔ 07 ↔ 08 ↔ 09 + ↕ ↕ ↕ + 10 ↔ 11 ↔ 12 ↔ 13 ↔ 14 + ↕ ↕ + 15 ↔ 16 ↔ 17 ↔ 18 ↔ 19 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.run "qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx new file mode 100644 index 00000000000..440dfef0fb1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx new file mode 100644 index 00000000000..b7dc9418398 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeSydneyV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeSydneyV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 +--- + +# FakeSydneyV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSydneyV2.run "qiskit_ibm_runtime.fake_provider.FakeSydneyV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx new file mode 100644 index 00000000000..b8112f974c1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTokyo.mdx new file mode 100644 index 00000000000..fe22e419807 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx new file mode 100644 index 00000000000..adb97c7d78c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -0,0 +1,454 @@ +--- +title: FakeTorino +description: API reference for qiskit_ibm_runtime.fake_provider.FakeTorino +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino +--- + +# FakeTorino + + + A fake 133 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeTorino.run "qiskit_ibm_runtime.fake_provider.FakeTorino.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx new file mode 100644 index 00000000000..f1269ea583e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx new file mode 100644 index 00000000000..415876a9e42 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeTorontoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeTorontoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 +--- + +# FakeTorontoV2 + + + A fake 27 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeTorontoV2.run "qiskit_ibm_runtime.fake_provider.FakeTorontoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx new file mode 100644 index 00000000000..b49cf44887f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx new file mode 100644 index 00000000000..c3086075bc2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeValenciaV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeValenciaV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 +--- + +# FakeValenciaV2 + + + A fake 5 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeValenciaV2.run "qiskit_ibm_runtime.fake_provider.FakeValenciaV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx new file mode 100644 index 00000000000..6612788d79d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx new file mode 100644 index 00000000000..3b0ba5f098a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -0,0 +1,460 @@ +--- +title: FakeVigoV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeVigoV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 +--- + +# FakeVigoV2 + + + A fake 5 qubit backend. + + ```python + 0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeVigoV2.run "qiskit_ibm_runtime.fake_provider.FakeVigoV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx new file mode 100644 index 00000000000..ffc7daaea8b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx new file mode 100644 index 00000000000..04c5690bd1a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -0,0 +1,454 @@ +--- +title: FakeWashingtonV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 +--- + +# FakeWashingtonV2 + + + A fake 127 qubit backend. + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.run "qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx new file mode 100644 index 00000000000..b5502bc9f23 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx new file mode 100644 index 00000000000..130ada3bedd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -0,0 +1,462 @@ +--- +title: FakeYorktownV2 +description: API reference for qiskit_ibm_runtime.fake_provider.FakeYorktownV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 +--- + +# FakeYorktownV2 + + + A fake 5 qubit backend. + + ```python + 1 + / | + 0 - 2 - 3 + | / + 4 + ``` + + FakeBackendV2 initializer. + + ## Attributes + + ### backend\_name + + + + ### conf\_filename + + + + ### coupling\_map + + + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)") object + + + ### defs\_filename + + + + ### dirname + + + + ### dt + + + Return the system time resolution of input signals + + This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `Optional`\[`float`] + + **Returns** + + The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + ### dtm + + + Return the system time resolution of output signals + + **Return type** + + `float` + + **Returns** + + The output signal timestep in seconds. + + + ### instruction\_durations + + + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)") object. + + + ### instruction\_schedule\_map + + + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.1)") for the instructions defined in this backend’s target. + + + ### instructions + + + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + + **Return type** + + `List`\[`Tuple`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)"), `Tuple`\[`int`]]] + + + ### max\_circuits + + + **Return type** + + `None` + + + ### meas\_map + + + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + + **Return type** + + `List`\[`List`\[`int`]] + + **Returns** + + The grouping of measurements which are multiplexed + + + ### num\_qubits + + + Return the number of qubits the backend has. + + **Return type** + + `int` + + + ### operation\_names + + + A list of instruction names that the backend supports. + + **Return type** + + `List`\[`str`] + + + ### operations + + + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)") instances that the backend supports. + + **Return type** + + `List`\[[`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")] + + + ### options + + + Return the options for the backend + + The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeYorktownV2.run "qiskit_ibm_runtime.fake_provider.FakeYorktownV2.run") method. + + + ### props\_filename + + + + ### provider + + + Return the backend Provider. + + **Returns** + + the Provider responsible for the backend. + + **Return type** + + Provider + + + ### target + + + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. + + **Return type** + + Target + + + ### version + + + + ### name + + + Name of the backend. + + + ### description + + + Optional human-readable description. + + + ### online\_date + + + Date that the backend came online. + + + ### backend\_version + + + Version of the backend being provided. This is not the same as `BackendV2.version`, which is the version of the `Backend` abstract interface. + + + ## Methods + + ### acquire\_channel + + + Return the acquisition channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement acquisition line. + + **Return type** + + AcquireChannel + + + ### check\_faulty + + + Check if the input circuit uses faulty qubits or edges. + + **Parameters** + + **circuit** ([`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)")) – Circuit to check. + + **Raises** + + **ValueError** – If an instruction operating on a faulty qubit or edge is found. + + **Return type** + + `None` + + + ### configuration + + + Return the backend configuration. + + **Return type** + + `Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + + + ### control\_channel + + + Return the secondary drive channel for the given qubit + + This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Parameters** + + **qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + + **Returns** + + The multi qubit control line. + + **Return type** + + List\[ControlChannel] + + + ### defaults + + + Return the pulse defaults for the backend + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend defaults from the + * **file.** (*local*) + + **Return type** + + `PulseDefaults` + + **Returns** + + The backend pulse defaults or `None` if the backend does not support pulse. + + + ### drive\_channel + + + Return the drive channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit drive channel + + **Return type** + + DriveChannel + + + ### measure\_channel + + + Return the measure stimulus channel for the given qubit. + + This is required to be implemented if the backend supports Pulse scheduling. + + **Returns** + + The Qubit measurement stimulus line + + **Return type** + + MeasureChannel + + + ### properties + + + Return the backend properties + + **Parameters** + + * **refresh** (`bool`) – If `True`, re-retrieve the backend properties + * **file.** (*from the local*) + + **Return type** + + `BackendProperties` + + **Returns** + + The backend properties. + + + ### qubit\_properties + + + Return QubitProperties for a given qubit. + + If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + + **Parameters** + + **qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + + **Return type** + + `Union`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)"), `List`\[[`QubitProperties`](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.1)")]] + + **Returns** + + The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + + **Raises** + + **NotImplementedError** – if the backend doesn’t support querying the qubit properties + + + ### refresh + + + Update the data files from its real counterpart + + This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json + + **The new data files will persist through sessions so the files will stay updated unless they** + + are manually reverted locally or when qiskit-ibm-runtime is upgraded/reinstalled. + + **Parameters** + + **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – A `QiskitRuntimeService` instance + + **Raises** + + * **ValueError** – if the provided service is a non-QiskitRuntimeService instance. + * **Exception** – If the real target doesn’t exist or can’t be accessed + + **Return type** + + `None` + + + ### run + + + Run on the fake backend using a simulator. + + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. + + If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. + + Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + + **Parameters** + + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.1)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.1)") objects to run on the backend. + * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + + **Returns** + + The job object for the run + + **Return type** + + Job + + **Raises** + + **QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + + + ### set\_options + + + Set the options fields for the backend + + This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + + **Parameters** + + **fields** – The fields to update the options + + **Raises** + + **AttributeError** – If the field passed in is not part of the options + + + ### status + + + Return the backend status. + + **Return type** + + `BackendStatus` + + **Returns** + + The status of the backend. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx new file mode 100644 index 00000000000..630840a9852 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx @@ -0,0 +1,112 @@ +--- +title: NoiseLearner +description: API reference for qiskit_ibm_runtime.noise_learner.NoiseLearner +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner +--- + +# NoiseLearner + + + Class for executing noise learning experiments. + + + Currently, the [`NoiseLearner`](#qiskit_ibm_runtime.noise_learner.NoiseLearner "qiskit_ibm_runtime.noise_learner.NoiseLearner") is released an experimental feature. As such, it is subject to change without notification and its stability is not guaranteed. + + + The noise learner class allows characterizing the noise processes affecting the gates in one or more circuits of interest, based on the Pauli-Lindblad noise model described in \[1]. + + The [`run()`](#qiskit_ibm_runtime.noise_learner.NoiseLearner.run "qiskit_ibm_runtime.noise_learner.NoiseLearner.run") method allows runnig a noise learner job for a list of circuits. After the job is submitted, the gates are collected into independent layers, and subsequently the resulting layers are are characterized individually. + + The way in which the gates are collected into layers depends on the twirling `strategy` specified in the given `options` (see `NoiseLearnerOptions` for more details). Note that all strategies obey barriers. For example, if you have three ISA entangling layers of interest, consider putting them into one circuit separated by barriers acting on the qubits you wish to twirl, and select `strategy="active-circuit"`. + + The following snippet shows an example where the noise learner is used to characterized the layers of two GHZ circuits. + + ```python + from qiskit.circuit import QuantumCircuit + from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager + from qiskit_ibm_runtime import QiskitRuntimeService + from qiskit_ibm_runtime.noise_learner import NoiseLearner + from qiskit_ibm_runtime.options import NoiseLearnerOptions + + service = QiskitRuntimeService() + backend = service.least_busy(operational=True, simulator=False) + + # a circuit returning a two-qubit GHZ state + ghz = QuantumCircuit(2) + ghz.h(0) + ghz.cx(0, 1) + + # another circuit returning a two-qubit GHZ state + another_ghz = QuantumCircuit(3) + another_ghz.h(0) + another_ghz.cx(0, 1) + another_ghz.cx(1, 2) + another_ghz.cx(0, 1) + + pm = generate_preset_pass_manager(backend=backend, optimization_level=1) + circuits = pm.run([ghz, another_ghz]) + + # set the options + options = NoiseLearnerOptions() + options.layer_pair_depths = [0, 1, 10] + + # run the noise learner job + learner = NoiseLearner(backend, options) + job = learner.run(circuits) + ``` + + **Parameters** + + * **mode** (`Union`\[[`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.batch.Batch"), `None`]) – + + The execution mode used to make the primitive query. It can be: + + * A `Backend` if you are using job mode. + * A `Session` if you are using session execution mode. + * A `Batch` if you are using batch execution mode. + + Refer to the [Qiskit Runtime documentation](/run) for more information about the execution modes. + + * **options** (`Union`\[`Dict`, `NoiseLearnerOptions`, [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – `NoiseLearnerOptions`. Alternatively, `EstimatorOptions` can be provided for convenience, in which case the estimator options get reformatted into noise learner options and all the irrelevant fields are ignored. + + **References** + + 1. E. van den Berg, Z. Minev, A. Kandala, K. Temme, *Probabilistic error cancellation with sparse Pauli–Lindblad models on noisy quantum processors*, Nature Physics volume 19, pages1116–1121 (2023). [arXiv:2201.09866 \[quant-ph\]](https://arxiv.org/abs/2201.09866) + + ## Attributes + + ### options + + + The options in this noise learner. + + **Return type** + + `NoiseLearnerOptions` + + + ## Methods + + ### run + + + Submit a request to the noise learner program. + + This function breaks the given list of circuits into a list of unique layers, following the strategy set by the `twirling_strategy` field specified in the `options` (see `NoiseLearnerOptions` for more details) and sorting them based on the number of times they occur in the various circuits. Then, it runs the noise learning experiment for as many layers as specified by the `max_layers_to_learn` field in the `options`, prioritizing layers that occurr more frequently. + + **Parameters** + + **circuits** (`Iterable`\[`Union`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), `EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.1)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.1)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.1)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.1)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.1)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.1)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.1)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.1)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.1)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.1)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.1)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.1)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.1)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.1)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.0)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – An iterable of circuits to run the noise learner program for. Alternatively, estimator pub-like (primitive unified bloc) objects can be specified, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. In this case, the pub-like objects are converted to a list of circuits, and all the other fields (such as `observables` and `parameter_values`) are ignored. + + **Return type** + + [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.runtime_job_v2.RuntimeJobV2") + + **Returns** + + The submitted job. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx new file mode 100644 index 00000000000..059bc5ea382 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.options.EnvironmentOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.EnvironmentOptions.mdx new file mode 100644 index 00000000000..31fd98b6f9b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.EnvironmentOptions.mdx @@ -0,0 +1,45 @@ +--- +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. This applies to both V1 and V2 primitives. + + **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. + + Default: `None`. + + * **job\_tags** – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `qiskit_ibm_runtime.qiskit_runtime_service.jobs()` function call. Default: `None`. + + ## Attributes + + ### callback + + + + ### job\_tags + + + + ### log\_level + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.EstimatorOptions.mdx new file mode 100644 index 00000000000..f111329293d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.EstimatorOptions.mdx @@ -0,0 +1,141 @@ +--- +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** – + + (DEPRECATED) How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times. + + * 0: no optimization + * 1: light optimization + + Default: 0. + + * **resilience\_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. Default: `None`. + + * **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. These options are subject to change without notification, and stability is not guaranteed. Currently, the available options are: + + * Probabilistic Error Amplification (PEA). To enable PEA, set: + + ```python + estimator_options.experimental = {"resilience": {"zne": {"amplifier": "pea"}}} + ``` + + Since PEA is an amplification technique of ZNE, you will also need to enable ZNE by setting `resilience.zne_mitigation = True`. Other documented `resilience.zne` options can be used in conjunction to set extrapolators, amplification levels, etc. Experiments to learn a sparse Pauli noise model will be performed for every uniquely identified entangling layer (up to a specified cutoff) in the union of circuits across PUBs; see :class:\~.LayerNoiseLearningOptions\` for options. Add full-width barriers to specify layers unambiguously. + + ## 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.26/qiskit_ibm_runtime.options.ExecutionOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ExecutionOptions.mdx new file mode 100644 index 00000000000..1a3b1172337 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx new file mode 100644 index 00000000000..ad7d21af0cf --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -0,0 +1,30 @@ +--- +title: ExecutionOptionsV2 +description: API reference for qiskit_ibm_runtime.options.ExecutionOptionsV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2 +--- + +# ExecutionOptionsV2 + + + Execution options for V2 primitives. + + ## Attributes + + ### init\_qubits + + + Whether to reset the qubits to the ground state for each shot. Default is `True`. + + + ### rep\_delay + + + The repetition delay. This is the delay between a measurement and the subsequent quantum circuit. This is only supported on backends that have `backend.dynamic_reprate_enabled=True`. It must be from the range supplied by `backend.rep_delay_range`. Default is given by `backend.default_rep_delay`. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx new file mode 100644 index 00000000000..d6776f257ef --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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. This is only used by V2 Estimator. + + + These options are only used when the resilience level or options specify a technique that requires layer noise learning. + + + **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.26/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx new file mode 100644 index 00000000000..a4ad3ae68c6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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. This is only used by V2 Estimator. + + + These options are only used when the resilience level or options specify a technique that requires measurement noise learning. + + + **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.26/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.Options.mdx new file mode 100644 index 00000000000..424495a5072 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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 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.26/qiskit_ibm_runtime.options.PecOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.PecOptions.mdx new file mode 100644 index 00000000000..502f2c80a59 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.PecOptions.mdx @@ -0,0 +1,41 @@ +--- +title: PecOptions +description: API reference for qiskit_ibm_runtime.options.PecOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.PecOptions +--- + +# PecOptions + + + Probabalistic error cancellation mitigation options. This is only used by V2 Estimator. + + **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 0 corresponds to removing the full learned noise. + * A value of 1 corresponds to no removal of the learned noise. + * A value between 0 and 1 corresponds to partially removing the learned noise. + * A value greater than one corresponds to amplifying the learned noise. + + If “auto”, the value in the range `[0, 1]` will be chosen automatically for each input PUB based on the learned noise strength, `max_overhead`, and the depth of the PUB. Default: “auto”. + + ## Attributes + + ### max\_overhead + + + + ### noise\_gain + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ResilienceOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ResilienceOptions.mdx new file mode 100644 index 00000000000..40922335814 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ResilienceOptionsV2.mdx new file mode 100644 index 00000000000..81b7b6277d0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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. If you enable measurement mitigation, you can fine tune its noise learning by using [`measure_noise_learning`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning "qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning"). See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all measurement mitigation noise learning options. Default: True. + * **measure\_noise\_learning** – Additional measurement noise learning options. See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all options. + * **zne\_mitigation** – Whether to turn on Zero Noise Extrapolation error mitigation method. If you enable ZNE, you can fine tune its options by using [`zne`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.zne "qiskit_ibm_runtime.options.ResilienceOptionsV2.zne"). See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for additional ZNE related options. Default: False. + * **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. If you enable PEC, you can fine tune its options by using [`pec`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.pec "qiskit_ibm_runtime.options.ResilienceOptionsV2.pec"). See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for additional PEC related options. Default: False. + * **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.26/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx new file mode 100644 index 00000000000..a2793503e48 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx @@ -0,0 +1,46 @@ +--- +title: SamplerExecutionOptionsV2 +description: API reference for qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 +--- + +# SamplerExecutionOptionsV2 + + + Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. + + ## Attributes + + ### init\_qubits + + + Whether to reset the qubits to the ground state for each shot. Default is `True`. + + + ### meas\_type + + + How to process and return measurement results. + + This option sets the return type of all classical registers in all `SamplerPubResult`s. If a sampler pub with shape `pub_shape` has a circuit that contains a classical register with size `creg_size`, then the returned data associated with this register will have one of the following formats depending on the value of this option. + + * `"classified"`: A `BitArray` of shape `pub_shape` over `num_shots` with a number of bits equal to `creg_size`. + * `"kerneled"`: A complex NumPy array of shape `(*pub_shape, num_shots, creg_size)`, where each entry represents an IQ data point (resulting from kerneling the measurement trace) in arbitrary units. + * `"avg_kerneled"`: A complex NumPy array of shape `(*pub_shape, creg_size)`, where each entry represents an IQ data point (resulting from kerneling the measurement trace and averaging over shots) in arbitrary units. This option is equivalent to selecting `"kerneled"` and then averaging over the shots axis, but requires less data bandwidth. + + Default: “classified”. + + See [here](https://pubs.aip.org/aip/rsi/article/88/10/104703/836456) for a description of kerneling. + + + ### rep\_delay + + + The repetition delay. This is the delay between a measurement and the subsequent quantum circuit. This is only supported on backends that have `backend.dynamic_reprate_enabled=True`. It must be from the range supplied by `backend.rep_delay_range`. Default is given by `backend.default_rep_delay`. + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SamplerOptions.mdx new file mode 100644 index 00000000000..7b4fbe606c4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SamplerOptions.mdx @@ -0,0 +1,68 @@ +--- +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 [`SamplerExecutionOptionsV2`](qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2") 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\_shots + + + + ### dynamical\_decoupling + + + + ### environment + + + + ### execution + + + + ### experimental + + + + ### max\_execution\_time + + + + ### simulator + + + + ### twirling + + + + ## Methods + + ### update + + + Update the options. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.SimulatorOptions.mdx new file mode 100644 index 00000000000..3a37025c7cb --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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. Default: `None`. + * **seed\_simulator** – Random seed to control sampling. Default: `None`. + * **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]]`. Default: `None`, which implies no connectivity constraints. + * **basis\_gates** – List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set. Default: all basis gates supported by the simulator. + + ## 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`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)")]) – backend to be set. + + **Raises** + + **MissingOptionalLibraryError** – if qiskit-aer is not found. + + **Return type** + + `None` + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.TranspilationOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.TranspilationOptions.mdx new file mode 100644 index 00000000000..14420099eee --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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. This is only used by V1 primitives. + + **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.26/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.TwirlingOptions.mdx new file mode 100644 index 00000000000..fa1ecb126c9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -0,0 +1,73 @@ +--- +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. This is only used by V2 primitives. + + **Parameters** + + * **enable\_gates** – Whether to apply 2-qubit Clifford gate twirling. Default: False. + + * **enable\_measure** – Whether to enable twirling of measurements. Twirling will only be applied to those measurement registers not involved within a conditional logic. Default: True for Estimator, false for Sampler. + + * **num\_randomizations** – + + The number of random samples to use when twirling or peforming sampled mitigation. If `num_randomizations` is “auto”, for every pub executed `shots` times: + + * If `shots_per_randomization` is also “auto”, `shots_per_randomization` is set first as described below, then `num_randomizations` is set as `ceil(shots/shots_per_randomization)`, where `ceil` is the ceiling function. + * Otherwise, the value is set to `ceil(shots/shots_per_randomization)`. + + Default: “auto”. + + * **shots\_per\_randomization** – + + The number of shots to run for each random sample. If “auto”, for every pub executed `shots` times: + + * If `num_randomizations` is also “auto”, the value is set to `64` for PEC mitigation or to `max(64, ceil(shots / 32))` in all other cases, where `ceil` is the ceiling function. + * Otherwise, the value is set to `ceil(shots/num_randomizations)`. + + Default: “auto”. + + * **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.26/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ZneOptions.mdx new file mode 100644 index 00000000000..de6d49889c4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -0,0 +1,53 @@ +--- +title: ZneOptions +description: API reference for qiskit_ibm_runtime.options.ZneOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.ZneOptions +--- + +# ZneOptions + + + Zero noise extrapolation mitigation options. This is only used by V2 Estimator. + + **Parameters** + + * **amplifier** – + + Which technique to use for amplifying noise. One of: + + * ”gate\_folding” (default) uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are chosen randomly. + * ”gate\_folding\_front” uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are selected from the front of the topologically ordered DAG circuit. + * ”gate\_folding\_back” uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are selected from the back of the topologically ordered DAG circuit. + + * **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 + + ### amplifier + + + + ### extrapolator + + + + ### noise\_factors + + + + ## Methods + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx new file mode 100644 index 00000000000..09a1488fe5c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx @@ -0,0 +1,127 @@ +--- +title: ConvertIdToDelay +description: API reference for qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay +--- + +# ConvertIdToDelay + + + Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. + + Convert [`qiskit.circuit.library.IGate`](/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.1)") to a Convert [`qiskit.circuit.Delay`](/api/qiskit/circuit#qiskit.circuit.Delay "(in Qiskit v1.1)"). + + **Parameters** + + * **duration** – Duration of the delay to replace the identity gate with. + * **gate** (`str`) – Single qubit gate to extract duration from. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run a pass on the DAGCircuit. This is implemented by the pass developer. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)")) – the dag on which the pass is run. + + **Raises** + + **NotImplementedError** – when this is left unimplemented for a pass. + + **Return type** + + [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)") + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx new file mode 100644 index 00000000000..a43005b2b4f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -0,0 +1,142 @@ +--- +title: ALAPScheduleAnalysis +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis +--- + +# ALAPScheduleAnalysis + + + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. + + This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. + + In its current form this is similar to Qiskit’s ALAP scheduler in which instructions start as late as possible. + + The primary differences are that: + + * **Resets and control-flow currently trigger the end of a “quantum block”. The period between the end** + + of the block and the next is *nondeterministic* ie., we do not know when the next block will begin (as we could be evaluating a classical function of nondeterministic length) and therefore the next block starts at a *relative* t=0. + + * During a measurement it is possible to apply gates in parallel on disjoint qubits. + + * Measurements and resets on disjoint qubits happen simultaneously and are part of the same block. + + Scheduler for dynamic circuit backends. + + **Parameters** + + * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)")) – Durations of instructions to be used in scheduling. + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)")], `Generator`\[[`DAGOpNode`](/api/qiskit/qiskit.dagcircuit.DAGOpNode "(in Qiskit v1.1)"), `None`, `None`]]]) – A callable used to produce an ordering of the nodes to minimize the number of blocks needed. If not provided, `block_order_op_nodes()` will be used. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)") :param dag: DAG to schedule. :type dag: DAGCircuit + + **Raises** + + * **TranspilerError** – if the circuit is not mapped on physical qubits. + * **TranspilerError** – if conditional bit is added to non-supported instruction. + + **Return type** + + `None` + + **Returns** + + The scheduled DAGCircuit. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx new file mode 100644 index 00000000000..d03bb878cd9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -0,0 +1,142 @@ +--- +title: ASAPScheduleAnalysis +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis +--- + +# ASAPScheduleAnalysis + + + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. + + This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. + + In its current form this is similar to Qiskit’s ASAP scheduler in which instructions start as early as possible. + + The primary differences are that: + + * **Resets and control-flow currently trigger the end of a “quantum block”. The period between the end** + + of the block and the next is *nondeterministic* ie., we do not know when the next block will begin (as we could be evaluating a classical function of nondeterministic length) and therefore the next block starts at a *relative* t=0. + + * During a measurement it is possible to apply gates in parallel on disjoint qubits. + + * Measurements and resets on disjoint qubits happen simultaneously and are part of the same block. + + Scheduler for dynamic circuit backends. + + **Parameters** + + * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)")) – Durations of instructions to be used in scheduling. + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)")], `Generator`\[[`DAGOpNode`](/api/qiskit/qiskit.dagcircuit.DAGOpNode "(in Qiskit v1.1)"), `None`, `None`]]]) – A callable used to produce an ordering of the nodes to minimize the number of blocks needed. If not provided, `block_order_op_nodes()` will be used. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)") :param dag: DAG to schedule. :type dag: DAGCircuit + + **Raises** + + * **TranspilerError** – if the circuit is not mapped on physical qubits. + * **TranspilerError** – if conditional bit is added to non-supported instruction. + + **Return type** + + [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)") + + **Returns** + + The scheduled DAGCircuit. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx new file mode 100644 index 00000000000..e0887b21fde --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -0,0 +1,135 @@ +--- +title: BlockBasePadder +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder +--- + +# BlockBasePadder + + + The base class of padding pass. + + This pass requires one of scheduling passes to be executed before itself. Since there are multiple scheduling strategies, the selection of scheduling pass is left in the hands of the pass manager designer. Once a scheduling analysis pass is run, `node_start_time` is generated in the `property_set`. This information is represented by a python dictionary of the expected instruction execution times keyed on the node instances. The padding pass expects all `DAGOpNode` in the circuit to be scheduled. + + This base class doesn’t define any sequence to interleave, but it manages the location where the sequence is inserted, and provides a set of information necessary to construct the proper sequence. Thus, a subclass of this pass just needs to implement `_pad()` method, in which the subclass constructs a circuit block to insert. This mechanism removes lots of boilerplate logic to manage whole DAG circuits. + + Note that padding pass subclasses should define interleaving sequences satisfying: + + > * Interleaved sequence does not change start time of other nodes + > * Interleaved sequence should have total duration of the provided `time_interval`. + + Any manipulation violating these constraints may prevent this base pass from correctly tracking the start time of each instruction, which may result in violation of hardware alignment constraints. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the padding pass on `dag`. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)")) – DAG to be checked. + + **Returns** + + DAG with idle time filled with instructions. + + **Return type** + + DAGCircuit + + **Raises** + + **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx new file mode 100644 index 00000000000..eb3eadc1c23 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -0,0 +1,120 @@ +--- +title: DynamicCircuitInstructionDurations +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations +--- + +# DynamicCircuitInstructionDurations + + + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. + + Dynamic circuit instruction durations. + + ## Attributes + + ### MEASURE\_PATCH\_CYCLES + + + + ### MEASURE\_PATCH\_ODD\_OFFSET + + + + ## Methods + + ### from\_backend + + + Construct a `DynamicInstructionDurations` object from the backend. :type backend: [`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.1)") :param backend: backend from which durations (gate lengths) and dt are extracted. + + **Returns** + + The InstructionDurations constructed from backend. + + **Return type** + + DynamicInstructionDurations + + + ### from\_target + + + Construct a `DynamicInstructionDurations` object from the target. :type target: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") :param target: target from which durations (gate lengths) and dt are extracted. + + **Returns** + + The InstructionDurations constructed from backend. + + **Return type** + + DynamicInstructionDurations + + + ### get + + + Get the duration of the instruction with the name, qubits, and parameters. + + Some instructions may have a parameter dependent duration. + + **Parameters** + + * **inst** (*str |* [*qiskit.circuit.Instruction*](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.1)")) – An instruction or its name to be queried. + * **qubits** (*int | list\[int]*) – Qubit indices that the instruction acts on. + * **unit** (*str*) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. + * **parameters** (*list\[float] | None*) – The value of the parameters of the desired instruction. + + **Returns** + + The duration of the instruction on the qubits. + + **Return type** + + float|int + + **Raises** + + **TranspilerError** – No duration is defined for the instruction. + + + ### units\_used + + + Get the set of all units used in this instruction durations. + + **Return type** + + `set`\[`str`] + + **Returns** + + Set of units used in this instruction durations. + + + ### update + + + Update self with inst\_durations (inst\_durations overwrite self). Overrides the default durations for certain hardcoded instructions. + + **Parameters** + + * **inst\_durations** (`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]], `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]]]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)"), `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.26/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx new file mode 100644 index 00000000000..44a222f9223 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -0,0 +1,149 @@ +--- +title: PadDelay +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay +--- + +# PadDelay + + + Padding idle time with Delay instructions. + + Consecutive delays will be merged in the output of this pass. + + The ASAP-scheduled circuit output may become + + ```python + ┌────────────────┐ + q_0: ┤ Delay(160[dt]) ├──■── + └─────┬───┬──────┘┌─┴─┐ + q_1: ──────┤ X ├───────┤ X ├ + └───┘ └───┘ + ``` + + Note that the additional idle time of 60dt on the `q_0` wire coming from the duration difference between `Delay` of 100dt (`q_0`) and `XGate` of 160 dt (`q_1`) is absorbed in the delay instruction on the `q_0` wire, i.e. in total 160 dt. + + See [`BlockBasePadder`](qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder") pass for details. + + Create new padding delay pass. + + **Parameters** + + * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)")) – Durations of instructions to be used in scheduling. + * **fill\_very\_end** (`bool`) – Set `True` to fill the end of circuit with delay. + * **schedule\_idle\_qubits** (`bool`) – Set to true if you’d like a delay inserted on idle qubits. This is useful for timeline visualizations, but may cause issues for execution on large backends. + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)")], `Generator`\[[`DAGOpNode`](/api/qiskit/qiskit.dagcircuit.DAGOpNode "(in Qiskit v1.1)"), `None`, `None`]]]) – A callable used to produce an ordering of the nodes to minimize the number of blocks needed. If not provided, `block_order_op_nodes()` will be used. + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the padding pass on `dag`. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)")) – DAG to be checked. + + **Returns** + + DAG with idle time filled with instructions. + + **Return type** + + DAGCircuit + + **Raises** + + **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx new file mode 100644 index 00000000000..fda9797ba8a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -0,0 +1,286 @@ +--- +title: PadDynamicalDecoupling +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling +--- + +# PadDynamicalDecoupling + + + Dynamical decoupling insertion pass for IBM dynamic circuit backends. + + This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). + + ```python + import numpy as np + from qiskit.circuit import QuantumCircuit + from qiskit.circuit.library import XGate + from qiskit.transpiler import PassManager, InstructionDurations + from qiskit.visualization import timeline_drawer + + from qiskit_ibm_runtime.transpiler.passes.scheduling import ALAPScheduleAnalysis + from qiskit_ibm_runtime.transpiler.passes.scheduling import PadDynamicalDecoupling + + circ = QuantumCircuit(4) + circ.h(0) + circ.cx(0, 1) + circ.cx(1, 2) + circ.cx(2, 3) + circ.measure_all() + durations = InstructionDurations( + [("h", 0, 50), ("cx", [0, 1], 700), ("reset", None, 10), + ("cx", [1, 2], 200), ("cx", [2, 3], 300), + ("x", None, 50), ("measure", None, 1000)] + ) + ``` + + ```python + # balanced X-X sequence on all qubits + dd_sequence = [XGate(), XGate()] + pm = PassManager([ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence)]) + circ_dd = pm.run(circ) + circ_dd.draw() + ``` + + ```python + ┌───┐ ┌───────────────┐ ┌───┐ » + q_0: ──────┤ H ├─────────■──┤ Delay(96[dt]) ├──────┤ X ├──────» + ┌─────┴───┴─────┐ ┌─┴─┐└───────────────┘┌─────┴───┴─────┐» + q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■────────┤ Delay(48[dt]) ├» + ├───────────────┴┐└───┘ ┌─┴─┐ └───────────────┘» + q_2: ┤ Delay(750[dt]) ├───────────┤ X ├──────────────■────────» + ├────────────────┤ └───┘ ┌─┴─┐ » + q_3: ┤ Delay(950[dt]) ├────────────────────────────┤ X ├──────» + └────────────────┘ └───┘ » + meas: 4/═════════════════════════════════════════════════════════» + » + « ┌────────────────┐ ┌───┐ ┌───────────────┐ » + « q_0: ┤ Delay(208[dt]) ├──────┤ X ├──────┤ Delay(96[dt]) ├─────────────────» + « └─────┬───┬──────┘┌─────┴───┴─────┐└─────┬───┬─────┘┌───────────────┐» + « q_1: ──────┤ X ├───────┤ Delay(96[dt]) ├──────┤ X ├──────┤ Delay(56[dt]) ├» + « └───┘ └───────────────┘ └───┘ └───────────────┘» + « q_2: ─────────────────────────────────────────────────────────────────────» + « » + « q_3: ─────────────────────────────────────────────────────────────────────» + « » + «meas: 4/═════════════════════════════════════════════════════════════════════» + « » + « ░ ┌─┐ + « q_0: ─░─┤M├───────── + « ░ └╥┘┌─┐ + « q_1: ─░──╫─┤M├────── + « ░ ║ └╥┘┌─┐ + « q_2: ─░──╫──╫─┤M├─── + « ░ ║ ║ └╥┘┌─┐ + « q_3: ─░──╫──╫──╫─┤M├ + « ░ ║ ║ ║ └╥┘ + «meas: 4/════╩══╩══╩══╩═ + « 0 1 2 3 + ``` + + ```python + # Uhrig sequence on qubit 0 + n = 8 + dd_sequence = [XGate()] * n + def uhrig_pulse_location(k): + return np.sin(np.pi * (k + 1) / (2 * n + 2)) ** 2 + spacings = [] + for k in range(n): + spacings.append(uhrig_pulse_location(k) - sum(spacings)) + spacings.append(1 - sum(spacings)) + pm = PassManager( + [ + ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence, qubits=[0], spacings=spacings), + ] + ) + circ_dd = pm.run(circ) + circ_dd.draw() + ``` + + ```python + ┌───┐ ┌────────────────┐ ░ ┌─┐ » + q_0: ──────┤ H ├─────────■──┤ Delay(500[dt]) ├───────────────────░─┤M├──────» + ┌─────┴───┴─────┐ ┌─┴─┐└────────────────┘┌────────────────┐ ░ └╥┘┌─┐ » + q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■─────────┤ Delay(300[dt]) ├─░──╫─┤M├───» + ├───────────────┴┐└───┘ ┌─┴─┐ └────────────────┘ ░ ║ └╥┘┌─┐» + q_2: ┤ Delay(750[dt]) ├───────────┤ X ├───────────────■──────────░──╫──╫─┤M├» + ├────────────────┤ └───┘ ┌─┴─┐ ░ ║ ║ └╥┘» + q_3: ┤ Delay(950[dt]) ├─────────────────────────────┤ X ├────────░──╫──╫──╫─» + └────────────────┘ └───┘ ░ ║ ║ ║ » + meas: 4/═══════════════════════════════════════════════════════════════╩══╩══╩═» + 0 1 2 » + « + « q_0: ─── + « + « q_1: ─── + « + « q_2: ─── + « ┌─┐ + « q_3: ┤M├ + « └╥┘ + «meas: 4/═╩═ + « 3 + ``` + + + You need to call [`ALAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis") before running dynamical decoupling to guarantee your circuit satisfies acquisition alignment constraints for dynamic circuit backends. + + + Dynamical decoupling initializer. + + **Parameters** + + * **durations** ([`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.1)")) – Durations of instructions to be used in scheduling. + + * **dd\_sequences** (`Union`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.1)")], `List`\[`List`\[[`Gate`](/api/qiskit/qiskit.circuit.Gate "(in Qiskit v1.1)")]]]) – Sequence of gates to apply in idle spots. Alternatively a list of gate sequences may be supplied that will preferentially be inserted if there is a delay of sufficient duration. This may be tuned by the optionally supplied `sequence_min_length_ratios`. + + * **qubits** (`Optional`\[`List`\[`int`]]) – Physical qubits on which to apply DD. If None, all qubits will undergo DD (when possible). + + * **spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates. The available slack will be divided according to this. The list length must be one more than the length of dd\_sequence, and the elements must sum to 1. If None, a balanced spacing will be used \[d/2, d, d, …, d, d, d/2]. This spacing only applies to the first subcircuit, if a `coupling_map` is specified + + * **skip\_reset\_qubits** (`bool`) – If True, does not insert DD on idle periods that immediately follow initialized/reset qubits (as qubits in the ground state are less susceptible to decoherence). + + * **pulse\_alignment** (`int`) – The hardware constraints for gate timing allocation. This is usually provided from `backend.configuration().timing_constraints`. If provided, the delay length, i.e. `spacing`, is implicitly adjusted to satisfy this constraint. + + * **extra\_slack\_distribution** (`str`) – + + The option to control the behavior of DD sequence generation. The duration of the DD sequence should be identical to an idle time in the scheduled quantum circuit, however, the delay in between gates comprising the sequence should be integer number in units of dt, and it might be further truncated when `pulse_alignment` is specified. This sometimes results in the duration of the created sequence being shorter than the idle time that you want to fill with the sequence, i.e. extra slack. This option takes following values. + + > * ”middle”: Put the extra slack to the interval at the middle of the sequence. + > * ”edges”: Divide the extra slack as evenly as possible into intervals at beginning and end of the sequence. + + * **sequence\_min\_length\_ratios** (`Union`\[`int`, `List`\[`int`], `None`]) – List of minimum delay length to DD sequence ratio to satisfy in order to insert the DD sequence. For example if the X-X dynamical decoupling sequence is 320dt samples long and the available delay is 384dt it has a ratio of 384dt/320dt=1.2. From the perspective of dynamical decoupling this is likely to add more control noise than decoupling error rate reductions. The defaults value is 2.0. + + * **insert\_multiple\_cycles** (`bool`) – If the available duration exceeds 2\*sequence\_min\_length\_ratio\*duration(dd\_sequence) enable the insertion of multiple rounds of the dynamical decoupling sequence in that delay. + + * **coupling\_map** (`Optional`\[[`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.1)")]) – directed graph representing the coupling map for the device. Specifying a coupling map partitions the device into subcircuits, in order to apply DD sequences with different pulse spacings within each. Currently support 2 subcircuits. + + * **alt\_spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates, for the second subcircuit, as determined by the coupling map. If None, a balanced spacing that is staggered with respect to the first subcircuit will be used \[d, d, d, …, d, d, 0]. + + * **schedule\_idle\_qubits** (`bool`) – Set to true if you’d like a delay inserted on idle qubits. This is useful for timeline visualizations, but may cause issues for execution on large backends. + + * **dd\_barrier** (`Optional`\[`str`]) – only apply DD to delays terminating with a barrier whose label contains the specified string + + * **block\_ordering\_callable** (`Optional`\[`Callable`\[\[[`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)")], `Generator`\[[`DAGOpNode`](/api/qiskit/qiskit.dagcircuit.DAGOpNode "(in Qiskit v1.1)"), `None`, `None`]]]) – A callable used to produce an ordering of the nodes to minimize the number of blocks needed. If not provided, `block_order_op_nodes()` will be used. + + **Raises** + + * **TranspilerError** – When invalid DD sequence is specified. + * **TranspilerError** – When pulse gate with the duration which is non-multiple of the alignment constraint value is found. + * **TranspilerError** – When the coupling map is not supported (i.e., if degree > 3) + + ## Attributes + + ### is\_analysis\_pass + + + Check if the pass is an analysis pass. + + If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + ### is\_transformation\_pass + + + Check if the pass is a transformation pass. + + If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + + + ## Methods + + ### \_\_call\_\_ + + + Runs the pass on circuit. + + **Parameters** + + * **circuit** (*QuantumCircuit*) – The dag on which the pass is run. + * **property\_set** (*PropertySet | dict | None*) – Input/output property set. An analysis pass might change the property set in-place. + + **Return type** + + QuantumCircuit + + **Returns** + + If on transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit. + + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** (`Any`) – Qiskit IR to optimize. + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – State associated with workflow execution by the pass manager itself. + * **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + + **Return type** + + `tuple`\[`Any`, [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")] + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + + ### name + + + Name of the pass. + + **Return type** + + `str` + + + ### run + + + Run the padding pass on `dag`. + + **Parameters** + + **dag** ([`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)")) – DAG to be checked. + + **Returns** + + DAG with idle time filled with instructions. + + **Return type** + + DAGCircuit + + **Raises** + + **TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)")) – Pass manager state to update. + * **run\_state** (`RunState`) – Completion status of current task. + + **Return type** + + [`PassManagerState`](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.1)") + + **Returns** + + Updated pass manager state. + + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx new file mode 100644 index 00000000000..5fa9bdc0567 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx @@ -0,0 +1,374 @@ +--- +title: scheduling +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling +--- + + + + + +# Transpiler scheduling passes + + + +`qiskit_ibm_runtime.transpiler.passes.scheduling` + +A collection of scheduling passes for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical control-flow/feedback based off of measurement results. + + + You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.1)") or [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.1)"). + + +## Classes + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`BlockBasePadder`](qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder")(\[schedule\_idle\_qubits, ...]) | The base class of padding pass. | +| [`ALAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis")(durations\[, ...]) | Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. | +| [`ASAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis")(durations\[, ...]) | Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. | +| [`DynamicCircuitInstructionDurations`](qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations "qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations")(\[...]) | For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. | +| [`PadDelay`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay")(durations\[, fill\_very\_end, ...]) | Padding idle time with Delay instructions. | +| [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling")(durations, dd\_sequences) | Dynamical decoupling insertion pass for IBM dynamic circuit backends. | + +## Example usage + +Below we demonstrate how to schedule and pad a teleportation circuit with delays for a dynamic circuit backend’s execution model: + +```python +from qiskit.circuit import ClassicalRegister, QuantumCircuit, QuantumRegister +from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager +from qiskit.transpiler.passmanager import PassManager + +from qiskit_ibm_runtime.transpiler.passes.scheduling import DynamicCircuitInstructionDurations +from qiskit_ibm_runtime.transpiler.passes.scheduling import ALAPScheduleAnalysis +from qiskit_ibm_runtime.transpiler.passes.scheduling import PadDelay +from qiskit_ibm_runtime.fake_provider import FakeJakartaV2 + +backend = FakeJakartaV2() + +# Use this duration class to get appropriate durations for dynamic +# circuit backend scheduling +durations = DynamicCircuitInstructionDurations.from_backend(backend) +# Generate the main Qiskit transpile passes. +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +# Configure the as-late-as-possible scheduling pass +pm.scheduling = PassManager([ALAPScheduleAnalysis(durations), PadDelay(durations)]) + +qr = QuantumRegister(3) +crz = ClassicalRegister(1, name="crz") +crx = ClassicalRegister(1, name="crx") +result = ClassicalRegister(1, name="result") + +teleport = QuantumCircuit(qr, crz, crx, result, name="Teleport") + +teleport.h(qr[1]) +teleport.cx(qr[1], qr[2]) +teleport.cx(qr[0], qr[1]) +teleport.h(qr[0]) +teleport.measure(qr[0], crz) +teleport.measure(qr[1], crx) +with teleport.if_test((crz, 1)): + teleport.z(qr[2]) +with teleport.if_test((crx, 1)): + teleport.x(qr[2]) +teleport.measure(qr[2], result) + +# Transpile. +scheduled_teleport = pm.run(teleport) + +scheduled_teleport.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_0\_0.png](/images/api/qiskit-ibm-runtime/0.26/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.26/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png) + +When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.1)") function internally builds its pass set by using [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.1)"). This returns instances of [`StagedPassManager`](/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v1.1)"), 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.26/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png) + +The [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.1)"). 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.26/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png) + +If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.1)") 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.26/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.26/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.26/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.26/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.26/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.26/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.26/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.26/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.26/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.26/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.26/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.26/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png) + + diff --git a/docs/api/qiskit-ibm-runtime/0.26/runtime_service.mdx b/docs/api/qiskit-ibm-runtime/0.26/runtime_service.mdx new file mode 100644 index 00000000000..792dd892a86 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/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")(\[mode, 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")(\[mode, 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 primitive execution. | +| [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2")(backend, api\_client, ...\[, ...]) | Representation of a runtime V2 primitive exeuction. | +| [`RuntimeEncoder`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, ...]) | JSON Encoder used by runtime service. | +| [`RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | + diff --git a/docs/api/qiskit-ibm-runtime/0.26/transpiler.mdx b/docs/api/qiskit-ibm-runtime/0.26/transpiler.mdx new file mode 100644 index 00000000000..14ad90f1388 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.26/transpiler.mdx @@ -0,0 +1,26 @@ +--- +title: passes +description: API reference for qiskit_ibm_runtime.transpiler.passes +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler.passes +--- + + + + + +# Transpiler passes + + + +`qiskit_ibm_runtime.transpiler.passes` + +A collection of transpiler passes for IBM backends. Refer to [transpile](/transpile) to learn more about transpilation and passes. + +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| [`ConvertIdToDelay`](qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay "qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay")(durations\[, gate]) | Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. | + +See [`qiskit_ibm_runtime.transpiler.passes.scheduling`](qiskit_ibm_runtime.transpiler.passes.scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") for a collection of scheduling passes. + diff --git a/docs/api/qiskit-ibm-runtime/_package.json b/docs/api/qiskit-ibm-runtime/_package.json index df74448165f..a62be2a149e 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.26.0" + "version": "0.27.1" } diff --git a/docs/api/qiskit-ibm-runtime/dev/_package.json b/docs/api/qiskit-ibm-runtime/dev/_package.json index 495ec856d30..f813f911b92 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.27.0-dev" + "version": "0.28.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 18bde98c813..e1ae8c891da 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 @@ -19,7 +19,7 @@ python_api_name: qiskit_ibm_runtime.Batch * There is usually minimal delay between job, which can help avoid drift. * If you partition your workload into multiple jobs and run them in `batch` mode, you can get results from individual jobs, which makes them more flexible to work with. For example, if a job’s results do not meet your expectations, you can cancel the remaining jobs, or simply re-submit that individual job and avoid re-running the entire workload. - All jobs need to be provided at the outset. To submit iterative jobs, use the `session` mode instead. + Batch mode can shorten processing time if all jobs are provided at the outset. If you want to submit iterative jobs, use `session` mode instead. You can open a Qiskit Runtime batch by using this `Batch` class, then submit jobs to one or more primitives. @@ -51,7 +51,7 @@ python_api_name: qiskit_ibm_runtime.Batch print(f"Counts for the first PUB: {pub_result.data.cr.get_counts()}") ``` - For more details, check the “[Run jobs in a batch](/run/run-jobs-batch)” tutorial. + For more details, check the “[Run jobs in a batch](/guides/run-jobs-batch)” page. Batch constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit_ibm_runtime.Batch * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – Instance of `Backend` class or backend string name. Note that passing a backend name is deprecated. - * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). + * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/guides/max-execution-time). **Raises** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx index cfad70b16e2..abf4baef2c9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + alias of [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1") 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 c633105b1b8..ca3625a4db6 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 @@ -8,11 +8,11 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 # EstimatorV1 - + Class for interacting with Qiskit Runtime Estimator primitive service. - The `EstimatorV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/api/migration-guides/v2-primitives). for more details. The `EstimatorV1` support will be removed no earlier than July 15, 2024. + The `EstimatorV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/migration-guides/v2-primitives). for more details. The `EstimatorV1` support will be removed no earlier than July 15, 2024. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. @@ -99,7 +99,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 ### run - + Submit a request to the estimator primitive. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx index 61970b31856..2c695a9fc90 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. @@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 * A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode. * A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode. - Refer to the [Qiskit Runtime documentation](/run). for more information about the `Execution modes`. + Refer to the [Qiskit Runtime documentation](/guides/execution-modes). for more information about the `Execution modes`. * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – (DEPRECATED) 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. @@ -125,7 +125,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/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx index 269a60465e4..e313a401758 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + JSON Decoder used by runtime service. `object_hook`, if specified, will be called with the result of every JSON object decoded and its return value will be used in place of the given `dict`. This can be used to provide custom deserializations (e.g. to support JSON-RPC class hinting). @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder ### object\_hook - + Called to decode object. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx index 2389fba0891..be2a3e3aaa4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + JSON Encoder used by runtime service. Constructor for JSONEncoder, with sensible defaults. @@ -43,7 +43,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder ### default - + Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). For example, to support arbitrary iterators, you could implement default like this: diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx index a5f1a779025..f2a863738c9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/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/dev/qiskit_ibm_runtime.SamplerV1.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.mdx index 36eb0d4ebee..dc5b35e5929 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 @@ -8,11 +8,11 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 # SamplerV1 - + Class for interacting with Qiskit Runtime Sampler primitive service. - The `SamplerV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/api/migration-guides/v2-primitives). for more details. The `SamplerV1` support will be removed no earlier than July 15, 2024. + The `SamplerV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/migration-guides/v2-primitives). for more details. The `SamplerV1` support will be removed no earlier than July 15, 2024. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. @@ -91,7 +91,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 ### run - + Submit a request to the sampler primitive. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx index 0956d2f47bb..a46298a923e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx @@ -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. @@ -29,7 +29,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 * A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode. * A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode. - Refer to the [Qiskit Runtime documentation](/run). for more information about the `Execution modes`. + Refer to the [Qiskit Runtime documentation](/guides/execution-modes). for more information about the `Execution modes`. * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – (DEPRECATED) 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. @@ -93,7 +93,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/dev/qiskit_ibm_runtime.Session.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.mdx index f3dc7087713..fcc22f0c7e6 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 @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_runtime.Session * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – Instance of `Backend` class or string name of backend. Note that passing a backend name is deprecated. - * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). + * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/guides/max-execution-time). **Raises** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx index 371475f89bb..9386af72769 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner # NoiseLearner - + Class for executing noise learning experiments. @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner * A `Session` if you are using session execution mode. * A `Batch` if you are using batch execution mode. - Refer to the [Qiskit Runtime documentation](/run) for more information about the execution modes. + Refer to the [Qiskit Runtime documentation](/guides/execution-modes) for more information about the execution modes. * **options** (`Union`\[`Dict`, `NoiseLearnerOptions`, [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – `NoiseLearnerOptions`. Alternatively, `EstimatorOptions` can be provided for convenience, in which case the estimator options get reformatted into noise learner options and all the irrelevant fields are ignored. @@ -91,7 +91,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner ### run - + Submit a request to the noise learner program. This function breaks the given list of circuits into a list of unique layers, following the strategy set by the `twirling_strategy` field specified in the `options` (see `NoiseLearnerOptions` for more details) and sorting them based on the number of times they occur in the various circuits. Then, it runs the noise learning experiment for as many layers as specified by the `max_layers_to_learn` field in the `options`, prioritizing layers that occurr more frequently. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.mdx index 78082f44982..434b2c5f9cf 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 @@ -46,7 +46,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions * 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. + Refer to the [Configure error mitigation for Qiskit Runtime](/guides/configure-error-mitigation). for more information about the error mitigation methods used at each level. Default: 1. 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 184bf7c7882..168b2537f2a 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 @@ -31,13 +31,13 @@ python_api_name: qiskit_ibm_runtime.options.Options * 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. + Refer to the [Qiskit Runtime documentation](/guides/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. + Refer to the [Max execution time documentation](/guides/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. 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 cec3eae1206..7e3ffe30a9e 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,8 +8,44 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions # ZneOptions - - Zero noise extrapolation mitigation options. This is only used by V2 Estimator. + + Zero noise extrapolation mitigation options. This is only used by the V2 Estimator. + + ..note: + + ```python + Any V2 estimator is guaranteed to return data fields called ``evs`` and ``stds`` that + report the desired expectation value estimates and errors, respectively. + When ZNE options are enabled in the runtime estimator, additional data is returned. + + In particular, suppose an input pub has observable array shape ``obs_shape`` and parameter + values shape ``par_shape``, with corresponding pub shape + ``shape=np.broadcast_shapes(obs_shape, par_shape)``. Then the corresponding pub result will + additionally contain: + + 1. `pub_result.data.evs_extrapolated` and `pub_result.data.stds_extrapolated`, + both with shape ``(*shape, num_extrapolators, num_evaluation_points)``, where + ``num_extrapolators`` is the length of the list of + ``options.resilience.zne.extrapolators``, and ``num_evaluation_points`` is the length of + the list ``options.resilience.extrapolated_noise_factors``. These values provide + evaluations of every extrapolator at every specified noise extrapolation value. + 2. ``pub_result.data.evs_noise_factors``, ``pub_result.data.stds_noise_factors``, and + ``ensemble_stds_noise_factors`` all have shape ``(*shape, num_noise_factors)`` where + ``num_noise_factors`` is the length of ``options.resilience.zne.noise_factors``. These + values provide evaluations of the best-fit model at each of the noise amplifications. + In the case of no twirling, both ``*stds*`` arrays will be equal, otherwise, + ``stds_noise_factors`` is derived from the spread over twirling samples, whereas + ``ensemble_stds_noise_factors`` assumes only shot noise and no drift. + + Technical note: for single observables with multiple basis terms it might turn out that + multiple extrapolation methods are used in _the same_ expectation value, for example, ``XX`` + gets linearly extrapolated but ``XY`` gets exponentially extrapolated in the observable + ``{"XX": 0.5, "XY": 0.5}``. Let's call this a *hetergeneous fit*. The data from (2) is + evaluated from heterogeneous fits by selecting the best fit for every individual distinct + term, whereas data from (1) is evaluated from forced homogenous fits, one for each provided + extrapolator. If your work requires a nuanced distinction in this regard, we presently + recommend that you use single-term observables in addition to your multi-term observables. + ``` **Parameters** @@ -18,10 +54,20 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions Which technique to use for amplifying noise. One of: * ”gate\_folding” (default) uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are chosen randomly. + * ”gate\_folding\_front” uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are selected from the front of the topologically ordered DAG circuit. + * ”gate\_folding\_back” uses 2-qubit gate folding to amplify noise. If the noise factor requires amplifying only a subset of the gates, then these gates are selected from the back of the topologically ordered DAG circuit. - * **noise\_factors** – Noise factors to use for noise amplification. Default: (1, 3, 5). + * ”pea” uses a technique called probabalistic error amplification ([PEA](https://www.nature.com/articles/s41586-023-06096-3)) to amplify noise. + + When this option is selected, gate twirling will always be used whether or not it has been enabled in the options. + + In this technique, the twirled noise model of each each unique layer of entangling gates in your ISA circuits is learned beforehand, see [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for relevant learning options. Once complete, your circuits are executed at each noise factor, where every entangling layer of your circuits is amplified by probabilistically injecting single-qubit noise proportional to the corresponding learned noise model. + + * **noise\_factors** – Noise factors to use for noise amplification. Default: (1, 1.5, 2) for PEA, and (1, 3, 5) otherwise. + + * **extrapolated\_noise\_factors** – Noise factors to evaluate the fit extrapolation models at. If unset, this will default to `[0, *noise_factors]`. This option does not affect execution or model fitting in any way, it only determines the points at which the `extrapolator``s are evaluated to be returned in the data fields called ``evs_extrapolated` and `stds_extrapolated`. * **extrapolator** – @@ -38,7 +84,11 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions ### amplifier - + + + ### extrapolated\_noise\_factors + + ### extrapolator diff --git a/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx b/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx index 14ad90f1388..79808c8da48 100644 --- a/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx @@ -16,7 +16,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes `qiskit_ibm_runtime.transpiler.passes` -A collection of transpiler passes for IBM backends. Refer to [transpile](/transpile) to learn more about transpilation and passes. +A collection of transpiler passes for IBM backends. Refer to [guides/transpile](/guides/transpile) to learn more about transpilation and passes. | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx index 9650f307780..ecdf5baf50b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Batch.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Batch # Batch - + Class for running jobs in batch execution mode. The `batch` mode is designed to efficiently perform experiments that comprise multiple independent jobs. @@ -19,7 +19,7 @@ python_api_name: qiskit_ibm_runtime.Batch * There is usually minimal delay between job, which can help avoid drift. * If you partition your workload into multiple jobs and run them in `batch` mode, you can get results from individual jobs, which makes them more flexible to work with. For example, if a job’s results do not meet your expectations, you can cancel the remaining jobs, or simply re-submit that individual job and avoid re-running the entire workload. - All jobs need to be provided at the outset. To submit iterative jobs, use the `session` mode instead. + Batch mode can shorten processing time if all jobs are provided at the outset. If you want to submit iterative jobs, use `session` mode instead. You can open a Qiskit Runtime batch by using this `Batch` class, then submit jobs to one or more primitives. @@ -51,7 +51,7 @@ python_api_name: qiskit_ibm_runtime.Batch print(f"Counts for the first PUB: {pub_result.data.cr.get_counts()}") ``` - For more details, check the “[Run jobs in a batch](/run/run-jobs-batch)” tutorial. + For more details, check the “[Run jobs in a batch](/guides/run-jobs-batch)” page. Batch constructor. @@ -59,7 +59,7 @@ python_api_name: qiskit_ibm_runtime.Batch * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – Instance of `Backend` class or backend string name. Note that passing a backend name is deprecated. - * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). + * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/guides/max-execution-time). **Raises** @@ -99,7 +99,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### backend - + Return backend for this session. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### cancel - + Cancel all pending jobs in a session. **Return type** @@ -123,7 +123,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** @@ -133,7 +133,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### details - + Return session details. **Return type** @@ -162,7 +162,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### from\_id - + Construct a Session object with a given session\_id **Parameters** @@ -190,7 +190,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### run - + Run a program in the session. **Parameters** @@ -211,7 +211,7 @@ python_api_name: qiskit_ibm_runtime.Batch ### status - + Return current session status. **Return type** 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 6f7f53bcf81..6457346dded 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 b0de857f90f..4e49d9af6eb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.mdx @@ -8,11 +8,11 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 # EstimatorV1 - + Class for interacting with Qiskit Runtime Estimator primitive service. - The `EstimatorV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/api/migration-guides/v2-primitives). for more details. The `EstimatorV1` support will be removed no earlier than July 15, 2024. + The `EstimatorV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/migration-guides/v2-primitives). for more details. The `EstimatorV1` support will be removed no earlier than July 15, 2024. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. @@ -99,7 +99,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV1 ### run - + Submit a request to the estimator primitive. **Parameters** @@ -124,7 +124,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 a6a082f5102..45f634a04bf 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. @@ -61,7 +61,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 * A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode. * A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode. - Refer to the [Qiskit Runtime documentation](/run). for more information about the `Execution modes`. + Refer to the [Qiskit Runtime documentation](/guides/execution-modes). for more information about the `Execution modes`. * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – (DEPRECATED) 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. @@ -125,7 +125,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 2eec9c000e0..8baeaf2bb78 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 ### get\_translation\_stage\_plugin - + Return the default translation stage plugin name for IBM backends. **Return type** @@ -487,7 +487,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### measure\_channel - + Return the measure stimulus channel for the given qubit. **Returns** @@ -501,7 +501,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### open\_session - + Open session **Return type** @@ -511,7 +511,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. @@ -563,7 +563,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** @@ -652,7 +652,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### status - + Return the backend status. @@ -674,7 +674,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### target\_history - + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") object for the backend. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 647d600ee63..2f4ff161d2a 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 @@ -70,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### active\_account - + Return the IBM Quantum account currently in use for the session. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backend - + Return a single backend matching the specified filtering. **Parameters** @@ -108,7 +108,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backends - + Return all backends accessible via this account, subject to optional filtering. **Parameters** @@ -169,7 +169,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### check\_pending\_jobs - + Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached. **Return type** @@ -179,7 +179,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -199,7 +199,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_job - + Delete a runtime job. Note that this operation cannot be reversed. @@ -220,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### get\_backend - + Return a single backend matching the specified filtering. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### instances - + Return the IBM Quantum instances list currently in use for the session. **Return type** @@ -244,7 +244,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### job - + Retrieve a runtime job. **Parameters** @@ -267,7 +267,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### jobs - + Retrieve all runtime jobs, subject to optional filtering. **Parameters** @@ -299,7 +299,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### least\_busy - + Return the least busy available backend. **Parameters** @@ -331,7 +331,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### run - + Execute the runtime program. **Parameters** @@ -372,7 +372,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** @@ -422,7 +422,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### usage - + Return monthly open plan usage information. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.mdx index 462bdb4a27a..d0c310bdeb2 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 d562873421f..a8d5ed872d0 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 388acfbc3c7..2e0cf21a714 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - + Representation of a runtime primitive execution. A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime primitive, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. @@ -179,7 +179,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** @@ -193,7 +193,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### cancel - + Cancel the job. **Raises** @@ -208,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### cancel\_result\_streaming - + Cancel result streaming. **Return type** @@ -238,7 +238,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### error\_message - + Returns the reason if the job failed. **Return type** @@ -252,7 +252,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### errored - + Return whether the job has failed. **Return type** @@ -262,7 +262,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** @@ -272,7 +272,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### interim\_results - + Return the interim results of the job. **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### logs - + Return job logs. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### metrics - + Return job metrics. **Return type** @@ -344,7 +344,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### properties - + Return the backend properties for this job. **Parameters** @@ -362,7 +362,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. @@ -382,7 +382,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### queue\_position - + Return the position of the job in the server queue. @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### result - + Return the results of the job. **Parameters** @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### status - + Return the status of the job. **Return type** @@ -453,7 +453,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### stream\_results - + Start streaming job results. **Parameters** @@ -478,7 +478,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### submit - + Unsupported method. .. note: ```python @@ -498,7 +498,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### update\_tags - + Update the tags associated with this job. **Parameters** @@ -520,7 +520,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob ### wait\_for\_final\_state - + Poll for the job status from the API until the status is in a final state. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2.mdx index 9cb951ad936..ef71a734b14 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. @@ -157,7 +157,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** @@ -171,7 +171,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancel - + Cancel the job. **Raises** @@ -186,7 +186,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancel\_result\_streaming - + Cancel result streaming. **Return type** @@ -196,7 +196,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### cancelled - + Return whether the job has been cancelled. **Return type** @@ -206,7 +206,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### done - + Return whether the job has successfully run. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### error\_message - + Returns the reason if the job failed. **Return type** @@ -230,7 +230,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### errored - + Return whether the job has failed. **Return type** @@ -240,7 +240,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** @@ -250,7 +250,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### interim\_results - + Return the interim results of the job. **Parameters** @@ -282,7 +282,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### logs - + Return job logs. @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### metrics - + Return job metrics. **Return type** @@ -322,7 +322,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### properties - + Return the backend properties for this job. **Parameters** @@ -340,7 +340,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### result - + Return the results of the job. **Parameters** @@ -365,7 +365,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### running - + Return whether the job is actively running. **Return type** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### status - + Return the status of the job. **Return type** @@ -389,7 +389,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### stream\_results - + Start streaming job results. **Parameters** @@ -414,7 +414,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### update\_tags - + Update the tags associated with this job. **Parameters** @@ -436,7 +436,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 ### wait\_for\_final\_state - + Poll for the job status from the API until the status is in a final state. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.mdx index a52f4bbfe8b..a959bf3a105 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 e15fb7eccc9..aaea40c7a77 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.mdx @@ -8,11 +8,11 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 # SamplerV1 - + Class for interacting with Qiskit Runtime Sampler primitive service. - The `SamplerV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/api/migration-guides/v2-primitives). for more details. The `SamplerV1` support will be removed no earlier than July 15, 2024. + The `SamplerV1` primitives have been deprecated in 0.23, released on April 15, 2024. See the [V2 migration guide](/migration-guides/v2-primitives). for more details. The `SamplerV1` support will be removed no earlier than July 15, 2024. Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. @@ -91,7 +91,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV1 ### run - + Submit a request to the sampler primitive. **Parameters** @@ -115,7 +115,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 2964a7fd0c4..90140074191 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. @@ -29,7 +29,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 * A [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") if you are using session execution mode. * A [`Batch`](qiskit_ibm_runtime.Batch "qiskit_ibm_runtime.Batch") if you are using batch execution mode. - Refer to the [Qiskit Runtime documentation](/run). for more information about the `Execution modes`. + Refer to the [Qiskit Runtime documentation](/guides/execution-modes). for more information about the `Execution modes`. * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – (DEPRECATED) 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. @@ -93,7 +93,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 7f041807df8..1c8014f5960 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. @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_runtime.Session * **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – (DEPRECATED) Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. * **backend** (`Union`\[`str`, [`BackendV1`](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.1)"), [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.1)"), `None`]) – Instance of `Backend` class or string name of backend. Note that passing a backend name is deprecated. - * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/run/max-execution-time). + * **max\_time** (`Union`\[`int`, `str`, `None`]) – Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/guides/max-execution-time). **Raises** @@ -90,7 +90,7 @@ python_api_name: qiskit_ibm_runtime.Session ### backend - + Return backend for this session. **Return type** @@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_runtime.Session ### cancel - + Cancel all pending jobs in a session. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit_ibm_runtime.Session ### close - + Close the session so new jobs will no longer be accepted, but existing queued or running jobs will run to completion. The session will be terminated once there are no more pending jobs. **Return type** @@ -124,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.Session ### details - + Return session details. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit_ibm_runtime.Session ### from\_id - + Construct a Session object with a given session\_id **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit_ibm_runtime.Session ### run - + Run a program in the session. **Parameters** @@ -202,7 +202,7 @@ python_api_name: qiskit_ibm_runtime.Session ### status - + Return current session status. **Return type** 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 8890ca55c0e..721ea0c52dc 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers # FakeAlgiers - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.mdx index 7208c50e431..c416551b1c1 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 c153acee9f5..ce0846f6f73 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 # FakeAlmadenV2 - + A fake Almaden V2 backend. ```python @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.mdx index f92c3b47768..328b3063d64 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 bd8c8f338f1..6fe178cee35 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 # FakeArmonkV2 - + A fake 1 qubit backend. ```python @@ -213,7 +213,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -229,7 +229,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### configuration - + Return the backend configuration. **Return type** @@ -257,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -279,7 +279,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -298,7 +298,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -314,7 +314,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -330,7 +330,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### properties - + Return the backend properties **Parameters** @@ -373,7 +373,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -398,7 +398,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -443,7 +443,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.mdx index a07f886c864..f7cdbe0c09e 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 3d573f2a09b..15615b72bc0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 # FakeAthensV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index 01b715e64b7..c0ca079cef8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland # FakeAuckland - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.mdx index 9bbffee75a6..056813f3ab0 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 d5332e3eecc..0d32a79a443 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 # FakeBelemV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.mdx index 3525cc3a394..729881b6e8f 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 5fd491bd689..b512bde050f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 # FakeBoeblingenV2 - + A fake Boeblingen V2 backend. ```python @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.mdx index 31ee7aecf91..9f845b65286 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 df1c7cf744e..029a5fe1754 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 # FakeBogotaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx index 0a2c5e44eab..1e7332d77bc 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane # FakeBrisbane - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.mdx index c20fe347974..051bd7f5090 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 e1bb59aa8e0..e2f420da01d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 # FakeBrooklynV2 - + A fake Brooklyn V2 backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.mdx index a9a21d266aa..d49b79de432 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 127a5a9d700..dae891e2c1f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 # FakeBurlingtonV2 - + A fake 5 qubit backend. ```python @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.mdx index f7cf144706d..59596ffd4e3 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 5fc9e89f0f3..c5869a4d526 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 # FakeCairoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.mdx index 1076dbffe39..f4eda19fd08 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 d7badebe8f3..07a2a90ee9e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 # FakeCambridgeV2 - + A fake Cambridge backend. ```python @@ -221,7 +221,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -237,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### configuration - + Return the backend configuration. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -287,7 +287,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -306,7 +306,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -322,7 +322,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -338,7 +338,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### properties - + Return the backend properties **Parameters** @@ -381,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -406,7 +406,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -451,7 +451,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.mdx index d482fbaef46..80a2f1596bb 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 88bb1c79389..7f4eb0b6bb0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 # FakeCasablancaV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx index 37bf981685a..7068b283a20 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco # FakeCusco - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.mdx index 30cbd86c1c5..195b2c5803d 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 6079d3f9702..40efb04962d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 # FakeEssexV2 - + A fake 5 qubit backend. ```python @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx index 6cb37372fdf..73675e82003 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend # FakeFractionalBackend - + A fake 5 qubit backend with dynamic and fractional feature modeled based on FakeLima. This backend include following features. @@ -216,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -232,7 +232,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### configuration - + Return the backend configuration. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -282,7 +282,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -301,7 +301,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -317,7 +317,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -333,7 +333,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### properties - + Return the backend properties **Parameters** @@ -376,7 +376,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -401,7 +401,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -446,7 +446,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index 51f16b76d7c..2a08ef3df88 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva # FakeGeneva - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.mdx index 8f1a6834a32..5edb2ec7095 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 beb76493cda..88e573ce9c9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 # FakeGuadalupeV2 - + A fake 16 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.mdx index 8098ae34f32..af11482cd59 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 f3c313c8522..e4c478dfed0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 # FakeHanoiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.mdx index 79946b6f86c..36382818cb7 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 d0c2a48553d..40e08f6dfd4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 # FakeJakartaV2 - + A fake 7 qubit V2 backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.mdx index 3f30a5ce9af..848df52a10d 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 39e96448d97..2eca997abd4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 # FakeJohannesburgV2 - + A fake Johannesburg V2 backend. ```python @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx index ad313e3060e..a14ede04b7b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki # FakeKawasaki - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.mdx index b06c4a9a607..9bc781d3492 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 c8ef0359185..2234cd0103c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 # FakeKolkataV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx index 82951060f81..b7de1c6454c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv # FakeKyiv - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx index 1c9e9c39f41..4db97d98d32 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto # FakeKyoto - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.mdx index dab07147397..f6bd5bc5be9 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 0ac27a26482..fc33d98d31d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 # FakeLagosV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.mdx index b9decbce941..444d64f0bd2 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 81c83d200a4..372e5f89e2f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 # FakeLimaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.mdx index 25a97233276..b3fbfb9f25e 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 387102b7f98..77848d86330 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 # FakeLondonV2 - + A fake 5 qubit backend. ```python @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.mdx index cf901c511da..6c6ced205b3 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 6234f348dd6..97675cdda33 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 # FakeManhattanV2 - + A fake Manhattan backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.mdx index 8153afefb88..cc165f85693 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 ced90cc7dd5..65e3bb4982e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 # FakeManilaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.mdx index 276f6340147..50d5f14f297 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 197bc00723c..c5aa146e036 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 # FakeMelbourneV2 - + A fake 14 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.mdx index 30b41c42e8a..021641afb6b 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 ebf64095f8e..748fe83d9e4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 # FakeMontrealV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.mdx index 0536fbc6b60..cb308884817 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 26f5dedf437..8674536d8ef 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 # FakeMumbaiV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.mdx index 7e91ccf5eab..90c94b64046 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 e443019cc17..3e810f4cacb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 # FakeNairobiV2 - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx index db955c0a890..d59dbe1c49b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka # FakeOsaka - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index 4b0b244756f..0f4aeaf32ec 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo # FakeOslo - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.mdx index cb9e758d8cd..e1c40eaf689 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 30ef015fac4..e4250da355d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 # FakeOurenseV2 - + A fake 5 qubit backend. ```python @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.mdx index c26b1811f09..53f0cfe45b0 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 2f2f9fdc206..8b45775d4d1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 # FakeParisV2 - + A fake Paris backend. ```python @@ -221,7 +221,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -237,7 +237,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### configuration - + Return the backend configuration. **Return type** @@ -265,7 +265,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -287,7 +287,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -306,7 +306,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -322,7 +322,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -338,7 +338,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### properties - + Return the backend properties **Parameters** @@ -381,7 +381,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -406,7 +406,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -451,7 +451,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx index 790e047cd9a..73555f43eb0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill # FakePeekskill - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index ec3f6442416..f5fda53def4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth # FakePerth - + A fake 7 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.mdx index 33efb2c8967..e5f55249bc1 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 757aeea5151..b04b892d5b9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 # FakePoughkeepsieV2 - + A fake Poughkeepsie backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index a4f9a3c0dc6..9aa918e1761 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague # FakePrague - + A fake 33 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.mdx index 02ffacde0b9..d49577a2967 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"). @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider ### backends - + Return a list of backends matching the specified filtering. **Parameters** @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider ### get\_backend - + Return a single backend matching the specified filtering. 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 a129eae5b33..77057a51387 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 # FakeProviderForBackendV2 - + Fake provider containing fake V2 backends. Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). @@ -17,7 +17,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 ### backend - + Filter backends in provider by name. **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 ### backends - + Return all backends accessible via this account. **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 ### get\_backend - + Return a single backend matching the specified filtering. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx index b3cc0d3f173..34ca4f8131c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec # FakeQuebec - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.mdx index fb24d87ba65..4133d6be2cc 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 e88214373b9..5337ba7ef4f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 # FakeQuitoV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.mdx index e0ee21fa05a..8ac6956afe9 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 618eef229a3..6560cb60cc5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 # FakeRochesterV2 - + A fake Rochester backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.mdx index 441203aceb3..8439d8a5185 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 b62a79d8796..ef7ae662fff 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 # FakeRomeV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.mdx index 65c575472da..e5d328dc603 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 b057265d89b..ed8c34daf4e 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 3eb6fd49cc2..0afae550c8f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 # FakeSantiagoV2 - + A fake Santiago backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index 8dd897ab14a..f08aa3fde72 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke # FakeSherbrooke - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.mdx index 6b33d7469bb..2856dab8add 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 627e277f655..adc89a7d649 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 # FakeSingaporeV2 - + A fake Singapore backend. ```python @@ -219,7 +219,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### configuration - + Return the backend configuration. **Return type** @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -285,7 +285,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -304,7 +304,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -320,7 +320,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -336,7 +336,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### properties - + Return the backend properties **Parameters** @@ -379,7 +379,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -404,7 +404,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -449,7 +449,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.mdx index 440dfef0fb1..33eff6e82e3 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 b7dc9418398..eee8dc17f8e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 # FakeSydneyV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.mdx index b8112f974c1..964a6870892 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 fe22e419807..a97d59c502f 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 adb97c7d78c..fee2074f6e2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino # FakeTorino - + A fake 133 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.mdx index f1269ea583e..1aca633d64a 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 415876a9e42..31fc6ec5a9e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 # FakeTorontoV2 - + A fake 27 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.mdx index b49cf44887f..e960d8e7816 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 c3086075bc2..ed198bfc332 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 # FakeValenciaV2 - + A fake 5 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.mdx index 6612788d79d..b86dddea7f1 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 3b0ba5f098a..59cdf792eb6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 # FakeVigoV2 - + A fake 5 qubit backend. ```python @@ -215,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -231,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -249,7 +249,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### configuration - + Return the backend configuration. **Return type** @@ -259,7 +259,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -281,7 +281,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -300,7 +300,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -316,7 +316,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -332,7 +332,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### properties - + Return the backend properties **Parameters** @@ -375,7 +375,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -400,7 +400,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -445,7 +445,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.mdx index ffc7daaea8b..98a26a44701 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 04c5690bd1a..8fa199aed9e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 # FakeWashingtonV2 - + A fake 127 qubit backend. FakeBackendV2 initializer. @@ -209,7 +209,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -225,7 +225,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -243,7 +243,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### configuration - + Return the backend configuration. **Return type** @@ -253,7 +253,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -275,7 +275,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -294,7 +294,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -310,7 +310,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -326,7 +326,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### properties - + Return the backend properties **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -394,7 +394,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -439,7 +439,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.mdx index b5502bc9f23..a20cdd1a3c4 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 130ada3bedd..2744c495282 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 # FakeYorktownV2 - + A fake 5 qubit backend. ```python @@ -217,7 +217,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -233,7 +233,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### check\_faulty - + Check if the input circuit uses faulty qubits or edges. **Parameters** @@ -251,7 +251,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### configuration - + Return the backend configuration. **Return type** @@ -261,7 +261,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### control\_channel - + Return the secondary drive channel for the given qubit This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### defaults - + Return the pulse defaults for the backend **Parameters** @@ -302,7 +302,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -318,7 +318,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -334,7 +334,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### properties - + Return the backend properties **Parameters** @@ -377,7 +377,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### refresh - + Update the data files from its real counterpart This method pulls the latest backend data files from their real counterpart and overwrites the corresponding files in the local installation: \* ../fake\_provider/backends/\{backend\_name}/conf\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/defs\_\{backend\_name}.json \* ../fake\_provider/backends/\{backend\_name}/props\_\{backend\_name}.json @@ -402,7 +402,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### run - + Run on the fake backend using a simulator. This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.1)") object. @@ -447,7 +447,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### status - + Return the backend status. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx index 630840a9852..f21dc68e8dd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner # NoiseLearner - + Class for executing noise learning experiments. @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner * A `Session` if you are using session execution mode. * A `Batch` if you are using batch execution mode. - Refer to the [Qiskit Runtime documentation](/run) for more information about the execution modes. + Refer to the [Qiskit Runtime documentation](/guides/execution-modes) for more information about the execution modes. * **options** (`Union`\[`Dict`, `NoiseLearnerOptions`, [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – `NoiseLearnerOptions`. Alternatively, `EstimatorOptions` can be provided for convenience, in which case the estimator options get reformatted into noise learner options and all the irrelevant fields are ignored. @@ -91,7 +91,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner ### run - + Submit a request to the noise learner program. This function breaks the given list of circuits into a list of unique layers, following the strategy set by the `twirling_strategy` field specified in the `options` (see `NoiseLearnerOptions` for more details) and sorting them based on the number of times they occur in the various circuits. Then, it runs the noise learning experiment for as many layers as specified by the `max_layers_to_learn` field in the `options`, prioritizing layers that occurr more frequently. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx index 059bc5ea382..c246d16be9a 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 31fd98b6f9b..2de694cb65b 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. This applies to both V1 and V2 primitives. **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 f111329293d..d7d73ffbb54 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** @@ -46,7 +46,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions * 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. + Refer to the [Configure error mitigation for Qiskit Runtime](/guides/configure-error-mitigation). for more information about the error mitigation methods used at each level. Default: 1. @@ -130,7 +130,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 1a3b1172337..047fb60d86b 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 ad7d21af0cf..8b9078dc3ef 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptionsV2 # ExecutionOptionsV2 - + Execution options for V2 primitives. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.mdx index d6776f257ef..eae5fd01c17 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. This is only used by V2 Estimator. 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 a4ad3ae68c6..cbd631dade3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.MeasureNoiseLearningOptions # MeasureNoiseLearningOptions - + Options for measurement noise learning. This is only used by V2 Estimator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.mdx index 424495a5072..0c842c211d5 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 V1 primitives. **Parameters** @@ -31,13 +31,13 @@ python_api_name: qiskit_ibm_runtime.options.Options * 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. + Refer to the [Qiskit Runtime documentation](/guides/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. + Refer to the [Max execution time documentation](/guides/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. @@ -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 502f2c80a59..16341a7ab8b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.PecOptions # PecOptions - + Probabalistic error cancellation mitigation options. This is only used by V2 Estimator. **Parameters** 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 40922335814..a9e3743e0b4 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 81b7b6277d0..58bc128d4f6 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.SamplerExecutionOptionsV2.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx index a2793503e48..ed51e68ae47 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerExecutionOptionsV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerExecutionOptionsV2 # SamplerExecutionOptionsV2 - + Extension of [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. ## Attributes diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.mdx index 7b4fbe606c4..2266550358a 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** @@ -57,7 +57,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions ### update - + Update the options. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.mdx index 3a37025c7cb..da1e93b07b1 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 14420099eee..b92eaab28e4 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. This is only used by V1 primitives. **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 fa1ecb126c9..8865a7f637c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions # TwirlingOptions - + Twirling options. This is only used by V2 primitives. **Parameters** 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 de6d49889c4..187ca02742b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions # ZneOptions - + Zero noise extrapolation mitigation options. This is only used by V2 Estimator. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx index 09a1488fe5c..df700b4a23e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay # ConvertIdToDelay - + Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. Convert [`qiskit.circuit.library.IGate`](/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.1)") to a Convert [`qiskit.circuit.Delay`](/api/qiskit/circuit#qiskit.circuit.Delay "(in Qiskit v1.1)"). @@ -89,7 +89,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index a43005b2b4f..568bb815add 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna # ALAPScheduleAnalysis - + Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. @@ -103,7 +103,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna ### run - + Run the ASAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)") :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 d03bb878cd9..b3ed5b83adc 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna # ASAPScheduleAnalysis - + Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. @@ -103,7 +103,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna ### run - + Run the ALAPSchedule pass on dag. :type dag: [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.1)") :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 e0887b21fde..70545d3f9f0 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 eb3eadc1c23..af40f39860a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - + For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. Dynamic circuit instruction durations. @@ -27,7 +27,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_backend - + Construct a `DynamicInstructionDurations` object from the backend. :type backend: [`Backend`](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.1)") :param backend: backend from which durations (gate lengths) and dt are extracted. **Returns** @@ -41,7 +41,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI ### from\_target - + Construct a `DynamicInstructionDurations` object from the target. :type target: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.1)") :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 44a222f9223..8e250877eb3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay # PadDelay - + Padding idle time with Delay instructions. Consecutive delays will be merged in the output of this pass. @@ -107,7 +107,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay ### run - + Run the padding pass on `dag`. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index fda9797ba8a..19d98ef3eda 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Dynamical decoupling insertion pass for IBM dynamic circuit backends. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). @@ -244,7 +244,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec ### run - + Run the padding pass on `dag`. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/release-notes.mdx b/docs/api/qiskit-ibm-runtime/release-notes.mdx index ff8bfa07cc3..723d9ee6965 100644 --- a/docs/api/qiskit-ibm-runtime/release-notes.mdx +++ b/docs/api/qiskit-ibm-runtime/release-notes.mdx @@ -8,6 +8,28 @@ in_page_toc_max_heading_level: 2 +## 0.27.1 (2024-08-12) + +### New Features + +* Added logic to encode and decode `PauliLindbladError` and `LayerError`. ([1853](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1853)) + + + +## 0.27.0 (2024-08-08) + + + +### New Features + +* Added `PauliLindbladError` and `LayerError` classes to represent layers noise processes. ([1844](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1844)) + +### Bug Fixes + +* Fixed an issue with using the aer simulator and local service mode with sessions. ([1838](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1838)) + + + ## 0.26.0 (2024-07-31) ### Deprecation Notes @@ -15,6 +37,9 @@ in_page_toc_max_heading_level: 2 * Passing in a backend as a string into `Session`, `Batch`, `EstimatorV2`, and `SamplerV2` has been deprecated. Use the actual backend object instead. ([1804](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1804)) * Passing a backend as the mode in `SamplerV2` and `EstimatorV2` currently runs a job in job mode even if inside of a `Session` or `Batch` context manager. This behavior is deprecated and in a future release the the Session/Batch will take precedence. ([1816](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1816)) * Passing in `service` in `Session`, `Batch` has been deprecated. The `service` parameter is no longer necessary because the service can be extracted from the backend. ([1826](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1826)) +* Since backend modules from `qiskit.providers.models` including `BackendProperties` and `BackendConfiguration` are deprecated in Qiskit 1.2, they have been copied into `qiskit-ibm-runtime`. Make sure to upgrade to the latest version, `0.26.0`, to use these classes. ([1803](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1803)) + + ### New Features @@ -36,6 +61,8 @@ in_page_toc_max_heading_level: 2 * Added `NoiseLearner` and related functionality, such as `NoiseLearnerOptions` and `NoiseLearnerResults`. ([1805](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1805)) + + ### Bug Fixes * Every circuit is checked to be ISA compliant. As part of this check, an error is raised if instructions that are not supported by the backend are detected. Previously, a bug caused some of the instructions to be skipped (those that reside inside bodies of control flow operations). We have fixed the bug in this release. ([1784](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1784)) @@ -43,18 +70,18 @@ in_page_toc_max_heading_level: 2 * The options validation for checking if `zne_mitigation` or `pec_mitigation` are set to `True` when using other related options has been removed. ([1792](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1792)) * Fixed an issue where users were unable to retrieve job results if the python library `simplejson` was installed in their environment. ([1800](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1800)) - + ## 0.25.0 (2024-07-02) - + ### Deprecation Notes * The `optimization_level` option in `EstimatorV2` is deprecated. Instead, you can perform circuit optimization using the Qiskit transpiler or Qiskit transpiler service. ([1748](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1748)) * [`qiskit_ibm_runtime.RuntimeJobV2.interim_results()`](qiskit_ibm_runtime.RuntimeJobV2#interim_results "qiskit_ibm_runtime.RuntimeJobV2.interim_results"), [`qiskit_ibm_runtime.RuntimeJobV2.stream_results()`](qiskit_ibm_runtime.RuntimeJobV2#stream_results "qiskit_ibm_runtime.RuntimeJobV2.stream_results"), [`qiskit_ibm_runtime.RuntimeJob.interim_results()`](qiskit_ibm_runtime.RuntimeJob#interim_results "qiskit_ibm_runtime.RuntimeJob.interim_results"), and [`qiskit_ibm_runtime.RuntimeJob.stream_results()`](qiskit_ibm_runtime.RuntimeJob#stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") are now all deprecated. ([1776](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1776)) - + ### New Features @@ -62,21 +89,21 @@ in_page_toc_max_heading_level: 2 * Added an `instance` property to `BaseRuntimeJob` which returns the instance where the job was run. ([1771](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1771)) * `default_shots` are now a supported option when using `EstimatorV2` in local testing mode. ([1773](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1773)) - + ## 0.24.1 (2024-06-18) - + ### Bug Fixes * Disallowing fractional gates by default, so backend target would not exclude control flow. ([1755](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1755)) - + ## 0.24.0 (2024-06-10) - + ### Deprecation Notes @@ -88,13 +115,13 @@ in_page_toc_max_heading_level: 2 [`qiskit_ibm_runtime.RuntimeJob.program_id()`](qiskit_ibm_runtime.RuntimeJob#program_id "qiskit_ibm_runtime.RuntimeJob.program_id") is deprecated and will be replaced by [`qiskit_ibm_runtime.RuntimeJob.primitive_id()`](qiskit_ibm_runtime.RuntimeJob#primitive_id "qiskit_ibm_runtime.RuntimeJob.primitive_id"). ([1238](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1238)) -* The `backend` argument in [Sampler](/run/primitives-get-started#3-initialize-the-qiskit-runtime-sampler) and [Estimator](/run/primitives-get-started#3-initialize-qiskit-runtime-estimator) has been deprecated. Please use `mode` instead. The `session` argument in [Sampler](/run/primitives-get-started#3-initialize-the-qiskit-runtime-sampler) and [Estimator](/run/primitives-get-started#3-initialize-qiskit-runtime-estimator) has also been deprecated. Please use `mode` instead. ([1556](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1556)) +* The `backend` argument in [Sampler](/guides/get-started-with-primitives#3-initialize-the-qiskit-runtime-sampler) and [Estimator](/guides/get-started-with-primitives#3-initialize-qiskit-runtime-estimator) has been deprecated. Please use `mode` instead. The `session` argument in [Sampler](/guides/get-started-with-primitives#3-initialize-the-qiskit-runtime-sampler) and [Estimator](/guides/get-started-with-primitives#3-initialize-qiskit-runtime-estimator) has also been deprecated. Please use `mode` instead. ([1556](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1556)) * [`qiskit_ibm_runtime.QiskitRuntimeService.get_backend()`](qiskit_ibm_runtime.QiskitRuntimeService#get_backend "qiskit_ibm_runtime.QiskitRuntimeService.get_backend") is deprecated. Please [`qiskit_ibm_runtime.QiskitRuntimeService.backend()`](qiskit_ibm_runtime.QiskitRuntimeService#backend "qiskit_ibm_runtime.QiskitRuntimeService.backend") use instead. The V1 fake backends, `FakeBackend`, along with [`FakeProvider`](qiskit_ibm_runtime.fake_provider.FakeProvider "qiskit_ibm_runtime.fake_provider.FakeProvider") are also being deprecated in favor of the V2 fake backends and [`FakeProviderForBackendV2`](qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 "qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2"). ([1689](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1689)) * Specifying options without the full dictionary structure is deprecated. Instead, pass in a fully structured dictionary. For example, use `{'environment': {'log_level': 'INFO'}}` instead of `{'log_level': 'INFO'}`. ([1731](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1731)) - + ### New Features @@ -133,7 +160,7 @@ in_page_toc_max_heading_level: 2 * [`QiskitRuntimeService.backends()`](qiskit_ibm_runtime.QiskitRuntimeService#backends "qiskit_ibm_runtime.QiskitRuntimeService.backends") now always returns a new `IBMBackend` instance even when the same query is used. The backend properties and defaults data are retrieved from the server for every instance when they are accessed for the first time, while the configuration data is cached internally in the service instance. ([1732](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1732)) - + ### Bug Fixes @@ -145,18 +172,18 @@ in_page_toc_max_heading_level: 2 * Fixed nested experimental suboptions override non-experimental suboptions. ([1731](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1731)) * The backend utils method `convert_to_target` has been replaced with the [convert\_to\_target](/api/qiskit/qiskit.providers.convert_to_target) method from Qiskit. This fixes some issues related to target generation and calibration data. ([1600](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1600)) - + ## 0.23.0 (2024-04-15) - + ### Deprecation Notes -* [backend.run()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#run) has been deprecated. Please use the primitives instead. More details can be found in the [migration guide](/api/migration-guides/qiskit-runtime) . ([1561](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1561)) +* [backend.run()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#run) has been deprecated. Please use the primitives instead. More details can be found in the [migration guide](/migration-guides/qiskit-runtime) . ([1561](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1561)) * In a future release, the `service` parameter in [from\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#from_id) will be required. ([1311](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1311)) - + ### New Features @@ -166,7 +193,7 @@ in_page_toc_max_heading_level: 2 * [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.SamplerV2") now supports twirling. Twirling will only be applied to those measurement registers not involved within a conditional logic. ([1557](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1557)) * Session [details()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#details) now includes a new field, `usage_time`. Usage is defined as the time a quantum system is committed to complete a job. ([1567](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1567)) - + ### Bug Fixes @@ -175,59 +202,59 @@ in_page_toc_max_heading_level: 2 * Fixed a bug with encoding/decoding `ParameterExpression`. ([1521](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1521)) * Fixed an issue where the [in\_final\_state()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJobV2#in_final_state) method in [`RuntimeJobV2`](qiskit_ibm_runtime.RuntimeJobV2 "qiskit_ibm_runtime.RuntimeJobV2") would not update the status when called. ([1547](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1547)) - + ## 0.22.0 (2024-03-21) - + ### Upgrade Notes * Modify `skip_reset_qubits` optional flag to the constructor for [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling"). If `False`, dynamical decoupling is applied on qubits regardless of their state, even on delays that are at the beginning of a circuit. This option now matches the behavior in Qiskit. ([1409](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1409)) - + ### New Features * A new local testing mode is added. It allows you to validate your quantum prorams before sending them to a physical system. The local testing mode is activated if one of the fake backends in `qiskit_ibm_runtime.fake_provider` or a Qiskit Aer backend instance is used when instantiating a primitive or a session. ([1495](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1495)) - + ### Bug Fixes * Fix a bug that caused setting of `resilience_level=0` in `EstimatorV2` to be ignored (and the default value used instead). ([1541](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1541)) - + ## 0.21.2 (2024-03-18) - + ### Bug Fixes * Fixed a bug where `RuntimeDecoder` could import arbitrary classes. ([1527](https://github.com/Qiskit/qiskit-ibm-runtime/pull/1527)) - + ## 0.21.1 - + ### Bug Fixes * Fixed a bug where `SamplerV1` and `EstimatorV1` could not be imported because of an issue with how the aliases were defined. - + ## 0.21.0 - + ### Upgrade Notes -* Circuits that do not match the target hardware definition are no longer supported by Qiskit Runtime primitives, unless `channel_strategy="q-ctrl"` is used. See the transpilation documentation ([transpile](/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/run/primitives-examples)) to see this coupled with operator transformations. +* Circuits that do not match the target hardware definition are no longer supported by Qiskit Runtime primitives, unless `channel_strategy="q-ctrl"` is used. See the transpilation documentation ([transpile](/guides/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/guides/primitives-examples)) to see this coupled with operator transformations. - + ### Deprecation Notes @@ -235,7 +262,7 @@ in_page_toc_max_heading_level: 2 It will also be a required parameter for `qiskit_ibm_runtime.Session` and `qiskit_ibm_runtime.Batch`. - + ### Bug Fixes @@ -243,11 +270,11 @@ in_page_toc_max_heading_level: 2 * Fixed a bug where retrieving a fake backend through `FakeProviderForBackendV2.backend()` would result in a type error. * Fixes the check for ISA circuits to allow pulse gates and circuits that don’t have layout. - + ## 0.20.0 - + ### New Features @@ -255,7 +282,7 @@ in_page_toc_max_heading_level: 2 * 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) 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](/guides/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. @@ -265,13 +292,13 @@ in_page_toc_max_heading_level: 2 The sessions functionality will not change but note that `backend.run()` sessions prior to this release will no longer be supported after March 31, 2024. Please update your `qiskit-ibm-runtime` version as soon as possible before this date. - + ### Deprecation Notes -* Circuits that do not match the target hardware definition will no longer be supported after March 1, 2024. See the transpilation documentation ([transpile](/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/run/primitives-examples)) to see this coupled with operator transformations. +* Circuits that do not match the target hardware definition will no longer be supported after March 1, 2024. See the transpilation documentation ([transpile](/guides/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/guides/primitives-examples)) to see this coupled with operator transformations. - + ### Bug Fixes @@ -281,39 +308,39 @@ 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 @@ -321,30 +348,30 @@ in_page_toc_max_heading_level: 2 * Added `max_time` parameter to `IBMBackend.open_session()`. * Added a method `RuntimeJob.queue_info()` to get the queue information from the backend. This feature was transferred from `qiskit_ibm_provider`. - + ### Deprecation Notes * [runtime()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#runtime) has been deprecated. - + ### Bug Fixes * Many methods in [RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) require retrieving the job data from the API with `job_get()`. This API call will now exclude the `params` field by default because they are only necessary in [qiskit\_ibm\_runtime.RuntimeJob.inputs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#inputs). - + ## 0.17.0 - + ### New Features * Added a new method [properties()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#properties) which returns the backend properties of the job at the time the job was run. * [details()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#details) has a new field, activated\_at, which is the timestamp of when the session was changed to active. - + ### Bug Fixes @@ -362,7 +389,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 @@ -370,39 +397,39 @@ in_page_toc_max_heading_level: 2 Sessions are now thread-safe and allow for multiple concurrent interactive experiments. - + ### New Features * Sessions are now thread-safe. - + ### Upgrade Notes * Methods related to using custom programs are removed. - + ### Bug Fixes * If a cloud instance that is `q-ctrl` enabled is used while `q-ctrl` is not passed in as the `channel_strategy`, an error will be raised. - + ## 0.15.1 - + ### Bug Fixes * Reverting 0.15.0 changes to [from\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#from_id) because it was a breaking change without proper deprecation. - + ## 0.15.0 - + ### New Features @@ -439,13 +466,13 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Removed storing result in `RuntimeJob._results`. Instead retrieve results every time the `results()` method is called. - + ### Deprecation Notes * Usage of the `~/.qiskit/qiskitrc.json` file for account information has been deprecated. Use `~/.qiskit/qiskit-ibm.json` instead. - + ### Bug Fixes @@ -454,34 +481,34 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * The `backend` parameter in [from\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#from_id) is being deprecated because sessions do not support multiple backends. Additionally, the `service` parameter is no longer optional. * The `circuit_indices` and `observable_indices` run inputs for [Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) and [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) have been completely removed. - + ### Other Notes * Added migration code for running `backend.run` in qiskit\_ibm\_runtime instead of in qiskit\_ibm\_provider. - + ## 0.14.0 - + ### New Features * There is a new class, `qiskit_ibm_runtime.Batch` that currently works the same way as [qiskit\_ibm\_runtime.Session](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session) but will later be updated to better support submitting multiple jobs at once. * Arbitrary keys and values are no longer allowed in `Options`. - + ### Deprecation Notes * Custom programs are being deprecated as of qiskit-ibm-runtime 0.14.0 and will be removed on November 27, 2023. Users can instead convert their custom programs to use Qiskit Runtime primitives with Qiskit Serverless. Refer to the migration guide for instructions: [https://qiskit.github.io/qiskit-serverless/migration/migration\_from\_qiskit\_runtime\_programs.html](https://qiskit.github.io/qiskit-serverless/migration/migration_from_qiskit_runtime_programs.html) - + ## 0.13.0 - + ### New Features @@ -491,7 +518,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * At initialization, if not passed in directly, the default `instance` selected by the provider will be logged at the “INFO” level. When running a job, if the backend selected is not in the default instance but in a different instance the user also has access to, that instance will also be logged. - + ### Upgrade Notes @@ -499,18 +526,18 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper The old close method behavior has been moved to a new method, [qiskit\_ibm\_runtime.Session.cancel()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#cancel), where all queued jobs within a session are cancelled and terminated. - + ### Bug Fixes * Fixed a bug where `shots` passed in as a numpy type were not being serialized correctly. * Fixed a bug in [target\_history()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#target_history) where the datetime parameter was not being used to retrieve backend properties from the specified date. - + ## 0.12.2 - + ### New Features @@ -519,17 +546,17 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Added new method `Session.from_id` which creates a new session with a given id. * There will now be a warning if a user submits a job that is predicted to exceed their system execution time monthly quota of 10 minutes. This only applies to jobs run on real hardware in the instance `ibm-q/open/main`. If the job does end up exceeding the quota, it will be canceled. - + ### Upgrade Notes * Job error messages now include the error code. Error codes can be found in [errors](/errors). - + ## 0.12.1 - + ### New Features @@ -537,7 +564,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Users can now pass in a value of `default` to the `channel_strategy` parameter in [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService). Now, if an account is configured with a certain channel strategy, the user can override it by passing in `default`. * The Sampler and Estimator primitives have been enhanced to incorporate custom validation procedures when the channel\_strategy property within the :class:qiskit\_ibm\_runtime.QiskitRuntimeService is configured as “q-ctrl.” This customized validation logic effectively rectifies incorrect input options and safeguards users against inadvertently disabling Q-CTRL’s performance enhancements. - + ### Bug Fixes @@ -546,11 +573,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Job error messages will no longer be returned in all uppercase. * The max\_execution\_time option is now based on system execution time instead of wall clock time. System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - + ## 0.12.0 - + ### New Features @@ -569,19 +596,19 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * There is a new parameter, `channel_strategy` that can be set in the initialization of [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) or saved in [qiskit\_ibm\_runtime.QiskitRuntimeService.save\_account()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService#save_account). If `channel_strategy` is set to `q-ctrl`, all jobs within the service will use the Q-CTRL error mitigation strategy. - + ### Upgrade Notes * Circuits and other input parameters will no longer be automatically stored in runtime jobs. They can still be retrieved with [qiskit\_ibm\_runtime.RuntimeJob.inputs()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#inputs). - + ### Deprecation Notes * The `noise_amplifier` resilience options is deprecated. After the deprecation period, only local folding amplification will be supported. Refer to [https://github.com/qiskit-community/prototype-zne](https://github.com/qiskit-community/prototype-zne) for global folding amplification. - + ### Bug Fixes @@ -589,11 +616,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Fixes a race condition in the test test\_cancel\_running\_job() in test\_job.py where job cancellation could not be performed. Refer to #1019 \<[https://github.com/Qiskit/qiskit-ibm-runtime/issues/1019](https://github.com/Qiskit/qiskit-ibm-runtime/issues/1019)>\_ for more details. * Previously we added validation when jobs were run to make sure the number of circuits was not greater than the maximum for that backend, `backend.max_circuits`. This limit isn’t actually necessary for primtives run from within a session. - + ## 0.11.3 - + ### New Features @@ -603,11 +630,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * There is a new method [update\_tags()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#update_tags) that can be used to update the `job_tags` of a job. * If `instance` is provided as parameter to [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService), then this is used as a filter in `QiskitRuntimeService.backends()`. If `instance` is not recognized as one of the provider instances, an exception will be raised. Previously, we only issued a warning. - + ## 0.11.2 - + ### New Features @@ -628,28 +655,28 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper options.simulator.seed_simulator = 42 ``` - + ### Bug Fixes * Fixed infinite recursion when attempting to deepcopy an IBMBackend. Added a method `qiskit_ibm_runtime.IBMBackend.deepcopy()`. * Fixed an issue where circuit metadata was not being serialized correctly resulting in a type error. - + ## 0.11.1 - + ### Deprecation Notes * In [qiskit\_ibm\_runtime.RuntimeJob.metrics()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#metrics), the bss field will be replaced by usage. - + ## 0.11.0 - + ### New Features @@ -669,59 +696,59 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper options.simulator = {"coupling_map": CouplingMap.from_line(10)} ``` - + ### Upgrade Notes * A default session is no longer open for you if you pass a backend name or backend instance to [qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) or [qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) constructors. The primitive will instead run without a session. In addition, you should now use the `backend` parameter to pass a backend name or instance instead of the `session` parameter (which can continue to be used to pass a session). * The first parameter of the [qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) and [qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) constructors is now `backend` instead of `session`. - + ### Deprecation Notes * Passing a backend name or backend instance to the `session` parameter when initializing a [qiskit\_ibm\_runtime.Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) or [qiskit\_ibm\_runtime.Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) has been deprecated. Please use the `backend` parameter instead. You can continue to pass a session using the `session` parameter. - + ## 0.10.0 - + ### New Features * Python 3.11 is now supported. - + ### Upgrade Notes * Added error messages in case the user defines unsupported values for ‘max\_execution\_time’. Previously, this validation was done on the server side. - + ### Bug Fixes * Added deserialization of the params of RuntimeJob.inputs. Previously, the circuits were returned in serialized format. Fixes issue [#829](https://github.com/Qiskit/qiskit-ibm-runtime/issues/829). * Allow for users to retrieve all backends even if one of the backends has a missing configuration. The backend without a configuration will not be returned. - + ## 0.9.4 - + ### New Features * Added methods to validate input options to `transpilation` and `environment` options. - + ### Upgrade Notes * When constructing a backend `qiskit.transpiler.Target`, faulty qubits and gates from the backend configuration will be filtered out. - + ### Deprecation Notes @@ -733,41 +760,41 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper 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) 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). 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 @@ -775,7 +802,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * If a job is returned without a backend, retrieving the backend through [qiskit\_ibm\_runtime.RuntimeJob.backend()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#backend) will re-retrieve data from the server and attempt to update the backend. Additionally, `job_id` and `backend`, which were deprecated attributes of [qiskit\_ibm\_runtime.RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) have now been removed. * Added a user warning when the user passes an option that is not supported in Options. - + ### Bug Fixes @@ -784,11 +811,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * If an instance is passed in to [qiskit\_ibm\_runtime.QiskitRuntimeService.get\_backend()](/api/qiskit-ibm-runtime/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 @@ -806,47 +833,47 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper name = "my_account",) ``` - + ### Deprecation Notes * `backend` is no longer a supported option when using [qiskit\_ibm\_runtime.Session.run()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session#run). Sessions do not support multiple cross backends. Additionally, an exception will be raised if a backend passed in through options does not match the original session backend in an active session. - + ### Bug Fixes * `ECRGate` and `CZGate` mappings have been added to the `Target` constructor to fix a tranpile bug. - + ### Other Notes * Since error messages from a failing job may be long, we shortened them so that they begin from the last `Traceback` in the message. - + ## 0.9.0 - + ### Upgrade Notes * Changed the default values for `optimization_level` and for `resilience_level` in `qiskit_ibm_runtime.Options`. If their values are defined by the user, they are not modified. If not set, if the backend is a noiseless simulator then `optimization_level` is set to 1 and `resilience_level` is set to 0; Otherwise, they are be set to 3 and 1 respectively. * [session\_id()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#session_id) and [tags()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#tags) were added for an easy way to return the session\_id and job\_tags of a job. - + ### Bug Fixes * Fixed a bug where jobs that did not run before a session closes are not actually run as a part of that session. Jobs should run as a part of a session even if that session is closed by the exit of the context manager. * Fixes the issue wherein submitting a large job fails due to write operation timeout. - + ## 0.8.0 - + ### New Features @@ -854,29 +881,29 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Advanced resilience options can now be set under `options.resilience`. See [qiskit\_ibm\_runtime.options.ResilienceOptions](/api/qiskit-ibm-runtime/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) 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 @@ -884,13 +911,13 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * The [qiskit\_ibm\_runtime.options.EnvironmentOptions](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions) class now accepts a `callback` parameter. This parameter can be used to stream the interim and final results of the primitives. * The `qiskit_ibm_runtime.Options` class now accepts `max_execution_time` as a first level option and `job_tags` as an option under `environment`. [qiskit\_ibm\_runtime.RuntimeOptions](/api/qiskit-ibm-runtime/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 @@ -898,7 +925,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * Passing `instance` parameter to the [qiskit\_ibm\_runtime.QiskitRuntimeService.run()](/api/qiskit-ibm-runtime/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 @@ -908,7 +935,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper ## 0.7.0rc2 - + ### Upgrade Notes @@ -916,7 +943,7 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) is updated to return `SamplerResult` with `SamplerResult.quasi_dists` as a list of `QuasiDistrbution`. It used to set a list of `dict` as `SamplerResult.quasi_dists`, but it did not follow the design of `SamplerResult`. * The [RuntimeJob](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob) class is now a subclass of `qiskit.providers.Job`. - + ### Deprecation Notes @@ -927,13 +954,13 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper ## 0.7.0rc1 - + ### Prelude There are significant changes to how primitives are invoked within a session, and the options available to the primitives. Please review the rest of the release notes and the tutorials for full information. - + ### New Features @@ -992,7 +1019,7 @@ There are significant changes to how primitives are invoked within a session, an * The [qiskit\_ibm\_runtime.QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) `channel` can now be stored as an environment variable, `QISKIT_IBM_CHANNEL`. This way, when using Runtime Primitives, the service does not have to be instantiated manually and can instead be created directly from environment variables. - + ### Upgrade Notes @@ -1015,7 +1042,7 @@ There are significant changes to how primitives are invoked within a session, an * Since some accounts have many runtime programs, caching a list of all programs on the first call of `programs()` has been removed. Instead, programs will only be cached up to the `limit` given, which has a default value of 20. - + ### Deprecation Notes @@ -1033,17 +1060,17 @@ There are significant changes to how primitives are invoked within a session, an options.transpilation.skip_transpilation = True ``` - + ### Bug Fixes * Fixes issue [#428](https://github.com/Qiskit/qiskit-ibm-runtime/issues/428) by raising the minimum required `qiskit-terra` version to `0.21.0`, since latest version of `qiskit-ibm-runtime` is not compatible with `0.20.0` or earlier of `qiskit-terra`. - + ## 0.6.0 - + ### Upgrade Notes @@ -1060,17 +1087,17 @@ There are significant changes to how primitives are invoked within a session, an * `IBMRuntimeService` class which was deprecated earlier is now removed. Use [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService) class going forward. - + ## 0.5.0 - + ### Prelude This release leverages the API and Queue enhancements to become more runtime session aware. As a result when using the primitives (sampler and estimator), runtime jobs in the same session will skip to the front of the queue, thereby speeding up the runtime session, once it has started. - + ### New Features @@ -1083,7 +1110,7 @@ This release leverages the API and Queue enhancements to become more runtime ses backend.service # QiskitRuntimeService instance used to instantiate the backend ``` - + ### Upgrade Notes @@ -1140,11 +1167,11 @@ This release leverages the API and Queue enhancements to become more runtime ses * [qubit\_properties()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend#qubit_properties) will now return a sub class of `QubitProperties` called `IBMQubitProperties` and will expose anharmonicity in addition to the t1, t2 and frequency already exposed by the `QubitProperties` class. - + ## 0.4.0 - + ### Upgrade Notes @@ -1229,55 +1256,55 @@ This release leverages the API and Queue enhancements to become more runtime ses result = sampler(circuit_indices=[0], ...) ``` - + ### Deprecation Notes * `IBMRuntimeService`, `IBMEstimator` and `IBMSampler` classes have been deprecated and will be removed in a future release. Use [QiskitRuntimeService](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService), [Estimator](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator) and [Sampler](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler) classes instead. See upgrade notes section for a detailed explanation with examples. - + ## 0.3.0 - + ### Upgrade Notes * A new parameter `channel` has now been added to `qiskit_ibm_runtime.IBMRuntimeService` class and also to methods like `save_account()`, `saved_accounts()` and `delete_account()`. It can be set to `ibm_quantum` or `ibm_cloud` to authenticate to either of the two different channels through which Qiskit Runtime service is currently offered. `channel` replaces the `auth` parameter which has now been deprecated. - + ### Deprecation Notes * The `auth` parameter to `qiskit_ibm_runtime.IBMRuntimeService` class and also to methods like `save_account()`, `saved_accounts()` and `delete_account()` has now been deprecated and will be removed in a future release. Please use the new `channel` parameter instead. - + ### Bug Fixes * Fixed [#291](https://github.com/Qiskit/qiskit-ibm-runtime/issues/219) where passing a single `QuantumCircuit` to sampler or estimator primitives was throwing an error. - + ## 0.2.0 - + ### New Features * `qiskit_ibm_runtime.IBMEstimator` and `qiskit_ibm_runtime.IBMSampler` classes now allow you to easily interact with the `estimator` and `sampler` primitive programs. Refer to the examples in the respective class doc strings to learn more about how to use them. - + ### Bug Fixes * Fixed a bug where [qiskit\_ibm\_runtime.RuntimeJob.wait\_for\_final\_state()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#wait_for_final_state) would result in a NoneType error if the job already completed and [qiskit\_ibm\_runtime.RuntimeJob.status()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#status) was called beforehand. - + ## 0.1.0 - + ### Prelude @@ -1287,13 +1314,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 @@ -1354,35 +1381,35 @@ qiskit-ibm-runtime is not included as part of Qiskit meta package and thereby yo * 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) and [qiskit\_ibm\_runtime.utils.json.RuntimeDecoder](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder) have been updated to handle instances of the Instruction class. * Fixed an issue where numpy ndarrays with object types could not be serialized. [qiskit\_ibm\_runtime.utils.json.RuntimeEncoder](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder) and [qiskit\_ibm\_runtime.utils.json.RuntimeDecoder](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder) have been updated to handle these ndarrays. - + ## 0.1.0rc1 - + ### New Features * You can now pass `instance` parameter in the hub/group/project format to `qiskit_ibm_runtime.IBMRuntimeService.jobs()` to filter jobs. Currently only supported for legacy authentication. * You can now use the [qiskit\_ibm\_runtime.RuntimeJob.interim\_results()](/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob#interim_results) method to retrieve runtime program interim results. Note that interim results will only be available for up to two days. - + ### Upgrade Notes @@ -1390,7 +1417,7 @@ qiskit-ibm-runtime is not included as part of Qiskit meta package and thereby yo * When uploading a program with `qiskit_ibm_runtime.IBMRuntimeService.upload_program()`, the program description is now optional. * When printing programs with `qiskit_ibm_runtime.IBMRuntimeService.pprint_programs()`, `backend_requirements` will now be listed. - + ### Bug Fixes diff --git a/docs/api/qiskit-ibm-runtime/transpiler.mdx b/docs/api/qiskit-ibm-runtime/transpiler.mdx index 14ad90f1388..79808c8da48 100644 --- a/docs/api/qiskit-ibm-runtime/transpiler.mdx +++ b/docs/api/qiskit-ibm-runtime/transpiler.mdx @@ -16,7 +16,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes `qiskit_ibm_runtime.transpiler.passes` -A collection of transpiler passes for IBM backends. Refer to [transpile](/transpile) to learn more about transpilation and passes. +A collection of transpiler passes for IBM backends. Refer to [guides/transpile](/guides/transpile) to learn more about transpilation and passes. | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/_package.json b/docs/api/qiskit/_package.json index d08e818572a..afdf7a233c0 100644 --- a/docs/api/qiskit/_package.json +++ b/docs/api/qiskit/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit", - "version": "1.1.1" + "version": "1.1.2" } diff --git a/docs/api/qiskit/classicalfunction.mdx b/docs/api/qiskit/classicalfunction.mdx index ade7aed1495..34143a1513c 100644 --- a/docs/api/qiskit/classicalfunction.mdx +++ b/docs/api/qiskit/classicalfunction.mdx @@ -47,6 +47,10 @@ The classical function compiler provides the necessary tools to map a classical Following Qiskit’s little-endian bit ordering convention, the left-most bit (`a`) is the most significant bit and the right-most bit (`d`) is the least significant bit. + + The functionality of qiskit.circuit.classicalfunction requires tweedledum, which isn’t available on all platforms (up to Python version 3.11). See [tweedledum installation guide](https://github.com/boschmitt/tweedledum/tree/master?tab=readme-ov-file#installation) for more details. + + ## Supplementary Information ### Tweedledum @@ -69,7 +73,7 @@ Decorator for a classical function that returns a ClassicalFunction object. #### classical\_function - + Parses and type checks the callable `func` to compile it into an `ClassicalFunction` that can be synthesized into a `QuantumCircuit`. **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx index 76e1782e2b0..c83519c684e 100644 --- a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class - + Core Qiskit representation of a quantum circuit. @@ -385,7 +385,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### copy\_empty\_like - + Return a copy of self with the same structure but empty. That structure includes: @@ -457,7 +457,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -479,7 +479,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -756,7 +756,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### assign\_parameters - + Assign parameters to new parameters or values. If `parameters` is passed as a dictionary, the keys should be [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances in the current circuit. The values of the dictionary can either be numeric values or new parameter objects. @@ -1386,7 +1386,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### barrier - + Apply `Barrier`. If `qargs` is empty, applies to all qubits in the circuit. **Parameters** @@ -1405,7 +1405,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ccx - + Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1428,7 +1428,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ccz - + Apply [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1452,7 +1452,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ch - + Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1475,7 +1475,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cp - + Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### crx - + Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1523,7 +1523,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cry - + Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1547,7 +1547,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### crz - + Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1571,7 +1571,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cs - + Apply [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1594,7 +1594,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### csdg - + Apply [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1617,7 +1617,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cswap - + Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1641,7 +1641,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### csx - + Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1664,7 +1664,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cu - + Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1691,7 +1691,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cx - + Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1714,7 +1714,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cy - + Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1737,7 +1737,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cz - + Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1760,7 +1760,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### dcx - + Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1781,7 +1781,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### delay - + Apply [`Delay`](circuit#qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is `None`, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. **Parameters** @@ -1805,7 +1805,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ecr - + Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1826,7 +1826,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### h - + Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1846,7 +1846,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### id - + Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1866,7 +1866,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### initialize - + Initialize qubits in a specific state. Qubit initialization is done by first resetting the qubits to $|0\rangle$ followed by calling [`StatePreparation`](qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation") class to prepare the qubits in a specified state. Both these steps are included in the [`Initialize`](qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize") instruction. @@ -1955,7 +1955,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### iswap - + Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1976,7 +1976,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcp - + Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2055,7 +2055,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcx - + Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). The multi-cX gate can be implemented using different techniques, which use different numbers of ancilla qubits and have varying circuit depth. These modes are: @@ -2091,7 +2091,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure - + Measure a quantum bit (`qubit`) in the Z basis into a classical bit (`cbit`). When a quantum state is measured, a qubit is projected in the computational (Pauli Z) basis to either $\lvert 0 \rangle$ or $\lvert 1 \rangle$. The classical bit `cbit` indicates the result of that projection as a `0` or a `1` respectively. This operation is non-reversible. @@ -2167,7 +2167,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ms - + Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2188,7 +2188,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### p - + Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2209,7 +2209,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### pauli - + Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). **Parameters** @@ -2228,7 +2228,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### prepare\_state - + Prepare qubits in a specific state. This class implements a state preparing unitary. Unlike [`initialize()`](#qiskit.circuit.QuantumCircuit.initialize "qiskit.circuit.QuantumCircuit.initialize") it does not reset the qubits first. @@ -2323,7 +2323,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### r - + Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2345,7 +2345,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rcccx - + Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2368,7 +2368,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rccx - + Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2390,7 +2390,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### reset - + Reset the quantum bit(s) to their default state. **Parameters** @@ -2408,7 +2408,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rv - + Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2433,7 +2433,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rx - + Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2455,7 +2455,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rxx - + Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2477,7 +2477,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ry - + Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2499,7 +2499,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ryy - + Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2521,7 +2521,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rz - + Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2542,7 +2542,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rzx - + Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2564,7 +2564,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rzz - + Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2586,7 +2586,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### s - + Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2606,7 +2606,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sdg - + Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2626,7 +2626,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### store - + Store the result of the given real-time classical expression `rvalue` in the memory location defined by `lvalue`. Typically `lvalue` will be a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node and `rvalue` will be some [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") to write into it, but anything that [`expr.lift()`](circuit_classical#qiskit.circuit.classical.expr.lift "qiskit.circuit.classical.expr.lift") can raise to an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") is permissible in both places, and it will be called on them. @@ -2653,7 +2653,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### swap - + Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2674,7 +2674,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sx - + Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2694,7 +2694,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sxdg - + Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2714,7 +2714,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### t - + Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2734,7 +2734,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### tdg - + Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2754,7 +2754,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### u - + Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2777,7 +2777,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### unitary - + Apply unitary gate specified by `obj` to `qubits`. **Parameters** @@ -2811,7 +2811,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### x - + Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2832,7 +2832,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### y - + Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2852,7 +2852,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### z - + Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2896,7 +2896,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### break\_loop - + Apply [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp"). @@ -2918,7 +2918,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### continue\_loop - + Apply [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp"). @@ -2940,7 +2940,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### for\_loop - + Create a `for` loop on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which, when entered, provides a loop variable (unless one is given, in which case it will be reused) and will automatically build a [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -2991,7 +2991,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### if\_else - + Apply [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp"). @@ -3035,7 +3035,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### if\_test - + Create an `if` statement on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") with the given `true_body`, and there will be no branch for the `false` condition (see also the [`if_else()`](#qiskit.circuit.QuantumCircuit.if_else "qiskit.circuit.QuantumCircuit.if_else") method). However, if `true_body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which can be used to build `if` statements. The return value of the `with` statement is a chainable context manager, which can be used to create subsequent `else` blocks. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3089,7 +3089,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### switch - + Create a `switch`/`case` structure on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") with the given case structure. If `cases` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3136,7 +3136,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### while\_loop - + Create a `while` loop on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a `WhileLoopOp` with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a `WhileLoopOp` when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3237,7 +3237,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure\_active - + Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. Returns a new circuit with measurements if inplace=False. @@ -3257,7 +3257,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure\_all - + Adds measurement to all qubits. By default, adds new classical bits in a [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") to store these measurements. If `add_bits=False`, the results of the measurements will instead be stored in the already existing classical bits, with qubit `n` being measured into classical bit `n`. @@ -3286,7 +3286,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### clear - + Clear all instructions in self. Clearing the circuits will keep the metadata and calibrations. @@ -3300,7 +3300,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### remove\_final\_measurements - + Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -3350,7 +3350,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_calibration - + Register a low-level, custom pulse definition for the given gate. **Parameters** @@ -3610,7 +3610,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_duration - + Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. **Parameters** @@ -3628,7 +3628,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_start\_time - + Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. Return 0 if there are no instructions over qubits @@ -3653,7 +3653,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_stop\_time - + Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. Return 0 if there are no instructions over qubits diff --git a/docs/api/qiskit/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.C3SXGate.mdx index 42cd0fc0d4a..099352e91df 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/qiskit.circuit.library.C3XGate.mdx index c601cf906ad..6776a0dee38 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The X gate controlled on 3 qubits. @@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### control - + Controlled version of this gate. **Parameters** @@ -175,7 +175,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### inverse - + Invert this gate. The C3X is its own inverse. **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/qiskit.circuit.library.C4XGate.mdx index d1058b22160..dbf6e8fed8d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 4-qubit controlled X gate. @@ -158,7 +158,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### control - + Controlled version of this gate. **Parameters** @@ -179,7 +179,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### inverse - + Invert this gate. The C4X is its own inverse. **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CCXGate.mdx index 55f27ce0f60..fc8cf13789f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") CCX gate, also known as Toffoli gate. @@ -210,7 +210,7 @@ $$ ### control - + Controlled version of this gate. **Parameters** @@ -231,7 +231,7 @@ $$ ### inverse - + Return an inverted CCX gate (also a CCX). **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CXGate.mdx index 236b8a72457..67a369ea04a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-X gate. @@ -206,7 +206,7 @@ $$ ### control - + Return a controlled-X gate with more control lines. **Parameters** @@ -227,7 +227,7 @@ $$ ### inverse - + Return inverted CX gate (itself). **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx index 7cb401f7c52..100eec51f98 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -160,7 +160,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### control - + Return a multi-controlled-X gate with more control lines. **Parameters** @@ -181,7 +181,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -193,7 +193,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### inverse - + Invert this gate. The MCX is its own inverse. **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx index 8ce27c1fcdc..ec02eb2dab0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. @@ -160,7 +160,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### inverse - + Invert this gate. The MCX is its own inverse. **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx index ce98e43d8d4..4a88843b4ff 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -160,13 +160,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. ### inverse - + Invert this gate. The MCX is its own inverse. **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx index 2fe4ae1b65c..8071eb4f2f2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -158,13 +158,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. ### inverse - + Invert this gate. The MCX is its own inverse. **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RC3XGate.mdx index 824605c4a23..9d6721152af 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RCCXGate.mdx index 0b517c029b2..37fb122afaa 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/qiskit.circuit.library.XGate.mdx index 5ebf5dce11d..1e729eb4e82 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.XGate # XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The single-qubit Pauli-X gate ($\sigma_x$). @@ -156,7 +156,7 @@ $$ ### control - + Return a (multi-)controlled-X gate. One control returns a CX gate. Two controls returns a CCX gate. @@ -179,7 +179,7 @@ $$ ### inverse - + Return inverted X gate (itself). **Parameters** diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.mdx index 779c21d66cb..213448987ce 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") Quantum circuit as a directed acyclic graph. @@ -146,7 +146,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### ancestors - + Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -202,25 +202,25 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### bfs\_successors - + Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. ### classical\_predecessors - + Returns iterator of the predecessors of a node that are connected by a classical edge as DAGOpNodes and DAGInNodes. ### classical\_successors - + Returns iterator of the successors of a node that are connected by a classical edge as DAGOpNodes and DAGInNodes. ### collect\_1q\_runs - + Return a set of non-conditional runs of 1q “op” nodes. **Return type** @@ -230,13 +230,13 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### collect\_2q\_runs - + Return a set of non-conditional runs of 2q “op” nodes. ### collect\_runs - + Return a set of non-conditional runs of “op” nodes with the given names. For example, “… h q\[0]; cx q\[0],q\[1]; cx q\[0],q\[1]; h q\[1]; ..” would produce the tuple of cx nodes as an element of the set returned from a call to collect\_runs(\[“cx”]). If instead the cx nodes were “cx q\[0],q\[1]; cx q\[1],q\[0];”, the method would still return the pair in a tuple. The namelist can contain names that are not in the circuit’s basis. @@ -317,7 +317,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### count\_ops - + Count the occurrences of operation names. **Parameters** @@ -335,7 +335,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### count\_ops\_longest\_path - + Count the occurrences of operation names on the longest path. Returns a dictionary of counts keyed on the operation name. @@ -366,13 +366,13 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### descendants - + Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. ### draw - + Draws the dag circuit. This function needs [Graphviz](https://www.graphviz.org/) to be installed. Graphviz is not a python package and can’t be pip installed (the `graphviz` package on PyPI is a Python interface library for Graphviz and does not actually install Graphviz). You can refer to [the Graphviz documentation](https://www.graphviz.org/download/) on how to install it. @@ -394,7 +394,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### edges - + Iterator for edge values and source and dest node This works by returning the output edges from the specified nodes. If no nodes are specified all edges from the graph are returned. @@ -438,13 +438,13 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### front\_layer - + Return a list of op nodes in the first layer of this dag. ### gate\_nodes - + Get the list of gate nodes in the dag. **Returns** @@ -496,13 +496,13 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### is\_predecessor - + Checks if a second node is in the predecessors of node. ### is\_successor - + Checks if a second node is in the successors of node. @@ -532,7 +532,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### layers - + Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. A layer is a circuit whose gates act on disjoint qubits, i.e., a layer has depth 1. The total number of layers equals the circuit depth d. The layers are indexed from 0 to d-1 with the earliest layer at index 0. The layers are constructed using a greedy algorithm. Each returned layer is a dict containing \{“graph”: circuit graph, “partition”: list of qubit lists}. @@ -548,31 +548,31 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### longest\_path - + Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. ### multi\_qubit\_ops - + Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. ### multigraph\_layers - + Yield layers of the multigraph. ### named\_nodes - + Get the set of “op” nodes with the given name. ### node - + Get the node in the dag. **Parameters** @@ -590,7 +590,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### nodes - + Iterator for node values. **Yields** @@ -600,7 +600,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### nodes\_on\_wire - + Iterator for nodes that affect a given wire. **Parameters** @@ -637,7 +637,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### op\_nodes - + Get the list of “op” nodes in the dag. **Parameters** @@ -656,31 +656,31 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### op\_predecessors - + Returns the iterator of “op” predecessors of a node in the dag. ### op\_successors - + Returns iterator of “op” successors of a node in the dag. ### predecessors - + Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. ### properties - + Return a dictionary of circuit properties. ### quantum\_causal\_cone - + Returns causal cone of a qubit. A qubit’s causal cone is the set of qubits that can influence the output of that qubit through interactions, whether through multi-qubit gates or operations. Knowing the causal cone of a qubit can be useful when debugging faulty circuits, as it can help identify which wire(s) may be causing the problem. @@ -702,13 +702,13 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### quantum\_predecessors - + Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. ### quantum\_successors - + Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -720,7 +720,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### remove\_ancestors\_of - + Remove all of the ancestor operation nodes of node. @@ -751,25 +751,25 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### remove\_descendants\_of - + Remove all of the descendant operation nodes of node. ### remove\_nonancestors\_of - + Remove all of the non-ancestors operation nodes of node. ### remove\_nondescendants\_of - + Remove all of the non-descendants operation nodes of node. ### remove\_op\_node - + Remove an operation node n. Add edges from predecessors to successors. @@ -802,7 +802,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### replace\_block\_with\_op - + Replace a block of nodes with a single node. This is used to consolidate a block of DAGOpNodes into a single operation. A typical example is a block of gates being consolidated into a single `UnitaryGate` representing the unitary matrix of the block. @@ -843,7 +843,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### separable\_circuits - + Decompose the circuit into sets of qubits with no gates connecting them. **Parameters** @@ -866,7 +866,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### serial\_layers - + Yield a layer for all gates of this circuit. A serial layer is a circuit with one gate. The layers have the same structure as in layers(). @@ -900,7 +900,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### substitute\_node - + Replace an DAGOpNode with a single operation. qargs, cargs and conditions for the new operation will be inferred from the node to be replaced. The new operation will be checked to match the shape of the replaced operation. **Parameters** @@ -926,7 +926,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### substitute\_node\_with\_dag - + Replace one node with dag. **Parameters** @@ -958,13 +958,13 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### successors - + Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. ### swap\_nodes - + Swap connected nodes e.g. due to commutation. **Parameters** @@ -1017,7 +1017,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit ### two\_qubit\_ops - + Get list of 2 qubit operations. Ignore directives like snapshot and barrier. diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.mdx index f7d836024c4..92a252c600d 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.mdx @@ -30,7 +30,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode ### semantic\_eq - Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.15)"). **Parameters** diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGNode.mdx index 9db81fb6cc0..0d22b0a71dc 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGNode.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit.dagcircuit.DAGNode ### semantic\_eq - Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.15)"). **Parameters** diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.mdx index f3893daa61d..10b8c742819 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode ### semantic\_eq - Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.15)"). **Parameters** diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.mdx index 2173bbcd59b..cbe8149a2c7 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.mdx @@ -30,7 +30,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode ### semantic\_eq - Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.14)"). + Check if DAG nodes are considered equivalent, e.g., as a node\_match for [`rustworkx.is_isomorphic_node_match()`](https://www.rustworkx.org/apiref/rustworkx.is_isomorphic_node_match.html#rustworkx.is_isomorphic_node_match "(in rustworkx v0.15)"). **Parameters** diff --git a/docs/api/qiskit/qiskit.primitives.BitArray.mdx b/docs/api/qiskit/qiskit.primitives.BitArray.mdx index 83d76d8052e..56b74207e8a 100644 --- a/docs/api/qiskit/qiskit.primitives.BitArray.mdx +++ b/docs/api/qiskit/qiskit.primitives.BitArray.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BitArray # BitArray - + Bases: `ShapedMixin` Stores an array of bit values. @@ -79,7 +79,7 @@ python_api_name: qiskit.primitives.BitArray ### concatenate - + Join a sequence of bit arrays along an existing axis. **Parameters** @@ -105,7 +105,7 @@ python_api_name: qiskit.primitives.BitArray ### concatenate\_bits - + Join a sequence of bit arrays along the bits axis. @@ -133,7 +133,7 @@ python_api_name: qiskit.primitives.BitArray ### concatenate\_shots - + Join a sequence of bit arrays along the shots axis. **Parameters** @@ -157,7 +157,7 @@ python_api_name: qiskit.primitives.BitArray ### expectation\_values - + Compute the expectation values of the provided observables, broadcasted against this bit array. @@ -215,7 +215,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** * **counts** (*Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*] | Iterable\[Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – One or more counts-like mappings with the same number of shots. - * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The desired number of bits per shot. If unset, the biggest value found sets this value. + * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The desired number of bits per shot. If unset, the biggest value found sets this value, with a minimum of one bit. **Returns** @@ -233,7 +233,7 @@ python_api_name: qiskit.primitives.BitArray ### from\_samples - + Construct a new bit array from an iterable of bitstrings, hexstrings, or integers. All samples are assumed to be integers if the first one is. Strings are all assumed to be bitstrings whenever the first string doesn’t start with `"0x"`. @@ -243,7 +243,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** * **samples** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*] | Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – A list of bitstrings, a list of integers, or a list of hexstrings. - * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The desired number of bits per sample. If unset, the biggest sample provided is used to determine this value. + * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The desired number of bits per sample. If unset, the biggest sample provided is used to determine this value, with a minimum of one bit. **Returns** @@ -260,7 +260,7 @@ python_api_name: qiskit.primitives.BitArray ### get\_bitstrings - + Return a list of bitstrings. **Parameters** @@ -278,7 +278,7 @@ python_api_name: qiskit.primitives.BitArray ### get\_counts - + Return a counts dictionary with bitstring keys. **Parameters** @@ -296,7 +296,7 @@ python_api_name: qiskit.primitives.BitArray ### get\_int\_counts - + Return a counts dictionary, where bitstrings are stored as `int`s. **Parameters** @@ -314,7 +314,7 @@ python_api_name: qiskit.primitives.BitArray ### reshape - + Return a new reshaped bit array. The [`num_shots`](#qiskit.primitives.BitArray.num_shots "qiskit.primitives.BitArray.num_shots") axis is either included or excluded from the reshaping procedure depending on which picture the new shape is compatible with. For example, for a bit array with shape `(20, 5)` and `64` shots, a reshape to `(100,)` would leave the number of shots intact, whereas a reshape to `(200, 32)` would change the number of shots to `32`. @@ -338,7 +338,7 @@ python_api_name: qiskit.primitives.BitArray ### slice\_bits - + Return a bit array sliced along the bit axis of some indices of interest. @@ -366,7 +366,7 @@ python_api_name: qiskit.primitives.BitArray ### slice\_shots - + Return a bit array sliced along the shots axis of some indices of interest. **Parameters** @@ -388,7 +388,7 @@ python_api_name: qiskit.primitives.BitArray ### transpose - + Return a bit array with axes transposed. **Parameters** diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx b/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx index 187bbd0e584..085f75c8453 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx +++ b/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 # GenericBackendV2 - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") Generic [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") implementation with a configurable constructor. This class will return a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") instance that runs on a local simulator (in the spirit of fake backends) and contains all the necessary information to test backend-interfacing components, such as the transpiler. A [`GenericBackendV2`](#qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") instance can be constructed from as little as a specified `num_qubits`, but users can additionally configure the basis gates, coupling map, ability to run dynamic circuits (control flow instructions), instruction calibrations and dtm. The remainder of the backend properties are generated by randomly sampling from default ranges extracted from historical IBM backend data. The seed for this random generation can be fixed to ensure the reproducibility of the backend output. This backend only supports gates in the standard library, if you need a more flexible backend, there is always the option to directly instantiate a [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object to use for transpilation. @@ -180,7 +180,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 ### acquire\_channel - + Return the acquisition channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -200,7 +200,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 ### 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. @@ -226,7 +226,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 ### drive\_channel - + Return the drive channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -246,7 +246,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 ### measure\_channel - + Return the measure stimulus channel for the given qubit. This is required to be implemented if the backend supports Pulse scheduling. @@ -290,7 +290,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 ### run - + Run on the backend using a simulator. This method runs circuit jobs (an individual or a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") ) and pulse jobs (an individual or a list of [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")) using [`BasicSimulator`](qiskit.providers.basic_provider.BasicSimulator "qiskit.providers.basic_provider.BasicSimulator") or Aer simulator and returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object. diff --git a/docs/api/qiskit/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/qiskit.pulse.Schedule.mdx index 02d17e02e1f..b0adccf4951 100644 --- a/docs/api/qiskit/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/qiskit.pulse.Schedule.mdx @@ -79,7 +79,7 @@ python_api_name: qiskit.pulse.Schedule **Notes** - Nested schedules are returned as-is. If you want to collect only instructions, use py:meth:\~Schedule.instructions instead. + Nested schedules are returned as-is. If you want to collect only instructions, use [`instructions()`](#qiskit.pulse.Schedule.instructions "qiskit.pulse.Schedule.instructions") instead. **Returns** @@ -279,7 +279,7 @@ $$ ### exclude - Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: + Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of [`filter()`](#qiskit.pulse.Schedule.filter "qiskit.pulse.Schedule.filter"), so that: ```python self.filter(args) | self.exclude(args) == self diff --git a/docs/api/qiskit/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/qiskit.pulse.ScheduleBlock.mdx index 7c49a019272..57b4a52acc2 100644 --- a/docs/api/qiskit/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/qiskit.pulse.ScheduleBlock.mdx @@ -368,7 +368,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### exclude - Return a new `ScheduleBlock` with only the instructions from this `ScheduleBlock` *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: + Return a new `ScheduleBlock` with only the instructions from this `ScheduleBlock` *failing* at least one of the provided filters. This method is the complement of [`filter()`](#qiskit.pulse.ScheduleBlock.filter "qiskit.pulse.ScheduleBlock.filter"), so that: ```python self.filter(args) + self.exclude(args) == self in terms of instructions included. diff --git a/docs/api/qiskit/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/qiskit.quantum_info.Pauli.mdx index 3c9db2da625..69581cf8145 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `BasePauli` N-qubit Pauli operator. @@ -46,7 +46,7 @@ $$ **String representation** - An $n$-qubit Pauli may be represented by a string consisting of $n$ characters from `['I', 'X', 'Y', 'Z']`, and optionally phase coefficient in $['', '-i', '-', 'i']$. For example: `XYZ` or `'-iZIZ'`. + An $n$-qubit Pauli may be represented by a string consisting of $n$ characters from `['I', 'X', 'Y', 'Z']`, and optionally phase coefficient in `['', '-i', '-', 'i']`. For example: `'XYZ'` or `'-iZIZ'`. In the string representation qubit-0 corresponds to the right-most Pauli character, and qubit-$(n-1)$ to the left-most Pauli character. For example `'XYZ'` represents $X\otimes Y \otimes Z$ with `'Z'` on qubit-0, `'Y'` on qubit-1, and `'X'` on qubit-2. @@ -99,11 +99,11 @@ $$ Initialize the Pauli. - When using the symplectic array input data both z and x arguments must be provided, however the first (z) argument can be used alone for string label, Pauli operator, or ScalarOp input data. + When using the symplectic array input data both z and x arguments must be provided, however the first (z) argument can be used alone for string label, Pauli operator, or [`ScalarOp`](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") input data. **Parameters** - **data** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)") *or*[*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – input data for Pauli. If input is a tuple it must be of the form `(z, x)` or (z, x, phase)\`\` where `z` and `x` are boolean Numpy arrays, and phase is an integer from Z\_4. If input is a string, it must be a concatenation of a phase and a Pauli string (e.g. ‘XYZ’, ‘-iZIZ’) where a phase string is a combination of at most three characters from \[‘+’, ‘-’, ‘’], \[‘1’, ‘’], and \[‘i’, ‘j’, ‘’] in this order, e.g. ‘’, ‘-1j’ while a Pauli string is 1 or more characters of ‘I’, ‘X’, ‘Y’ or ‘Z’, e.g. ‘Z’, ‘XIYY’. + **data** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)") *or*[*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – input data for Pauli. If input is a tuple it must be of the form `(z, x)` or `(z, x, phase)` where `z` and `x` are boolean Numpy arrays, and phase is an integer from $\mathbb{Z}_4$. If input is a string, it must be a concatenation of a phase and a Pauli string (e.g. `'XYZ', '-iZIZ'`) where a phase string is a combination of at most three characters from `['+', '-', '']`, `['1', '']`, and `['i', 'j', '']` in this order, e.g. `''`, `'-1j'` while a Pauli string is 1 or more characters of `'I'`, `'X'`, `'Y'`, or `'Z'`, e.g. `'Z'`, `'XIYY'`. **Raises** @@ -169,13 +169,13 @@ $$ ### adjoint - + Return the adjoint of the Operator. ### anticommutes - + Return True if other Pauli anticommutes with self. **Parameters** @@ -194,7 +194,7 @@ $$ ### apply\_layout - + Apply a transpiler layout to this [`Pauli`](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") **Parameters** @@ -213,7 +213,7 @@ $$ ### commutes - + Return True if the Pauli commutes with other. **Parameters** @@ -232,7 +232,7 @@ $$ ### compose - + Return the operator composition with another Pauli. **Parameters** @@ -263,7 +263,7 @@ $$ ### conjugate - + Return the conjugate of each Pauli in the list. @@ -275,7 +275,7 @@ $$ ### delete - + Return a Pauli with qubits deleted. **Parameters** @@ -297,7 +297,7 @@ $$ ### dot - + Return the right multiplied operator self \* other. **Parameters** @@ -317,7 +317,7 @@ $$ ### equiv - + Return True if Pauli’s are equivalent up to group phase. **Parameters** @@ -335,7 +335,7 @@ $$ ### evolve - + Performs either Heisenberg (default) or Schrödinger picture evolution of the Pauli by a Clifford and returns the evolved Pauli. Schrödinger picture evolution can be chosen by passing parameter `frame='s'`. This option yields a faster calculation. @@ -366,7 +366,7 @@ $$ ### expand - + Return the reverse-order tensor product with another Pauli. **Parameters** @@ -392,7 +392,7 @@ $$ ### insert - + Insert a Pauli at specific qubit value. **Parameters** @@ -415,7 +415,7 @@ $$ ### inverse - + Return the inverse of the Pauli. @@ -473,7 +473,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -487,7 +487,7 @@ $$ ### tensor - + Return the tensor product with another Pauli. **Parameters** @@ -511,13 +511,13 @@ $$ ### to\_instruction - + Convert to Pauli circuit instruction. ### to\_label - + Convert a Pauli to a string label. @@ -535,7 +535,7 @@ $$ ### to\_matrix - + Convert to a Numpy array or sparse CSR matrix. **Parameters** @@ -553,7 +553,7 @@ $$ ### transpose - + Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/qiskit.quantum_info.PauliList.mdx index a6e6abdf13d..6dde9ede703 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.PauliList.mdx @@ -578,7 +578,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - [rustworkx.PyGraph](https://www.rustworkx.org/apiref/rustworkx.PyGraph.html#rustworkx.PyGraph "(in rustworkx v0.14)") + [rustworkx.PyGraph](https://www.rustworkx.org/apiref/rustworkx.PyGraph.html#rustworkx.PyGraph "(in rustworkx v0.15)") ### output\_dims diff --git a/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.mdx index 39be2ee3310..e6bdd774f0a 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.mdx @@ -587,7 +587,7 @@ $$ **Return type** - [rustworkx.PyGraph](https://www.rustworkx.org/apiref/rustworkx.PyGraph.html#rustworkx.PyGraph "(in rustworkx v0.14)") + [rustworkx.PyGraph](https://www.rustworkx.org/apiref/rustworkx.PyGraph.html#rustworkx.PyGraph "(in rustworkx v0.15)") ### output\_dims diff --git a/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.mdx index 6d8cae9778a..b2af1958401 100644 --- a/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") The Solovay Kitaev discrete decomposition algorithm. @@ -23,30 +23,30 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition ### find\_basic\_approximation - - Finds gate in `self._basic_approximations` that best represents `sequence`. + + Find `GateSequence` in `self._basic_approximations` that approximates `sequence`. **Parameters** - **sequence** (*GateSequence*) – The gate to find the approximation to. + **sequence** (*GateSequence*) – `GateSequence` to find the approximation to. **Returns** - Gate in basic approximations that is closest to `sequence`. + `GateSequence` in `self._basic_approximations` that approximates `sequence`. **Return type** - [*Gate*](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") + *GateSequence* ### load\_basic\_approximations - + Load basic approximations. **Parameters** - **data** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – If a string, specifies the path to the file from where to load the data. If a dictionary, directly specifies the decompositions as `{gates: matrix}`. There `gates` are the names of the gates producing the SO(3) matrix `matrix`, e.g. `{"h t": np.array([[0, 0.7071, -0.7071], [0, -0.7071, -0.7071], [-1, 0, 0]]}`. + **data** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – If a string, specifies the path to the file from where to load the data. If a dictionary, directly specifies the decompositions as `{gates: matrix}` or `{gates: (matrix, global_phase)}`. There, `gates` are the names of the gates producing the SO(3) matrix `matrix`, e.g. `{"h t": np.array([[0, 0.7071, -0.7071], [0, -0.7071, -0.7071], [-1, 0, 0]]}` and the `global_phase` can be given to account for a global phase difference between the U(2) matrix of the quantum gates and the stored SO(3) matrix. If not given, the `global_phase` will be assumed to be 0. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition ### run - + Run the algorithm. **Parameters** diff --git a/docs/api/qiskit/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/qiskit.transpiler.CouplingMap.mdx index fa6581e7449..4e92be83f75 100644 --- a/docs/api/qiskit/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/qiskit.transpiler.CouplingMap.mdx @@ -168,7 +168,7 @@ python_api_name: qiskit.transpiler.CouplingMap Draws the coupling map. - This function calls the [`graphviz_draw()`](https://www.rustworkx.org/apiref/rustworkx.visualization.graphviz_draw.html#rustworkx.visualization.graphviz_draw "(in rustworkx v0.14)") function from the `rustworkx` package to draw the [`CouplingMap`](#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") object. + This function calls the [`graphviz_draw()`](https://www.rustworkx.org/apiref/rustworkx.visualization.graphviz_draw.html#rustworkx.visualization.graphviz_draw "(in rustworkx v0.15)") function from the `rustworkx` package to draw the [`CouplingMap`](#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") object. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx index be096e4fe3a..3330b7a8657 100644 --- a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx @@ -17,8 +17,33 @@ python_api_name: qiskit.transpiler.TranspileLayout During the layout stage, the transpiler can potentially remap the order of the qubits in the circuit as it fits the circuit to the target backend. For example, let the input circuit be: + ```python + from qiskit.circuit import QuantumCircuit, QuantumRegister + + qr = QuantumRegister(3, name="MyReg") + qc = QuantumCircuit(qr) + qc.h(0) + qc.cx(0, 1) + qc.cx(0, 2) + qc.draw("mpl") + ``` + + ![../\_images/qiskit-transpiler-TranspileLayout-1.png](/images/api/qiskit/qiskit-transpiler-TranspileLayout-1.png) + Suppose that during the layout stage the transpiler reorders the qubits to be: + ```python + from qiskit import QuantumCircuit + + qc = QuantumCircuit(3) + qc.h(2) + qc.cx(2, 1) + qc.cx(2, 0) + qc.draw("mpl") + ``` + + ![../\_images/qiskit-transpiler-TranspileLayout-2.png](/images/api/qiskit/qiskit-transpiler-TranspileLayout-2.png) + Then the output of the [`initial_virtual_layout()`](#qiskit.transpiler.TranspileLayout.initial_virtual_layout "qiskit.transpiler.TranspileLayout.initial_virtual_layout") method is equivalent to: ```python @@ -33,6 +58,19 @@ python_api_name: qiskit.transpiler.TranspileLayout Building on the above example, suppose that during the routing stage the transpiler needs to insert swap gates, and the output circuit becomes: + ```python + from qiskit import QuantumCircuit + + qc = QuantumCircuit(3) + qc.h(2) + qc.cx(2, 1) + qc.swap(0, 1) + qc.cx(2, 1) + qc.draw("mpl") + ``` + + ![../\_images/qiskit-transpiler-TranspileLayout-3.png](/images/api/qiskit/qiskit-transpiler-TranspileLayout-3.png) + Then the output of the [`routing_permutation()`](#qiskit.transpiler.TranspileLayout.routing_permutation "qiskit.transpiler.TranspileLayout.routing_permutation") method is: ```python diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.mdx index fdf5d92cae2..e53be49e6e7 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords # CollectCliffords - + Bases: `CollectAndCollapse` Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.mdx index e344ea9e3ed..f0489577e3b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### run - + Run the UnitarySynthesis pass on `dag`. **Parameters** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx index df7ff60e74d..df3f08c2b00 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUni # DefaultUnitarySynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") The default unitary synthesis plugin. @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUni ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/qiskit.visualization.dag_drawer.mdx b/docs/api/qiskit/qiskit.visualization.dag_drawer.mdx index d57394f7d31..5722bda4d2a 100644 --- a/docs/api/qiskit/qiskit.visualization.dag_drawer.mdx +++ b/docs/api/qiskit/qiskit.visualization.dag_drawer.mdx @@ -10,10 +10,10 @@ python_api_name: qiskit.visualization.dag_drawer # qiskit.visualization.dag\_drawer - + Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. - This function calls the [`graphviz_draw()`](https://www.rustworkx.org/apiref/rustworkx.visualization.graphviz_draw.html#rustworkx.visualization.graphviz_draw "(in rustworkx v0.14)") function from the `rustworkx` package to draw the DAG. + This function calls the [`graphviz_draw()`](https://www.rustworkx.org/apiref/rustworkx.visualization.graphviz_draw.html#rustworkx.visualization.graphviz_draw "(in rustworkx v0.15)") function from the `rustworkx` package to draw the DAG. **Parameters** diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx index 7c1cf62eb98..80faa5750ae 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx @@ -31,7 +31,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.0)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx index 36d144fc2ea..d17a48d7558 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector * **bloch** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[double]*) – array of three elements where \[\, \, \] (Cartesian) or \[\, \, \] (spherical in radians) \ is inclination angle from +z direction \ is azimuth from +x direction * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – a string that represents the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An Axes to use for rendering the bloch sphere + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An Axes to use for rendering the bloch sphere * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – Figure size in inches. Has no effect is passing `ax`. * **coord\_type** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – a string that specifies coordinate type for bloch (Cartesian or spherical), default is Cartesian * **font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Font size. @@ -30,7 +30,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.0)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx b/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx index 484b81bb8f0..047800ace1a 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.visualization.plot_distribution * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Label each bar in histogram with probability value. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – A string to use for the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx b/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx index e59a9b0dbdd..ccfa9d25eb6 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.visualization.plot_histogram * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Label each bar in histogram with counts value. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – A string to use for the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx index 8e8a9bec453..85c7d463257 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx @@ -22,8 +22,8 @@ python_api_name: qiskit.visualization.plot_state_city * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – Figure size in inches. * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of len=2 giving colors for real and imaginary components of matrix elements. * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Transparency value for bars - * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. - * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_real only the imaginary component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_real only the imaginary component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -31,7 +31,7 @@ python_api_name: qiskit.visualization.plot_state_city **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.0)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx index 1cc52541fef..bdc3792eae9 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx @@ -21,8 +21,8 @@ python_api_name: qiskit.visualization.plot_state_hinton * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – a string that represents the plot title * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – Figure size in inches. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – file path to save image to. - * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. - * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -30,7 +30,7 @@ python_api_name: qiskit.visualization.plot_state_hinton **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.0)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx index 8b8e57a70e1..121645915e5 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx @@ -28,7 +28,7 @@ $$ * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – a string that represents the plot title * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – Figure size in inches. * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Color of the coefficient value bars. - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -36,7 +36,7 @@ $$ **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.0)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx index c3dd3448132..2301ea4ed1b 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – Figure size in inches. - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.0)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.1)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **show\_state\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – An optional boolean indicating whether to show labels for each basis state. * **show\_state\_phases** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – An optional boolean indicating whether to show the phase for each basis state. * **use\_degrees** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – An optional boolean indicating whether to use radians or degrees for the phase values in the plot. @@ -28,7 +28,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.0)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.1)") **Raises** diff --git a/docs/api/qiskit/release-notes/1.1.mdx b/docs/api/qiskit/release-notes/1.1.mdx index 232798700ba..54b7b9f7041 100644 --- a/docs/api/qiskit/release-notes/1.1.mdx +++ b/docs/api/qiskit/release-notes/1.1.mdx @@ -14,16 +14,54 @@ in_page_toc_max_heading_level: 3 +## 1.1.2 + + + +### Prelude + +Qiskit 1.1.2 is a minor bugfix release for the 1.1 series. + + + +### Bug Fixes + +* Fixed a bug in [`BitArray.from_counts()`](/api/qiskit/qiskit.primitives.BitArray#from_counts "qiskit.primitives.BitArray.from_counts") and [`BitArray.from_samples()`](/api/qiskit/qiskit.primitives.BitArray#from_samples "qiskit.primitives.BitArray.from_samples"). Previously these would raise an error if given data containing only zeros, and no value for the optional argument `num_bits`. Now they produce a [`BitArray`](/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.BitArray") with [`BitArray.num_bits`](/api/qiskit/qiskit.primitives.BitArray#num_bits "qiskit.primitives.BitArray.num_bits") set to 1. + +* Fixed a missing decorator in [`C3SXGate`](/api/qiskit/qiskit.circuit.library.C3SXGate "qiskit.circuit.library.C3SXGate") that made it fail if [`Gate.to_matrix()`](/api/qiskit/qiskit.circuit.Gate#to_matrix "qiskit.circuit.Gate.to_matrix") was called. The gate matrix is now return as expected. + +* Added missing Clifford gates to the [`CollectCliffords`](/api/qiskit/qiskit.transpiler.passes.CollectCliffords "qiskit.transpiler.passes.CollectCliffords") transpiler pass. In particular, we have added the gates [`ECRGate`](/api/qiskit/qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"), [`DCXGate`](/api/qiskit/qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"), `iSWAPGate`, [`SXGate`](/api/qiskit/qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate") and [`SXdgGate`](/api/qiskit/qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate") to this transpiler pass. + +* The [`QuantumCircuit.parameters`](/api/qiskit/qiskit.circuit.QuantumCircuit#parameters "qiskit.circuit.QuantumCircuit.parameters") attribute will now correctly be empty when using [`QuantumCircuit.copy_empty_like()`](/api/qiskit/qiskit.circuit.QuantumCircuit#copy_empty_like "qiskit.circuit.QuantumCircuit.copy_empty_like") on a parametric circuit. Previously, an internal cache would be copied over without invalidation. Fix [#12617](https://github.com/Qiskit/qiskit/issues/12617). + +* Fix the [`SolovayKitaev`](/api/qiskit/qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev") transpiler pass when loading basic approximations from an existing `.npy` file. Previously, loading a stored approximation which allowed for further reductions (e.g. due to gate cancellations) could cause a runtime failure. Additionally, the global phase difference of the U(2) gate product and SO(3) representation was lost during a save-reload procedure. Fixes [Qiskit/qiskit#12576](https://github.com/Qiskit/qiskit/issues/12576). + +* Fixed an issue with [`dag_drawer()`](/api/qiskit/qiskit.visualization.dag_drawer "qiskit.visualization.dag_drawer") and [`DAGCircuit.draw()`](/api/qiskit/qiskit.dagcircuit.DAGCircuit#draw "qiskit.dagcircuit.DAGCircuit.draw") when attempting to visualize a [`DAGCircuit`](/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") instance that contained [`Var`](/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") wires. The visualizer would raise an exception trying to do this which has been fixed so the expected visualization will be generated. + +* The constructor [`GenericBackendV2`](/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") previously allowed malformed backends to be constructed because it accepted basis gates that couldn’t be allocated given the backend size. For example, a backend with a single qubit could previously accept a basis with two-qubit gates. + +* The OpenQASM 2 parser ([`qiskit.qasm2`](/api/qiskit/qasm2#module-qiskit.qasm2 "qiskit.qasm2")) can now handle conditionals with integers that do not fit within a 64-bit integer. Fixed [#12773](https://github.com/Qiskit/qiskit/issues/12773). + +* Previously, [`DAGCircuit.replace_block_with_op()`](/api/qiskit/qiskit.dagcircuit.DAGCircuit#replace_block_with_op "qiskit.dagcircuit.DAGCircuit.replace_block_with_op") allowed an `n`-qubit operation to be placed onto a block of `m` qubits, leaving the DAG in an invalid state. This behavior has been fixed, and any attempt to do this will now raise a [`DAGCircuitError`](/api/qiskit/dagcircuit#qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") as expected. + + + + + ## 1.1.1 + + ### Prelude Qiskit 1.1.1 is a minor bugfix release for the 1.1 series. + + ### Bug Fixes * Fix a bug in [`Isometry`](/api/qiskit/qiskit.circuit.library.Isometry "qiskit.circuit.library.Isometry") due to an unnecessary assertion, that led to an error in [`UnitaryGate.control()`](/api/qiskit/qiskit.circuit.library.UnitaryGate#control "qiskit.circuit.library.UnitaryGate.control") when [`UnitaryGate`](/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") had more that two qubits. @@ -44,13 +82,13 @@ Qiskit 1.1.1 is a minor bugfix release for the 1.1 series. - + ## 1.1.0 - + ### Prelude @@ -454,7 +492,7 @@ The Qiskit 1.1.0 release is a minor feature release that includes a myriad of ne ### Quantum Information Features -* Added a new [`Pauli.apply_layout()`](/api/qiskit/qiskit.quantum_info.Pauli#apply_layout "qiskit.quantum_info.Pauli.apply_layout") that is equivalent to the [`SparsePauliOp.apply_layout()`](/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout"). This method is used to apply a [`TranspileLayout`](/api/qiskit/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") layout from the transpiler to a [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") observable that was built for an input circuit. This enables working with `BaseEstimator` / [`BaseEstimatorV2`](/api/qiskit/qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") implementations and local transpilation when the input is of type [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"). For example: +* Added a new [`apply_layout()`](/api/qiskit/qiskit.quantum_info.Pauli#apply_layout "qiskit.quantum_info.Pauli.apply_layout") method that is equivalent to [`apply_layout()`](/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout"). This method is used to apply a [`TranspileLayout`](/api/qiskit/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") layout from the transpiler to a [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") observable that was built for an input circuit. This enables working with `BaseEstimator` / [`BaseEstimatorV2`](/api/qiskit/qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") implementations and local transpilation when the input is of type [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"). For example: ```python from qiskit.circuit.library import RealAmplitudes @@ -775,7 +813,7 @@ The Qiskit 1.1.0 release is a minor feature release that includes a myriad of ne - + ### Bug Fixes @@ -872,9 +910,9 @@ The Qiskit 1.1.0 release is a minor feature release that includes a myriad of ne ### Other Notes -* Support for the arm64 macOS platform has been promoted from Tier 3 to Tier 1. Previously the platform was at Tier 3 because there was no available CI environment for testing Qiskit on the platform. Now that Github has made an arm64 macOS environment available to open source projects [\[1\]](#id6) we’re testing the platform along with the other Tier 1 supported platforms. +* Support for the arm64 macOS platform has been promoted from Tier 3 to Tier 1. Previously the platform was at Tier 3 because there was no available CI environment for testing Qiskit on the platform. Now that Github has made an arm64 macOS environment available to open source projects [\[1\]](#id9) we’re testing the platform along with the other Tier 1 supported platforms. - \[[1](#id5)] + \[[1](#id8)] [https://github.blog/changelog/2024-01-30-github-actions-introducing-the-new-m1-macos-runner-available-to-open-source/](https://github.blog/changelog/2024-01-30-github-actions-introducing-the-new-m1-macos-runner-available-to-open-source/) @@ -886,7 +924,7 @@ The Qiskit 1.1.0 release is a minor feature release that includes a myriad of ne - + ### Providers Upgrade Notes diff --git a/docs/api/qiskit/transpiler.mdx b/docs/api/qiskit/transpiler.mdx index 853d1dae438..2adb270a37b 100644 --- a/docs/api/qiskit/transpiler.mdx +++ b/docs/api/qiskit/transpiler.mdx @@ -535,7 +535,10 @@ Next, for the heuristic stage, 2 passes are used by default: * [`SabreLayout`](qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout"): Selects a layout by starting from an initial random layout and then repeatedly running a routing algorithm (by default [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap")) both forward and backward over the circuit, using the permutation caused by swap insertions to adjust that initial random layout. For more details you can refer to the paper describing the algorithm: [arXiv:1809.02573](https://arxiv.org/abs/1809.02573) [`SabreLayout`](qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") is used to select a layout if a perfect layout isn’t found for optimization levels 1, 2, and 3. * [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout"): Always used for the layout at optimization level 0. -* [`DenseLayout`](qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout"): Finds the sub-graph of the device with greatest connectivity that has the same number of qubits as the circuit. Used for optimization level 1 if there are control flow operations (such as [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp")) present in the circuit. + +There are other passes than can be used for the heuristic stage, but are not included in the default pipeline, such as: + +* [`DenseLayout`](qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout"): Finds the sub-graph of the device with greatest connectivity that has the same number of qubits as the circuit. Let’s see what layouts are automatically picked at various optimization levels. The circuits returned by [`qiskit.compiler.transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") are annotated with this initial layout information, and we can view this layout selection graphically using [`qiskit.visualization.plot_circuit_layout()`](qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout"): diff --git a/public/api/qiskit-ibm-runtime/0.26/objects.inv b/public/api/qiskit-ibm-runtime/0.26/objects.inv new file mode 100644 index 00000000000..7d17eec8279 Binary files /dev/null and b/public/api/qiskit-ibm-runtime/0.26/objects.inv differ diff --git a/public/api/qiskit-ibm-runtime/dev/objects.inv b/public/api/qiskit-ibm-runtime/dev/objects.inv index 7d17eec8279..7a0fb4eafec 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/objects.inv b/public/api/qiskit/objects.inv index 49a45d9ab4b..29038943c2c 100644 Binary files a/public/api/qiskit/objects.inv and b/public/api/qiskit/objects.inv differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_00.png b/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_00.png new file mode 100644 index 00000000000..791d475ac65 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_00.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_01.png b/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_01.png new file mode 100644 index 00000000000..a28c74e2aad Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_01.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_02.png new file mode 100644 index 00000000000..2a82c141f4e Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png new file mode 100644 index 00000000000..981bd2c8247 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png new file mode 100644 index 00000000000..60ce9e8f589 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png new file mode 100644 index 00000000000..b53eba64209 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png new file mode 100644 index 00000000000..510d8a55dce Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png new file mode 100644 index 00000000000..71289824d1b Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png new file mode 100644 index 00000000000..f9bc0ccc34e Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png new file mode 100644 index 00000000000..827a2b5f0ef Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png new file mode 100644 index 00000000000..29e72bfc144 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png new file mode 100644 index 00000000000..de7ec4b4001 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png new file mode 100644 index 00000000000..f26e5142c8a Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png new file mode 100644 index 00000000000..f26e5142c8a Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png new file mode 100644 index 00000000000..ff8bb675494 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png new file mode 100644 index 00000000000..ec6a398d7a4 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png new file mode 100644 index 00000000000..58a7843dee3 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png new file mode 100644 index 00000000000..c7ced624473 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png new file mode 100644 index 00000000000..6d68aca1504 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.26/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_00.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_00.png index 791d475ac65..525727b96c4 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_00.png and b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_00.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_01.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_01.png index a28c74e2aad..ddcdc81a90a 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_01.png and b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_01.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 5f3dcd81612..fee54280ff2 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/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png index 981bd2c8247..e8bb0d80c69 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png index 60ce9e8f589..16eeb863365 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png index b53eba64209..ac133e52341 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png index 510d8a55dce..94435917b97 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png index 71289824d1b..cea5147eb1c 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png index f9bc0ccc34e..2727f8b7b36 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png index 827a2b5f0ef..510bb446283 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png index 29e72bfc144..52168651d54 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png index de7ec4b4001..f3d635d0ba5 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png index f26e5142c8a..ec9c1acfb64 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png index f26e5142c8a..ec9c1acfb64 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png index ff8bb675494..98ce16c3a34 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png index ec6a398d7a4..c03b8120549 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png index 58a7843dee3..a5ea96531d6 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png index c7ced624473..7e240ab6236 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png index 6d68aca1504..4c719a051af 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png and b/public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.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 791d475ac65..c88cc1e76a5 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 a28c74e2aad..4d524ebccbf 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 2a82c141f4e..6411552e9df 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 981bd2c8247..9f86141a663 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 60ce9e8f589..a336184d4d2 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 b53eba64209..59f4cc2695b 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 510d8a55dce..8c8e74e53ca 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 71289824d1b..de7a4fb631d 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 f9bc0ccc34e..accd92d883c 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 827a2b5f0ef..e4e8ef2d74a 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 29e72bfc144..7d0d933f7bf 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 de7ec4b4001..f6a7e5c6ce4 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 f26e5142c8a..7e4e0746d7f 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 f26e5142c8a..7e4e0746d7f 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 ff8bb675494..daab247ce3b 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 ec6a398d7a4..de422b4349a 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 58a7843dee3..81275678cd8 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 c7ced624473..070c422f1c7 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 6d68aca1504..ea9460be4c3 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/public/images/api/qiskit/circuit-1.png b/public/images/api/qiskit/circuit-1.png index 8a0f2846045..c13096f3257 100644 Binary files a/public/images/api/qiskit/circuit-1.png and b/public/images/api/qiskit/circuit-1.png differ diff --git a/public/images/api/qiskit/circuit-2.png b/public/images/api/qiskit/circuit-2.png index f053cbed5e3..d0f2fee1348 100644 Binary files a/public/images/api/qiskit/circuit-2.png and b/public/images/api/qiskit/circuit-2.png differ diff --git a/public/images/api/qiskit/circuit-4.png b/public/images/api/qiskit/circuit-4.png index 84918d77229..17199c2c49a 100644 Binary files a/public/images/api/qiskit/circuit-4.png and b/public/images/api/qiskit/circuit-4.png differ diff --git a/public/images/api/qiskit/circuit_library-1.png b/public/images/api/qiskit/circuit_library-1.png index 2fe901a9591..fadd9911ae9 100644 Binary files a/public/images/api/qiskit/circuit_library-1.png and b/public/images/api/qiskit/circuit_library-1.png differ diff --git a/public/images/api/qiskit/converters-1.png b/public/images/api/qiskit/converters-1.png index 58ccdd1f0b7..94e4e27af0a 100644 Binary files a/public/images/api/qiskit/converters-1.png and b/public/images/api/qiskit/converters-1.png differ diff --git a/public/images/api/qiskit/providers_fake_provider-1_00.png b/public/images/api/qiskit/providers_fake_provider-1_00.png index 492bc32ba8a..c88cc1e76a5 100644 Binary files a/public/images/api/qiskit/providers_fake_provider-1_00.png and b/public/images/api/qiskit/providers_fake_provider-1_00.png differ diff --git a/public/images/api/qiskit/providers_fake_provider-1_01.png b/public/images/api/qiskit/providers_fake_provider-1_01.png index 8387e002107..5babc3c71df 100644 Binary files a/public/images/api/qiskit/providers_fake_provider-1_01.png and b/public/images/api/qiskit/providers_fake_provider-1_01.png differ diff --git a/public/images/api/qiskit/providers_fake_provider-1_02.png b/public/images/api/qiskit/providers_fake_provider-1_02.png index d86e74abf0b..d964be4ca88 100644 Binary files a/public/images/api/qiskit/providers_fake_provider-1_02.png and b/public/images/api/qiskit/providers_fake_provider-1_02.png differ diff --git a/public/images/api/qiskit/pulse-1.png b/public/images/api/qiskit/pulse-1.png index 1dae7f2e7a6..43ed2175912 100644 Binary files a/public/images/api/qiskit/pulse-1.png and b/public/images/api/qiskit/pulse-1.png differ diff --git a/public/images/api/qiskit/pulse-2.png b/public/images/api/qiskit/pulse-2.png index 0253fd6811d..4370577c79c 100644 Binary files a/public/images/api/qiskit/pulse-2.png and b/public/images/api/qiskit/pulse-2.png differ diff --git a/public/images/api/qiskit/pulse-3.png b/public/images/api/qiskit/pulse-3.png index 8b6eac3c3ed..3f786fcd386 100644 Binary files a/public/images/api/qiskit/pulse-3.png and b/public/images/api/qiskit/pulse-3.png differ diff --git a/public/images/api/qiskit/pulse-4.png b/public/images/api/qiskit/pulse-4.png index 5cebd47cac9..248ba825560 100644 Binary files a/public/images/api/qiskit/pulse-4.png and b/public/images/api/qiskit/pulse-4.png differ diff --git a/public/images/api/qiskit/pulse-5.png b/public/images/api/qiskit/pulse-5.png index 2583b365cc1..aab1d7ce4bb 100644 Binary files a/public/images/api/qiskit/pulse-5.png and b/public/images/api/qiskit/pulse-5.png differ diff --git a/public/images/api/qiskit/pulse-6.png b/public/images/api/qiskit/pulse-6.png index 24d32b98ece..fb1b30ecfb1 100644 Binary files a/public/images/api/qiskit/pulse-6.png and b/public/images/api/qiskit/pulse-6.png differ diff --git a/public/images/api/qiskit/pulse-7.png b/public/images/api/qiskit/pulse-7.png index e3e2e9ccd59..3633f21ac48 100644 Binary files a/public/images/api/qiskit/pulse-7.png and b/public/images/api/qiskit/pulse-7.png differ diff --git a/public/images/api/qiskit/qasm3-1.png b/public/images/api/qiskit/qasm3-1.png index ac8c730a89b..4a0aaff6e31 100644 Binary files a/public/images/api/qiskit/qasm3-1.png and b/public/images/api/qiskit/qasm3-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-ControlledGate-1.png b/public/images/api/qiskit/qiskit-circuit-ControlledGate-1.png index 777e2763293..b3407b02b38 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-ControlledGate-1.png and b/public/images/api/qiskit/qiskit-circuit-ControlledGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-ControlledGate-2.png b/public/images/api/qiskit/qiskit-circuit-ControlledGate-2.png index 7095e4d66b3..60f20443f08 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-ControlledGate-2.png and b/public/images/api/qiskit/qiskit-circuit-ControlledGate-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-Operation-1.png b/public/images/api/qiskit/qiskit-circuit-Operation-1.png index 62fc22355fd..4deb948e033 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-Operation-1.png and b/public/images/api/qiskit/qiskit-circuit-Operation-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-Parameter-1_00.png b/public/images/api/qiskit/qiskit-circuit-Parameter-1_00.png index a7fa94a7b70..a3d766bcca1 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-Parameter-1_00.png and b/public/images/api/qiskit/qiskit-circuit-Parameter-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-Parameter-1_01.png b/public/images/api/qiskit/qiskit-circuit-Parameter-1_01.png index aec1fe2336c..9a80a745599 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-Parameter-1_01.png and b/public/images/api/qiskit/qiskit-circuit-Parameter-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png index 336d720997b..7e9b8c2be7a 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png index c4b4d05a9e8..387360c17b9 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png index 1e172555f96..a7ea83feff9 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png index 0cf0558d563..9e8d4d700d2 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png index 2fe67b78f80..5c7a13515f9 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4.png index 096898ed189..599f7583ec5 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-5.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-5.png index 4005262d8e3..585076a50d9 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-5.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-5.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-AND-1.png b/public/images/api/qiskit/qiskit-circuit-library-AND-1.png index b0a3425b66d..fb13cd9f379 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-AND-1.png and b/public/images/api/qiskit/qiskit-circuit-library-AND-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-AND-2.png b/public/images/api/qiskit/qiskit-circuit-library-AND-2.png index 2c55b27227d..b8ab6158f8d 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-AND-2.png and b/public/images/api/qiskit/qiskit-circuit-library-AND-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png b/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png index 8b02b717b55..cdb81f097e0 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png and b/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GMS-1.png b/public/images/api/qiskit/qiskit-circuit-library-GMS-1.png index 08c4e6af696..dd4ef1dd1d2 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GMS-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GMS-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GR-1.png b/public/images/api/qiskit/qiskit-circuit-library-GR-1.png index 2d0df8f098b..402c66a7c80 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GR-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GR-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GRX-1.png b/public/images/api/qiskit/qiskit-circuit-library-GRX-1.png index b6b6bd2ede0..80467f14b32 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GRX-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GRX-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GRY-1.png b/public/images/api/qiskit/qiskit-circuit-library-GRY-1.png index 2d0df8f098b..402c66a7c80 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GRY-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GRY-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GRZ-1.png b/public/images/api/qiskit/qiskit-circuit-library-GRZ-1.png index 60136f307f8..79baa0a9862 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GRZ-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GRZ-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GraphState-1.png b/public/images/api/qiskit/qiskit-circuit-library-GraphState-1.png index 60f2e72f9d8..3e9387d7467 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GraphState-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GraphState-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png b/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png index 26c184b5596..ff5331b5c52 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png and b/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-IQP-1.png b/public/images/api/qiskit/qiskit-circuit-library-IQP-1.png index 98b65d881a1..851ceb004a5 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-IQP-1.png and b/public/images/api/qiskit/qiskit-circuit-library-IQP-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-IQP-2.png b/public/images/api/qiskit/qiskit-circuit-library-IQP-2.png index a9db494335e..30398f8e884 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-IQP-2.png and b/public/images/api/qiskit/qiskit-circuit-library-IQP-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-InnerProduct-1.png b/public/images/api/qiskit/qiskit-circuit-library-InnerProduct-1.png index af10e30ea91..c681ad95b1f 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-InnerProduct-1.png and b/public/images/api/qiskit/qiskit-circuit-library-InnerProduct-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png b/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png index bdfaf5995ec..66dc39071e2 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png and b/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-OR-1.png b/public/images/api/qiskit/qiskit-circuit-library-OR-1.png index 0accdc5298d..b3fabbd5fb3 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-OR-1.png and b/public/images/api/qiskit/qiskit-circuit-library-OR-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-OR-2.png b/public/images/api/qiskit/qiskit-circuit-library-OR-2.png index f47713642e2..64ff50a0827 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-OR-2.png and b/public/images/api/qiskit/qiskit-circuit-library-OR-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png b/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png index 54506aa4598..6c6a5875703 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png and b/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-Permutation-1.png b/public/images/api/qiskit/qiskit-circuit-library-Permutation-1.png index 45c55cdf553..159bf601804 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-Permutation-1.png and b/public/images/api/qiskit/qiskit-circuit-library-Permutation-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-Permutation-2.png b/public/images/api/qiskit/qiskit-circuit-library-Permutation-2.png index cdcd9c23a59..11f8b6f5b73 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-Permutation-2.png and b/public/images/api/qiskit/qiskit-circuit-library-Permutation-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-1.png b/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-1.png index 916b2170d30..8e4878706cd 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-1.png and b/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.png b/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.png index 031fa39cacf..ae5199d6932 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.png and b/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.png b/public/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.png index d5991b2d034..6aed2573106 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.png and b/public/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PiecewiseChebyshev-1.png b/public/images/api/qiskit/qiskit-circuit-library-PiecewiseChebyshev-1.png index c6c24921a52..c1c1006b86c 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PiecewiseChebyshev-1.png and b/public/images/api/qiskit/qiskit-circuit-library-PiecewiseChebyshev-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QFT-1.png b/public/images/api/qiskit/qiskit-circuit-library-QFT-1.png index a4a66e2ea7b..7783a4311fe 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QFT-1.png and b/public/images/api/qiskit/qiskit-circuit-library-QFT-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QFT-2.png b/public/images/api/qiskit/qiskit-circuit-library-QFT-2.png index fd59ef05181..17d74a76103 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QFT-2.png and b/public/images/api/qiskit/qiskit-circuit-library-QFT-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QFT-3.png b/public/images/api/qiskit/qiskit-circuit-library-QFT-3.png index ad844182b63..c983e36405d 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QFT-3.png and b/public/images/api/qiskit/qiskit-circuit-library-QFT-3.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-1.png b/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-1.png index 51c23dcd8e7..5a14be99146 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-1.png and b/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-2.png b/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-2.png index 7105aac411e..2571a9e52f8 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-2.png and b/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-XOR-1.png b/public/images/api/qiskit/qiskit-circuit-library-XOR-1.png index 917980eac91..768366c7fd7 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-XOR-1.png and b/public/images/api/qiskit/qiskit-circuit-library-XOR-1.png differ diff --git a/public/images/api/qiskit/qiskit-primitives-StatevectorEstimator-1.png b/public/images/api/qiskit/qiskit-primitives-StatevectorEstimator-1.png index 4bdc4a4300e..36eb0ca979c 100644 Binary files a/public/images/api/qiskit/qiskit-primitives-StatevectorEstimator-1.png and b/public/images/api/qiskit/qiskit-primitives-StatevectorEstimator-1.png differ diff --git a/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png b/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png index 3582ca85846..9417dba01ba 100644 Binary files a/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png and b/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png differ diff --git a/public/images/api/qiskit/qiskit-quantum_info-Statevector-1.png b/public/images/api/qiskit/qiskit-quantum_info-Statevector-1.png index 5074e033ad3..78065d42b4c 100644 Binary files a/public/images/api/qiskit/qiskit-quantum_info-Statevector-1.png and b/public/images/api/qiskit/qiskit-quantum_info-Statevector-1.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-1.png b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-1.png new file mode 100644 index 00000000000..919d49d87c3 Binary files /dev/null and b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-1.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-2.png b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-2.png new file mode 100644 index 00000000000..af846c41921 Binary files /dev/null and b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-2.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-3.png b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-3.png new file mode 100644 index 00000000000..f47c40bfaf0 Binary files /dev/null and b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-3.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png index 3f7209fd93b..a34aff9f483 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png and b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png index c6815fbb517..0748455f1fb 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png and b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-FilterOpNodes-1.png b/public/images/api/qiskit/qiskit-transpiler-passes-FilterOpNodes-1.png index 3ceb225559b..f0f4d6d6910 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-FilterOpNodes-1.png and b/public/images/api/qiskit/qiskit-transpiler-passes-FilterOpNodes-1.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png index 3f7209fd93b..a34aff9f483 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png and b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png index c6815fbb517..0748455f1fb 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png and b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-RemoveBarriers-1.png b/public/images/api/qiskit/qiskit-transpiler-passes-RemoveBarriers-1.png index 39ccbbf0f14..d441e6b4205 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-RemoveBarriers-1.png and b/public/images/api/qiskit/qiskit-transpiler-passes-RemoveBarriers-1.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-StarPreRouting-1.png b/public/images/api/qiskit/qiskit-transpiler-passes-StarPreRouting-1.png index 39791edcd49..31d7c409a6d 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-StarPreRouting-1.png and b/public/images/api/qiskit/qiskit-transpiler-passes-StarPreRouting-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png b/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png index 4005262d8e3..585076a50d9 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png and b/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-1.png b/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-1.png index 15abc8c25de..1c40861424a 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-2.png b/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-2.png index 1e7864a25f3..e801e218ea5 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-1.png b/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-1.png index 6568797eeac..8bc6adfebc2 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-2.png b/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-2.png index 4e366495401..10568862dbe 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.png b/public/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.png index 31f7bfa47e7..4bda4aac4ab 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_coupling_map-1.png b/public/images/api/qiskit/qiskit-visualization-plot_coupling_map-1.png index 6077c38654e..8d5be4eaf5b 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_coupling_map-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_coupling_map-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_00.png b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_00.png index 90ec89dda78..406bef82572 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_00.png and b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_01.png b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_01.png index d182dc1f8bc..d0929688523 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_01.png and b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_02.png b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_02.png index 0b31653158e..376e1f7f9ba 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_02.png and b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_02.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_error_map-1.png b/public/images/api/qiskit/qiskit-visualization-plot_error_map-1.png index ef579fe7143..f338605cfdc 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_error_map-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_error_map-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_gate_map-1.png b/public/images/api/qiskit/qiskit-visualization-plot_gate_map-1.png index 30a01e33411..7b36286d23f 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_gate_map-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_gate_map-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_00.png b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_00.png index 4429f903fb0..b43d66c1864 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_00.png and b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_01.png b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_01.png index b92871a2148..c34147b8872 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_01.png and b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_02.png b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_02.png index 613d8b4ac8d..4b6963b5401 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_02.png and b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_02.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_city-1.png b/public/images/api/qiskit/qiskit-visualization-plot_state_city-1.png index 58e65ce6e0e..0e199688d2a 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_city-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_city-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_city-2.png b/public/images/api/qiskit/qiskit-visualization-plot_state_city-2.png index 96355ffa98f..918583d944a 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_city-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_city-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_hinton-1.png b/public/images/api/qiskit/qiskit-visualization-plot_state_hinton-1.png index 5275cc396b1..a642d1436ba 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_hinton-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_hinton-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-1.png b/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-1.png index aee9d6e4af5..c062bd0eb6a 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-2.png b/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-2.png index b05a0272d45..4c3fb0f27c7 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-1.png b/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-1.png index d3dbbf5d144..92a9350fe71 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-2.png b/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-2.png index 6a301745f74..a3503cd37b5 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-1.png b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-1.png index f71061a297d..02c11b24eac 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-1.png and b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-2.png b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-2.png index fc0ac0b4d08..4bd89116ac0 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-2.png and b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-3.png b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-3.png index da66a8bbfa1..88c150b9f23 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-3.png and b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-3.png differ diff --git a/public/images/api/qiskit/release_notes-1.png b/public/images/api/qiskit/release_notes-1.png index 567b9fe7ac4..eaa3822064d 100644 Binary files a/public/images/api/qiskit/release_notes-1.png and b/public/images/api/qiskit/release_notes-1.png differ diff --git a/public/images/api/qiskit/release_notes-2.png b/public/images/api/qiskit/release_notes-2.png index f1fcd45ff61..9035f6c6175 100644 Binary files a/public/images/api/qiskit/release_notes-2.png and b/public/images/api/qiskit/release_notes-2.png differ diff --git a/public/images/api/qiskit/release_notes-3.png b/public/images/api/qiskit/release_notes-3.png index 18397c7b011..dbba083b606 100644 Binary files a/public/images/api/qiskit/release_notes-3.png and b/public/images/api/qiskit/release_notes-3.png differ diff --git a/public/images/api/qiskit/release_notes-4.png b/public/images/api/qiskit/release_notes-4.png index 334488a01e3..9c0510ef96d 100644 Binary files a/public/images/api/qiskit/release_notes-4.png and b/public/images/api/qiskit/release_notes-4.png differ diff --git a/public/images/api/qiskit/release_notes-5.png b/public/images/api/qiskit/release_notes-5.png index b35792135a2..a09ebe13647 100644 Binary files a/public/images/api/qiskit/release_notes-5.png and b/public/images/api/qiskit/release_notes-5.png differ diff --git a/public/images/api/qiskit/release_notes-6.png b/public/images/api/qiskit/release_notes-6.png index ea746301783..5b4b91c5cf8 100644 Binary files a/public/images/api/qiskit/release_notes-6.png and b/public/images/api/qiskit/release_notes-6.png differ diff --git a/public/images/api/qiskit/release_notes-7.png b/public/images/api/qiskit/release_notes-7.png index d86a8787928..4b92bf0bd92 100644 Binary files a/public/images/api/qiskit/release_notes-7.png and b/public/images/api/qiskit/release_notes-7.png differ diff --git a/public/images/api/qiskit/transpiler-10.png b/public/images/api/qiskit/transpiler-10.png index 8f47d5b1a47..147906e20c5 100644 Binary files a/public/images/api/qiskit/transpiler-10.png and b/public/images/api/qiskit/transpiler-10.png differ diff --git a/public/images/api/qiskit/transpiler-11.png b/public/images/api/qiskit/transpiler-11.png index a721d7ef459..251ad64c662 100644 Binary files a/public/images/api/qiskit/transpiler-11.png and b/public/images/api/qiskit/transpiler-11.png differ diff --git a/public/images/api/qiskit/transpiler-12.png b/public/images/api/qiskit/transpiler-12.png index 224b901a2d3..df71baf451d 100644 Binary files a/public/images/api/qiskit/transpiler-12.png and b/public/images/api/qiskit/transpiler-12.png differ diff --git a/public/images/api/qiskit/transpiler-13.png b/public/images/api/qiskit/transpiler-13.png index a721d7ef459..251ad64c662 100644 Binary files a/public/images/api/qiskit/transpiler-13.png and b/public/images/api/qiskit/transpiler-13.png differ diff --git a/public/images/api/qiskit/transpiler-14.png b/public/images/api/qiskit/transpiler-14.png index 390056e6dd4..9a121abcd01 100644 Binary files a/public/images/api/qiskit/transpiler-14.png and b/public/images/api/qiskit/transpiler-14.png differ diff --git a/public/images/api/qiskit/transpiler-15.png b/public/images/api/qiskit/transpiler-15.png index cf48c5158d1..8b89b844c21 100644 Binary files a/public/images/api/qiskit/transpiler-15.png and b/public/images/api/qiskit/transpiler-15.png differ diff --git a/public/images/api/qiskit/transpiler-16.png b/public/images/api/qiskit/transpiler-16.png index 3f7dbfdb543..1c80b4f22d7 100644 Binary files a/public/images/api/qiskit/transpiler-16.png and b/public/images/api/qiskit/transpiler-16.png differ diff --git a/public/images/api/qiskit/transpiler-17.png b/public/images/api/qiskit/transpiler-17.png index 91011ea2612..0dacf452d74 100644 Binary files a/public/images/api/qiskit/transpiler-17.png and b/public/images/api/qiskit/transpiler-17.png differ diff --git a/public/images/api/qiskit/transpiler-4.png b/public/images/api/qiskit/transpiler-4.png index 4e69dd1ea91..f88f8ba301c 100644 Binary files a/public/images/api/qiskit/transpiler-4.png and b/public/images/api/qiskit/transpiler-4.png differ diff --git a/public/images/api/qiskit/transpiler-5.png b/public/images/api/qiskit/transpiler-5.png index 3dd453185a3..24b3934ddb7 100644 Binary files a/public/images/api/qiskit/transpiler-5.png and b/public/images/api/qiskit/transpiler-5.png differ diff --git a/public/images/api/qiskit/transpiler-6.png b/public/images/api/qiskit/transpiler-6.png index 72a6d1882bf..fce253a6f09 100644 Binary files a/public/images/api/qiskit/transpiler-6.png and b/public/images/api/qiskit/transpiler-6.png differ diff --git a/public/images/api/qiskit/transpiler-7.png b/public/images/api/qiskit/transpiler-7.png index 9d42aa7e35b..e2fd04fed80 100644 Binary files a/public/images/api/qiskit/transpiler-7.png and b/public/images/api/qiskit/transpiler-7.png differ diff --git a/public/images/api/qiskit/transpiler-8.png b/public/images/api/qiskit/transpiler-8.png index c5e2503a8c9..44ccc8587db 100644 Binary files a/public/images/api/qiskit/transpiler-8.png and b/public/images/api/qiskit/transpiler-8.png differ diff --git a/public/images/api/qiskit/transpiler-9.png b/public/images/api/qiskit/transpiler-9.png index 84e85ed33fa..db65452d05e 100644 Binary files a/public/images/api/qiskit/transpiler-9.png and b/public/images/api/qiskit/transpiler-9.png differ diff --git a/public/images/api/qiskit/visualization-1.png b/public/images/api/qiskit/visualization-1.png index b76a3576f4e..90b2383b958 100644 Binary files a/public/images/api/qiskit/visualization-1.png and b/public/images/api/qiskit/visualization-1.png differ diff --git a/public/images/api/qiskit/visualization-2.png b/public/images/api/qiskit/visualization-2.png index c81c927f2a7..59424563a85 100644 Binary files a/public/images/api/qiskit/visualization-2.png and b/public/images/api/qiskit/visualization-2.png differ diff --git a/public/images/api/qiskit/visualization-3.png b/public/images/api/qiskit/visualization-3.png index 4767f79b119..a0b6b768d48 100644 Binary files a/public/images/api/qiskit/visualization-3.png and b/public/images/api/qiskit/visualization-3.png differ diff --git a/public/images/api/qiskit/visualization-4.png b/public/images/api/qiskit/visualization-4.png index 2af09a6e969..8d41145c5af 100644 Binary files a/public/images/api/qiskit/visualization-4.png and b/public/images/api/qiskit/visualization-4.png differ diff --git a/public/images/api/qiskit/visualization-5.png b/public/images/api/qiskit/visualization-5.png index 6d41a011843..f2f246824be 100644 Binary files a/public/images/api/qiskit/visualization-5.png and b/public/images/api/qiskit/visualization-5.png differ diff --git a/public/images/api/qiskit/visualization-6.png b/public/images/api/qiskit/visualization-6.png index 6d41a011843..f2f246824be 100644 Binary files a/public/images/api/qiskit/visualization-6.png and b/public/images/api/qiskit/visualization-6.png differ diff --git a/scripts/config/api-html-artifacts.json b/scripts/config/api-html-artifacts.json index 4183047023a..c25c4fa10e2 100644 --- a/scripts/config/api-html-artifacts.json +++ b/scripts/config/api-html-artifacts.json @@ -35,7 +35,8 @@ "0.7": "https://ibm.box.com/shared/static/t2vuik7bqboata3i34r4a83baabo95xn.zip" }, "qiskit-ibm-runtime": { - "dev": "https://ibm.box.com/shared/static/8m6c8zkuwo4hafho3x5a9w34ehjr9pep.zip", + "dev": "https://ibm.box.com/shared/static/nvoittuwpeut6668e4uoxds99xj5fijq.zip", + "0.27": "https://ibm.box.com/shared/static/5etecpdznfqodns0ixnokinaha864qnb.zip", "0.26": "https://ibm.box.com/shared/static/g98z73cfv8ubcs9em72h69oo8arelqi2.zip", "0.25": "https://ibm.box.com/shared/static/0uf2wja99xx4dqihi4papg97coacn0gu.zip", "0.24": "https://ibm.box.com/shared/static/0r0ilv9fy9qtq8qjiqf8ocppp8y5qhks.zip", diff --git a/scripts/config/historical-pages-to-latest.json b/scripts/config/historical-pages-to-latest.json index c3d36b03662..5328cf15d04 100644 --- a/scripts/config/historical-pages-to-latest.json +++ b/scripts/config/historical-pages-to-latest.json @@ -18547,6 +18547,7 @@ "0.25": { "qiskit_ibm_runtime.RuntimeOptions": "/" }, + "0.26": {}, "dev": {} }, "qiskit-ibm-provider": { diff --git a/scripts/js/commands/checkInternalLinks.ts b/scripts/js/commands/checkInternalLinks.ts index 92385f8e2e9..e0d4040abc3 100644 --- a/scripts/js/commands/checkInternalLinks.ts +++ b/scripts/js/commands/checkInternalLinks.ts @@ -103,7 +103,8 @@ const PROVIDER_GLOBS_TO_LOAD = ["docs/api/qiskit/*.mdx"]; const RUNTIME_GLOBS_TO_LOAD = [ "docs/api/qiskit/*.mdx", "docs/api/qiskit-ibm-runtime/options.mdx", - "docs/guides/local-testing-mode.ipynb", + "docs/guides/*.{mdx,ipynb}", + "docs/migration-guides/*.{mdx,ipynb}", ]; const QISKIT_GLOBS_TO_LOAD = [ "docs/api/qiskit/release-notes/0.44.mdx",