diff --git a/docs/api/qiskit-ibm-runtime/0.20/_package.json b/docs/api/qiskit-ibm-runtime/0.20/_package.json new file mode 100644 index 00000000000..ca759f626c4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/_package.json @@ -0,0 +1,4 @@ +{ + "name": "qiskit-ibm-runtime", + "version": "0.20.0" +} diff --git a/docs/api/qiskit-ibm-runtime/0.20/_toc.json b/docs/api/qiskit-ibm-runtime/0.20/_toc.json new file mode 100644 index 00000000000..5f09ab565f3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/_toc.json @@ -0,0 +1,517 @@ +{ + "title": "Qiskit Runtime IBM Client", + "children": [ + { + "title": "qiskit_ibm_runtime", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.20/runtime_service" + }, + { + "title": "Estimator", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Estimator" + }, + { + "title": "IBMBackend", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.IBMBackend" + }, + { + "title": "QiskitRuntimeService", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.QiskitRuntimeService" + }, + { + "title": "RuntimeDecoder", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeDecoder" + }, + { + "title": "RuntimeEncoder", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeEncoder" + }, + { + "title": "RuntimeJob", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeJob" + }, + { + "title": "RuntimeOptions", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeOptions" + }, + { + "title": "Sampler", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Sampler" + }, + { + "title": "Session", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Session" + } + ] + }, + { + "title": "qiskit_ibm_runtime.fake_provider", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.20/fake_provider" + }, + { + "title": "FakeAlmaden", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmaden" + }, + { + "title": "FakeAlmadenV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2" + }, + { + "title": "FakeArmonk", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonk" + }, + { + "title": "FakeArmonkV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonkV2" + }, + { + "title": "FakeAthens", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthens" + }, + { + "title": "FakeAthensV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthensV2" + }, + { + "title": "FakeAuckland", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAuckland" + }, + { + "title": "FakeBelem", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelem" + }, + { + "title": "FakeBelemV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelemV2" + }, + { + "title": "FakeBoeblingen", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingen" + }, + { + "title": "FakeBoeblingenV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2" + }, + { + "title": "FakeBogota", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogota" + }, + { + "title": "FakeBogotaV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogotaV2" + }, + { + "title": "FakeBrooklyn", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklyn" + }, + { + "title": "FakeBrooklynV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2" + }, + { + "title": "FakeBurlington", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlington" + }, + { + "title": "FakeBurlingtonV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2" + }, + { + "title": "FakeCairo", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairo" + }, + { + "title": "FakeCairoV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairoV2" + }, + { + "title": "FakeCambridge", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridge" + }, + { + "title": "FakeCambridgeV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2" + }, + { + "title": "FakeCasablanca", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablanca" + }, + { + "title": "FakeCasablancaV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2" + }, + { + "title": "FakeEssex", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssex" + }, + { + "title": "FakeEssexV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssexV2" + }, + { + "title": "FakeGeneva", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGeneva" + }, + { + "title": "FakeGuadalupe", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupe" + }, + { + "title": "FakeGuadalupeV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2" + }, + { + "title": "FakeHanoi", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoi" + }, + { + "title": "FakeHanoiV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoiV2" + }, + { + "title": "FakeJakarta", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakarta" + }, + { + "title": "FakeJakartaV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakartaV2" + }, + { + "title": "FakeJohannesburg", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburg" + }, + { + "title": "FakeJohannesburgV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2" + }, + { + "title": "FakeKolkata", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkata" + }, + { + "title": "FakeKolkataV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkataV2" + }, + { + "title": "FakeLagos", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagos" + }, + { + "title": "FakeLagosV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagosV2" + }, + { + "title": "FakeLima", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLima" + }, + { + "title": "FakeLimaV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLimaV2" + }, + { + "title": "FakeLondon", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondon" + }, + { + "title": "FakeLondonV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondonV2" + }, + { + "title": "FakeManhattan", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattan" + }, + { + "title": "FakeManhattanV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattanV2" + }, + { + "title": "FakeManila", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManila" + }, + { + "title": "FakeManilaV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManilaV2" + }, + { + "title": "FakeMelbourne", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourne" + }, + { + "title": "FakeMelbourneV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2" + }, + { + "title": "FakeMontreal", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontreal" + }, + { + "title": "FakeMontrealV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontrealV2" + }, + { + "title": "FakeMumbai", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbai" + }, + { + "title": "FakeMumbaiV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2" + }, + { + "title": "FakeNairobi", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobi" + }, + { + "title": "FakeNairobiV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobiV2" + }, + { + "title": "FakeOslo", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOslo" + }, + { + "title": "FakeOurense", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurense" + }, + { + "title": "FakeOurenseV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurenseV2" + }, + { + "title": "FakeParis", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParis" + }, + { + "title": "FakeParisV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParisV2" + }, + { + "title": "FakePerth", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePerth" + }, + { + "title": "FakePoughkeepsie", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie" + }, + { + "title": "FakePoughkeepsieV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2" + }, + { + "title": "FakePrague", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePrague" + }, + { + "title": "FakeProvider", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProvider" + }, + { + "title": "FakeProviderForBackendV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2" + }, + { + "title": "FakeQuito", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuito" + }, + { + "title": "FakeQuitoV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuitoV2" + }, + { + "title": "FakeRochester", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochester" + }, + { + "title": "FakeRochesterV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochesterV2" + }, + { + "title": "FakeRome", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRome" + }, + { + "title": "FakeRomeV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRomeV2" + }, + { + "title": "FakeRueschlikon", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRueschlikon" + }, + { + "title": "FakeSantiago", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiago" + }, + { + "title": "FakeSantiagoV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2" + }, + { + "title": "FakeSherbrooke", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSherbrooke" + }, + { + "title": "FakeSingapore", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingapore" + }, + { + "title": "FakeSingaporeV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2" + }, + { + "title": "FakeSydney", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydney" + }, + { + "title": "FakeSydneyV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydneyV2" + }, + { + "title": "FakeTenerife", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTenerife" + }, + { + "title": "FakeTokyo", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTokyo" + }, + { + "title": "FakeToronto", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeToronto" + }, + { + "title": "FakeTorontoV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTorontoV2" + }, + { + "title": "FakeValencia", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValencia" + }, + { + "title": "FakeValenciaV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValenciaV2" + }, + { + "title": "FakeVigo", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigo" + }, + { + "title": "FakeVigoV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigoV2" + }, + { + "title": "FakeWashington", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashington" + }, + { + "title": "FakeWashingtonV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2" + }, + { + "title": "FakeYorktown", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktown" + }, + { + "title": "FakeYorktownV2", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktownV2" + } + ] + }, + { + "title": "qiskit_ibm_runtime.options", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.20/options" + }, + { + "title": "EnvironmentOptions", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.EnvironmentOptions" + }, + { + "title": "ExecutionOptions", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ExecutionOptions" + }, + { + "title": "Options", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.Options" + }, + { + "title": "ResilienceOptions", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ResilienceOptions" + }, + { + "title": "SimulatorOptions", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.SimulatorOptions" + }, + { + "title": "TranspilationOptions", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.TranspilationOptions" + } + ] + }, + { + "title": "qiskit_ibm_runtime.transpiler", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.20/transpiler" + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes" + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes.basis", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.basis" + }, + { + "title": "qiskit_ibm_runtime.transpiler.passes.scheduling", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling" + }, + { + "title": "ALAPScheduleAnalysis", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis" + }, + { + "title": "ASAPScheduleAnalysis", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis" + }, + { + "title": "BlockBasePadder", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder" + }, + { + "title": "DynamicCircuitInstructionDurations", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations" + }, + { + "title": "PadDelay", + "url": "/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay" + }, + { + "title": "PadDynamicalDecoupling", + "url": "/api/qiskit-ibm-runtime/0.20/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.20/fake_provider.md b/docs/api/qiskit-ibm-runtime/0.20/fake_provider.md new file mode 100644 index 00000000000..ad8fcf1c013 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/fake_provider.md @@ -0,0 +1,189 @@ +--- +title: fake_provider +description: API reference for qiskit_ibm_runtime.fake_provider +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.fake_provider +--- + + + + + +# Fake Provider + + + +`qiskit_ibm_runtime.fake_provider` + +## Overview + +The fake provider module contains fake providers and fake backends classes. The fake backends are built to mimic the behaviors of IBM Quantum systems using system snapshots. The system snapshots contain important information about the quantum system such as coupling map, basis gates, qubit properties (T1, T2, error rate, etc.) which are useful for testing the transpiler and performing noisy simulations of the system. + +## Example Usage + +Here is an example of using a fake backend for transpilation and simulation. + +```python +from qiskit import QuantumCircuit +from qiskit import transpile +from qiskit.visualization import plot_histogram +from qiskit_ibm_runtime.fake_provider import FakeManilaV2 + +# Get a fake backend from the fake provider +backend = FakeManilaV2() + +# Create a simple circuit +circuit = QuantumCircuit(3) +circuit.h(0) +circuit.cx(0,1) +circuit.cx(0,2) +circuit.measure_all() +circuit.draw('mpl', style="iqp") + +# Transpile the ideal circuit to a circuit that can be directly executed by the backend +transpiled_circuit = transpile(circuit, backend) +transpiled_circuit.draw('mpl', style="iqp") + +# Run the transpiled circuit using the simulated fake backend +job = backend.run(transpiled_circuit) +counts = job.result().get_counts() +plot_histogram(counts) +``` + +![../\_images/fake\_provider-1\_00.png](/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_00.png) + +![../\_images/fake\_provider-1\_01.png](/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_01.png) + +![../\_images/fake\_provider-1\_02.png](/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_02.png) + + + Please note that the simulation is done using a noise model generated from system snapshots obtained in the past (sometimes a few years ago) and the results are not representative of the latest behaviours of the real quantum system which the fake backend is mimicking. If you want to run noisy simulations to compare with the real quantum system, you should use the `qiskit_aer` library. After installation, you can follow the steps below to generate a simulator that mimics a real quantum system with the latest calibration results. + + ```python + from qiskit_ibm_runtime import QiskitRuntimeService + from qiskit_aer import AerSimulator + + # get a real backend from the runtime service + service = QiskitRuntimeService() + backend = service.get_backend('ibmq_manila') + + # generate a simulator that mimics the real quantum system with the latest calibration results + backend_sim = AerSimulator.from_backend(backend) + ``` + + +## Fake Providers + +Fake providers provide access to a list of fake backends. + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | +| [`FakeProviderForBackendV2`](qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 "qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2")() | Fake provider containing fake V2 backends. | +| [`FakeProvider`](qiskit_ibm_runtime.fake_provider.FakeProvider "qiskit_ibm_runtime.fake_provider.FakeProvider")() | Fake provider containing fake V1 backends. | + +## Fake Backends + +### Fake V2 Backends + +Fake V2 backends are fake backends with IBM Quantum systems snapshots implemented with `BackendV2` interface. They are all subclasses of `FakeBackendV2`. + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | +| [`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. | +| [`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. | +| [`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. | +| [`FakeKolkataV2`](qiskit_ibm_runtime.fake_provider.FakeKolkataV2 "qiskit_ibm_runtime.fake_provider.FakeKolkataV2")() | A fake 27 qubit backend. | +| [`FakeLagosV2`](qiskit_ibm_runtime.fake_provider.FakeLagosV2 "qiskit_ibm_runtime.fake_provider.FakeLagosV2")() | A fake 7 qubit backend. | +| [`FakeLimaV2`](qiskit_ibm_runtime.fake_provider.FakeLimaV2 "qiskit_ibm_runtime.fake_provider.FakeLimaV2")() | A fake 5 qubit backend. | +| [`FakeLondonV2`](qiskit_ibm_runtime.fake_provider.FakeLondonV2 "qiskit_ibm_runtime.fake_provider.FakeLondonV2")() | A fake 5 qubit backend. | +| [`FakeManhattanV2`](qiskit_ibm_runtime.fake_provider.FakeManhattanV2 "qiskit_ibm_runtime.fake_provider.FakeManhattanV2")() | A fake Manhattan backend. | +| [`FakeManilaV2`](qiskit_ibm_runtime.fake_provider.FakeManilaV2 "qiskit_ibm_runtime.fake_provider.FakeManilaV2")() | A fake 5 qubit backend. | +| [`FakeMelbourneV2`](qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2")() | A fake 14 qubit backend. | +| [`FakeMontrealV2`](qiskit_ibm_runtime.fake_provider.FakeMontrealV2 "qiskit_ibm_runtime.fake_provider.FakeMontrealV2")() | A fake 27 qubit backend. | +| [`FakeMumbaiV2`](qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2")() | A fake 27 qubit backend. | +| [`FakeNairobiV2`](qiskit_ibm_runtime.fake_provider.FakeNairobiV2 "qiskit_ibm_runtime.fake_provider.FakeNairobiV2")() | A fake 7 qubit backend. | +| [`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. | +| [`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. | +| [`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. | +| [`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.20/index.md b/docs/api/qiskit-ibm-runtime/0.20/index.md new file mode 100644 index 00000000000..71a9da5c99c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/index.md @@ -0,0 +1,12 @@ +--- +title: Qiskit Runtime IBM Client API Docs +description: API documentation for qiskit-ibm-runtime +--- + +# qiskit-ibm-runtime API reference + +* [Qiskit Runtime (`qiskit_ibm_runtime`)](runtime_service) +* [Primitive options (`qiskit_ibm_runtime.options`)](options) +* [IBM Backend Transpiler Tools (`qiskit_ibm_runtime.transpiler`)](transpiler) +* [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider) + diff --git a/docs/api/qiskit-ibm-runtime/0.20/options.md b/docs/api/qiskit-ibm-runtime/0.20/options.md new file mode 100644 index 00000000000..5d3a56bc888 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/options.md @@ -0,0 +1,48 @@ +--- +title: options +description: API reference for qiskit_ibm_runtime.options +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.options +--- + + + + + +# Primitive options + + + +`qiskit_ibm_runtime.options` + +Options that can be passed to the primitives. + +The [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options") class encapsulates all the options you can specify when invoking a 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 + +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for the primitives. | +| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\[skip\_transpilation, ...]) | Transpilation options. | +| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\[noise\_amplifier, ...]) | Resilience options. | +| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\[shots, init\_qubits]) | Execution options. | +| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\[log\_level, callback, ...]) | Options related to the execution environment. | +| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\[noise\_model, ...]) | Simulator options. | + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Estimator.md new file mode 100644 index 00000000000..edae11af4a4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Estimator.md @@ -0,0 +1,145 @@ +--- +title: Estimator +description: API reference for qiskit_ibm_runtime.Estimator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.Estimator +--- + +# Estimator + + + +`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/estimator.py#L36-L219 "view source code") + +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.Estimator.run "qiskit_ibm_runtime.Estimator.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, and data is cached for efficiency. + +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** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + 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. + +**Return type** + +`Options` + +**Returns** + +options + + + +### session + +Return session used by this primitive. + +**Return type** + +`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + +**Returns** + +Session used by this primitive, or `None` if session is not used. + +## Methods + +### run + + + +`run(circuits, observables, parameter_values=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/estimator.py#L114-L148 "view source code") + +Submit a request to the estimator primitive. + +**Parameters** + +* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – a (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. +* **observables** (*BaseOperator | Sequence\[BaseOperator]*) – Observable objects. +* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. +* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). + +**Return type** + +[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") + +**Returns** + +Submitted job. The result of the job is an instance of `qiskit.primitives.EstimatorResult`. + +**Raises** + +**ValueError** – Invalid arguments are given. + +### set\_options + + + +`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/base_primitive.py#L216-L222 "view source code") + +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.20/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.IBMBackend.md new file mode 100644 index 00000000000..e00db922b50 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.IBMBackend.md @@ -0,0 +1,711 @@ +--- +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 + + + +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L75-L856 "view source code") + +Backend class interfacing with an IBM Quantum backend. + + + * You should not instantiate the `IBMBackend` class directly. Instead, use the methods provided by an [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") instance to retrieve and handle backends. + + +This class represents an IBM Quantum backend. Its attributes and methods provide information about the backend. For example, the [`status()`](#qiskit_ibm_runtime.IBMBackend.status "qiskit_ibm_runtime.IBMBackend.status") method returns a `BackendStatus` instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: + +```python +status = backend.status() +is_operational = status.operational +jobs_in_queue = status.pending_jobs +``` + +Here is list of attributes available on the `IBMBackend` class: + +> * name: backend name. +> +> * backend\_version: backend version in the form X.Y.Z. +> +> * num\_qubits: number of qubits. +> +> * target: A `qiskit.transpiler.Target` object for the backend. +> +> * basis\_gates: list of basis gates names on the backend. +> +> * gates: list of basis gates on the backend. +> +> * local: backend is local or remote. +> +> * simulator: backend is a simulator. +> +> * conditional: backend supports conditional operations. +> +> * open\_pulse: backend supports open pulse. +> +> * memory: backend supports memory. +> +> * max\_shots: maximum number of shots supported. +> +> * coupling\_map (list): The coupling map for the device +> +> * supported\_instructions (List\[str]): Instructions supported by the backend. +> +> * dynamic\_reprate\_enabled (bool): whether delay between programs can be set dynamically (ie via `rep_delay`). Defaults to False. +> +> * rep\_delay\_range (List\[float]): 2d list defining supported range of repetition delays for backend in μs. First entry is lower end of the range, second entry is higher end of the range. Optional, but will be specified when `dynamic_reprate_enabled=True`. +> +> * default\_rep\_delay (float): Value of `rep_delay` if not specified by user and `dynamic_reprate_enabled=True`. +> +> * n\_uchannels: Number of u-channels. +> +> * u\_channel\_lo: U-channel relationship on device los. +> +> * meas\_levels: Supported measurement levels. +> +> * qubit\_lo\_range: Qubit lo ranges for each qubit with form (min, max) in GHz. +> +> * meas\_lo\_range: Measurement lo ranges for each qubit with form (min, max) in GHz. +> +> * dt: Qubit drive channel timestep in nanoseconds. +> +> * dtm: Measurement drive channel timestep in nanoseconds. +> +> * rep\_times: Supported repetition times (program execution time) for backend in μs. +> +> * meas\_kernels: Supported measurement kernels. +> +> * discriminators: Supported discriminators. +> +> * hamiltonian: An optional dictionary with fields characterizing the system hamiltonian. +> +> * channel\_bandwidth (list): Bandwidth of all channels (qubit, measurement, and U) +> +> * acquisition\_latency (list): Array of dimension n\_qubits x n\_registers. Latency (in units of dt) to write a measurement result from qubit n into register slot m. +> +> * conditional\_latency (list): Array of dimension n\_channels \[d->u->m] x n\_registers. Latency (in units of dt) to do a conditional operation on channel n from register slot m +> +> * meas\_map (list): Grouping of measurement which are multiplexed +> +> * max\_circuits (int): The maximum number of experiments per job +> +> * sample\_name (str): Sample name for the backend +> +> * n\_registers (int): Number of register slots available for feedback (if conditional is True) +> +> * register\_map (list): An array of dimension n\_qubits X n\_registers that specifies whether a qubit can store a measurement in a certain register slot. +> +> * configurable (bool): True if the backend is configurable, if the backend is a simulator +> +> * credits\_required (bool): True if backend requires credits to run a job. +> +> * online\_date (datetime): The date that the device went online +> +> * display\_name (str): Alternate name field for the backend +> +> * description (str): A description for the backend +> +> * tags (list): A list of string tags to describe the backend +> +> * version: version of `Backend` class (Ex: 1, 2) +> +> * channels: An optional dictionary containing information of each channel – their purpose, type, and qubits operated on. +> +> * parametric\_pulses (list): A list of pulse shapes which are supported on the backend. For example: `['gaussian', 'constant']` +> +> * processor\_type (dict): Processor type for this backend. A dictionary of the form `{"family": , "revision": , segment: }` such as `{"family": "Canary", "revision": "1.0", segment: "A"}`. +> +> > * family: Processor family of this backend. +> > * revision: Revision version of this processor. +> > * segment: Segment this processor belongs to within a larger chip. + +IBMBackend constructor. + +**Parameters** + +* **configuration** (`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`]) – Backend configuration. +* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Instance of QiskitRuntimeService. +* **api\_client** (`RuntimeClient`) – IBM client used to communicate with the server. + +## Attributes + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Returns** + +The output signal timestep in seconds. + +**Return type** + +dtm + + + +### id\_warning\_issued + +`= False` + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +The maximum number of circuits + +The maximum number of circuits (or Pulse schedules) that can be run in a single job. If there is no limit this will return None. + +**Return type** + +`int` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The grouping of measurements which are multiplexed + +**Return type** + +meas\_map + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.IBMBackend.run "qiskit_ibm_runtime.IBMBackend.run") method. + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### service + +Return the `service` object + +**Returns** + +instance of QiskitRuntimeService + +**Return type** + +service + + + +### session + +Return session + +**Return type** + +`Session` + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +`Target` + +**Returns** + +Target + + + +### version + +`= 2` + + + +### 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__()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L506-L508 "view source code") + +Call self as a function. + +**Return type** + +[`IBMBackend`](#qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend") + +### acquire\_channel + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L480-L486 "view source code") + +Return the acquisition channel for the given qubit. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### cancel\_session + + + +`cancel_session()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L839-L846 "view source code") + +Cancel session. All pending jobs will be cancelled. + +**Return type** + +`None` + +### check\_faulty + + + +`check_faulty(circuit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L530-L562 "view source code") + +Check if the input circuit uses faulty qubits or edges. + +**Parameters** + +**circuit** (`QuantumCircuit`) – Circuit to check. + +**Raises** + +**ValueError** – If an instruction operating on a faulty qubit or edge is found. + +**Return type** + +`None` + +### close\_session + + + +`close_session()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L848-L856 "view source code") + +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 + + + +`configuration()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L447-L462 "view source code") + +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 + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L488-L501 "view source code") + +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 + + + +`defaults(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L424-L445 "view source code") + +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 + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L464-L470 "view source code") + +Return the drive channel for the given qubit. + +**Returns** + +The Qubit drive channel + +**Return type** + +DriveChannel + +### measure\_channel + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L472-L478 "view source code") + +Return the measure stimulus channel for the given qubit. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### open\_session + + + +`open_session(max_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L823-L832 "view source code") + +Open session + +**Return type** + +`Session` + +### properties + + + +`properties(refresh=False, datetime=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L348-L398 "view source code") + +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 + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L582-L739 "view source code") + +Run on the backend. If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. + +**Parameters** + +* **circuits** (`Union`\[`QuantumCircuit`, `str`, `List`\[`Union`\[`QuantumCircuit`, `str`]]]) – An individual or a list of `QuantumCircuit`. + +* **dynamic** (`Optional`\[`bool`]) – Whether the circuit is dynamic (uses in-circuit conditionals) + +* **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call. + +* **init\_circuit** (`Optional`\[`QuantumCircuit`]) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified. + +* **init\_num\_resets** (`Optional`\[`int`]) – The number of qubit resets to insert before each circuit execution. + +* **or** (*The following parameters are applicable only if dynamic=False is specified*) – + +* **to.** (*defaulted*) – + +* **header** (`Optional`\[`Dict`]) – User input that will be attached to the job and will be copied to the corresponding result header. Headers do not affect the run. This replaces the old `Qobj` header. + +* **shots** (`Union`\[`int`, `float`, `None`]) – Number of repetitions of each circuit, for sampling. Default: 4000 or `max_shots` from the backend configuration, whichever is smaller. + +* **memory** (`Optional`\[`bool`]) – If `True`, per-shot measurement bitstrings are returned as well (provided the backend supports it). For OpenPulse jobs, only measurement level 2 supports this option. + +* **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) – + + Level of the measurement output for pulse experiments. See [OpenPulse specification](https://arxiv.org/pdf/1809.03452.pdf) for details: + + * `0`, measurements of the raw signal (the measurement output pulse envelope) + * `1`, measurement kernel is selected (a complex number obtained after applying the measurement kernel to the measurement output signal) + * `2` (default), a discriminator is selected and the qubit state is stored (0 or 1) + +* **meas\_return** (`Union`\[`str`, `MeasReturnType`, `None`]) – + + Level of measurement data for the backend to return. For `meas_level` 0 and 1: + + * `single` returns information from every shot. + * `avg` returns average measurement output (averaged over number of shots). + +* **rep\_delay** (`Optional`\[`float`]) – Delay between programs in seconds. Only supported on certain backends (if `backend.configuration().dynamic_reprate_enabled=True`). If supported, `rep_delay` must be from the range supplied by the backend (`backend.configuration().rep_delay_range`). Default is given by `backend.configuration().default_rep_delay`. + +* **init\_qubits** (`Optional`\[`bool`]) – Whether to reset the qubits to the ground state for each shot. Default: `True`. + +* **use\_measure\_esp** (`Optional`\[`bool`]) – Whether to use excited state promoted (ESP) readout for measurements which are the terminal instruction to a qubit. ESP readout can offer higher fidelity than standard measurement sequences. See [here](https://arxiv.org/pdf/2008.08571.pdf). Default: `True` if backend supports ESP readout, else `False`. Backend support for ESP readout is determined by the flag `measure_esp_enabled` in `backend.configuration()`. + +* **noise\_model** (`Optional`\[`Any`]) – Noise model. (Simulators only) + +* **seed\_simulator** (`Optional`\[`int`]) – Random seed to control sampling. (Simulators only) + +* **\*\*run\_config** – Extra arguments used to configure the run. + +**Return type** + +[`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_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L400-L422 "view source code") + +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 + + + +`target_history(datetime=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L338-L346 "view source code") + +A `qiskit.transpiler.Target` object for the backend. :rtype: `Target` :returns: Target with properties found on datetime + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.QiskitRuntimeService.md new file mode 100644 index 00000000000..0e636261475 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -0,0 +1,514 @@ +--- +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 + + + +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L64-L1219 "view source code") + +Class for interacting with the Qiskit Runtime service. + +Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. + +A sample workflow of using the runtime service: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler, Estimator, Options +from qiskit.circuit.library import RealAmplitudes +from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister +from qiskit.quantum_info import SparsePauliOp + +# Initialize account. +service = QiskitRuntimeService() + +# Set options, which can be overwritten at job level. +options = Options(optimization_level=1) + +# 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) + +with Session(service=service, backend="ibmq_qasm_simulator") as session: + # Submit a request to the Sampler primitive within the session. + sampler = Sampler(session=session, options=options) + job = sampler.run(circuits=qc) + print(f"Sampler results: {job.result()}") + + # Submit a request to the Estimator primitive within the session. + estimator = Estimator(session=session, options=options) + job = estimator.run( + circuits=[psi], observables=[H1], parameter_values=[theta] + ) + print(f"Estimator results: {job.result()}") +``` + +The example above uses the dedicated [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") and [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") classes. You can also use the [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method directly to invoke a Qiskit Runtime program. + +If the program has any interim results, you can use the `callback` parameter of the [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method to stream the interim results. Alternatively, you can use the [`RuntimeJob.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. + +The [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method returns a [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") object. You can use its methods to perform tasks like checking job status, getting job result, and canceling job. + +QiskitRuntimeService constructor + +An account is selected in the following order: + +> * Account with the input name, if specified. +> * Default account for the channel type, if channel is specified but token is not. +> * Account defined by the input channel and token, if specified. +> * Account defined by the default\_channel if defined in filename +> * Account defined by the environment variables, if defined. +> * Default account for the `ibm_cloud` account, if one is available. +> * Default account for the `ibm_quantum` account, if one is available. + +instance, proxies, and verify can be used to overwrite corresponding values in the loaded account. + +**Parameters** + +* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’]]) – Channel type. `ibm_cloud` or `ibm_quantum`. +* **token** (`Optional`\[`str`]) – IBM Cloud API key or IBM Quantum API token. +* **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum). +* **filename** (`Optional`\[`str`]) – Full path of the file where the account is created. Default: \_DEFAULT\_ACCOUNT\_CONFIG\_JSON\_FILE +* **name** (`Optional`\[`str`]) – Name of the account to load. +* **instance** (`Optional`\[`str`]) – The service instance to use. For `ibm_cloud` runtime, this is the Cloud Resource Name (CRN) or the service name. For `ibm_quantum` runtime, this is the hub/group/project in that format. +* **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication) +* **verify** (`Optional`\[`bool`]) – Whether to verify the server’s TLS certificate. +* **channel\_strategy** (`Optional`\[`str`]) – Error mitigation strategy. + +**Returns** + +An instance of QiskitRuntimeService. + +**Raises** + +**IBMInputValueError** – If an input is invalid. + +## Attributes + + + +### channel + +Return the channel type used. + +**Return type** + +`str` + +**Returns** + +The channel type used. + + + +### global\_service + +`= None` + + + +### runtime + +Return self for compatibility with IBMQ provider. + +**Returns** + +self + + + +### version + +`= 1` + +## Methods + +### active\_account + + + +`active_account()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L708-L714 "view source code") + +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 + + + +`backend(name=None, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L817-L847 "view source code") + +Return a single backend matching the specified filtering. + +**Parameters** + +* **name** (`Optional`\[`str`]) – Name of the backend. +* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. If an instance is not given, among the providers with access to the backend, a premium provider will be prioritized. For users without access to a premium provider, the default open provider will be used. + +**Returns** + +A backend matching the filtering. + +**Return type** + +Backend + +**Raises** + +**QiskitBackendNotFoundError** – if no backend could be found. + +### backends + + + +`backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L544-L652 "view source code") + +Return all backends accessible via this account, subject to optional filtering. + +**Parameters** + +* **name** (`Optional`\[`str`]) – Backend name to filter by. + +* **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have. + +* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. + +* **dynamic\_circuits** (`Optional`\[`bool`]) – Filter by whether the backend supports dynamic circuits. + +* **filters** (`Optional`\[`Callable`\[\[`List`\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")]], `bool`]]) – + + More complex filters, such as lambda functions. For example: + + ```python + QiskitRuntimeService.backends( + filters=lambda b: b.max_shots > 50000) + QiskitRuntimeService.backends( + filters=lambda x: ("rz" in x.basis_gates ) + ``` + +* **\*\*kwargs** – + + Simple filters that require a specific value for an attribute in backend configuration or status. Examples: + + ```python + # Get the operational real backends + QiskitRuntimeService.backends(simulator=False, operational=True) + + # Get the backends with at least 127 qubits + QiskitRuntimeService.backends(min_num_qubits=127) + + # Get the backends that support OpenPulse + QiskitRuntimeService.backends(open_pulse=True) + ``` + + For the full list of backend attributes, see the IBMBackend class documentation \<[api/qiskit/providers\_models](/api/qiskit/providers_models)> + +**Return type** + +`List`\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")] + +**Returns** + +The list of available backends that match the filter. + +**Raises** + +* **IBMInputValueError** – If an input is invalid. +* **QiskitBackendNotFoundError** – If the backend is not in any instance. + +### delete\_account + + + +`static delete_account(filename=None, name=None, channel=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L716-L734 "view source code") + +Delete a saved account from disk. + +**Parameters** + +* **filename** (`Optional`\[`str`]) – Name of file from which to delete the account. +* **name** (`Optional`\[`str`]) – Name of the saved account to delete. +* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’]]) – Channel type of the default account to delete. Ignored if account name is provided. + +**Return type** + +`bool` + +**Returns** + +True if the account was deleted. False if no account was found. + +### delete\_job + + + +`delete_job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L1077-L1094 "view source code") + +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 + + + +`get_backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L849-L850 "view source code") + +Return a single backend matching the specified filtering. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +a backend matching the filtering. + +**Return type** + +Backend + +**Raises** + +**QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria. + +### instances + + + +`instances()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L1184-L1192 "view source code") + +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 + + + +`job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L960-L979 "view source code") + +Retrieve a runtime job. + +**Parameters** + +**job\_id** (`str`) – Job ID. + +**Return type** + +[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") + +**Returns** + +Runtime job retrieved. + +**Raises** + +* **RuntimeJobNotFound** – If the job doesn’t exist. +* **IBMRuntimeError** – If the request failed. + +### jobs + + + +`jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L981-L1075 "view source code") + +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`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob")] + +**Returns** + +A list of runtime jobs. + +**Raises** + +**IBMInputValueError** – If an input value is invalid. + +### least\_busy + + + +`least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L1147-L1182 "view source code") + +Return the least busy available backend. + +**Parameters** + +* **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have. + +* **instance** (`Optional`\[`str`]) – This is only supported for `ibm_quantum` runtime and is in the hub/group/project format. + +* **filters** (`Optional`\[`Callable`\[\[`List`\[[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend")]], `bool`]]) – + + Filters can be defined as for the [`backends()`](#qiskit_ibm_runtime.QiskitRuntimeService.backends "qiskit_ibm_runtime.QiskitRuntimeService.backends") method. An example to get the operational backends with 5 qubits: + + ```python + QiskitRuntimeService.least_busy(n_qubits=5, operational=True) + ``` + +**Return type** + +[`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend") + +**Returns** + +The backend with the fewest number of pending jobs. + +**Raises** + +**QiskitBackendNotFoundError** – If no backend matches the criteria. + +### run + + + +`run(program_id, inputs, options=None, callback=None, result_decoder=None, session_id=None, start_session=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L852-L958 "view source code") + +Execute the runtime program. + +**Parameters** + +* **program\_id** (`str`) – Program ID. + +* **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program. + +* **options** (`Union`\[[`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.runtime_options.RuntimeOptions"), `Dict`, `None`]) – Runtime options that control the execution environment. See [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") for all available options. + +* **callback** (`Optional`\[`Callable`]) – + + Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: + + > 1. Job ID + > 2. Job result. + +* **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results. If more than one decoder is specified, the first is used for interim results and the second final results. If not specified, a program-specific decoder or the default `ResultDecoder` is used. + +* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session. + +* **start\_session** (`Optional`\[`bool`]) – Set to True to explicitly start a runtime session. Defaults to False. + +**Return type** + +[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") + +**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 + + + +`static save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, channel_strategy=None, set_as_default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L736-L785 "view source code") + +Save the account to disk for future use. + +**Parameters** + +* **token** (`Optional`\[`str`]) – IBM Cloud API key or IBM Quantum API token. +* **url** (`Optional`\[`str`]) – The API URL. Defaults to [https://cloud.ibm.com](https://cloud.ibm.com) (ibm\_cloud) or [https://auth.quantum-computing.ibm.com/api](https://auth.quantum-computing.ibm.com/api) (ibm\_quantum). +* **instance** (`Optional`\[`str`]) – The CRN (ibm\_cloud) or hub/group/project (ibm\_quantum). +* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’]]) – Channel type. ibm\_cloud or ibm\_quantum. +* **filename** (`Optional`\[`str`]) – Full path of the file where the account is saved. +* **name** (`Optional`\[`str`]) – Name of the account to save. +* **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication) +* **verify** (`Optional`\[`bool`]) – Verify the server’s TLS certificate. +* **overwrite** (`Optional`\[`bool`]) – `True` if the existing account is to be overwritten. +* **channel\_strategy** (`Optional`\[`str`]) – Error mitigation strategy. +* **set\_as\_default** (`Optional`\[`bool`]) – If `True`, the account is saved in filename, as the default account. + +**Return type** + +`None` + +### saved\_accounts + + + +`static saved_accounts(default=None, channel=None, filename=None, name=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L787-L815 "view source code") + +List the accounts saved on disk. + +**Parameters** + +* **default** (`Optional`\[`bool`]) – If set to True, only default accounts are returned. +* **channel** (`Optional`\[`Literal`\[‘ibm\_cloud’, ‘ibm\_quantum’]]) – Channel type. ibm\_cloud or ibm\_quantum. +* **filename** (`Optional`\[`str`]) – Name of file whose accounts are returned. +* **name** (`Optional`\[`str`]) – If set, only accounts with the given name are returned. + +**Return type** + +`dict` + +**Returns** + +A dictionary with information about the accounts saved on disk. + +**Raises** + +**ValueError** – If an invalid account is found on disk. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeDecoder.md new file mode 100644 index 00000000000..2a367574489 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeDecoder.md @@ -0,0 +1,60 @@ +--- +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 + + + +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py#L282-L343 "view source code") + +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 + + + +`decode(s, _w=)` + +Return the Python representation of `s` (a `str` instance containing a JSON document). + +### object\_hook + + + +`object_hook(obj)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py#L297-L343 "view source code") + +Called to decode object. + +**Return type** + +`Any` + +### raw\_decode + + + +`raw_decode(s, idx=0)` + +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.20/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeEncoder.md new file mode 100644 index 00000000000..fc1b85bba7e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeEncoder.md @@ -0,0 +1,105 @@ +--- +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 + + + +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py#L196-L279 "view source code") + +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 + + + +`default(obj)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py#L199-L279 "view source code") + +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 + + + +`encode(o)` + +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 + + + +`iterencode(o, _one_shot=False)` + +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.20/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeJob.md new file mode 100644 index 00000000000..861646b4459 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeJob.md @@ -0,0 +1,553 @@ +--- +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 + + + +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L55-L752 "view source code") + +Representation of a runtime program execution. + +A new `RuntimeJob` instance is returned when you call [`QiskitRuntimeService.run`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") to execute a runtime program, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. + +If the program execution is successful, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_runtime.RuntimeJob.status "qiskit_ibm_runtime.RuntimeJob.status"). Job status can be one of the `JobStatus` members. + +Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](#qiskit_ibm_runtime.RuntimeJob.result "qiskit_ibm_runtime.RuntimeJob.result") is an example of a blocking method: + +```python +job = service.run(...) + +try: + job_result = job.result() # It will block until the job finishes. + print("The job finished with result {}".format(job_result)) +except RuntimeJobFailureError as ex: + print("Job failed!: {}".format(ex)) +``` + +If the program has any interim results, you can use the `callback` parameter of the [`run()`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") method to stream the interim results along with the final result. Alternatively, you can use the [`stream_results()`](#qiskit_ibm_runtime.RuntimeJob.stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes. + +RuntimeJob constructor. + +**Parameters** + +* **backend** (`Backend`) – The backend instance used to run this job. +* **api\_client** (`RuntimeClient`) – Object for connecting to the server. +* **client\_params** (`ClientParameters`) – Parameters used for server connection. +* **job\_id** (`str`) – Job ID. +* **program\_id** (`str`) – ID of the program this job is for. +* **params** (`Optional`\[`Dict`]) – Job parameters. +* **creation\_date** (`Optional`\[`str`]) – Job creation date, in UTC. +* **user\_callback** (`Optional`\[`Callable`]) – User callback function. +* **result\_decoder** (`Union`\[`Type`\[`ResultDecoder`], `Sequence`\[`Type`\[`ResultDecoder`]], `None`]) – A `ResultDecoder` subclass used to decode job results. +* **image** (`Optional`\[`str`]) – Runtime image used for this job: image\_name:tag. +* **service** ([`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")) – Runtime service. +* **session\_id** (`Optional`\[`str`]) – Job ID of the first job in a runtime session. +* **tags** (`Optional`\[`List`]) – Tags assigned to the job. + +## Attributes + + + +### creation\_date + +Job creation date in local time. + +**Return type** + +`Optional`\[`datetime`] + +**Returns** + +The job creation date as a datetime object, in local time, or `None` if creation date is not available. + + + +### image + +Return the runtime image used for the job. + +**Returns** + +image\_name:tag or “” if the default image is used. + +**Return type** + +Runtime image + + + +### inputs + +Job input parameters. + +**Return type** + +`Dict` + +**Returns** + +Input parameters used in this job. + + + +### program\_id + +Program ID. + +**Return type** + +`str` + +**Returns** + +ID of the program this job is for. + + + +### session\_id + +Session ID. + +**Return type** + +`str` + +**Returns** + +Session ID. None if the backend is a simulator. + + + +### tags + +Job tags. + +**Return type** + +`List` + +**Returns** + +Tags assigned to the job that can be used for filtering. + + + +### usage\_estimation + +Return the usage estimation infromation for this job. + +**Return type** + +`Dict`\[`str`, `Any`] + +**Returns** + +`quantum_seconds` which is the estimated system execution time of the job in seconds. Quantum time represents the time that the system is dedicated to processing your job. + + + +### version + +`= 1` + +## Methods + +### backend + + + +`backend(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L251-L265 "view source code") + +Return the backend where this job was executed. Retrieve data again if backend is None. + +**Raises** + +**IBMRuntimeError** – If a network error occurred. + +**Return type** + +`Optional`\[`Backend`] + +### cancel + + + +`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L235-L249 "view source code") + +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()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L352-L356 "view source code") + +Cancel result streaming. + +**Return type** + +`None` + +### cancelled + + + +`cancelled()` + +Return whether the job has been cancelled. + +**Return type** + +`bool` + +### done + + + +`done()` + +Return whether the job has successfully run. + +**Return type** + +`bool` + +### error\_message + + + +`error_message()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L276-L283 "view source code") + +Returns the reason if the job failed. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +Error message string or `None`. + +### in\_final\_state + + + +`in_final_state()` + +Return whether the job is in a final job state such as `DONE` or `ERROR`. + +**Return type** + +`bool` + +### interim\_results + + + +`interim_results(decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L178-L196 "view source code") + +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 + + + +`job_id()` + +Return a unique id identifying the job. + +**Return type** + +`str` + +### logs + + + +`logs()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L358-L377 "view source code") + +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 + + + +`metrics()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L379-L391 "view source code") + +Return job metrics. + +**Return type** + +`Dict`\[`str`, `Any`] + +**Returns** + +Job metrics, which includes timestamp information. + +**Raises** + +**IBMRuntimeError** – If a network error occurred. + +### properties + + + +`properties(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L436-L448 "view source code") + +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 + + + +`queue_info()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L720-L752 "view source code") + +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 + + + +`queue_position(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L693-L718 "view source code") + +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 + + + +`result(timeout=None, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L198-L233 "view source code") + +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 + + + +`running()` + +Return whether the job is actively running. + +**Return type** + +`bool` + +### status + + + +`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L267-L274 "view source code") + +Return the status of the job. + +**Return type** + +`JobStatus` + +**Returns** + +Status of this job. + +### stream\_results + + + +`stream_results(callback, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L322-L350 "view source code") + +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 + + + +`submit()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L393-L405 "view source code") + +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_tags(new_tags)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L407-L434 "view source code") + +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 + + + +`wait_for_final_state(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L285-L320 "view source code") + +Use the websocket server to wait for the final the state of a job. + +The server will remain open if the job is still running and the connection will be terminated once the job completes. Then update and return the status of the job. + +**Parameters** + +**timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + +**Raises** + +**RuntimeJobTimeoutError** – If the job does not complete within given timeout. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeOptions.md new file mode 100644 index 00000000000..650a2a9aaec --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.RuntimeOptions.md @@ -0,0 +1,108 @@ +--- +title: RuntimeOptions +description: API reference for qiskit_ibm_runtime.RuntimeOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.RuntimeOptions +--- + +# RuntimeOptions + + + +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_options.py#L24-L106 "view source code") + +Class for representing generic runtime execution options. + +RuntimeOptions constructor. + +**Parameters** + +* **backend** (`Optional`\[`str`]) – target backend to run on. This is required for `ibm_quantum` channel. +* **image** (`Optional`\[`str`]) – the runtime image used to execute the program, specified in the form of `image_name:tag`. Not all accounts are authorized to select a different image. +* **log\_level** (`Optional`\[`str`]) – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. The default level is `WARNING`. +* **instance** (`Optional`\[`str`]) – The hub/group/project to use, in that format. This is only supported for `ibm_quantum` channel. If `None`, a hub/group/project that provides access to the target backend is randomly selected. +* **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call. +* **max\_execution\_time** (`Optional`\[`int`]) – Maximum execution time in seconds, which is based on system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. +* **session\_time** (`Optional`\[`int`]) – Length of session in seconds. + +## Attributes + + + +### backend + +`str | None` + +`= None` + + + +### image + +`str | None` + +`= None` + + + +### instance + +`str | None` + +`= None` + + + +### job\_tags + +`List[str] | None` + +`= None` + + + +### log\_level + +`str | None` + +`= None` + + + +### max\_execution\_time + +`int | None` + +`= None` + + + +### session\_time + +`int | None` + +`= None` + +## Methods + +### validate + + + +`validate(channel)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_options.py#L76-L106 "view source code") + +Validate options. + +**Parameters** + +**channel** (`str`) – channel type. + +**Raises** + +**IBMInputValueError** – If one or more option is invalid. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Sampler.md new file mode 100644 index 00000000000..e0d643f5588 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Sampler.md @@ -0,0 +1,136 @@ +--- +title: Sampler +description: API reference for qiskit_ibm_runtime.Sampler +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.Sampler +--- + +# Sampler + + + +`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/sampler.py#L35-L184 "view source code") + +Class for interacting with Qiskit Runtime Sampler primitive service. + +Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. + +The [`run()`](#qiskit_ibm_runtime.Sampler.run "qiskit_ibm_runtime.Sampler.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, and data is cached for efficiency. + +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** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + 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. + +**Return type** + +`Options` + +**Returns** + +options + + + +### session + +Return session used by this primitive. + +**Return type** + +`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + +**Returns** + +Session used by this primitive, or `None` if session is not used. + +## Methods + +### run + + + +`run(circuits, parameter_values=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/sampler.py#L102-L130 "view source code") + +Submit a request to the sampler primitive. + +**Parameters** + +* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – A (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. +* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. +* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). + +**Return type** + +[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") + +**Returns** + +Submitted job. The result of the job is an instance of `qiskit.primitives.SamplerResult`. + +**Raises** + +**ValueError** – Invalid arguments are given. + +### set\_options + + + +`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/base_primitive.py#L216-L222 "view source code") + +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.20/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Session.md new file mode 100644 index 00000000000..c3bb4cc48e4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.Session.md @@ -0,0 +1,204 @@ +--- +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 + + + +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L40-L336 "view source code") + +Class for creating a flexible Qiskit Runtime session. + +A Qiskit Runtime `session` allows you to group a collection of iterative calls to the quantum computer. A session is started when the first job within the session is started. Subsequent jobs within the session are prioritized by the scheduler. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. + +You can open a Qiskit Runtime session using this `Session` class and submit jobs to one or more primitives. + +For example: + +```python +from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister +from qiskit_ibm_runtime import Sampler, Session, Options + +# 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) + +options = Options(optimization_level=3) + +with Session(backend="ibmq_qasm_simulator") as session: + sampler = Sampler(session=session, options=options) + job = sampler.run(qc) + print(f"Sampler job ID: {job.job_id()}") + print(f"Sampler job result: {job.result()}") +``` + +Session constructor. + +**Parameters** + +* **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – Optional instance of the `QiskitRuntimeService` class. If `None`, the service associated with the backend, if known, is used. Otherwise `QiskitRuntimeService()` is used to initialize your default saved account. +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Optional instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. An instance of `qiskit_ibm_provider.IBMBackend` will not work. If not specified, a backend will be selected automatically (IBM Cloud channel only). +* **max\_time** (`Union`\[`int`, `str`, `None`]) – (EXPERIMENTAL setting, can break between releases without warning) Maximum amount of time, a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be 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 + + + +`backend()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L208-L214 "view source code") + +Return backend for this session. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +Backend for this session. None if unknown. + +### cancel + + + +`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L194-L198 "view source code") + +Cancel all pending jobs in a session. + +**Return type** + +`None` + +### close + + + +`close()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L200-L206 "view source code") + +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 + + + +`details()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L242-L278 "view source code") + +Return session details. + +**Returns** + +id: id of the session. backend\_name: backend used for the session. interactive\_timeout: The maximum idle time (in seconds) between jobs that is allowed to occur before the session is deactivated. max\_time: Maximum allowed time (in seconds) for the session, subject to plan limits. active\_timeout: The maximum time (in seconds) a session can stay active. state: State of the session - open, active, inactive, or closed. accepting\_jobs: Whether or not the session is accepting jobs. last\_job\_started: Timestamp of when the last job in the session started. last\_job\_completed: Timestamp of when the last job in the session completed. started\_at: Timestamp of when the session was started. closed\_at: Timestamp of when the session was closed. activated\_at: Timestamp of when the session state was changed to active. + +**Return type** + +A dictionary with the sessions details, including + +### from\_id + + + +`classmethod from_id(session_id, service=None, backend=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L298-L323 "view source code") + +Construct a Session object with a given session\_id + +**Parameters** + +* **session\_id** (`str`) – the id of the session to be created. This must be an already existing session id. +* **service** (`Optional`\[[`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.qiskit_runtime_service.QiskitRuntimeService")]) – instance of the `QiskitRuntimeService` class. +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – instance of [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class or string name of backend. + +**Return type** + +[`Session`](#qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session") + +**Returns** + +A new Session with the given `session_id` + +### run + + + +`run(program_id, inputs, options=None, callback=None, result_decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L149-L192 "view source code") + +Run a program in the session. + +**Parameters** + +* **program\_id** (`str`) – Program ID. +* **inputs** (`Dict`) – Program input parameters. These input values are passed to the runtime program. +* **options** (`Optional`\[`Dict`]) – Runtime options that control the execution environment. See [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") for all available options. +* **callback** (`Optional`\[`Callable`]) – Callback function to be invoked for any interim results and final result. + +**Return type** + +[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") + +**Returns** + +Submitted job. + +### status + + + +`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L216-L240 "view source code") + +Return current session status. + +**Returns** + +Pending: Session is created but not active. It will become active when the next job of this session is dequeued. In progress, accepting new jobs: session is active and accepting new jobs. In progress, not accepting new jobs: session is active and not accepting new jobs. Closed: max\_time expired or session was explicitly closed. None: status details are not available. + +**Return type** + +The current status of the session, including + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md new file mode 100644 index 00000000000..08c420e0312 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md @@ -0,0 +1,177 @@ +--- +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 + + + +`FakeAlmaden` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L41-L58 "view source code") + +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 + +`= 'fake_almaden'` + + + +### conf\_filename + +`= 'conf_almaden.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/almaden'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_almaden.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md new file mode 100644 index 00000000000..2731171efc6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md @@ -0,0 +1,387 @@ +--- +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 + + + +`FakeAlmadenV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L21-L38 "view source code") + +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 + +`= 'fake_almaden'` + + + +### conf\_filename + +`= 'conf_almaden.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/almaden'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run "qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.run") method. + + + +### props\_filename + +`= 'props_almaden.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonk.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonk.md new file mode 100644 index 00000000000..2735b267633 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonk.md @@ -0,0 +1,189 @@ +--- +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 + + + +`FakeArmonk` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L36-L48 "view source code") + +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 + +`= 'fake_armonk'` + + + +### conf\_filename + +`= 'conf_armonk.json'` + + + +### defs\_filename + +`= 'defs_armonk.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/armonk'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_armonk.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md new file mode 100644 index 00000000000..97cea6b3f6e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md @@ -0,0 +1,381 @@ +--- +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 + + + +`FakeArmonkV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L21-L33 "view source code") + +A fake 1 qubit backend. + +```python +0 +``` + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_armonk'` + + + +### conf\_filename + +`= 'conf_armonk.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_armonk.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/armonk'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeArmonkV2.run "qiskit_ibm_runtime.fake_provider.FakeArmonkV2.run") method. + + + +### props\_filename + +`= 'props_armonk.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthens.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthens.md new file mode 100644 index 00000000000..f7bb0cd4d3f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthens.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeAthens` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L31-L38 "view source code") + +A fake 5 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_athens'` + + + +### conf\_filename + +`= 'conf_athens.json'` + + + +### defs\_filename + +`= 'defs_athens.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/athens'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_athens.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md new file mode 100644 index 00000000000..bec95b6467c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeAthensV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L21-L28 "view source code") + +A fake 5 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_athens'` + + + +### conf\_filename + +`= 'conf_athens.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_athens.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/athens'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAthensV2.run "qiskit_ibm_runtime.fake_provider.FakeAthensV2.run") method. + + + +### props\_filename + +`= 'props_athens.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAuckland.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAuckland.md new file mode 100644 index 00000000000..982e308f839 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeAuckland.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeAuckland` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py#L22-L29 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_auckland'` + + + +### conf\_filename + +`= 'conf_auckland.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_auckland.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/auckland'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAuckland.run "qiskit_ibm_runtime.fake_provider.FakeAuckland.run") method. + + + +### props\_filename + +`= 'props_auckland.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelem.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelem.md new file mode 100644 index 00000000000..8cdf31e5d19 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelem.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeBelem` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L31-L38 "view source code") + +A fake 5 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_belem'` + + + +### conf\_filename + +`= 'conf_belem.json'` + + + +### defs\_filename + +`= 'defs_belem.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/belem'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_belem.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md new file mode 100644 index 00000000000..c3417125d30 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeBelemV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L21-L28 "view source code") + +A fake 5 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_belem'` + + + +### conf\_filename + +`= 'conf_belem.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_belem.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/belem'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBelemV2.run "qiskit_ibm_runtime.fake_provider.FakeBelemV2.run") method. + + + +### props\_filename + +`= 'props_belem.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md new file mode 100644 index 00000000000..8818d7785b1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md @@ -0,0 +1,195 @@ +--- +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 + + + +`FakeBoeblingen` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L42-L60 "view source code") + +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 + +`= 'fake_boeblingen'` + + + +### conf\_filename + +`= 'conf_boeblingen.json'` + + + +### defs\_filename + +`= 'defs_boeblingen.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/boeblingen'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_boeblingen.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md new file mode 100644 index 00000000000..84da16aaada --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md @@ -0,0 +1,387 @@ +--- +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 + + + +`FakeBoeblingenV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L21-L39 "view source code") + +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 + +`= 'fake_boeblingen'` + + + +### conf\_filename + +`= 'conf_boeblingen.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_boeblingen.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/boeblingen'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.run "qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.run") method. + + + +### props\_filename + +`= 'props_boeblingen.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogota.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogota.md new file mode 100644 index 00000000000..fcda71f37a1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogota.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeBogota` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L31-L38 "view source code") + +A fake 5 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_bogota'` + + + +### conf\_filename + +`= 'conf_bogota.json'` + + + +### defs\_filename + +`= 'defs_bogota.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/bogota'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_bogota.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md new file mode 100644 index 00000000000..d7be2f10516 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeBogotaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L21-L28 "view source code") + +A fake 5 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_bogota'` + + + +### conf\_filename + +`= 'conf_bogota.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_bogota.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/bogota'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBogotaV2.run "qiskit_ibm_runtime.fake_provider.FakeBogotaV2.run") method. + + + +### props\_filename + +`= 'props_bogota.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md new file mode 100644 index 00000000000..34a9375f2e9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeBrooklyn` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L31-L38 "view source code") + +A fake Brooklyn backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_brooklyn'` + + + +### conf\_filename + +`= 'conf_brooklyn.json'` + + + +### defs\_filename + +`= 'defs_brooklyn.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/brooklyn'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_brooklyn.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md new file mode 100644 index 00000000000..6c36246a4d3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeBrooklynV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L21-L28 "view source code") + +A fake Brooklyn V2 backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_brooklyn'` + + + +### conf\_filename + +`= 'conf_brooklyn.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_brooklyn.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/brooklyn'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.run "qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.run") method. + + + +### props\_filename + +`= 'props_brooklyn.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlington.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlington.md new file mode 100644 index 00000000000..167af4fb88f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlington.md @@ -0,0 +1,173 @@ +--- +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 + + + +`FakeBurlington` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L37-L50 "view source code") + +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 + +`= 'fake_burlington'` + + + +### conf\_filename + +`= 'conf_burlington.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/burlington'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_burlington.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md new file mode 100644 index 00000000000..28e9536cf76 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md @@ -0,0 +1,383 @@ +--- +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 + + + +`FakeBurlingtonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L21-L34 "view source code") + +A fake 5 qubit backend. + +```python +0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 +``` + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_burlington'` + + + +### conf\_filename + +`= 'conf_burlington.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/burlington'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.run "qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.run") method. + + + +### props\_filename + +`= 'props_burlington.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairo.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairo.md new file mode 100644 index 00000000000..e369a5a7b99 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairo.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeCairo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L31-L38 "view source code") + +A fake 27 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_cairo'` + + + +### conf\_filename + +`= 'conf_cairo.json'` + + + +### defs\_filename + +`= 'defs_cairo.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cairo'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_cairo.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md new file mode 100644 index 00000000000..998ef0f99c2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeCairoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_cairo'` + + + +### conf\_filename + +`= 'conf_cairo.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_cairo.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cairo'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCairoV2.run "qiskit_ibm_runtime.fake_provider.FakeCairoV2.run") method. + + + +### props\_filename + +`= 'props_cairo.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridge.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridge.md new file mode 100644 index 00000000000..83914bd354e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridge.md @@ -0,0 +1,179 @@ +--- +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 + + + +`FakeCambridge` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L43-L62 "view source code") + +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 + +`= 'fake_cambridge'` + + + +### conf\_filename + +`= 'conf_cambridge.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cambridge'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_cambridge.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md new file mode 100644 index 00000000000..3223dbdb144 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md @@ -0,0 +1,389 @@ +--- +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 + + + +`FakeCambridgeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L21-L40 "view source code") + +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 + +`= 'fake_cambridge'` + + + +### conf\_filename + +`= 'conf_cambridge.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cambridge'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.run "qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.run") method. + + + +### props\_filename + +`= 'props_cambridge.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md new file mode 100644 index 00000000000..f07fdf7e90e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeCasablanca` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L31-L38 "view source code") + +A fake 7 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_casablanca'` + + + +### conf\_filename + +`= 'conf_casablanca.json'` + + + +### defs\_filename + +`= 'defs_casablanca.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/casablanca'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_casablanca.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md new file mode 100644 index 00000000000..48aa653c74b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeCasablancaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L21-L28 "view source code") + +A fake 7 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_casablanca'` + + + +### conf\_filename + +`= 'conf_casablanca.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_casablanca.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/casablanca'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.run "qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.run") method. + + + +### props\_filename + +`= 'props_casablanca.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssex.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssex.md new file mode 100644 index 00000000000..30b0a3f07d3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssex.md @@ -0,0 +1,175 @@ +--- +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 + + + +`FakeEssex` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L39-L54 "view source code") + +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 + +`= 'fake_essex'` + + + +### conf\_filename + +`= 'conf_essex.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/essex'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_essex.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md new file mode 100644 index 00000000000..f52d617ba21 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md @@ -0,0 +1,385 @@ +--- +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 + + + +`FakeEssexV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L21-L36 "view source code") + +A fake 5 qubit backend. + +```python +0 ↔ 1 ↔ 2 + ↕ + 3 + ↕ + 4 +``` + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_essex'` + + + +### conf\_filename + +`= 'conf_essex.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/essex'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeEssexV2.run "qiskit_ibm_runtime.fake_provider.FakeEssexV2.run") method. + + + +### props\_filename + +`= 'props_essex.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGeneva.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGeneva.md new file mode 100644 index 00000000000..31d42cf6a34 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGeneva.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeGeneva` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py#L22-L29 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_geneva'` + + + +### conf\_filename + +`= 'conf_geneva.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_geneva.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/geneva'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeGeneva.run "qiskit_ibm_runtime.fake_provider.FakeGeneva.run") method. + + + +### props\_filename + +`= 'props_geneva.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md new file mode 100644 index 00000000000..6f3f9192fec --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeGuadalupe` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L32-L39 "view source code") + +A fake 16 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_guadalupe'` + + + +### conf\_filename + +`= 'conf_guadalupe.json'` + + + +### defs\_filename + +`= 'defs_guadalupe.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/guadalupe'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_guadalupe.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md new file mode 100644 index 00000000000..72644571f69 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeGuadalupeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L22-L29 "view source code") + +A fake 16 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_guadalupe'` + + + +### conf\_filename + +`= 'conf_guadalupe.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_guadalupe.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/guadalupe'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.run "qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.run") method. + + + +### props\_filename + +`= 'props_guadalupe.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoi.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoi.md new file mode 100644 index 00000000000..39ddd171695 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoi.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeHanoi` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L31-L38 "view source code") + +A fake 27 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_hanoi'` + + + +### conf\_filename + +`= 'conf_hanoi.json'` + + + +### defs\_filename + +`= 'defs_hanoi.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/hanoi'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_hanoi.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md new file mode 100644 index 00000000000..fa54d705a5f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeHanoiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_hanoi'` + + + +### conf\_filename + +`= 'conf_hanoi.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_hanoi.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/hanoi'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeHanoiV2.run "qiskit_ibm_runtime.fake_provider.FakeHanoiV2.run") method. + + + +### props\_filename + +`= 'props_hanoi.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakarta.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakarta.md new file mode 100644 index 00000000000..f4938e2b9aa --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakarta.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeJakarta` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L31-L38 "view source code") + +A fake 7 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_jakarta'` + + + +### conf\_filename + +`= 'conf_jakarta.json'` + + + +### defs\_filename + +`= 'defs_jakarta.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/jakarta'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_jakarta.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md new file mode 100644 index 00000000000..1d3cbbab0a7 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeJakartaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L21-L28 "view source code") + +A fake 7 qubit V2 backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_jakarta'` + + + +### conf\_filename + +`= 'conf_jakarta.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_jakarta.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/jakarta'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeJakartaV2.run "qiskit_ibm_runtime.fake_provider.FakeJakartaV2.run") method. + + + +### props\_filename + +`= 'props_jakarta.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md new file mode 100644 index 00000000000..8c18616c24d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md @@ -0,0 +1,177 @@ +--- +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 + + + +`FakeJohannesburg` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L41-L58 "view source code") + +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 + +`= 'fake_johannesburg'` + + + +### conf\_filename + +`= 'conf_johannesburg.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/johannesburg'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_johannesburg.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md new file mode 100644 index 00000000000..1dca3811fe0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md @@ -0,0 +1,387 @@ +--- +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 + + + +`FakeJohannesburgV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L21-L38 "view source code") + +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 + +`= 'fake_johannesburg'` + + + +### conf\_filename + +`= 'conf_johannesburg.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/johannesburg'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.run "qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.run") method. + + + +### props\_filename + +`= 'props_johannesburg.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkata.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkata.md new file mode 100644 index 00000000000..73b259a39dc --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkata.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeKolkata` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L31-L38 "view source code") + +A fake 27 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_kolkata'` + + + +### conf\_filename + +`= 'conf_kolkata.json'` + + + +### defs\_filename + +`= 'defs_kolkata.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kolkata'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_kolkata.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md new file mode 100644 index 00000000000..ee3920cf960 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeKolkataV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_kolkata'` + + + +### conf\_filename + +`= 'conf_kolkata.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_kolkata.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kolkata'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKolkataV2.run "qiskit_ibm_runtime.fake_provider.FakeKolkataV2.run") method. + + + +### props\_filename + +`= 'props_kolkata.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagos.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagos.md new file mode 100644 index 00000000000..18966c99e3e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagos.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeLagos` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L31-L38 "view source code") + +A fake 7 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_lagos'` + + + +### conf\_filename + +`= 'conf_lagos.json'` + + + +### defs\_filename + +`= 'defs_lagos.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/lagos'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_lagos.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md new file mode 100644 index 00000000000..c921bb30bd5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeLagosV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L21-L28 "view source code") + +A fake 7 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_lagos'` + + + +### conf\_filename + +`= 'conf_lagos.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_lagos.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/lagos'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLagosV2.run "qiskit_ibm_runtime.fake_provider.FakeLagosV2.run") method. + + + +### props\_filename + +`= 'props_lagos.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLima.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLima.md new file mode 100644 index 00000000000..7c0cf92b666 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLima.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeLima` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L31-L38 "view source code") + +A fake 5 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_lima'` + + + +### conf\_filename + +`= 'conf_lima.json'` + + + +### defs\_filename + +`= 'defs_lima.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/lima'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_lima.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md new file mode 100644 index 00000000000..5a20d6a5ee2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeLimaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L21-L28 "view source code") + +A fake 5 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_lima'` + + + +### conf\_filename + +`= 'conf_lima.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_lima.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/lima'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLimaV2.run "qiskit_ibm_runtime.fake_provider.FakeLimaV2.run") method. + + + +### props\_filename + +`= 'props_lima.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondon.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondon.md new file mode 100644 index 00000000000..edf701d6351 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondon.md @@ -0,0 +1,175 @@ +--- +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 + + + +`FakeLondon` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L39-L54 "view source code") + +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 + +`= 'fake_london'` + + + +### conf\_filename + +`= 'conf_london.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/london'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_london.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md new file mode 100644 index 00000000000..2a77cc4075c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md @@ -0,0 +1,385 @@ +--- +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 + + + +`FakeLondonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L21-L36 "view source code") + +A fake 5 qubit backend. + +```python +0 ↔ 1 ↔ 2 + ↕ + 3 + ↕ + 4 +``` + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_london'` + + + +### conf\_filename + +`= 'conf_london.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/london'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeLondonV2.run "qiskit_ibm_runtime.fake_provider.FakeLondonV2.run") method. + + + +### props\_filename + +`= 'props_london.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattan.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattan.md new file mode 100644 index 00000000000..98b213f38ac --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattan.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeManhattan` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L31-L38 "view source code") + +A fake Manhattan backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_manhattan'` + + + +### conf\_filename + +`= 'conf_manhattan.json'` + + + +### defs\_filename + +`= 'defs_manhattan.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/manhattan'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_manhattan.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md new file mode 100644 index 00000000000..66e3d53d1af --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeManhattanV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L21-L28 "view source code") + +A fake Manhattan backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_manhattan'` + + + +### conf\_filename + +`= 'conf_manhattan.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_manhattan.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/manhattan'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeManhattanV2.run "qiskit_ibm_runtime.fake_provider.FakeManhattanV2.run") method. + + + +### props\_filename + +`= 'props_manhattan.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManila.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManila.md new file mode 100644 index 00000000000..74f7f71a6af --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManila.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeManila` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L31-L38 "view source code") + +A fake 5 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_manila'` + + + +### conf\_filename + +`= 'conf_manila.json'` + + + +### defs\_filename + +`= 'defs_manila.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/manila'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_manila.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md new file mode 100644 index 00000000000..3c13a17354d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeManilaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L21-L28 "view source code") + +A fake 5 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_manila'` + + + +### conf\_filename + +`= 'conf_manila.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_manila.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/manila'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeManilaV2.run "qiskit_ibm_runtime.fake_provider.FakeManilaV2.run") method. + + + +### props\_filename + +`= 'props_manila.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md new file mode 100644 index 00000000000..1cc5349e4b4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md @@ -0,0 +1,142 @@ +--- +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 + + + +`FakeMelbourne` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L38-L95 "view source code") + +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 + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L89-L95 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md new file mode 100644 index 00000000000..5752179d450 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeMelbourneV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L29-L35 "view source code") + +A fake 14 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_melbourne'` + + + +### conf\_filename + +`= 'conf_melbourne.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/melbourne'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.run "qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.run") method. + + + +### props\_filename + +`= 'props_melbourne.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontreal.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontreal.md new file mode 100644 index 00000000000..758340de903 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontreal.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeMontreal` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L31-L38 "view source code") + +A fake 27 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_montreal'` + + + +### conf\_filename + +`= 'conf_montreal.json'` + + + +### defs\_filename + +`= 'defs_montreal.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/montreal'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_montreal.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md new file mode 100644 index 00000000000..e24c1e08383 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeMontrealV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_montreal'` + + + +### conf\_filename + +`= 'conf_montreal.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_montreal.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/montreal'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMontrealV2.run "qiskit_ibm_runtime.fake_provider.FakeMontrealV2.run") method. + + + +### props\_filename + +`= 'props_montreal.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbai.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbai.md new file mode 100644 index 00000000000..fefd67dd44f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbai.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeMumbai` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L31-L38 "view source code") + +A fake 27 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_mumbai'` + + + +### conf\_filename + +`= 'conf_mumbai.json'` + + + +### defs\_filename + +`= 'defs_mumbai.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/mumbai'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_mumbai.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md new file mode 100644 index 00000000000..4628e7b631f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeMumbaiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_mumbai'` + + + +### conf\_filename + +`= 'conf_mumbai.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_mumbai.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/mumbai'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.run "qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.run") method. + + + +### props\_filename + +`= 'props_mumbai.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobi.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobi.md new file mode 100644 index 00000000000..7ed004a8e44 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobi.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeNairobi` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L31-L38 "view source code") + +A fake 7 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_nairobi'` + + + +### conf\_filename + +`= 'conf_nairobi.json'` + + + +### defs\_filename + +`= 'defs_nairobi.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/nairobi'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_nairobi.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md new file mode 100644 index 00000000000..461ca09c1b8 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeNairobiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L21-L28 "view source code") + +A fake 7 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_nairobi'` + + + +### conf\_filename + +`= 'conf_nairobi.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_nairobi.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/nairobi'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeNairobiV2.run "qiskit_ibm_runtime.fake_provider.FakeNairobiV2.run") method. + + + +### props\_filename + +`= 'props_nairobi.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOslo.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOslo.md new file mode 100644 index 00000000000..fbbec79d7b4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOslo.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeOslo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py#L22-L29 "view source code") + +A fake 7 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_oslo'` + + + +### conf\_filename + +`= 'conf_oslo.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_oslo.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/oslo'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOslo.run "qiskit_ibm_runtime.fake_provider.FakeOslo.run") method. + + + +### props\_filename + +`= 'props_oslo.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurense.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurense.md new file mode 100644 index 00000000000..a663c05a4c7 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurense.md @@ -0,0 +1,173 @@ +--- +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 + + + +`FakeOurense` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L37-L50 "view source code") + +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 + +`= 'fake_ourense'` + + + +### conf\_filename + +`= 'conf_ourense.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/ourense'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_ourense.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md new file mode 100644 index 00000000000..4a65c7f2ec6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md @@ -0,0 +1,383 @@ +--- +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 + + + +`FakeOurenseV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L21-L34 "view source code") + +A fake 5 qubit backend. + +```python +0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 +``` + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_ourense'` + + + +### conf\_filename + +`= 'conf_ourense.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/ourense'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOurenseV2.run "qiskit_ibm_runtime.fake_provider.FakeOurenseV2.run") method. + + + +### props\_filename + +`= 'props_ourense.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParis.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParis.md new file mode 100644 index 00000000000..f4363561eae --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParis.md @@ -0,0 +1,197 @@ +--- +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 + + + +`FakeParis` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L44-L64 "view source code") + +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 + +`= 'fake_paris'` + + + +### conf\_filename + +`= 'conf_paris.json'` + + + +### defs\_filename + +`= 'defs_paris.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/paris'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_paris.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParisV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParisV2.md new file mode 100644 index 00000000000..20bddd80ad9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeParisV2.md @@ -0,0 +1,389 @@ +--- +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 + + + +`FakeParisV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L21-L41 "view source code") + +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 + +`= 'fake_paris'` + + + +### conf\_filename + +`= 'conf_paris.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_paris.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/paris'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeParisV2.run "qiskit_ibm_runtime.fake_provider.FakeParisV2.run") method. + + + +### props\_filename + +`= 'props_paris.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePerth.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePerth.md new file mode 100644 index 00000000000..5c4ac453e52 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePerth.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakePerth` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py#L22-L29 "view source code") + +A fake 7 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_perth'` + + + +### conf\_filename + +`= 'conf_perth.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_perth.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/perth'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePerth.run "qiskit_ibm_runtime.fake_provider.FakePerth.run") method. + + + +### props\_filename + +`= 'props_perth.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md new file mode 100644 index 00000000000..9c96dcf3b52 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md @@ -0,0 +1,146 @@ +--- +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 + + + +`FakePoughkeepsie` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L39-L128 "view source code") + +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 + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L122-L128 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md new file mode 100644 index 00000000000..cab29be2a95 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakePoughkeepsieV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L29-L36 "view source code") + +A fake Poughkeepsie backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_poughkeepsie'` + + + +### conf\_filename + +`= 'conf_poughkeepsie.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_poughkeepsie.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.run "qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.run") method. + + + +### props\_filename + +`= 'props_poughkeepsie.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePrague.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePrague.md new file mode 100644 index 00000000000..99413c085f4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakePrague.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakePrague` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py#L22-L28 "view source code") + +A fake 33 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_prague'` + + + +### conf\_filename + +`= 'conf_prague.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/prague'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePrague.run "qiskit_ibm_runtime.fake_provider.FakePrague.run") method. + + + +### props\_filename + +`= 'props_prague.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProvider.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProvider.md new file mode 100644 index 00000000000..0deceb327aa --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProvider.md @@ -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 + + + +`FakeProvider` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L142-L211 "view source code") + +Fake provider containing fake V1 backends. + +Only filtering backends by name is implemented. This class contains all fake V1 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). + +## Attributes + + + +### version + +`= 1` + +## Methods + +### backends + + + +`backends(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L160-L161 "view source code") + +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 + + + +`get_backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L149-L158 "view source code") + +Return a single backend matching the specified filtering. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +a backend matching the filtering. + +**Return type** + +Backend + +**Raises** + +**QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md new file mode 100644 index 00000000000..bd71cb19f20 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md @@ -0,0 +1,84 @@ +--- +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 + + + +`FakeProviderForBackendV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L65-L139 "view source code") + +Fake provider containing fake V2 backends. + +Only filtering backends by name is implemented. This class contains all fake V2 backends available in the [`qiskit_ibm_runtime.fake_provider`](fake_provider#module-qiskit_ibm_runtime.fake_provider "qiskit_ibm_runtime.fake_provider"). + +## Attributes + + + +### version + +`= 1` + +## Methods + +### backend + + + +`backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L72-L84 "view source code") + +Filter backends in provider by name. + +### backends + + + +`backends(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L86-L87 "view source code") + +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 + + + +`get_backend(name=None, **kwargs)` + +Return a single backend matching the specified filtering. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +a backend matching the filtering. + +**Return type** + +Backend + +**Raises** + +**QiskitBackendNotFoundError** – if no backend could be found or more than one backend matches the filtering criteria. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuito.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuito.md new file mode 100644 index 00000000000..af26d993790 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuito.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeQuito` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py#L31-L38 "view source code") + +A fake 5 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_quito'` + + + +### conf\_filename + +`= 'conf_quito.json'` + + + +### defs\_filename + +`= 'defs_quito.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/quito'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_quito.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md new file mode 100644 index 00000000000..194156b6493 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeQuitoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py#L21-L28 "view source code") + +A fake 5 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_quito'` + + + +### conf\_filename + +`= 'conf_quito.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_quito.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/quito'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeQuitoV2.run "qiskit_ibm_runtime.fake_provider.FakeQuitoV2.run") method. + + + +### props\_filename + +`= 'props_quito.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochester.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochester.md new file mode 100644 index 00000000000..81179f2ba44 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochester.md @@ -0,0 +1,167 @@ +--- +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 + + + +`FakeRochester` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py#L30-L36 "view source code") + +A fake Rochester backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_rochester'` + + + +### conf\_filename + +`= 'conf_rochester.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/rochester'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_rochester.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md new file mode 100644 index 00000000000..b25d523c06c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeRochesterV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py#L21-L27 "view source code") + +A fake Rochester backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_rochester'` + + + +### conf\_filename + +`= 'conf_rochester.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/rochester'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRochesterV2.run "qiskit_ibm_runtime.fake_provider.FakeRochesterV2.run") method. + + + +### props\_filename + +`= 'props_rochester.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRome.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRome.md new file mode 100644 index 00000000000..2d2dc476151 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRome.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeRome` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py#L31-L38 "view source code") + +A fake 5 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_rome'` + + + +### conf\_filename + +`= 'conf_rome.json'` + + + +### defs\_filename + +`= 'defs_rome.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/rome'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_rome.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md new file mode 100644 index 00000000000..622d93c116d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeRomeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py#L21-L28 "view source code") + +A fake 5 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_rome'` + + + +### conf\_filename + +`= 'conf_rome.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_rome.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/rome'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeRomeV2.run "qiskit_ibm_runtime.fake_provider.FakeRomeV2.run") method. + + + +### props\_filename + +`= 'props_rome.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md new file mode 100644 index 00000000000..d10a03f3b23 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md @@ -0,0 +1,138 @@ +--- +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 + + + +`FakeRueschlikon` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py#L21-L74 "view source code") + +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 + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` + +Return backend properties + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiago.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiago.md new file mode 100644 index 00000000000..ec524ccddcd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiago.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeSantiago` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py#L31-L38 "view source code") + +A fake Santiago backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_santiago'` + + + +### conf\_filename + +`= 'conf_santiago.json'` + + + +### defs\_filename + +`= 'defs_santiago.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/santiago'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_santiago.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md new file mode 100644 index 00000000000..47d2e67ac99 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeSantiagoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py#L21-L28 "view source code") + +A fake Santiago backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_santiago'` + + + +### conf\_filename + +`= 'conf_santiago.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_santiago.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/santiago'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.run "qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.run") method. + + + +### props\_filename + +`= 'props_santiago.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md new file mode 100644 index 00000000000..67abf2d9a06 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeSherbrooke` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_sherbrooke'` + + + +### conf\_filename + +`= 'conf_sherbrooke.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_sherbrooke.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/sherbrooke'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSherbrooke.run "qiskit_ibm_runtime.fake_provider.FakeSherbrooke.run") method. + + + +### props\_filename + +`= 'props_sherbrooke.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingapore.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingapore.md new file mode 100644 index 00000000000..0f791011c15 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingapore.md @@ -0,0 +1,177 @@ +--- +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 + + + +`FakeSingapore` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py#L41-L58 "view source code") + +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 + +`= 'fake_singapore'` + + + +### conf\_filename + +`= 'conf_singapore.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/singapore'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_singapore.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md new file mode 100644 index 00000000000..74b8768bb1e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md @@ -0,0 +1,387 @@ +--- +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 + + + +`FakeSingaporeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py#L21-L38 "view source code") + +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 + +`= 'fake_singapore'` + + + +### conf\_filename + +`= 'conf_singapore.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/singapore'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.run "qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.run") method. + + + +### props\_filename + +`= 'props_singapore.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydney.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydney.md new file mode 100644 index 00000000000..4e05d4cfa3c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydney.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeSydney` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py#L31-L38 "view source code") + +A fake 27 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_sydney'` + + + +### conf\_filename + +`= 'conf_sydney.json'` + + + +### defs\_filename + +`= 'defs_sydney.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/sydney'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_sydney.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md new file mode 100644 index 00000000000..615c773bbb6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeSydneyV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_sydney'` + + + +### conf\_filename + +`= 'conf_sydney.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_sydney.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/sydney'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeSydneyV2.run "qiskit_ibm_runtime.fake_provider.FakeSydneyV2.run") method. + + + +### props\_filename + +`= 'props_sydney.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTenerife.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTenerife.md new file mode 100644 index 00000000000..40dbdc95275 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTenerife.md @@ -0,0 +1,144 @@ +--- +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 + + + +`FakeTenerife` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py#L28-L68 "view source code") + +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 + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py#L62-L68 "view source code") + +Returns a snapshot of device properties as recorded on 8/30/19. + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTokyo.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTokyo.md new file mode 100644 index 00000000000..f67985278d5 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTokyo.md @@ -0,0 +1,146 @@ +--- +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 + + + +`FakeTokyo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py#L28-L141 "view source code") + +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 + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py#L135-L141 "view source code") + +Returns a snapshot of device properties as recorded on 8/30/19. + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeToronto.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeToronto.md new file mode 100644 index 00000000000..072908e34b6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeToronto.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeToronto` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py#L31-L38 "view source code") + +A fake 27 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_toronto'` + + + +### conf\_filename + +`= 'conf_toronto.json'` + + + +### defs\_filename + +`= 'defs_toronto.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/toronto'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_toronto.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md new file mode 100644 index 00000000000..a5ea3d0dd79 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeTorontoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_toronto'` + + + +### conf\_filename + +`= 'conf_toronto.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_toronto.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/toronto'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeTorontoV2.run "qiskit_ibm_runtime.fake_provider.FakeTorontoV2.run") method. + + + +### props\_filename + +`= 'props_toronto.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValencia.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValencia.md new file mode 100644 index 00000000000..98f2f35d029 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValencia.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeValencia` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py#L31-L38 "view source code") + +A fake 5 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_valencia'` + + + +### conf\_filename + +`= 'conf_valencia.json'` + + + +### defs\_filename + +`= 'defs_valencia.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/valencia'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_valencia.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md new file mode 100644 index 00000000000..54908a211b9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeValenciaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py#L21-L28 "view source code") + +A fake 5 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_valencia'` + + + +### conf\_filename + +`= 'conf_valencia.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_valencia.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/valencia'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeValenciaV2.run "qiskit_ibm_runtime.fake_provider.FakeValenciaV2.run") method. + + + +### props\_filename + +`= 'props_valencia.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigo.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigo.md new file mode 100644 index 00000000000..b7098a7cac0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigo.md @@ -0,0 +1,173 @@ +--- +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 + + + +`FakeVigo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py#L37-L50 "view source code") + +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 + +`= 'fake_vigo'` + + + +### conf\_filename + +`= 'conf_vigo.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/vigo'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_vigo.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md new file mode 100644 index 00000000000..4da4f84551c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md @@ -0,0 +1,383 @@ +--- +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 + + + +`FakeVigoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py#L21-L34 "view source code") + +A fake 5 qubit backend. + +```python +0 ↔ 1 ↔ 3 ↔ 4 + ↕ + 2 +``` + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_vigo'` + + + +### conf\_filename + +`= 'conf_vigo.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/vigo'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeVigoV2.run "qiskit_ibm_runtime.fake_provider.FakeVigoV2.run") method. + + + +### props\_filename + +`= 'props_vigo.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashington.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashington.md new file mode 100644 index 00000000000..3b6a69f2942 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashington.md @@ -0,0 +1,185 @@ +--- +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 + + + +`FakeWashington` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py#L31-L38 "view source code") + +A fake 127 qubit backend. + +FakeBackend initializer. + +**Parameters** + +* **configuration** (*BackendConfiguration*) – backend configuration +* **time\_alive** (*int*) – time to wait before returning result + +## Attributes + + + +### backend\_name + +`= 'fake_washington'` + + + +### conf\_filename + +`= 'conf_washington.json'` + + + +### defs\_filename + +`= 'defs_washington.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/washington'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_washington.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### defaults + + + +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") + +Returns a snapshot of device defaults + +**Return type** + +`PulseDefaults` + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md new file mode 100644 index 00000000000..f8411be62da --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeWashingtonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_washington'` + + + +### conf\_filename + +`= 'conf_washington.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_washington.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/washington'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.run "qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.run") method. + + + +### props\_filename + +`= 'props_washington.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktown.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktown.md new file mode 100644 index 00000000000..64de0b96149 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktown.md @@ -0,0 +1,175 @@ +--- +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 + + + +`FakeYorktown` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py#L39-L54 "view source code") + +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 + +`= 'fake_yorktown'` + + + +### conf\_filename + +`= 'conf_yorktown.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/yorktown'` + + + +### options + +Return the options for the backend + +The 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 + +`= 'props_yorktown.json'` + + + +### version + +`= 1` + +## Methods + +### configuration + + + +`configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +BackendConfiguration + +### name + + + +`name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") + +Returns a snapshot of device properties + +**Return type** + +`BackendProperties` + +### provider + + + +`provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + +### run + + + +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") + +Main job in simulator + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value 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 + + + +`status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +BackendStatus + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md new file mode 100644 index 00000000000..e43c336f65f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md @@ -0,0 +1,385 @@ +--- +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 + + + +`FakeYorktownV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py#L21-L36 "view source code") + +A fake 5 qubit backend. + +```python + 1 + / | +0 - 2 - 3 + | / + 4 +``` + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_yorktown'` + + + +### conf\_filename + +`= 'conf_yorktown.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= None` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/yorktown'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeYorktownV2.run "qiskit_ibm_runtime.fake_provider.FakeYorktownV2.run") method. + + + +### props\_filename + +`= 'props_yorktown.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.EnvironmentOptions.md new file mode 100644 index 00000000000..04659f16d89 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -0,0 +1,67 @@ +--- +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 + + + +`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/environment_options.py#L27-L62 "view source code") + +Options related to the execution environment. + +**Parameters** + +* **log\_level** (`str`) – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. The default level is `WARNING`. + +* **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. + +* **job\_tags** (`Optional`\[`List`]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `qiskit_ibm_runtime.qiskit_runtime_service.jobs()` function call. + +## Attributes + + + +### callback + +`Callable | None` + +`= None` + + + +### log\_level + +`str` + +`= 'WARNING'` + + + +### job\_tags + +`List | None` + +## Methods + +### validate\_environment\_options + + + +`static validate_environment_options(environment_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/environment_options.py#L51-L62 "view source code") + +Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ExecutionOptions.md new file mode 100644 index 00000000000..390cd6cbe76 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -0,0 +1,53 @@ +--- +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 + + + +`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/execution_options.py#L25-L47 "view source code") + +Execution options. + +**Parameters** + +* **shots** (`int`) – Number of repetitions of each circuit, for sampling. Default: 4000. +* **init\_qubits** (`bool`) – Whether to reset the qubits to the ground state for each shot. Default: `True`. + +## Attributes + + + +### init\_qubits + +`bool` + +`= True` + + + +### shots + +`int` + +`= 4000` + +## Methods + +### validate\_execution\_options + + + +`static validate_execution_options(execution_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/execution_options.py#L39-L47 "view source code") + +Validate that execution options are legal. :raises ValueError: if any execution option is not supported + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.Options.md new file mode 100644 index 00000000000..e4f8352ea2d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.Options.md @@ -0,0 +1,124 @@ +--- +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(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/options.py#L32-L279 "view source code") + +Options for the 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 + +`int | None` + +`= None` + + + +### optimization\_level + +`int | None` + +`= None` + + + +### resilience\_level + +`int | None` + +`= None` + + + +### transpilation + +`TranspilationOptions | Dict` + + + +### resilience + +`ResilienceOptions | Dict` + + + +### execution + +`ExecutionOptions | Dict` + + + +### environment + +`EnvironmentOptions | Dict` + + + +### simulator + +`SimulatorOptions | Dict` + +## Methods + +### validate\_options + + + +`static validate_options(options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/options.py#L165-L190 "view source code") + +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.20/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ResilienceOptions.md new file mode 100644 index 00000000000..6430212cf4a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -0,0 +1,63 @@ +--- +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 + + + +`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/resilience_options.py#L34-L91 "view source code") + +Resilience options. + +**Parameters** + +* **noise\_factors** (`Optional`\[`Sequence`\[`float`]]) – 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** (*DEPRECATED*) – A noise amplification strategy. Currently only +* **resilience\_level=2.** (*"LocalFoldingAmplifier" is supported Only applicable for*) – Default: “LocalFoldingAmplifier”. +* **extrapolator** (`Optional`\[`Literal`\[‘LinearExtrapolator’, ‘QuadraticExtrapolator’, ‘CubicExtrapolator’, ‘QuarticExtrapolator’]]) – 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 + +`Literal['LinearExtrapolator', 'QuadraticExtrapolator', 'CubicExtrapolator', 'QuarticExtrapolator']` + +`= None` + + + +### noise\_amplifier + +`Literal['LocalFoldingAmplifier']` + +`= None` + + + +### noise\_factors + +`Sequence[float]` + +`= None` + +## Methods + +### validate\_resilience\_options + + + +`static validate_resilience_options(resilience_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/resilience_options.py#L60-L91 "view source code") + +Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.SimulatorOptions.md new file mode 100644 index 00000000000..008e6406767 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -0,0 +1,93 @@ +--- +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 + + + +`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/simulator_options.py#L35-L95 "view source code") + +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** (`Union`\[`dict`, `NoiseModel`, `None`]) – Noise model for the simulator. +* **seed\_simulator** (`Optional`\[`int`]) – Random seed to control sampling. +* **coupling\_map** (`Union`\[`List`\[`List`\[`int`]], `CouplingMap`, `None`]) – Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interactions, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` +* **basis\_gates** (`Optional`\[`List`\[`str`]]) – List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. If `None`, do not unroll. + +## Attributes + + + +### basis\_gates + +`List[str] | None` + +`= None` + + + +### coupling\_map + +`List[List[int]] | CouplingMap | None` + +`= None` + + + +### noise\_model + +`dict | NoiseModel | None` + +`= None` + + + +### seed\_simulator + +`int | None` + +`= None` + +## Methods + +### set\_backend + + + +`set_backend(backend)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/simulator_options.py#L71-L95 "view source code") + +Set backend for simulation. This method changes noise\_model, coupling\_map, basis\_gates according to given backend. + +**Parameters** + +**backend** (`Union`\[`BackendV1`, `BackendV2`]) – backend to be set. + +**Raises** + +**MissingOptionalLibraryError if qiskit-aer is not found.** – + +**Return type** + +`None` + +### validate\_simulator\_options + + + +`static validate_simulator_options(simulator_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/simulator_options.py#L61-L69 "view source code") + +Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.TranspilationOptions.md new file mode 100644 index 00000000000..dd9a466845f --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -0,0 +1,80 @@ +--- +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 + + + +`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/transpilation_options.py#L41-L97 "view source code") + +Transpilation options. + +**Parameters** + +* **skip\_transpilation** (`bool`) – Whether to skip transpilation. +* **initial\_layout** (`Union`\[`dict`, `List`, `None`]) – Initial position of virtual qubits on physical qubits. See `qiskit.compiler.transpile` for more information. +* **layout\_method** (`Optional`\[`str`]) – Name of layout selection pass. One of ‘trivial’, ‘dense’, ‘noise\_adaptive’, ‘sabre’. +* **routing\_method** (`Optional`\[`str`]) – Name of routing pass. One of ‘basic’, ‘lookahead’, ‘stochastic’, ‘sabre’, ‘none’. +* **approximation\_degree** (`Optional`\[`float`]) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) + +## Attributes + + + +### approximation\_degree + +`float | None` + +`= None` + + + +### initial\_layout + +`dict | List | None` + +`= None` + + + +### layout\_method + +`str | None` + +`= None` + + + +### routing\_method + +`str | None` + +`= None` + + + +### skip\_transpilation + +`bool` + +`= False` + +## Methods + +### validate\_transpilation\_options + + + +`static validate_transpilation_options(transpilation_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/transpilation_options.py#L68-L97 "view source code") + +Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.basis.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.basis.md new file mode 100644 index 00000000000..eaa6e82ebe1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.basis.md @@ -0,0 +1,22 @@ +--- +title: basis +description: API reference for qiskit_ibm_runtime.transpiler.passes.basis +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler.passes.basis +--- + + + +# basis + + + +## Basis + + + +`qiskit_ibm_runtime.transpiler.passes.basis` + +Passes to layout circuits to IBM backend’s instruction sets. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.md new file mode 100644 index 00000000000..f8a5717abc4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.md @@ -0,0 +1,29 @@ +--- +title: passes +description: API reference for qiskit_ibm_runtime.transpiler.passes +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler.passes +--- + + + + + +# qiskit\_ibm\_runtime.transpiler.passes + + + +## Transpiler Passes + + + +`qiskit_ibm_runtime.transpiler.passes` + +A collection of transpiler passes for IBM backends. + +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | +| [`basis`](qiskit_ibm_runtime.transpiler.passes.basis#module-qiskit_ibm_runtime.transpiler.passes.basis "qiskit_ibm_runtime.transpiler.passes.basis") | Basis (qiskit\_ibm\_runtime.transpiler.passes.basis) | +| [`scheduling`](qiskit_ibm_runtime.transpiler.passes.scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") | Scheduling (qiskit\_ibm\_runtime.transpiler.passes.scheduling) | + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md new file mode 100644 index 00000000000..e0a71a02227 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -0,0 +1,153 @@ +--- +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 + + + +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L427-L644 "view source code") + +Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. + +This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. + +In its current form this is similar to Qiskit’s ALAP scheduler in which instructions start as late as possible. + +The primary differences are that: + +* **Resets and control-flow currently trigger the end of a “quantum block”. The period between the end** + + of the block and the next is *nondeterministic* ie., we do not know when the next block will begin (as we could be evaluating a classical function of nondeterministic length) and therefore the next block starts at a *relative* t=0. + +* During a measurement it is possible to apply gates in parallel on disjoint qubits. + +* Measurements and resets on disjoint qubits happen simultaneously and are part of the same block. + +Scheduler for dynamic circuit backends. + +**Parameters** + +**durations** (`InstructionDurations`) – Durations of instructions to be used in scheduling. + +## Attributes + + + +### is\_analysis\_pass + +Check if the pass is an analysis pass. + +If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + +### is\_transformation\_pass + +Check if the pass is a transformation pass. + +If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + +## Methods + +### \_\_call\_\_ + + + +`__call__(circuit, property_set=None)` + +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(passmanager_ir, state, callback=None)` + +Execute optimization task for input Qiskit IR. + +**Parameters** + +* **passmanager\_ir** (`Any`) – Qiskit IR to optimize. +* **state** (`PassManagerState`) – State associated with workflow execution by the pass manager itself. +* **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + +**Return type** + +`tuple`\[`Any`, `PassManagerState`] + +**Returns** + +Optimized Qiskit IR and state of the workflow. + +### name + + + +`name()` + +Name of the pass. + +**Return type** + +`str` + +### run + + + +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L448-L467 "view source code") + +Run the ASAPSchedule pass on dag. :type dag: `DAGCircuit` :param dag: DAG to schedule. :type dag: DAGCircuit + +**Raises** + +* **TranspilerError** – if the circuit is not mapped on physical qubits. +* **TranspilerError** – if conditional bit is added to non-supported instruction. + +**Return type** + +`None` + +**Returns** + +The scheduled DAGCircuit. + +### update\_status + + + +`update_status(state, run_state)` + +Update workflow status. + +**Parameters** + +* **state** (`PassManagerState`) – Pass manager state to update. +* **run\_state** (`RunState`) – Completion status of current task. + +**Return type** + +`PassManagerState` + +**Returns** + +Updated pass manager state. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md new file mode 100644 index 00000000000..e09b7e69458 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -0,0 +1,153 @@ +--- +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 + + + +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L299-L424 "view source code") + +Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. + +This is a scheduler designed to work for the unique scheduling constraints of the dynamic circuits backends due to the limitations imposed by hardware. This is expected to evolve over time as the dynamic circuit backends also change. + +In its current form this is similar to Qiskit’s ASAP scheduler in which instructions start as early as possible. + +The primary differences are that: + +* **Resets and control-flow currently trigger the end of a “quantum block”. The period between the end** + + of the block and the next is *nondeterministic* ie., we do not know when the next block will begin (as we could be evaluating a classical function of nondeterministic length) and therefore the next block starts at a *relative* t=0. + +* During a measurement it is possible to apply gates in parallel on disjoint qubits. + +* Measurements and resets on disjoint qubits happen simultaneously and are part of the same block. + +Scheduler for dynamic circuit backends. + +**Parameters** + +**durations** (`InstructionDurations`) – Durations of instructions to be used in scheduling. + +## Attributes + + + +### is\_analysis\_pass + +Check if the pass is an analysis pass. + +If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + +### is\_transformation\_pass + +Check if the pass is a transformation pass. + +If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + +## Methods + +### \_\_call\_\_ + + + +`__call__(circuit, property_set=None)` + +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(passmanager_ir, state, callback=None)` + +Execute optimization task for input Qiskit IR. + +**Parameters** + +* **passmanager\_ir** (`Any`) – Qiskit IR to optimize. +* **state** (`PassManagerState`) – State associated with workflow execution by the pass manager itself. +* **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + +**Return type** + +`tuple`\[`Any`, `PassManagerState`] + +**Returns** + +Optimized Qiskit IR and state of the workflow. + +### name + + + +`name()` + +Name of the pass. + +**Return type** + +`str` + +### run + + + +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L320-L339 "view source code") + +Run the ALAPSchedule pass on dag. :type dag: `DAGCircuit` :param dag: DAG to schedule. :type dag: DAGCircuit + +**Raises** + +* **TranspilerError** – if the circuit is not mapped on physical qubits. +* **TranspilerError** – if conditional bit is added to non-supported instruction. + +**Return type** + +`DAGCircuit` + +**Returns** + +The scheduled DAGCircuit. + +### update\_status + + + +`update_status(state, run_state)` + +Update workflow status. + +**Parameters** + +* **state** (`PassManagerState`) – Pass manager state to update. +* **run\_state** (`RunState`) – Completion status of current task. + +**Return type** + +`PassManagerState` + +**Returns** + +Updated pass manager state. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md new file mode 100644 index 00000000000..c5d6a3e4554 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md @@ -0,0 +1,147 @@ +--- +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 + + + +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L38-L633 "view source code") + +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\_\_ + + + +`__call__(circuit, property_set=None)` + +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(passmanager_ir, state, callback=None)` + +Execute optimization task for input Qiskit IR. + +**Parameters** + +* **passmanager\_ir** (`Any`) – Qiskit IR to optimize. +* **state** (`PassManagerState`) – State associated with workflow execution by the pass manager itself. +* **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + +**Return type** + +`tuple`\[`Any`, `PassManagerState`] + +**Returns** + +Optimized Qiskit IR and state of the workflow. + +### name + + + +`name()` + +Name of the pass. + +**Return type** + +`str` + +### run + + + +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") + +Run the padding pass on `dag`. + +**Parameters** + +**dag** (`DAGCircuit`) – DAG to be checked. + +**Returns** + +DAG with idle time filled with instructions. + +**Return type** + +DAGCircuit + +**Raises** + +**TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + +### update\_status + + + +`update_status(state, run_state)` + +Update workflow status. + +**Parameters** + +* **state** (`PassManagerState`) – Pass manager state to update. +* **run\_state** (`RunState`) – Completion status of current task. + +**Return type** + +`PassManagerState` + +**Returns** + +Updated pass manager state. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md new file mode 100644 index 00000000000..2ff10a04170 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -0,0 +1,136 @@ +--- +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 + + + +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L133-L359 "view source code") + +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 + +`= 160` + + + +### MEASURE\_PATCH\_ODD\_OFFSET + +`= 64` + +## Methods + +### from\_backend + + + +`classmethod from_backend(backend)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L155-L203 "view source code") + +Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. + +**Returns** + +The InstructionDurations constructed from backend. + +**Return type** + +DynamicInstructionDurations + +### from\_target + + + +`classmethod from_target(target)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L205-L222 "view source code") + +Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. + +**Returns** + +The InstructionDurations constructed from backend. + +**Return type** + +DynamicInstructionDurations + +### get + + + +`get(inst, qubits, unit='dt', parameters=None)` + +Get the duration of the instruction with the name, qubits, and parameters. + +Some instructions may have a parameter dependent duration. + +**Parameters** + +* **inst** (*str | qiskit.circuit.Instruction*) – An instruction or its name to be queried. +* **qubits** (*int | list\[int]*) – Qubit indices that the instruction acts on. +* **unit** (*str*) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. +* **parameters** (*list\[float] | None*) – The value of the parameters of the desired instruction. + +**Returns** + +The duration of the instruction on the qubits. + +**Return type** + +float|int + +**Raises** + +**TranspilerError** – No duration is defined for the instruction. + +### units\_used + + + +`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(inst_durations, dt=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L224-L270 "view source code") + +Update self with inst\_durations (inst\_durations overwrite self). Overrides the default durations for certain hardcoded instructions. + +**Parameters** + +* **inst\_durations** (`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]], `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `Optional`\[`Iterable`\[`float`]]]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], `InstructionDurations`, `None`]) – Instruction durations to be merged into self (overwriting self). +* **dt** (`Optional`\[`float`]) – Sampling duration in seconds of the target backend. + +**Returns** + +The updated InstructionDurations. + +**Return type** + +InstructionDurations + +**Raises** + +**TranspilerError** – If the format of instruction\_durations is invalid. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md new file mode 100644 index 00000000000..6b881b783f3 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md @@ -0,0 +1,160 @@ +--- +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 + + + +`PadDelay(durations, fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py#L23-L87 "view source code") + +Padding idle time with Delay instructions. + +Consecutive delays will be merged in the output of this pass. + +The ASAP-scheduled circuit output may become + +```python + ┌────────────────┐ +q_0: ┤ Delay(160[dt]) ├──■── + └─────┬───┬──────┘┌─┴─┐ +q_1: ──────┤ X ├───────┤ X ├ + └───┘ └───┘ +``` + +Note that the additional idle time of 60dt on the `q_0` wire coming from the duration difference between `Delay` of 100dt (`q_0`) and `XGate` of 160 dt (`q_1`) is absorbed in the delay instruction on the `q_0` wire, i.e. in total 160 dt. + +See [`BlockBasePadder`](qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder") pass for details. + +Create new padding delay pass. + +**Parameters** + +* **durations** (`InstructionDurations`) – Durations of instructions to be used in scheduling. +* **fill\_very\_end** (`bool`) – Set `True` to fill the end of circuit with delay. +* **schedule\_idle\_qubits** (`bool`) – Set to true if you’d like a delay inserted on idle qubits. This is useful for timeline visualizations, but may cause issues for execution on large backends. + +## Attributes + + + +### is\_analysis\_pass + +Check if the pass is an analysis pass. + +If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + +### is\_transformation\_pass + +Check if the pass is a transformation pass. + +If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + +## Methods + +### \_\_call\_\_ + + + +`__call__(circuit, property_set=None)` + +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(passmanager_ir, state, callback=None)` + +Execute optimization task for input Qiskit IR. + +**Parameters** + +* **passmanager\_ir** (`Any`) – Qiskit IR to optimize. +* **state** (`PassManagerState`) – State associated with workflow execution by the pass manager itself. +* **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + +**Return type** + +`tuple`\[`Any`, `PassManagerState`] + +**Returns** + +Optimized Qiskit IR and state of the workflow. + +### name + + + +`name()` + +Name of the pass. + +**Return type** + +`str` + +### run + + + +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") + +Run the padding pass on `dag`. + +**Parameters** + +**dag** (`DAGCircuit`) – DAG to be checked. + +**Returns** + +DAG with idle time filled with instructions. + +**Return type** + +DAGCircuit + +**Raises** + +**TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + +### update\_status + + + +`update_status(state, run_state)` + +Update workflow status. + +**Parameters** + +* **state** (`PassManagerState`) – Pass manager state to update. +* **run\_state** (`RunState`) – Completion status of current task. + +**Return type** + +`PassManagerState` + +**Returns** + +Updated pass manager state. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md new file mode 100644 index 00000000000..1abfaaccc54 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -0,0 +1,296 @@ +--- +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 + + + +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False, dd_barrier=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py#L39-L567 "view source code") + +Dynamical decoupling insertion pass for IBM dynamic circuit backends. + +This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). + +```python +import numpy as np +from qiskit.circuit import QuantumCircuit +from qiskit.circuit.library import XGate +from qiskit.transpiler import PassManager, InstructionDurations +from qiskit.visualization import timeline_drawer + +from qiskit_ibm_runtime.transpiler.passes.scheduling import ALAPScheduleAnalysis +from qiskit_ibm_runtime.transpiler.passes.scheduling import PadDynamicalDecoupling + +circ = QuantumCircuit(4) +circ.h(0) +circ.cx(0, 1) +circ.cx(1, 2) +circ.cx(2, 3) +circ.measure_all() +durations = InstructionDurations( + [("h", 0, 50), ("cx", [0, 1], 700), ("reset", None, 10), + ("cx", [1, 2], 200), ("cx", [2, 3], 300), + ("x", None, 50), ("measure", None, 1000)] +) +``` + +```python +# balanced X-X sequence on all qubits +dd_sequence = [XGate(), XGate()] +pm = PassManager([ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence)]) +circ_dd = pm.run(circ) +circ_dd.draw() +``` + +```python + ┌───┐ ┌───────────────┐ ┌───┐ » + q_0: ──────┤ H ├─────────■──┤ Delay(96[dt]) ├──────┤ X ├──────» + ┌─────┴───┴─────┐ ┌─┴─┐└───────────────┘┌─────┴───┴─────┐» + q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■────────┤ Delay(48[dt]) ├» + ├───────────────┴┐└───┘ ┌─┴─┐ └───────────────┘» + q_2: ┤ Delay(750[dt]) ├───────────┤ X ├──────────────■────────» + ├────────────────┤ └───┘ ┌─┴─┐ » + q_3: ┤ Delay(950[dt]) ├────────────────────────────┤ X ├──────» + └────────────────┘ └───┘ » +meas: 4/═════════════════════════════════════════════════════════» + » +« ┌────────────────┐ ┌───┐ ┌───────────────┐ » +« q_0: ┤ Delay(208[dt]) ├──────┤ X ├──────┤ Delay(96[dt]) ├─────────────────» +« └─────┬───┬──────┘┌─────┴───┴─────┐└─────┬───┬─────┘┌───────────────┐» +« q_1: ──────┤ X ├───────┤ Delay(96[dt]) ├──────┤ X ├──────┤ Delay(56[dt]) ├» +« └───┘ └───────────────┘ └───┘ └───────────────┘» +« q_2: ─────────────────────────────────────────────────────────────────────» +« » +« q_3: ─────────────────────────────────────────────────────────────────────» +« » +«meas: 4/═════════════════════════════════════════════════════════════════════» +« » +« ░ ┌─┐ +« q_0: ─░─┤M├───────── +« ░ └╥┘┌─┐ +« q_1: ─░──╫─┤M├────── +« ░ ║ └╥┘┌─┐ +« q_2: ─░──╫──╫─┤M├─── +« ░ ║ ║ └╥┘┌─┐ +« q_3: ─░──╫──╫──╫─┤M├ +« ░ ║ ║ ║ └╥┘ +«meas: 4/════╩══╩══╩══╩═ +« 0 1 2 3 +``` + +```python +# Uhrig sequence on qubit 0 +n = 8 +dd_sequence = [XGate()] * n +def uhrig_pulse_location(k): + return np.sin(np.pi * (k + 1) / (2 * n + 2)) ** 2 +spacings = [] +for k in range(n): + spacings.append(uhrig_pulse_location(k) - sum(spacings)) +spacings.append(1 - sum(spacings)) +pm = PassManager( + [ + ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence, qubits=[0], spacings=spacings), + ] +) +circ_dd = pm.run(circ) +circ_dd.draw() +``` + +```python + ┌───┐ ┌────────────────┐ ░ ┌─┐ » + q_0: ──────┤ H ├─────────■──┤ Delay(500[dt]) ├───────────────────░─┤M├──────» + ┌─────┴───┴─────┐ ┌─┴─┐└────────────────┘┌────────────────┐ ░ └╥┘┌─┐ » + q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■─────────┤ Delay(300[dt]) ├─░──╫─┤M├───» + ├───────────────┴┐└───┘ ┌─┴─┐ └────────────────┘ ░ ║ └╥┘┌─┐» + q_2: ┤ Delay(750[dt]) ├───────────┤ X ├───────────────■──────────░──╫──╫─┤M├» + ├────────────────┤ └───┘ ┌─┴─┐ ░ ║ ║ └╥┘» + q_3: ┤ Delay(950[dt]) ├─────────────────────────────┤ X ├────────░──╫──╫──╫─» + └────────────────┘ └───┘ ░ ║ ║ ║ » +meas: 4/═══════════════════════════════════════════════════════════════╩══╩══╩═» + 0 1 2 » +« +« q_0: ─── +« +« q_1: ─── +« +« q_2: ─── +« ┌─┐ +« q_3: ┤M├ +« └╥┘ +«meas: 4/═╩═ +« 3 +``` + + + You need to call [`ALAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis") before running dynamical decoupling to guarantee your circuit satisfies acquisition alignment constraints for dynamic circuit backends. + + +Dynamical decoupling initializer. + +**Parameters** + +* **durations** (`InstructionDurations`) – Durations of instructions to be used in scheduling. + +* **dd\_sequences** (`Union`\[`List`\[`Gate`], `List`\[`List`\[`Gate`]]]) – Sequence of gates to apply in idle spots. Alternatively a list of gate sequences may be supplied that will preferentially be inserted if there is a delay of sufficient duration. This may be tuned by the optionally supplied `sequence_min_length_ratios`. + +* **qubits** (`Optional`\[`List`\[`int`]]) – Physical qubits on which to apply DD. If None, all qubits will undergo DD (when possible). + +* **spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates. The available slack will be divided according to this. The list length must be one more than the length of dd\_sequence, and the elements must sum to 1. If None, a balanced spacing will be used \[d/2, d, d, …, d, d, d/2]. This spacing only applies to the first subcircuit, if a `coupling_map` is specified + +* **skip\_reset\_qubits** (`bool`) – If True, does not insert DD on idle periods that immediately follow initialized/reset qubits (as qubits in the ground state are less susceptible to decoherence). + +* **pulse\_alignment** (`int`) – The hardware constraints for gate timing allocation. This is usually provided from `backend.configuration().timing_constraints`. If provided, the delay length, i.e. `spacing`, is implicitly adjusted to satisfy this constraint. + +* **extra\_slack\_distribution** (`str`) – + + The option to control the behavior of DD sequence generation. The duration of the DD sequence should be identical to an idle time in the scheduled quantum circuit, however, the delay in between gates comprising the sequence should be integer number in units of dt, and it might be further truncated when `pulse_alignment` is specified. This sometimes results in the duration of the created sequence being shorter than the idle time that you want to fill with the sequence, i.e. extra slack. This option takes following values. + + > * ”middle”: Put the extra slack to the interval at the middle of the sequence. + > * ”edges”: Divide the extra slack as evenly as possible into intervals at beginning and end of the sequence. + +* **sequence\_min\_length\_ratios** (`Union`\[`int`, `List`\[`int`], `None`]) – List of minimum delay length to DD sequence ratio to satisfy in order to insert the DD sequence. For example if the X-X dynamical decoupling sequence is 320dt samples long and the available delay is 384dt it has a ratio of 384dt/320dt=1.2. From the perspective of dynamical decoupling this is likely to add more control noise than decoupling error rate reductions. The defaults value is 2.0. + +* **insert\_multiple\_cycles** (`bool`) – If the available duration exceeds 2\*sequence\_min\_length\_ratio\*duration(dd\_sequence) enable the insertion of multiple rounds of the dynamical decoupling sequence in that delay. + +* **coupling\_map** (`Optional`\[`CouplingMap`]) – directed graph representing the coupling map for the device. Specifying a coupling map partitions the device into subcircuits, in order to apply DD sequences with different pulse spacings within each. Currently support 2 subcircuits. + +* **alt\_spacings** (`Union`\[`List`\[`List`\[`float`]], `List`\[`float`], `None`]) – A list of lists of spacings between the DD gates, for the second subcircuit, as determined by the coupling map. If None, a balanced spacing that is staggered with respect to the first subcircuit will be used \[d, d, d, …, d, d, 0]. + +* **schedule\_idle\_qubits** (`bool`) – Set to true if you’d like a delay inserted on idle qubits. This is useful for timeline visualizations, but may cause issues for execution on large backends. + +* **dd\_barrier** (`Optional`\[`str`]) – only apply DD to delays terminating with a barrier whose label contains the specified string + +**Raises** + +* **TranspilerError** – When invalid DD sequence is specified. +* **TranspilerError** – When pulse gate with the duration which is non-multiple of the alignment constraint value is found. +* **TranspilerError** – When the coupling map is not supported (i.e., if degree > 3) + +## Attributes + + + +### is\_analysis\_pass + +Check if the pass is an analysis pass. + +If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. + + + +### is\_transformation\_pass + +Check if the pass is a transformation pass. + +If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + +## Methods + +### \_\_call\_\_ + + + +`__call__(circuit, property_set=None)` + +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(passmanager_ir, state, callback=None)` + +Execute optimization task for input Qiskit IR. + +**Parameters** + +* **passmanager\_ir** (`Any`) – Qiskit IR to optimize. +* **state** (`PassManagerState`) – State associated with workflow execution by the pass manager itself. +* **callback** (`Optional`\[`Callable`]) – A callback function which is caller per execution of optimization task. + +**Return type** + +`tuple`\[`Any`, `PassManagerState`] + +**Returns** + +Optimized Qiskit IR and state of the workflow. + +### name + + + +`name()` + +Name of the pass. + +**Return type** + +`str` + +### run + + + +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") + +Run the padding pass on `dag`. + +**Parameters** + +**dag** (`DAGCircuit`) – DAG to be checked. + +**Returns** + +DAG with idle time filled with instructions. + +**Return type** + +DAGCircuit + +**Raises** + +**TranspilerError** – When a particular node is not scheduled, likely some transform pass is inserted before this node is called. + +### update\_status + + + +`update_status(state, run_state)` + +Update workflow status. + +**Parameters** + +* **state** (`PassManagerState`) – Pass manager state to update. +* **run\_state** (`RunState`) – Completion status of current task. + +**Return type** + +`PassManagerState` + +**Returns** + +Updated pass manager state. + diff --git a/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.md b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.md new file mode 100644 index 00000000000..17b4713f948 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling.md @@ -0,0 +1,380 @@ +--- +title: scheduling +description: API reference for qiskit_ibm_runtime.transpiler.passes.scheduling +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling +--- + + + +# scheduling + + + +## Scheduling + + + +`qiskit_ibm_runtime.transpiler.passes.scheduling` + +A collection of scheduling passes for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical control-flow/feedback based off of measurement results. + + + You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in `transpile()` or `generate_preset_pass_manager()`. + + +Below we demonstrate how to schedule and pad a teleportation circuit with delays for a dynamic circuit backend’s execution model: + +```python +from qiskit.circuit import ClassicalRegister, QuantumCircuit, QuantumRegister +from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager +from qiskit.transpiler.passmanager import PassManager + +from qiskit_ibm_runtime.transpiler.passes.scheduling import DynamicCircuitInstructionDurations +from qiskit_ibm_runtime.transpiler.passes.scheduling import ALAPScheduleAnalysis +from qiskit_ibm_runtime.transpiler.passes.scheduling import PadDelay +from qiskit_ibm_runtime.fake_provider import FakeJakarta + +backend = FakeJakarta() + +# Temporary workaround for mock backends. For real backends this is not required. +backend.configuration().basis_gates.append("if_else") + + +# Use this duration class to get appropriate durations for dynamic +# circuit backend scheduling +durations = DynamicCircuitInstructionDurations.from_backend(backend) +# Generate the main Qiskit transpile passes. +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +# Configure the as-late-as-possible scheduling pass +pm.scheduling = PassManager([ALAPScheduleAnalysis(durations), PadDelay(durations)]) + +qr = QuantumRegister(3) +crz = ClassicalRegister(1, name="crz") +crx = ClassicalRegister(1, name="crx") +result = ClassicalRegister(1, name="result") + +teleport = QuantumCircuit(qr, crz, crx, result, name="Teleport") + +teleport.h(qr[1]) +teleport.cx(qr[1], qr[2]) +teleport.cx(qr[0], qr[1]) +teleport.h(qr[0]) +teleport.measure(qr[0], crz) +teleport.measure(qr[1], crx) +with teleport.if_test((crz, 1)): + teleport.z(qr[2]) +with teleport.if_test((crx, 1)): + teleport.x(qr[2]) +teleport.measure(qr[2], result) + +# Transpile. +scheduled_teleport = pm.run(teleport) + +scheduled_teleport.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_0\_0.png](/images/api/qiskit-ibm-runtime/0.20/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.20/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png) + +When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s `transpile()` function internally builds its pass set by using `generate_preset_pass_manager()`. This returns instances of `StagedPassManager`, which can be extended. + + + +### Scheduling old format `c_if` conditioned gates + +Scheduling with old format `c_if` conditioned gates is not supported. + +```python +qc_c_if = QuantumCircuit(1, 1) +qc_c_if.x(0).c_if(0, 1) +qc_c_if.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_2\_0.png](/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png) + +The [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking `transpile()`. This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification. + +```python +# Temporary workaround for mock backends. For real backends this is not required. +backend.get_translation_stage_plugin = lambda: "ibm_dynamic_circuits" + +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +pm.scheduling = PassManager( + [ + ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence), + ] +) + +qc_if_dd = pm.run(qc_c_if, backend) +qc_if_dd.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_3\_0.png](/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png) + +If you are not using the transpiler plugin stages to work around this please manually run the pass `qiskit.transpiler.passes.ConvertConditionsToIfOps` prior to your scheduling pass. + +```python +from qiskit.transpiler.passes import ConvertConditionsToIfOps + +pm = generate_preset_pass_manager(optimization_level=1, backend=backend) +pm.scheduling = PassManager( + [ + ConvertConditionsToIfOps(), + ALAPScheduleAnalysis(durations), + PadDelay(durations), + ] +) + +qc_if_dd = pm.run(qc_c_if) +qc_if_dd.draw(output="mpl", style="iqp") +``` + +![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_4\_0.png](/images/api/qiskit-ibm-runtime/0.20/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.20/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.20/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.20/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.20/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.20/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.20/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.20/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.20/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.20/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.20/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.20/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png) + + + + +#### Scheduling & Dynamical Decoupling + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`BlockBasePadder`](qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder")(\[schedule\_idle\_qubits]) | The base class of padding pass. | +| [`ALAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis")(durations) | Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. | +| [`ASAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis")(durations) | Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. | +| [`DynamicCircuitInstructionDurations`](qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations "qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations")(\[...]) | For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. | +| [`PadDelay`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay")(durations\[, fill\_very\_end, ...]) | Padding idle time with Delay instructions. | +| [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling")(durations, dd\_sequences) | Dynamical decoupling insertion pass for IBM dynamic circuit backends. | + diff --git a/docs/api/qiskit-ibm-runtime/0.20/runtime_service.md b/docs/api/qiskit-ibm-runtime/0.20/runtime_service.md new file mode 100644 index 00000000000..9c91dfe440a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/runtime_service.md @@ -0,0 +1,146 @@ +--- +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, Sampler, Estimator, Options +from qiskit.circuit.library import RealAmplitudes +from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister +from qiskit.quantum_info import SparsePauliOp + +# Initialize account. +service = QiskitRuntimeService() + +# Set options, which can be overwritten at job level. +options = Options(optimization_level=3) + +# 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="qc") +qc = QuantumCircuit(qr, cr, name="bell") +qc.h(qr[0]) +qc.cx(qr[0], qr[1]) +qc.measure(qr, cr) + +with Session(service=service, backend="ibmq_qasm_simulator") as session: + # Submit a request to the Sampler primitive within the session. + sampler = Sampler(session=session, options=options) + job = sampler.run(circuits=qc) + print(f"Sampler results: {job.result()}") + + # Submit a request to the Estimator primitive within the session. + estimator = Estimator(session=session, options=options) + job = estimator.run( + circuits=[psi], observables=[H1], parameter_values=[theta] + ) + print(f"Estimator results: {job.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) +``` + +### Interim and final results + +Some runtime primitives provide interim results that inform you about the progress of your job. You can choose to stream the interim results and final result when you run the program by passing in the `callback` parameter, or at a later time using the [`RuntimeJob.stream_results()`](qiskit_ibm_runtime.RuntimeJob#stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") method. For example: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, Sampler +from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister + +service = QiskitRuntimeService() +backend = service.backend("ibmq_qasm_simulator") + +# Bell Circuit +qr = QuantumRegister(2, name="qr") +cr = ClassicalRegister(2, name="qc") +qc = QuantumCircuit(qr, cr, name="bell") +qc.h(qr[0]) +qc.cx(qr[0], qr[1]) +qc.measure(qr, cr) + +def result_callback(job_id, result): + print(result) + +# Stream results as soon as the job starts running. +job = Sampler(backend).run(qc, callback=result_callback) +print(job.result()) +``` + +## 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")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | +| [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler")(\[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 flexible Qiskit Runtime session. | +| [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend")(configuration, service, api\_client) | Backend class interfacing with an IBM Quantum backend. | +| [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob")(backend, api\_client, ...\[, ...]) | Representation of a runtime program execution. | +| [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions")(\[backend, image, log\_level, ...]) | Class for representing generic runtime execution options. | +| [`RuntimeEncoder`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, ...]) | JSON Encoder used by runtime service. | +| [`RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | + diff --git a/docs/api/qiskit-ibm-runtime/0.20/transpiler.md b/docs/api/qiskit-ibm-runtime/0.20/transpiler.md new file mode 100644 index 00000000000..adebb057e81 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/0.20/transpiler.md @@ -0,0 +1,26 @@ +--- +title: transpiler +description: API reference for qiskit_ibm_runtime.transpiler +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.transpiler +--- + + + + + +# IBM Backend Transpiler Tools + + + +`qiskit_ibm_runtime.transpiler` + +A collection of transpiler tools for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical compute and control-flow/feedback based off of measurement results. + +## Transpiler Passes + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | +| [`passes`](qiskit_ibm_runtime.transpiler.passes#module-qiskit_ibm_runtime.transpiler.passes "qiskit_ibm_runtime.transpiler.passes") | Transpiler Passes (qiskit\_ibm\_runtime.transpiler.passes) | + diff --git a/docs/api/qiskit-ibm-runtime/_package.json b/docs/api/qiskit-ibm-runtime/_package.json index ca759f626c4..b51f8723928 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.20.0" + "version": "0.21.1" } diff --git a/docs/api/qiskit-ibm-runtime/_toc.json b/docs/api/qiskit-ibm-runtime/_toc.json index 283a6633eae..0e936f3d357 100644 --- a/docs/api/qiskit-ibm-runtime/_toc.json +++ b/docs/api/qiskit-ibm-runtime/_toc.json @@ -9,8 +9,12 @@ "url": "/api/qiskit-ibm-runtime/runtime_service" }, { - "title": "Estimator", - "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator" + "title": "EstimatorV1", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1" + }, + { + "title": "EstimatorV2", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2" }, { "title": "IBMBackend", @@ -37,8 +41,12 @@ "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions" }, { - "title": "Sampler", - "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler" + "title": "SamplerV1", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1" + }, + { + "title": "SamplerV2", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2" }, { "title": "Session", @@ -53,6 +61,10 @@ "title": "Overview", "url": "/api/qiskit-ibm-runtime/fake_provider" }, + { + "title": "FakeAlgiers", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers" + }, { "title": "FakeAlmaden", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden" @@ -105,6 +117,10 @@ "title": "FakeBogotaV2", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2" }, + { + "title": "FakeBrisbane", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane" + }, { "title": "FakeBrooklyn", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn" @@ -145,6 +161,10 @@ "title": "FakeCasablancaV2", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2" }, + { + "title": "FakeCusco", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco" + }, { "title": "FakeEssex", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex" @@ -189,6 +209,10 @@ "title": "FakeJohannesburgV2", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2" }, + { + "title": "FakeKawasaki", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki" + }, { "title": "FakeKolkata", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata" @@ -197,6 +221,14 @@ "title": "FakeKolkataV2", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2" }, + { + "title": "FakeKyiv", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv" + }, + { + "title": "FakeKyoto", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto" + }, { "title": "FakeLagos", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos" @@ -269,6 +301,10 @@ "title": "FakeNairobiV2", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2" }, + { + "title": "FakeOsaka", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka" + }, { "title": "FakeOslo", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo" @@ -289,6 +325,10 @@ "title": "FakeParisV2", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2" }, + { + "title": "FakePeekskill", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill" + }, { "title": "FakePerth", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth" @@ -313,6 +353,10 @@ "title": "FakeProviderForBackendV2", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2" }, + { + "title": "FakeQuebec", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec" + }, { "title": "FakeQuito", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito" @@ -377,6 +421,10 @@ "title": "FakeTokyo", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo" }, + { + "title": "FakeTorino", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino" + }, { "title": "FakeToronto", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto" @@ -426,22 +474,54 @@ "title": "Overview", "url": "/api/qiskit-ibm-runtime/options" }, + { + "title": "DynamicalDecouplingOptions", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions" + }, { "title": "EnvironmentOptions", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions" }, + { + "title": "EstimatorOptions", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions" + }, { "title": "ExecutionOptions", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions" }, + { + "title": "ExecutionOptionsV2", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2" + }, + { + "title": "LayerNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions" + }, + { + "title": "MeasureNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions" + }, { "title": "Options", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options" }, + { + "title": "PecOptions", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions" + }, { "title": "ResilienceOptions", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions" }, + { + "title": "ResilienceOptionsV2", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2" + }, + { + "title": "SamplerOptions", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions" + }, { "title": "SimulatorOptions", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions" @@ -449,6 +529,14 @@ { "title": "TranspilationOptions", "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions" + }, + { + "title": "TwirlingOptions", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions" + }, + { + "title": "ZneOptions", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions" } ] }, diff --git a/docs/api/qiskit-ibm-runtime/dev/_package.json b/docs/api/qiskit-ibm-runtime/dev/_package.json index c41c1253637..4b4544d8fd3 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.20.1-dev" + "version": "0.22.0-dev" } diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json index 801b22be5c9..6510deff55b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/_toc.json +++ b/docs/api/qiskit-ibm-runtime/dev/_toc.json @@ -9,8 +9,12 @@ "url": "/api/qiskit-ibm-runtime/dev/runtime_service" }, { - "title": "Estimator", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator" + "title": "EstimatorV1", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1" + }, + { + "title": "EstimatorV2", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2" }, { "title": "IBMBackend", @@ -37,8 +41,12 @@ "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions" }, { - "title": "Sampler", - "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler" + "title": "SamplerV1", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1" + }, + { + "title": "SamplerV2", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2" }, { "title": "Session", @@ -466,22 +474,54 @@ "title": "Overview", "url": "/api/qiskit-ibm-runtime/dev/options" }, + { + "title": "DynamicalDecouplingOptions", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions" + }, { "title": "EnvironmentOptions", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions" }, + { + "title": "EstimatorOptions", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions" + }, { "title": "ExecutionOptions", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions" }, + { + "title": "ExecutionOptionsV2", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2" + }, + { + "title": "LayerNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions" + }, + { + "title": "MeasureNoiseLearningOptions", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions" + }, { "title": "Options", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options" }, + { + "title": "PecOptions", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions" + }, { "title": "ResilienceOptions", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions" }, + { + "title": "ResilienceOptionsV2", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2" + }, + { + "title": "SamplerOptions", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions" + }, { "title": "SimulatorOptions", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions" @@ -489,6 +529,14 @@ { "title": "TranspilationOptions", "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions" + }, + { + "title": "TwirlingOptions", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions" + }, + { + "title": "ZneOptions", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions" } ] }, diff --git a/docs/api/qiskit-ibm-runtime/dev/options.md b/docs/api/qiskit-ibm-runtime/dev/options.md index 5d3a56bc888..c3de6e01159 100644 --- a/docs/api/qiskit-ibm-runtime/dev/options.md +++ b/docs/api/qiskit-ibm-runtime/dev/options.md @@ -18,7 +18,39 @@ python_api_name: qiskit_ibm_runtime.options Options that can be passed to the primitives. -The [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options") class encapsulates all the options you can specify when invoking a 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: +**V2 Primitives** + +`SamplerV2` and `EstimatorV2` each have their own options. You can use the `options` attribute to set the options. For example: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) +estimator = EstimatorV2(backend=backend) +estimator.options.resilience_level = 1 +``` + +You can also use the `update()` method to do bulk update. For example: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) +estimator = EstimatorV2(backend=backend) +estimator.options.update(resilience_level=1) +``` + +Refer to [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions") and [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions") for V2 Sampler and V2 Estimator options, respectively. + + + If an option is not specified, the server default value is used. The default values are subject to change. See the [API Reference](/api/qiskit-ibm-runtime/options) for the most up-to-date default values. + + +**V1 Primitives** + +The [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options") class encapsulates all the options you can specify when invoking a V1 primitive. It includes frequently used options, such as `optimization_level` and `resilience_level` as well as sub-categories, such as `transpilation` and `execution`. You can use auto-complete to easily find the options inside each sub-category, for example: ```python from qiskit_ibm_runtime.options import Options @@ -37,12 +69,22 @@ options = Options(transpilation={"initial_layout": [0, 1, 2, 3]}) ## Classes -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for the primitives. | -| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\[skip\_transpilation, ...]) | Transpilation options. | -| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\[noise\_amplifier, ...]) | Resilience options. | -| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\[shots, init\_qubits]) | Execution options. | -| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\[log\_level, callback, ...]) | Options related to the execution environment. | -| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\[noise\_model, ...]) | Simulator 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. | +| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\*args, \*\*kwargs) | Options for dynamical decoupling (DD). | +| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\*args, \*\*kwargs) | Resilience options for V2 Estimator. | +| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\*args, \*\*kwargs) | Options for learning layer noise. | +| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\*args, \*\*kwargs) | Options for measurement noise learning. | +| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\*args, \*\*kwargs) | Probabalistic error cancellation mitigation options. | +| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\*args, \*\*kwargs) | Zero noise extrapolation mitigation options. | +| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\*args, \*\*kwargs) | Twirling options. | +| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\*args, \*\*kwargs) | Execution options for V2 primitives. | +| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for the primitives, used by V1 primitives. | +| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\*args, \*\*kwargs) | Transpilation options. | +| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\*args, \*\*kwargs) | Resilience options for V1 primitives. | +| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\*args, \*\*kwargs) | Execution options for V1 primitives. | +| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\*args, \*\*kwargs) | Options related to the execution environment. | +| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\*args, \*\*kwargs) | Simulator options. | diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md index 23b9c932ad7..a3c48ac6919 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.md @@ -2,144 +2,11 @@ title: Estimator description: API reference for qiskit_ibm_runtime.Estimator in_page_toc_min_heading_level: 1 -python_api_type: class +python_api_type: attribute python_api_name: qiskit_ibm_runtime.Estimator --- # Estimator - - -`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L36-L219 "view source code") - -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.Estimator.run "qiskit_ibm_runtime.Estimator.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, and data is cached for efficiency. - -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** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – - - 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. - -**Return type** - -`Options` - -**Returns** - -options - - - -### session - -Return session used by this primitive. - -**Return type** - -`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] - -**Returns** - -Session used by this primitive, or `None` if session is not used. - -## Methods - -### run - - - -`run(circuits, observables, parameter_values=None, **kwargs)` - -Submit a request to the estimator primitive. - -**Parameters** - -* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – a (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. -* **observables** (*BaseOperator | Sequence\[BaseOperator]*) – Observable objects. -* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. -* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). - -**Return type** - -[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") - -**Returns** - -Submitted job. The result of the job is an instance of `qiskit.primitives.EstimatorResult`. - -**Raises** - -**ValueError** – Invalid arguments are given. - -### set\_options - - - -`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L225-L231 "view source code") - -Set options values for the sampler. - -**Parameters** - -**\*\*fields** – The fields to update the options - -**Return type** - -`None` +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.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.md new file mode 100644 index 00000000000..56bbdf370df --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV1.md @@ -0,0 +1,143 @@ +--- +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 + + + +`EstimatorV1(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L180-L362 "view source code") + +Class for interacting with Qiskit Runtime Estimator primitive service. + +Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. + +The [`run()`](#qiskit_ibm_runtime.EstimatorV1.run "qiskit_ibm_runtime.EstimatorV1.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. + +You are encouraged to use [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") to open a session, during which you can invoke one or more primitives. Jobs submitted within a session are prioritized by the scheduler. + +Example: + +```python +from qiskit.circuit.library import RealAmplitudes +from qiskit.quantum_info import SparsePauliOp + +from qiskit_ibm_runtime import QiskitRuntimeService, Estimator + +service = QiskitRuntimeService(channel="ibm_cloud") + +psi1 = RealAmplitudes(num_qubits=2, reps=2) + +H1 = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) +H2 = SparsePauliOp.from_list([("IZ", 1)]) +H3 = SparsePauliOp.from_list([("ZI", 1), ("ZZ", 1)]) + +with Session(service=service, backend="ibmq_qasm_simulator") as session: + estimator = Estimator(session=session) + + theta1 = [0, 1, 1, 2, 3, 5] + + # calculate [ ] + psi1_H1 = estimator.run(circuits=[psi1], observables=[H1], parameter_values=[theta1]) + print(psi1_H1.result()) + + # calculate [ , ] + psi1_H23 = estimator.run( + circuits=[psi1, psi1], + observables=[H2, H3], + parameter_values=[theta1]*2 + ) + print(psi1_H23.result()) +``` + +Initializes the Estimator primitive. + +**Parameters** + +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + +* **session** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + Session in which to call the primitive. + + If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected. + +* **options** (`Union`\[`Dict`, [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.options.Options"), `None`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + +## Attributes + + + +### options + +Return options values for the sampler. :rtype: `Options` :returns: options + + + +### session + +Return session used by this primitive. + +**Return type** + +`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + +**Returns** + +Session used by this primitive, or `None` if session is not used. + + + +### version + +`= 1` + +## Methods + +### run + + + +`run(circuits, observables, parameter_values=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L257-L291 "view source code") + +Submit a request to the estimator primitive. + +**Parameters** + +* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – a (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. +* **observables** (*Sequence\[BaseOperator | str] | BaseOperator | str*) – Observable objects. +* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. +* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). + +**Return type** + +[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") + +**Returns** + +Submitted job. The result of the job is an instance of `qiskit.primitives.EstimatorResult`. + +**Raises** + +**ValueError** – Invalid arguments are given. + +### set\_options + + + +`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L402-L410 "view source code") + +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/dev/qiskit_ibm_runtime.EstimatorV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.md new file mode 100644 index 00000000000..b26b4982649 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.md @@ -0,0 +1,127 @@ +--- +title: EstimatorV2 +description: API reference for qiskit_ibm_runtime.EstimatorV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.EstimatorV2 +--- + +# EstimatorV2 + + + +`EstimatorV2(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L48-L177 "view source code") + +Class for interacting with Qiskit Runtime Estimator primitive service. + +Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. + +The [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. + +Following construction, an estimator is used by calling its [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") method with a list of PUBs (Primitive Unified Blocs). Each PUB contains four values that, together, define a computation unit of work for the estimator to complete: + +* a single `QuantumCircuit`, possibly parametrized, whose final state we define as $\psi(\theta)$, +* one or more observables (specified as any `ObservablesArrayLike`, including `Pauli`, `SparsePauliOp`, `str`) that specify which expectation values to estimate, denoted $H_j$, and +* a collection parameter value sets to bind the circuit against, $\theta_k$. +* an optional target precision for expectation value estimates. + +Here is an example of how the estimator is used. + +```python +from qiskit.circuit.library import RealAmplitudes +from qiskit.quantum_info import SparsePauliOp +from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 as Estimator + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) + +psi = RealAmplitudes(num_qubits=2, reps=2) +hamiltonian = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) +theta = [0, 1, 1, 2, 3, 5] + +pm = generate_preset_pass_manager(backend=backend, optimization_level=1) +isa_psi = pm.run(psi) +isa_observables = hamiltonian.apply_layout(isa_psi.layout) + +estimator = Estimator(backend=backend) + +# calculate [ ] +job = estimator.run([(isa_psi, isa_observables, [theta])]) +pub_result = job.result()[0] +print(f"Expectation values: {pub_result.data.evs}") +``` + +Initializes the Estimator primitive. + +**Parameters** + +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + +* **session** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + 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`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + +**Raises** + +**NotImplementedError** – If “q-ctrl” channel strategy is used. + +## Attributes + + + +### options + +Return options + +**Return type** + +`TypeVar`(`OptionsT`, bound= `BaseOptions`) + + + +### session + +Return session used by this primitive. + +**Return type** + +`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + +**Returns** + +Session used by this primitive, or `None` if session is not used. + + + +### version + +`= 2` + +## Methods + +### run + + + +`run(pubs, *, precision=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/estimator.py#L137-L154 "view source code") + +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 + +**Returns** + +Submitted job. + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md index e25f58729f7..0c7f6384210 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.md @@ -352,7 +352,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`__call__()` +`__call__()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/ibm_backend.py#L506-L508 "view source code") Call self as a function. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md index 49b7bd2c1c6..c31c45fbedf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,59 +10,10 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L64-L1219 "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L65-L1177 "view source code") Class for interacting with the Qiskit Runtime service. -Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. - -A sample workflow of using the runtime service: - -```python -from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler, Estimator, Options -from qiskit.circuit.library import RealAmplitudes -from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister -from qiskit.quantum_info import SparsePauliOp - -# Initialize account. -service = QiskitRuntimeService() - -# Set options, which can be overwritten at job level. -options = Options(optimization_level=1) - -# 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) - -with Session(service=service, backend="ibmq_qasm_simulator") as session: - # Submit a request to the Sampler primitive within the session. - sampler = Sampler(session=session, options=options) - job = sampler.run(circuits=qc) - print(f"Sampler results: {job.result()}") - - # Submit a request to the Estimator primitive within the session. - estimator = Estimator(session=session, options=options) - job = estimator.run( - circuits=[psi], observables=[H1], parameter_values=[theta] - ) - print(f"Estimator results: {job.result()}") -``` - -The example above uses the dedicated [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") and [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") classes. You can also use the [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method directly to invoke a Qiskit Runtime program. - -If the program has any interim results, you can use the `callback` parameter of the [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method to stream the interim results. Alternatively, you can use the [`RuntimeJob.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. - -The [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method returns a [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") object. You can use its methods to perform tasks like checking job status, getting job result, and canceling job. - QiskitRuntimeService constructor An account is selected in the following order: @@ -141,7 +92,7 @@ self -`active_account()` +`active_account()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L649-L655 "view source code") Return the IBM Quantum account currently in use for the session. @@ -157,7 +108,7 @@ A dictionary with information about the account currently in the session. -`backend(name=None, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L817-L847 "view source code") +`backend(name=None, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L758-L788 "view source code") Return a single backend matching the specified filtering. @@ -182,7 +133,7 @@ Backend -`backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L544-L652 "view source code") +`backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L486-L593 "view source code") Return all backends accessible via this account, subject to optional filtering. @@ -241,7 +192,7 @@ The list of available backends that match the filter. -`static delete_account(filename=None, name=None, channel=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L716-L734 "view source code") +`static delete_account(filename=None, name=None, channel=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L657-L675 "view source code") Delete a saved account from disk. @@ -263,7 +214,7 @@ True if the account was deleted. False if no account was found. -`delete_job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1077-L1094 "view source code") +`delete_job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1035-L1052 "view source code") Delete a runtime job. @@ -286,7 +237,7 @@ Note that this operation cannot be reversed. -`get_backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L849-L850 "view source code") +`get_backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L790-L791 "view source code") Return a single backend matching the specified filtering. @@ -311,7 +262,7 @@ Backend -`instances()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1184-L1192 "view source code") +`instances()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1142-L1150 "view source code") Return the IBM Quantum instances list currently in use for the session. @@ -327,7 +278,7 @@ A list with instances currently in the session. -`job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L960-L979 "view source code") +`job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L918-L937 "view source code") Retrieve a runtime job. @@ -337,7 +288,7 @@ Retrieve a runtime job. **Return type** -[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") +`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), `RuntimeJobV2`] **Returns** @@ -352,7 +303,7 @@ Runtime job retrieved. -`jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L981-L1075 "view source code") +`jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L939-L1033 "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -372,7 +323,7 @@ Retrieve all runtime jobs, subject to optional filtering. **Return type** -`List`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob")] +`List`\[`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), `RuntimeJobV2`]] **Returns** @@ -386,7 +337,7 @@ A list of runtime jobs. -`least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1147-L1182 "view source code") +`least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L1105-L1140 "view source code") Return the least busy available backend. @@ -420,7 +371,7 @@ The backend with the fewest number of pending jobs. -`run(program_id, inputs, options=None, callback=None, result_decoder=None, session_id=None, start_session=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L852-L958 "view source code") +`run(program_id, inputs, options=None, callback=None, result_decoder=None, session_id=None, start_session=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L793-L916 "view source code") Execute the runtime program. @@ -447,7 +398,7 @@ Execute the runtime program. **Return type** -[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") +`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), `RuntimeJobV2`] **Returns** @@ -463,7 +414,7 @@ A `RuntimeJob` instance representing the execution. -`static save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, channel_strategy=None, set_as_default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L736-L785 "view source code") +`static save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, channel_strategy=None, set_as_default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L677-L726 "view source code") Save the account to disk for future use. @@ -489,7 +440,7 @@ Save the account to disk for future use. -`static saved_accounts(default=None, channel=None, filename=None, name=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L787-L815 "view source code") +`static saved_accounts(default=None, channel=None, filename=None, name=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/qiskit_runtime_service.py#L728-L756 "view source code") List the accounts saved on disk. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md index 308b592348f..26cddb8092e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L282-L343 "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L332-L424 "view source code") JSON Decoder used by runtime service. @@ -40,7 +40,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`object_hook(obj)` +`object_hook(obj)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L347-L424 "view source code") Called to decode object. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md index dd309dd953e..533144160ec 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L196-L279 "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L207-L329 "view source code") JSON Encoder used by runtime service. @@ -52,7 +52,7 @@ If specified, default is a function that gets called for objects that can’t ot -`default(obj)` +`default(obj)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/utils/json.py#L210-L329 "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md index 890572b3515..82b51e7a101 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L55-L752 "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None, version=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L45-L416 "view source code") Representation of a runtime program execution. @@ -49,6 +49,7 @@ RuntimeJob constructor. * **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 @@ -162,7 +163,7 @@ Return the usage estimation infromation for this job. -`backend(timeout=None)` +`backend(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L352-L366 "view source code") Return the backend where this job was executed. Retrieve data again if backend is None. @@ -178,7 +179,7 @@ Return the backend where this job was executed. Retrieve data again if backend i -`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L235-L249 "view source code") +`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L172-L186 "view source code") Cancel the job. @@ -195,7 +196,7 @@ Cancel the job. -`cancel_result_streaming()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L352-L356 "view source code") +`cancel_result_streaming()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_runtime_job.py#L149-L153 "view source code") Cancel result streaming. @@ -231,7 +232,7 @@ Return whether the job has successfully run. -`error_message()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L276-L283 "view source code") +`error_message()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_runtime_job.py#L212-L219 "view source code") Returns the reason if the job failed. @@ -243,11 +244,23 @@ Returns the reason if the job failed. Error message string or `None`. +### errored + + + +`errored()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L201-L203 "view source code") + +Return whether the job has failed. + +**Return type** + +`bool` + ### in\_final\_state -`in_final_state()` +`in_final_state()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L197-L199 "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -259,7 +272,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`interim_results(decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L178-L196 "view source code") +`interim_results(decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L398-L416 "view source code") Return the interim results of the job. @@ -295,7 +308,7 @@ Return a unique id identifying the job. -`logs()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L358-L377 "view source code") +`logs()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L294-L313 "view source code") Return job logs. @@ -319,7 +332,7 @@ Job logs, including standard output and error. -`metrics()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L379-L391 "view source code") +`metrics()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_runtime_job.py#L155-L167 "view source code") Return job metrics. @@ -339,7 +352,7 @@ Job metrics, which includes timestamp information. -`properties(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L436-L448 "view source code") +`properties(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_runtime_job.py#L198-L210 "view source code") Return the backend properties for this job. @@ -359,7 +372,7 @@ The backend properties used for this job, at the time the job was run, or `None` -`queue_info()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L720-L752 "view source code") +`queue_info()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L260-L292 "view source code") Return queue information for this job. @@ -381,7 +394,7 @@ A `QueueInfo` instance that contains queue information for this job, or `None` i -`queue_position(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L693-L718 "view source code") +`queue_position(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L233-L258 "view source code") Return the position of the job in the server queue. @@ -405,7 +418,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`result(timeout=None, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L198-L233 "view source code") +`result(timeout=None, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L135-L170 "view source code") Return the results of the job. @@ -444,7 +457,7 @@ Return whether the job is actively running. -`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L267-L274 "view source code") +`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L188-L195 "view source code") Return the status of the job. @@ -460,7 +473,7 @@ Status of this job. -`stream_results(callback, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L322-L350 "view source code") +`stream_results(callback, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L368-L396 "view source code") Start streaming job results. @@ -487,7 +500,7 @@ Start streaming job results. -`submit()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L393-L405 "view source code") +`submit()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L219-L231 "view source code") Unsupported method. .. note: @@ -509,7 +522,7 @@ to submit a job. -`update_tags(new_tags)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L407-L434 "view source code") +`update_tags(new_tags)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_runtime_job.py#L169-L196 "view source code") Update the tags associated with this job. @@ -533,7 +546,7 @@ The new tags associated with this job. -`wait_for_final_state(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L285-L320 "view source code") +`wait_for_final_state(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_job.py#L315-L350 "view source code") Use the websocket server to wait for the final the state of a job. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md index ee8f9506592..bd8fb305b31 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeOptions.md @@ -90,7 +90,7 @@ RuntimeOptions constructor. -`validate(channel)` +`validate(channel)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/runtime_options.py#L76-L106 "view source code") Validate options. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md index c5f06308337..b3d8fab78d7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.md @@ -2,135 +2,11 @@ title: Sampler description: API reference for qiskit_ibm_runtime.Sampler in_page_toc_min_heading_level: 1 -python_api_type: class +python_api_type: attribute python_api_name: qiskit_ibm_runtime.Sampler --- # Sampler - - -`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L35-L184 "view source code") - -Class for interacting with Qiskit Runtime Sampler primitive service. - -Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. - -The [`run()`](#qiskit_ibm_runtime.Sampler.run "qiskit_ibm_runtime.Sampler.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, and data is cached for efficiency. - -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** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – - - 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. - -**Return type** - -`Options` - -**Returns** - -options - - - -### session - -Return session used by this primitive. - -**Return type** - -`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] - -**Returns** - -Session used by this primitive, or `None` if session is not used. - -## Methods - -### run - - - -`run(circuits, parameter_values=None, **kwargs)` - -Submit a request to the sampler primitive. - -**Parameters** - -* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – A (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. -* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. -* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). - -**Return type** - -[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") - -**Returns** - -Submitted job. The result of the job is an instance of `qiskit.primitives.SamplerResult`. - -**Raises** - -**ValueError** – Invalid arguments are given. - -### set\_options - - - -`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L225-L231 "view source code") - -Set options values for the sampler. - -**Parameters** - -**\*\*fields** – The fields to update the options - -**Return type** - -`None` +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.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.md new file mode 100644 index 00000000000..bdcabb0e41b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV1.md @@ -0,0 +1,134 @@ +--- +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 + + + +`SamplerV1(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L140-L290 "view source code") + +Class for interacting with Qiskit Runtime Sampler primitive service. + +Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. + +The [`run()`](#qiskit_ibm_runtime.SamplerV1.run "qiskit_ibm_runtime.SamplerV1.run") method can be used to submit circuits and parameters to the Sampler primitive. + +You are encouraged to use [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") to open a session, during which you can invoke one or more primitives. Jobs submitted within a session are prioritized by the scheduler. + +Example: + +```python +from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister +from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler + +service = QiskitRuntimeService(channel="ibm_cloud") + +# Bell Circuit +qr = QuantumRegister(2, name="qr") +cr = ClassicalRegister(2, name="cr") +qc = QuantumCircuit(qr, cr, name="bell") +qc.h(qr[0]) +qc.cx(qr[0], qr[1]) +qc.measure(qr, cr) + +with Session(service, backend="ibmq_qasm_simulator") as session: + sampler = Sampler(session=session) + + job = sampler.run(qc, shots=1024) + print(f"Job ID: {job.job_id()}") + print(f"Job result: {job.result()}") + + # You can run more jobs inside the session +``` + +Initializes the Sampler primitive. + +**Parameters** + +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + +* **session** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + Session in which to call the primitive. + + If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected. + +* **options** (`Union`\[`Dict`, [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.options.Options"), `None`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + +## Attributes + + + +### options + +Return options values for the sampler. :rtype: `Options` :returns: options + + + +### session + +Return session used by this primitive. + +**Return type** + +`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + +**Returns** + +Session used by this primitive, or `None` if session is not used. + + + +### version + +`= 1` + +## Methods + +### run + + + +`run(circuits, parameter_values=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L210-L238 "view source code") + +Submit a request to the sampler primitive. + +**Parameters** + +* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – A (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. +* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. +* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). + +**Return type** + +[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") + +**Returns** + +Submitted job. The result of the job is an instance of `qiskit.primitives.SamplerResult`. + +**Raises** + +**ValueError** – Invalid arguments are given. + +### set\_options + + + +`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/base_primitive.py#L402-L410 "view source code") + +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/dev/qiskit_ibm_runtime.SamplerV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.md new file mode 100644 index 00000000000..a4702d1f149 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.md @@ -0,0 +1,101 @@ +--- +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 + + + +`SamplerV2(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L46-L137 "view source code") + +Class for interacting with Qiskit Runtime Sampler primitive service. + +This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1. + +Qiskit Runtime Sampler primitive returns the sampled result according to the specified output type. For example, it returns a bitstring for each shot if measurement level 2 (bits) is requested. + +The [`run()`](#qiskit_ibm_runtime.SamplerV2.run "qiskit_ibm_runtime.SamplerV2.run") method can be used to submit circuits and parameters to the Sampler primitive. + +Initializes the Sampler primitive. + +**Parameters** + +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + +* **session** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + 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`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + +**Raises** + +**NotImplementedError** – If “q-ctrl” channel strategy is used. + +## Attributes + + + +### options + +`SamplerOptions` + +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 + +`= 2` + +## Methods + +### run + + + +`run(pubs, *, shots=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/sampler.py#L97-L124 "view source code") + +Submit a request to the estimator 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 + +**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/dev/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md index 01818f5fba1..9869b47b8a3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Session.md @@ -10,11 +10,11 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L40-L342 "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L41-L346 "view source code") -Class for creating a flexible Qiskit Runtime 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. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. +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. @@ -22,7 +22,11 @@ For example: ```python from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister -from qiskit_ibm_runtime import Sampler, Session, Options +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") @@ -32,13 +36,15 @@ qc.h(qr[0]) qc.cx(qr[0], qr[1]) qc.measure(qr, cr) -options = Options(optimization_level=3) +pm = generate_preset_pass_manager(backend=backend, optimization_level=1) +isa_circuit = pm.run(qc) -with Session(backend="ibmq_qasm_simulator") as session: - sampler = Sampler(session=session, options=options) - job = sampler.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"Sampler job result: {job.result()}") + print(f"Counts: {pub_result.data.cr.get_counts()}") ``` Session constructor. @@ -89,7 +95,7 @@ Session ID. None if the backend is a simulator. -`backend()` +`backend()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L218-L224 "view source code") Return backend for this session. @@ -105,7 +111,7 @@ Backend for this session. None if unknown. -`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L200-L204 "view source code") +`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L204-L208 "view source code") Cancel all pending jobs in a session. @@ -117,7 +123,7 @@ Cancel all pending jobs in a session. -`close()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L206-L212 "view source code") +`close()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L210-L216 "view source code") 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. @@ -129,7 +135,7 @@ Close the session so new jobs will no longer be accepted, but existing queued or -`details()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L248-L284 "view source code") +`details()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L252-L288 "view source code") Return session details. @@ -145,7 +151,7 @@ A dictionary with the sessions details, including -`classmethod from_id(session_id, service=None, backend=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L304-L329 "view source code") +`classmethod from_id(session_id, service=None, backend=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L308-L333 "view source code") Construct a Session object with a given session\_id @@ -167,7 +173,7 @@ A new Session with the given `session_id` -`run(program_id, inputs, options=None, callback=None, result_decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L155-L198 "view source code") +`run(program_id, inputs, options=None, callback=None, result_decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L159-L202 "view source code") Run a program in the session. @@ -180,7 +186,7 @@ Run a program in the session. **Return type** -[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") +`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), `RuntimeJobV2`] **Returns** @@ -190,7 +196,7 @@ Submitted job. -`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L222-L246 "view source code") +`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/session.py#L226-L250 "view source code") Return current session status. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.md index bfa2d708963..cd6cd98f5de 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md index a0685783ca7..c80e07c787e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md @@ -109,7 +109,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md index e0d0ec0558b..544466b92f0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md @@ -236,7 +236,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md index f8b91f68f4f..d8458dbb285 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonk.md @@ -93,7 +93,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md index 0a9428312a4..b19c2d0edd8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md @@ -230,7 +230,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md index 3d4e0931bed..099a9cfa39b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthens.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md index e7fd666bd83..8baa8bf8dbb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md index 22bb3ab1767..f89884f4e4f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md index 5eda0df6fe9..6a1d8ee3cdd 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelem.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md index a6c8760ffc6..76104b84986 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md index dcd46d03569..fa3e8ca67b3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md @@ -99,7 +99,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md index 7e3eb77b89e..f28134c210c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md @@ -236,7 +236,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md index 42d5a0e919e..dcaefb9a067 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogota.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md index 191a5ca7606..06a44861268 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.md index 8ad272fb329..1ef44666c48 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md index 1f98a5667d5..320470abb54 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md index 6a58baabce6..026da8a7f99 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md index 213b643af64..1ed44afff19 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlington.md @@ -105,7 +105,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md index 950b1418713..e4615022907 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md @@ -232,7 +232,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md index a5758166e6f..0586932004a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairo.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md index 00daf3a4d2c..436230ed2c4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md index aa5a12948dc..8ed2bebd194 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridge.md @@ -111,7 +111,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md index 713c2eebbf3..c907bb7ad6d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md @@ -238,7 +238,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md index 9c206e536a5..bd2ad8861ea 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md index 6c78b098274..5d97b169baf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.md index 2cee5ec5634..aac98f1d693 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md index ffddfa3f73d..422d65f6e9f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssex.md @@ -107,7 +107,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md index f0f0e49f16c..6f7c29a9274 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md @@ -234,7 +234,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md index 7b6d24d4403..9fdda0f817f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md index 06286362691..48658ab888c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md index 1e05ccab32a..5589436feed 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md index 99c8e4fb295..299c31d16c9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoi.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md index 20b1fe1cb64..48a1ce1a579 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md index 6f8bbb46b97..2adbe9c7b2e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakarta.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md index a07ea9a9268..e6ff3f5146b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md index 275953a1da9..f2692c0e5a9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md @@ -109,7 +109,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md index 2f885ce0cf6..943b90476c5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md @@ -236,7 +236,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.md index 538a350d6a8..1b84889b91d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md index 951c6eb6e13..be266bcc11d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkata.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md index 16cc98a3e3d..1a8803622f0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.md index f91c719e1dd..264e19678a7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.md index 2894a375d6e..4e6410584c2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md index 209cd975309..9299a661c73 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagos.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md index caa8526daf4..13df59bb4c3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.md index 39acf283667..e9f666a3806 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLima.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md index 5f6078685a9..edb84a52f54 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md index ca7ce2c1b2e..e25745374b7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondon.md @@ -107,7 +107,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md index 0731b7d3c50..ff0a801ca8d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md @@ -234,7 +234,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md index 658e20c09a7..9b3794c2344 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattan.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md index b37c97e532b..37aeca278ab 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.md index 31a0d9a30a9..f169439fb6a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManila.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md index 0296db2e4d7..6d866c584d6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md index 85f4bb73eb0..d29c1b96375 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md @@ -74,7 +74,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L89-L95 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md index 4d7fbf91a4e..7dee049e45e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md index e7227c67f34..4e62d35a4f1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontreal.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md index bc1d9fa2ee9..e6d6e9b96b5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md index fa88d150662..409e33d6368 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbai.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md index ee0a020b49f..3376b26a211 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md index 66ef2b6ad17..f6e491fac4f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobi.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md index 2d131eb9814..fd44ea0c287 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.md index 306a587e5a9..a861fd44050 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md index fc4e03776d3..e9bef8f9b38 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md index ad068d8f345..921cdf09399 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurense.md @@ -105,7 +105,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md index 9dfaf13b0f1..7b3e714cdd6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md @@ -232,7 +232,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.md index b67c2aee306..c038abf46ff 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParis.md @@ -101,7 +101,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md index 32e22654b2b..717860eb0a2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.md @@ -238,7 +238,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.md index bc83c8c4ed7..b32c8846b1c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.md index 964954f3996..541967dca8b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md index 646fb0128e7..089802c6bd9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md @@ -78,7 +78,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L122-L128 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md index d780262c13e..1b990d9a332 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.md index 768d78435f3..55574dc3b77 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md index 1a4a44a8951..7310ada5da0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProvider.md @@ -30,7 +30,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`backends(name=None, **kwargs)` +`backends(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py#L170-L171 "view source code") Return a list of backends matching the specified filtering. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md index 1d9d50a4d85..571c927b077 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md @@ -30,7 +30,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`backend(name=None, **kwargs)` +`backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_provider.py#L72-L84 "view source code") Filter backends in provider by name. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.md index 1f0de76fb31..61fa06cb6ec 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md index fa13828efe4..0776b6d7be0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuito.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md index 630c86bf5ac..784cbbddbb4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md index e8a20b93bfb..5399534962a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochester.md @@ -99,7 +99,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md index da5e9234f7a..92008c0a06d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.md index 13368774235..6d879734c33 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRome.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md index d140a3da438..5d26a83dec8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md index 179c54b8d1a..db284299687 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiago.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md index 7186ac0038b..bfe928273b3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md index 3f2e1c14f34..e3339541365 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md index deb882c58d2..5518e07a61e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingapore.md @@ -109,7 +109,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md index 8b4e3b503d0..6397bdd938a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md @@ -236,7 +236,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md index 215bfb12e81..cf55cf8ac88 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydney.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md index e8f45070dc8..b4ecf8d5f44 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md index 8982664b06b..7b1f10f963a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTenerife.md @@ -76,7 +76,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py#L62-L68 "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md index 18f3f7c1965..ae7882293ba 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTokyo.md @@ -78,7 +78,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py#L135-L141 "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.md index 8630e72ed50..3a076ab705b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md index 16b07d519c6..7b7a2a03bc0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeToronto.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md index 2b07bba0b3a..a8290393772 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md index b5f191bb690..564d9c09f18 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValencia.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md index c37b3d86a11..e481091a627 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md index 7d7d4e1a8a9..da46dea258f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigo.md @@ -105,7 +105,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md index f8e58f37bd7..a98d2664569 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md @@ -232,7 +232,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md index 56ecb286736..a832fcee2c1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashington.md @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md index 5aeb1bf4f65..92ae7d1fc34 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md index 8b7a2530fd2..5184f6102d9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktown.md @@ -107,7 +107,7 @@ str -`properties()` +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md index c55e27bfa00..6ed95715984 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md @@ -234,7 +234,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.md new file mode 100644 index 00000000000..a3db492b69a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.md @@ -0,0 +1,73 @@ +--- +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 + + + +`DynamicalDecouplingOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/dynamical_decoupling_options.py#L20-L50 "view source code") + +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 + +`UnsetType | bool` + +`= Unset` + + + +### extra\_slack\_distribution + +`UnsetType | Literal['middle', 'edges']` + +`= Unset` + + + +### scheduling\_method + +`UnsetType | Literal['alap', 'asap']` + +`= Unset` + + + +### sequence\_type + +`UnsetType | Literal['XX', 'XpXm', 'XY4']` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.md index c7274297554..8906d62006c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,22 +10,22 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/environment_options.py#L27-L62 "view source code") +`EnvironmentOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/environment_options.py#L28-L50 "view source code") Options related to the execution environment. **Parameters** -* **log\_level** (`str`) – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. The default level is `WARNING`. +* **log\_level** – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. Default: `WARNING`. -* **callback** (`Optional`\[`Callable`]) – +* **callback** – Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: > 1. Job ID > 2. Job result. -* **job\_tags** (`Optional`\[`List`]) – 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. +* **job\_tags** – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `qiskit_ibm_runtime.qiskit_runtime_service.jobs()` function call. ## Attributes @@ -37,31 +37,21 @@ Options related to the execution environment. `= None` - - -### log\_level - -`str` - -`= 'WARNING'` - ### job\_tags `List | None` -## Methods - -### validate\_environment\_options +`= None` - + -`static validate_environment_options(environment_options)` +### log\_level -Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. +`Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']` -**Return type** +`= 'WARNING'` -`None` +## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.md new file mode 100644 index 00000000000..f3ce5c7f4ab --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.EstimatorOptions.md @@ -0,0 +1,189 @@ +--- +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 + + + +`EstimatorOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/estimator_options.py#L35-L125 "view source code") + +Options for V2 Estimator. + +**Parameters** + +* **default\_precision** – The default precision to use for any PUB or `run()` call that does not specify one. Each estimator pub can specify its own precision. If the `run()` method is given a precision, then that value is used for all PUBs in the `run()` call that do not specify their own. Default: 0.015625 (1 / sqrt(4096). + +* **default\_shots** – + + The total number of shots to use per circuit per configuration. + + + If set, this value overrides [`default_precision`](#qiskit_ibm_runtime.options.EstimatorOptions.default_precision "qiskit_ibm_runtime.options.EstimatorOptions.default_precision"). + + + A configuration is a combination of a specific parameter value binding set and a physical measurement basis. A physical measurement basis groups together some collection of qubit-wise commuting observables for some specific circuit/parameter value set to create a single measurement with basis rotations that is inserted into hardware executions. + + If twirling is enabled, the value of this option will be divided over circuit, randomizations, with a smaller number of shots per randomization. See the [`twirling`](#qiskit_ibm_runtime.options.EstimatorOptions.twirling "qiskit_ibm_runtime.options.EstimatorOptions.twirling") options. + + Default: `None`. + +* **optimization\_level** – + + How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times. + + * 0: no optimization + * 1: light optimization + + Refer to the [Configure runtime compilation for Qiskit Runtime](/run/configure-runtime-compilation). for more information about the optimization levels. + + Default: 1. + +* **resilience\_level** – + + How much resilience to build against errors. Higher levels generate more accurate results, at the expense of longer processing times. + + * 0: No mitigation. + * 1: Minimal mitigation costs. Mitigate error associated with readout errors. + * 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias. + + Refer to the [Configure error mitigation for Qiskit Runtime](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + + Default: 1. + +* **seed\_estimator** – Seed used to control sampling. + +* **dynamical\_decoupling** – Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. + +* **resilience** – Advanced resilience options to fine tune the resilience strategy. See [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2") for all available options. + +* **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + +* **twirling** – Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. + +* **experimental** – Experimental options. + +## Attributes + + + +### default\_precision + +`UnsetType | float` + +`= Unset` + + + +### default\_shots + +`UnsetType | int | None` + +`= Unset` + + + +### dynamical\_decoupling + +`DynamicalDecouplingOptions | Dict` + +`= FieldInfo(annotation=Union[DynamicalDecouplingOptions, Dict], required=False, default_factory=DynamicalDecouplingOptions)` + + + +### environment + +`EnvironmentOptions | Dict` + +`= FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)` + + + +### execution + +`ExecutionOptionsV2 | Dict` + +`= FieldInfo(annotation=Union[ExecutionOptionsV2, Dict], required=False, default_factory=ExecutionOptionsV2)` + + + +### experimental + +`UnsetType | dict` + +`= Unset` + + + +### max\_execution\_time + +`UnsetType | int` + +`= Unset` + + + +### optimization\_level + +`UnsetType | int` + +`= Unset` + + + +### resilience + +`ResilienceOptionsV2 | Dict` + +`= FieldInfo(annotation=Union[ResilienceOptionsV2, Dict], required=False, default_factory=ResilienceOptionsV2)` + + + +### resilience\_level + +`UnsetType | int` + +`= Unset` + + + +### seed\_estimator + +`UnsetType | int` + +`= Unset` + + + +### simulator + +`SimulatorOptions | Dict` + +`= FieldInfo(annotation=Union[SimulatorOptions, Dict], required=False, default_factory=SimulatorOptions)` + + + +### twirling + +`TwirlingOptions | Dict` + +`= FieldInfo(annotation=Union[TwirlingOptions, Dict], required=False, default_factory=TwirlingOptions)` + +## Methods + +### update + + + +`update(**kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py#L106-L111 "view source code") + +Update the options. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.md index 6445cb0e842..185280e59e6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,14 +10,14 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/execution_options.py#L25-L47 "view source code") +`ExecutionOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/execution_options.py#L40-L52 "view source code") -Execution options. +Execution options for V1 primitives. **Parameters** -* **shots** (`int`) – Number of repetitions of each circuit, for sampling. Default: 4000. -* **init\_qubits** (`bool`) – Whether to reset the qubits to the ground state for each shot. Default: `True`. +* **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 @@ -39,15 +39,3 @@ Execution options. ## Methods -### validate\_execution\_options - - - -`static validate_execution_options(execution_options)` - -Validate that execution options are legal. :raises ValueError: if any execution option is not supported - -**Return type** - -`None` - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2.md new file mode 100644 index 00000000000..59ae5a3a542 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ExecutionOptionsV2.md @@ -0,0 +1,41 @@ +--- +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 + + + +`ExecutionOptionsV2(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/execution_options.py#L20-L37 "view source code") + +Execution options for V2 primitives. + +**Parameters** + +* **init\_qubits** – Whether to reset the qubits to the ground state for each shot. Default: `True`. +* **rep\_delay** – The repetition delay. This is the delay between a measurement and the subsequent quantum circuit. This is only supported on backends that have `backend.dynamic_reprate_enabled=True`. It must be from the range supplied by `backend.rep_delay_range`. Default is given by `backend.default_rep_delay`. + +## Attributes + + + +### init\_qubits + +`UnsetType | bool` + +`= Unset` + + + +### rep\_delay + +`UnsetType | float` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.md new file mode 100644 index 00000000000..bf346f668e9 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.md @@ -0,0 +1,63 @@ +--- +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 + + + +`LayerNoiseLearningOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/layer_noise_learning_options.py#L28-L75 "view source code") + +Options for learning layer noise. + + + These options are only used when the resilience level or options specify a technique that requires layer noise learning. + + +**Parameters** + +* **max\_layers\_to\_learn** – The max number of unique layers to learn. A `None` value indicates that there is no limit. If there are more unique layers present, then some layers will not be learned or mitigated. The learned layers are prioritized based on the number of times they occur in a set of run estimator PUBs, and for equally occurring layers are further sorted by the number of two-qubit gates in the layer. +* **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 + +`UnsetType | List[int]` + +`= Unset` + + + +### max\_layers\_to\_learn + +`UnsetType | int | None` + +`= Unset` + + + +### num\_randomizations + +`UnsetType | int` + +`= Unset` + + + +### shots\_per\_randomization + +`UnsetType | int` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.md new file mode 100644 index 00000000000..d636f027b15 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.md @@ -0,0 +1,45 @@ +--- +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 + + + +`MeasureNoiseLearningOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/measure_noise_learning_options.py#L20-L40 "view source code") + +Options for measurement noise learning. + + + These options are only used when the resilience level or options specify a technique that requires measurement noise learning. + + +**Parameters** + +* **num\_randomizations** – The number of random circuits to draw for the measurement learning experiment. Default: 32. +* **shots\_per\_randomization** – The number of shots to use for the learning experiment per random circuit. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + +## Attributes + + + +### num\_randomizations + +`UnsetType | int` + +`= Unset` + + + +### shots\_per\_randomization + +`UnsetType | int | Literal['auto']` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md index 00096b950bc..5d252f85249 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.Options.md @@ -10,9 +10,9 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py#L32-L279 "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py#L172-L404 "view source code") -Options for the primitives. +Options for the primitives, used by V1 primitives. **Parameters** @@ -114,7 +114,7 @@ Options for the primitives. -`static validate_options(options)` +`static validate_options(options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py#L306-L334 "view source code") 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. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.md new file mode 100644 index 00000000000..90743719a6d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.PecOptions.md @@ -0,0 +1,50 @@ +--- +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 + + + +`PecOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/pec_options.py#L20-L41 "view source code") + +Probabalistic error cancellation mitigation options. + +**Parameters** + +* **max\_overhead** – The maximum circuit sampling overhead allowed, or `None` for no maximum. + +* **noise\_gain** – + + The amount by which to scale the noise, where: + + * A value of one corresponds to attempting to remove all of the noise. + * A value greater than one corresponds to injecting noise. + * A value between 0 and 1 corresponds to partially removing the noise. + + If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + +## Attributes + + + +### max\_overhead + +`UnsetType | float | None` + +`= Unset` + + + +### noise\_gain + +`UnsetType | float | Literal['auto']` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.md index 631274aceb3..ec173c2daf4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,16 +10,16 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/resilience_options.py#L34-L91 "view source code") +`ResilienceOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/resilience_options.py#L104-L141 "view source code") -Resilience options. +Resilience options for V1 primitives. **Parameters** -* **noise\_factors** (`Optional`\[`Sequence`\[`float`]]) – 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** (*DEPRECATED*) – A noise amplification strategy. Currently only +* **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** (`Optional`\[`Literal`\[‘LinearExtrapolator’, ‘QuadraticExtrapolator’, ‘CubicExtrapolator’, ‘QuarticExtrapolator’]]) – 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. +* **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 @@ -27,7 +27,7 @@ Resilience options. ### extrapolator -`Literal['LinearExtrapolator', 'QuadraticExtrapolator', 'CubicExtrapolator', 'QuarticExtrapolator']` +`Literal['LinearExtrapolator', 'QuadraticExtrapolator', 'CubicExtrapolator', 'QuarticExtrapolator'] | None` `= None` @@ -35,7 +35,7 @@ Resilience options. ### noise\_amplifier -`Literal['LocalFoldingAmplifier']` +`Literal['LocalFoldingAmplifier'] | None` `= None` @@ -43,21 +43,9 @@ Resilience options. ### noise\_factors -`Sequence[float]` +`Sequence[float] | None` `= None` ## Methods -### validate\_resilience\_options - - - -`static validate_resilience_options(resilience_options)` - -Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. - -**Return type** - -`None` - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.md new file mode 100644 index 00000000000..4f1535dc82b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ResilienceOptionsV2.md @@ -0,0 +1,86 @@ +--- +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 + + + +`ResilienceOptionsV2(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/resilience_options.py#L38-L101 "view source code") + +Resilience options for V2 Estimator. + +**Parameters** + +* **measure\_mitigation** – Whether to enable measurement error mitigation method. Further suboptions are available in [`measure_noise_learning`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning "qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning"). Default: True. +* **measure\_noise\_learning** – Additional measurement noise learning options. See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all options. +* **zne\_mitigation** – Whether to turn on Zero Noise Extrapolation error mitigation method. Further suboptions are available in [`zne`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.zne "qiskit_ibm_runtime.options.ResilienceOptionsV2.zne"). Default: False. +* **zne** – Additional zero noise extrapolation mitigation options. See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for all options. +* **pec\_mitigation** – Whether to turn on Probabilistic Error Cancellation error mitigation method. Further suboptions are available in [`pec`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.pec "qiskit_ibm_runtime.options.ResilienceOptionsV2.pec"). Default: False. +* **pec** – Additional probabalistic error cancellation mitigation options. See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for all options. +* **layer\_noise\_learning** – Layer noise learning options. See [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for all options. + +## Attributes + + + +### layer\_noise\_learning + +`LayerNoiseLearningOptions | Dict` + +`= FieldInfo(annotation=Union[LayerNoiseLearningOptions, Dict], required=False, default_factory=LayerNoiseLearningOptions)` + + + +### measure\_mitigation + +`UnsetType | bool` + +`= Unset` + + + +### measure\_noise\_learning + +`MeasureNoiseLearningOptions | Dict` + +`= FieldInfo(annotation=Union[MeasureNoiseLearningOptions, Dict], required=False, default_factory=MeasureNoiseLearningOptions)` + + + +### pec + +`PecOptions | Dict` + +`= FieldInfo(annotation=Union[PecOptions, Dict], required=False, default_factory=PecOptions)` + + + +### pec\_mitigation + +`UnsetType | bool` + +`= Unset` + + + +### zne + +`ZneOptions | Dict` + +`= FieldInfo(annotation=Union[ZneOptions, Dict], required=False, default_factory=ZneOptions)` + + + +### zne\_mitigation + +`UnsetType | bool` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.md new file mode 100644 index 00000000000..6b01374b19e --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SamplerOptions.md @@ -0,0 +1,95 @@ +--- +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 + + + +`SamplerOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/sampler_options.py#L26-L48 "view source code") + +Options for V2 Sampler. + +**Parameters** + +* **default\_shots** – The default number of shots to use if none are specified in the PUBs or in the run method. Default: 4096. +* **dynamical\_decoupling** – Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. +* **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. +* **experimental** – Experimental options. + +## Attributes + + + +### default\_shots + +`UnsetType | int` + +`= Unset` + + + +### dynamical\_decoupling + +`DynamicalDecouplingOptions | Dict` + +`= FieldInfo(annotation=Union[DynamicalDecouplingOptions, Dict], required=False, default_factory=DynamicalDecouplingOptions)` + + + +### environment + +`EnvironmentOptions | Dict` + +`= FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)` + + + +### execution + +`ExecutionOptionsV2 | Dict` + +`= FieldInfo(annotation=Union[ExecutionOptionsV2, Dict], required=False, default_factory=ExecutionOptionsV2)` + + + +### experimental + +`UnsetType | dict` + +`= Unset` + + + +### max\_execution\_time + +`UnsetType | int` + +`= Unset` + + + +### simulator + +`SimulatorOptions | Dict` + +`= FieldInfo(annotation=Union[SimulatorOptions, Dict], required=False, default_factory=SimulatorOptions)` + +## Methods + +### update + + + +`update(**kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/options.py#L106-L111 "view source code") + +Update the options. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.md index 55e74d69da1..aa31d086398 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L35-L95 "view source code") +`SimulatorOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L33-L105 "view source code") Simulator options. @@ -18,10 +18,10 @@ For best practice in simulating a backend make sure to pass the basis gates and **Parameters** -* **noise\_model** (`Union`\[`dict`, `NoiseModel`, `None`]) – Noise model for the simulator. -* **seed\_simulator** (`Optional`\[`int`]) – Random seed to control sampling. -* **coupling\_map** (`Union`\[`List`\[`List`\[`int`]], `CouplingMap`, `None`]) – Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interactions, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` -* **basis\_gates** (`Optional`\[`List`\[`str`]]) – List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. If `None`, do not unroll. +* **noise\_model** – Noise model for the simulator. +* **seed\_simulator** – Random seed to control sampling. +* **coupling\_map** – Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interactions, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` +* **basis\_gates** – List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set. ## Attributes @@ -29,33 +29,33 @@ For best practice in simulating a backend make sure to pass the basis gates and ### basis\_gates -`List[str] | None` +`UnsetType | List[str]` -`= None` +`= Unset` ### coupling\_map -`List[List[int]] | CouplingMap | None` +`UnsetType | List[List[int]] | CouplingMap` -`= None` +`= Unset` ### noise\_model -`dict | NoiseModel | None` +`UnsetType | dict | NoiseModel | None` -`= None` +`= Unset` ### seed\_simulator -`int | None` +`UnsetType | int` -`= None` +`= Unset` ## Methods @@ -63,7 +63,7 @@ For best practice in simulating a backend make sure to pass the basis gates and -`set_backend(backend)` +`set_backend(backend)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L79-L105 "view source code") Set backend for simulation. This method changes noise\_model, coupling\_map, basis\_gates according to given backend. @@ -73,19 +73,7 @@ Set backend for simulation. This method changes noise\_model, coupling\_map, bas **Raises** -**MissingOptionalLibraryError if qiskit-aer is not found.** – - -**Return type** - -`None` - -### validate\_simulator\_options - - - -`static validate_simulator_options(simulator_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/simulator_options.py#L61-L69 "view source code") - -Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported +**MissingOptionalLibraryError** – if qiskit-aer is not found. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.md index 6d5b35be942..8b3ea8b2fb7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,17 +10,17 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/transpilation_options.py#L41-L97 "view source code") +`TranspilationOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/transpilation_options.py#L38-L75 "view source code") Transpilation options. **Parameters** -* **skip\_transpilation** (`bool`) – Whether to skip transpilation. -* **initial\_layout** (`Union`\[`dict`, `List`, `None`]) – Initial position of virtual qubits on physical qubits. See `qiskit.compiler.transpile` for more information. -* **layout\_method** (`Optional`\[`str`]) – Name of layout selection pass. One of ‘trivial’, ‘dense’, ‘noise\_adaptive’, ‘sabre’. -* **routing\_method** (`Optional`\[`str`]) – Name of routing pass. One of ‘basic’, ‘lookahead’, ‘stochastic’, ‘sabre’, ‘none’. -* **approximation\_degree** (`Optional`\[`float`]) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) +* **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 @@ -28,33 +28,33 @@ Transpilation options. ### approximation\_degree -`float | None` +`UnsetType | float` -`= None` +`= Unset` ### initial\_layout -`dict | List | None` +`UnsetType | dict | List` -`= None` +`= Unset` ### layout\_method -`str | None` +`UnsetType | Literal['trivial', 'dense', 'noise_adaptive', 'sabre']` -`= None` +`= Unset` ### routing\_method -`str | None` +`UnsetType | Literal['basic', 'lookahead', 'stochastic', 'sabre', 'none']` -`= None` +`= Unset` @@ -66,15 +66,3 @@ Transpilation options. ## Methods -### validate\_transpilation\_options - - - -`static validate_transpilation_options(transpilation_options)` - -Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. - -**Return type** - -`None` - diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.md new file mode 100644 index 00000000000..5374dcca83b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.md @@ -0,0 +1,81 @@ +--- +title: TwirlingOptions +description: API reference for qiskit_ibm_runtime.options.TwirlingOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.TwirlingOptions +--- + +# TwirlingOptions + + + +`TwirlingOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/twirling_options.py#L28-L67 "view source code") + +Twirling options. + +**Parameters** + +* **enable\_gates** – Whether to apply 2-qubit gate twirling. Default: False. + +* **enable\_measure** – Whether to enable twirling of expectation value measurements in Estimator. Default: True. + +* **num\_randomizations** – The number of random samples to use when twirling or peforming sampled mitigation. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + +* **shots\_per\_randomization** – The number of shots to run for each random sample. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + +* **strategy** – + + Specify the strategy of twirling qubits in identified layers of 2-qubit twirled gates. Allowed values are + + * If `"active"` only the instruction qubits in each individual twirled layer will be twirled. + * If `"active-circuit"` the union of all instruction qubits in the circuit will be twirled in each twirled layer. + * If `"active-accum"` the union of instructions qubits in the circuit up to the current twirled layer will be twirled in each individual twirled layer. + * If `"all"` all qubits in the input circuit will be twirled in each twirled layer. + + Default: “active-accum”. + +## Attributes + + + +### enable\_gates + +`UnsetType | bool` + +`= Unset` + + + +### enable\_measure + +`UnsetType | bool` + +`= Unset` + + + +### num\_randomizations + +`UnsetType | int | Literal['auto']` + +`= Unset` + + + +### shots\_per\_randomization + +`UnsetType | int | Literal['auto']` + +`= Unset` + + + +### strategy + +`UnsetType | Literal['active', 'active-accum', 'active-circuit', 'all']` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.md new file mode 100644 index 00000000000..e31b3ebd892 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.md @@ -0,0 +1,51 @@ +--- +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 + + + +`ZneOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/options/zne_options.py#L35-L88 "view source code") + +Zero noise extrapolation mitigation options. + +**Parameters** + +* **noise\_factors** – Noise factors to use for noise amplification. Default: (1, 3, 5). + +* **extrapolator** – + + Extrapolator(s) to try (in order) for extrapolating to zero noise. One or more of: + + * ”linear” + * ”exponential” + * ”double\_exponential” + * ”polynomial\_degree\_(1 \<= k \<= 7)” + + Default: (“exponential”, “linear”). + +## Attributes + + + +### extrapolator + +`UnsetType | Literal['linear', 'exponential', 'double_exponential', 'polynomial_degree_1', 'polynomial_degree_2', 'polynomial_degree_3', 'polynomial_degree_4', 'polynomial_degree_5', 'polynomial_degree_6', 'polynomial_degree_7'] | Sequence[Literal['linear', 'exponential', 'double_exponential', 'polynomial_degree_1', 'polynomial_degree_2', 'polynomial_degree_3', 'polynomial_degree_4', 'polynomial_degree_5', 'polynomial_degree_6', 'polynomial_degree_7']]` + +`= Unset` + + + +### noise\_factors + +`UnsetType | Sequence[float]` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index 22faa7b1e3c..430b9c00bbb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -113,7 +113,7 @@ Name of the pass. -`run(dag)` +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L448-L467 "view source code") Run the ASAPSchedule pass on dag. :type dag: `DAGCircuit` :param dag: DAG to schedule. :type dag: DAGCircuit diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index 24b45e7bc3e..88b2321b0f6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -113,7 +113,7 @@ Name of the pass. -`run(dag)` +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L320-L339 "view source code") Run the ALAPSchedule pass on dag. :type dag: `DAGCircuit` :param dag: DAG to schedule. :type dag: DAGCircuit diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md index c5ddc723d56..4c97d2ec75c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md @@ -104,7 +104,7 @@ Name of the pass. -`run(dag)` +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") Run the padding pass on `dag`. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index caf5531747a..1e6f4167806 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L133-L359 "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L133-L323 "view source code") 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. @@ -36,7 +36,7 @@ Dynamic circuit instruction durations. -`classmethod from_backend(backend)` +`classmethod from_backend(backend)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L155-L167 "view source code") Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. @@ -52,7 +52,7 @@ DynamicInstructionDurations -`classmethod from_target(target)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L205-L222 "view source code") +`classmethod from_target(target)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L169-L186 "view source code") Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. @@ -113,7 +113,7 @@ Set of units used in this instruction durations. -`update(inst_durations, dt=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L224-L270 "view source code") +`update(inst_durations, dt=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L188-L234 "view source code") Update self with inst\_durations (inst\_durations overwrite self). Overrides the default durations for certain hardcoded instructions. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md index dfc0ca55b2e..42130f06012 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md @@ -117,7 +117,7 @@ Name of the pass. -`run(dag)` +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") Run the padding pass on `dag`. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md index 2607ee0b6fe..da11c856cff 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -253,7 +253,7 @@ Name of the pass. -`run(dag)` +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/main/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") Run the padding pass on `dag`. diff --git a/docs/api/qiskit-ibm-runtime/dev/runtime_service.md b/docs/api/qiskit-ibm-runtime/dev/runtime_service.md index 9c91dfe440a..664a47067eb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/runtime_service.md +++ b/docs/api/qiskit-ibm-runtime/dev/runtime_service.md @@ -29,41 +29,49 @@ Qiskit Runtime also has the concept of a session. Jobs submitted within a sessio Below is an example of using primitives within a session: ```python -from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler, Estimator, Options +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() -# Set options, which can be overwritten at job level. -options = Options(optimization_level=3) - # 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="qc") +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=service, backend="ibmq_qasm_simulator") as session: +backend = service.least_busy(operational=True, simulator=False) +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, options=options) - job = sampler.run(circuits=qc) - print(f"Sampler results: {job.result()}") + 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, options=options) + estimator = Estimator(session=session) + estimator.options.resilience_level = 1 # Set options. job = estimator.run( - circuits=[psi], observables=[H1], parameter_values=[theta] + [(psi_isa_circuit, isa_observables, theta)] ) - print(f"Estimator results: {job.result()}") + pub_result = job.result()[0] + print(f"Expectation values: {pub_result.data.evs}") ``` ## Backend data @@ -103,44 +111,21 @@ import logging logging.getLogger('qiskit_ibm_runtime').setLevel(logging.WARNING) ``` -### Interim and final results - -Some runtime primitives provide interim results that inform you about the progress of your job. You can choose to stream the interim results and final result when you run the program by passing in the `callback` parameter, or at a later time using the [`RuntimeJob.stream_results()`](qiskit_ibm_runtime.RuntimeJob#stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") method. For example: - -```python -from qiskit_ibm_runtime import QiskitRuntimeService, Sampler -from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister - -service = QiskitRuntimeService() -backend = service.backend("ibmq_qasm_simulator") - -# Bell Circuit -qr = QuantumRegister(2, name="qr") -cr = ClassicalRegister(2, name="qc") -qc = QuantumCircuit(qr, cr, name="bell") -qc.h(qr[0]) -qc.cx(qr[0], qr[1]) -qc.measure(qr, cr) - -def result_callback(job_id, result): - print(result) - -# Stream results as soon as the job starts running. -job = Sampler(backend).run(qc, callback=result_callback) -print(job.result()) -``` - ## 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")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | -| [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler")(\[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 flexible Qiskit Runtime session. | -| [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend")(configuration, service, api\_client) | Backend class interfacing with an IBM Quantum backend. | -| [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob")(backend, api\_client, ...\[, ...]) | Representation of a runtime program execution. | -| [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions")(\[backend, image, log\_level, ...]) | Class for representing generic runtime execution options. | -| [`RuntimeEncoder`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, ...]) | JSON Encoder used by runtime service. | -| [`RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService")(\[channel, token, url, ...]) | Class for interacting with the Qiskit Runtime service. | +| [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") | alias of [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1") | +| [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.EstimatorV1")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | +| [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.EstimatorV2")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | +| [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") | alias of [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.sampler.SamplerV1") | +| [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.SamplerV1")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Sampler primitive service. | +| [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.SamplerV2")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Sampler primitive service. | +| [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session")(\[service, backend, max\_time]) | Class for creating a Qiskit Runtime session. | +| [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend")(configuration, service, api\_client) | Backend class interfacing with an IBM Quantum backend. | +| [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob")(backend, api\_client, ...\[, ...]) | Representation of a runtime program execution. | +| [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions")(\[backend, image, log\_level, ...]) | Class for representing generic runtime execution options. | +| [`RuntimeEncoder`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, ...]) | JSON Encoder used by runtime service. | +| [`RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | diff --git a/docs/api/qiskit-ibm-runtime/fake_provider.md b/docs/api/qiskit-ibm-runtime/fake_provider.md index 65438b4c0fb..a445dd8f227 100644 --- a/docs/api/qiskit-ibm-runtime/fake_provider.md +++ b/docs/api/qiskit-ibm-runtime/fake_provider.md @@ -90,6 +90,7 @@ Fake V2 backends are fake backends with IBM Quantum systems snapshots implemente | | | | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | +| [`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. | @@ -97,18 +98,23 @@ Fake V2 backends are fake backends with IBM Quantum systems snapshots implemente | [`FakeBelemV2`](qiskit_ibm_runtime.fake_provider.FakeBelemV2 "qiskit_ibm_runtime.fake_provider.FakeBelemV2")() | A fake 5 qubit backend. | | [`FakeBoeblingenV2`](qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 "qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2")() | A fake Boeblingen V2 backend. | | [`FakeBogotaV2`](qiskit_ibm_runtime.fake_provider.FakeBogotaV2 "qiskit_ibm_runtime.fake_provider.FakeBogotaV2")() | A fake 5 qubit backend. | +| [`FakeBrisbane`](qiskit_ibm_runtime.fake_provider.FakeBrisbane "qiskit_ibm_runtime.fake_provider.FakeBrisbane")() | A fake 127 qubit backend. | | [`FakeBrooklynV2`](qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 "qiskit_ibm_runtime.fake_provider.FakeBrooklynV2")() | A fake Brooklyn V2 backend. | | [`FakeBurlingtonV2`](qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 "qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2")() | A fake 5 qubit backend. | | [`FakeCairoV2`](qiskit_ibm_runtime.fake_provider.FakeCairoV2 "qiskit_ibm_runtime.fake_provider.FakeCairoV2")() | A fake 27 qubit backend. | | [`FakeCambridgeV2`](qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 "qiskit_ibm_runtime.fake_provider.FakeCambridgeV2")() | A fake Cambridge backend. | | [`FakeCasablancaV2`](qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 "qiskit_ibm_runtime.fake_provider.FakeCasablancaV2")() | A fake 7 qubit backend. | +| [`FakeCusco`](qiskit_ibm_runtime.fake_provider.FakeCusco "qiskit_ibm_runtime.fake_provider.FakeCusco")() | A fake 127 qubit backend. | | [`FakeEssexV2`](qiskit_ibm_runtime.fake_provider.FakeEssexV2 "qiskit_ibm_runtime.fake_provider.FakeEssexV2")() | A fake 5 qubit backend. | | [`FakeGeneva`](qiskit_ibm_runtime.fake_provider.FakeGeneva "qiskit_ibm_runtime.fake_provider.FakeGeneva")() | A fake 27 qubit backend. | | [`FakeGuadalupeV2`](qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 "qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2")() | A fake 16 qubit backend. | | [`FakeHanoiV2`](qiskit_ibm_runtime.fake_provider.FakeHanoiV2 "qiskit_ibm_runtime.fake_provider.FakeHanoiV2")() | A fake 27 qubit backend. | | [`FakeJakartaV2`](qiskit_ibm_runtime.fake_provider.FakeJakartaV2 "qiskit_ibm_runtime.fake_provider.FakeJakartaV2")() | A fake 7 qubit V2 backend. | | [`FakeJohannesburgV2`](qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 "qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2")() | A fake Johannesburg V2 backend. | +| [`FakeKawasaki`](qiskit_ibm_runtime.fake_provider.FakeKawasaki "qiskit_ibm_runtime.fake_provider.FakeKawasaki")() | A fake 127 qubit backend. | | [`FakeKolkataV2`](qiskit_ibm_runtime.fake_provider.FakeKolkataV2 "qiskit_ibm_runtime.fake_provider.FakeKolkataV2")() | A fake 27 qubit backend. | +| [`FakeKyiv`](qiskit_ibm_runtime.fake_provider.FakeKyiv "qiskit_ibm_runtime.fake_provider.FakeKyiv")() | A fake 127 qubit backend. | +| [`FakeKyoto`](qiskit_ibm_runtime.fake_provider.FakeKyoto "qiskit_ibm_runtime.fake_provider.FakeKyoto")() | A fake 127 qubit backend. | | [`FakeLagosV2`](qiskit_ibm_runtime.fake_provider.FakeLagosV2 "qiskit_ibm_runtime.fake_provider.FakeLagosV2")() | A fake 7 qubit backend. | | [`FakeLimaV2`](qiskit_ibm_runtime.fake_provider.FakeLimaV2 "qiskit_ibm_runtime.fake_provider.FakeLimaV2")() | A fake 5 qubit backend. | | [`FakeLondonV2`](qiskit_ibm_runtime.fake_provider.FakeLondonV2 "qiskit_ibm_runtime.fake_provider.FakeLondonV2")() | A fake 5 qubit backend. | @@ -118,12 +124,15 @@ Fake V2 backends are fake backends with IBM Quantum systems snapshots implemente | [`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. | @@ -131,6 +140,7 @@ Fake V2 backends are fake backends with IBM Quantum systems snapshots implemente | [`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. | diff --git a/docs/api/qiskit-ibm-runtime/options.md b/docs/api/qiskit-ibm-runtime/options.md index 5d3a56bc888..c3de6e01159 100644 --- a/docs/api/qiskit-ibm-runtime/options.md +++ b/docs/api/qiskit-ibm-runtime/options.md @@ -18,7 +18,39 @@ python_api_name: qiskit_ibm_runtime.options Options that can be passed to the primitives. -The [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options") class encapsulates all the options you can specify when invoking a 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: +**V2 Primitives** + +`SamplerV2` and `EstimatorV2` each have their own options. You can use the `options` attribute to set the options. For example: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) +estimator = EstimatorV2(backend=backend) +estimator.options.resilience_level = 1 +``` + +You can also use the `update()` method to do bulk update. For example: + +```python +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) +estimator = EstimatorV2(backend=backend) +estimator.options.update(resilience_level=1) +``` + +Refer to [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.SamplerOptions") and [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.EstimatorOptions") for V2 Sampler and V2 Estimator options, respectively. + + + If an option is not specified, the server default value is used. The default values are subject to change. See the [API Reference](/api/qiskit-ibm-runtime/options) for the most up-to-date default values. + + +**V1 Primitives** + +The [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options") class encapsulates all the options you can specify when invoking a V1 primitive. It includes frequently used options, such as `optimization_level` and `resilience_level` as well as sub-categories, such as `transpilation` and `execution`. You can use auto-complete to easily find the options inside each sub-category, for example: ```python from qiskit_ibm_runtime.options import Options @@ -37,12 +69,22 @@ options = Options(transpilation={"initial_layout": [0, 1, 2, 3]}) ## Classes -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for the primitives. | -| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\[skip\_transpilation, ...]) | Transpilation options. | -| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\[noise\_amplifier, ...]) | Resilience options. | -| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\[shots, init\_qubits]) | Execution options. | -| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\[log\_level, callback, ...]) | Options related to the execution environment. | -| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\[noise\_model, ...]) | Simulator 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. | +| [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions")(\*args, \*\*kwargs) | Options for dynamical decoupling (DD). | +| [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2")(\*args, \*\*kwargs) | Resilience options for V2 Estimator. | +| [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions")(\*args, \*\*kwargs) | Options for learning layer noise. | +| [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions")(\*args, \*\*kwargs) | Options for measurement noise learning. | +| [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions")(\*args, \*\*kwargs) | Probabalistic error cancellation mitigation options. | +| [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions")(\*args, \*\*kwargs) | Zero noise extrapolation mitigation options. | +| [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions")(\*args, \*\*kwargs) | Twirling options. | +| [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2")(\*args, \*\*kwargs) | Execution options for V2 primitives. | +| [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.Options")(\[optimization\_level, ...]) | Options for the primitives, used by V1 primitives. | +| [`TranspilationOptions`](qiskit_ibm_runtime.options.TranspilationOptions "qiskit_ibm_runtime.options.TranspilationOptions")(\*args, \*\*kwargs) | Transpilation options. | +| [`ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions")(\*args, \*\*kwargs) | Resilience options for V1 primitives. | +| [`ExecutionOptions`](qiskit_ibm_runtime.options.ExecutionOptions "qiskit_ibm_runtime.options.ExecutionOptions")(\*args, \*\*kwargs) | Execution options for V1 primitives. | +| [`EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "qiskit_ibm_runtime.options.EnvironmentOptions")(\*args, \*\*kwargs) | Options related to the execution environment. | +| [`SimulatorOptions`](qiskit_ibm_runtime.options.SimulatorOptions "qiskit_ibm_runtime.options.SimulatorOptions")(\*args, \*\*kwargs) | Simulator options. | diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md index edae11af4a4..a3c48ac6919 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Estimator.md @@ -2,144 +2,11 @@ title: Estimator description: API reference for qiskit_ibm_runtime.Estimator in_page_toc_min_heading_level: 1 -python_api_type: class +python_api_type: attribute python_api_name: qiskit_ibm_runtime.Estimator --- # Estimator - - -`Estimator(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/estimator.py#L36-L219 "view source code") - -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.Estimator.run "qiskit_ibm_runtime.Estimator.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, and data is cached for efficiency. - -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** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – - - 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. - -**Return type** - -`Options` - -**Returns** - -options - - - -### session - -Return session used by this primitive. - -**Return type** - -`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] - -**Returns** - -Session used by this primitive, or `None` if session is not used. - -## Methods - -### run - - - -`run(circuits, observables, parameter_values=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/estimator.py#L114-L148 "view source code") - -Submit a request to the estimator primitive. - -**Parameters** - -* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – a (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. -* **observables** (*BaseOperator | Sequence\[BaseOperator]*) – Observable objects. -* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. -* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). - -**Return type** - -[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") - -**Returns** - -Submitted job. The result of the job is an instance of `qiskit.primitives.EstimatorResult`. - -**Raises** - -**ValueError** – Invalid arguments are given. - -### set\_options - - - -`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/base_primitive.py#L216-L222 "view source code") - -Set options values for the sampler. - -**Parameters** - -**\*\*fields** – The fields to update the options - -**Return type** - -`None` +alias of [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1") diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.md new file mode 100644 index 00000000000..1b9e1dd18fa --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV1.md @@ -0,0 +1,143 @@ +--- +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 + + + +`EstimatorV1(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/estimator.py#L180-L362 "view source code") + +Class for interacting with Qiskit Runtime Estimator primitive service. + +Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. + +The [`run()`](#qiskit_ibm_runtime.EstimatorV1.run "qiskit_ibm_runtime.EstimatorV1.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. + +You are encouraged to use [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") to open a session, during which you can invoke one or more primitives. Jobs submitted within a session are prioritized by the scheduler. + +Example: + +```python +from qiskit.circuit.library import RealAmplitudes +from qiskit.quantum_info import SparsePauliOp + +from qiskit_ibm_runtime import QiskitRuntimeService, Estimator + +service = QiskitRuntimeService(channel="ibm_cloud") + +psi1 = RealAmplitudes(num_qubits=2, reps=2) + +H1 = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) +H2 = SparsePauliOp.from_list([("IZ", 1)]) +H3 = SparsePauliOp.from_list([("ZI", 1), ("ZZ", 1)]) + +with Session(service=service, backend="ibmq_qasm_simulator") as session: + estimator = Estimator(session=session) + + theta1 = [0, 1, 1, 2, 3, 5] + + # calculate [ ] + psi1_H1 = estimator.run(circuits=[psi1], observables=[H1], parameter_values=[theta1]) + print(psi1_H1.result()) + + # calculate [ , ] + psi1_H23 = estimator.run( + circuits=[psi1, psi1], + observables=[H2, H3], + parameter_values=[theta1]*2 + ) + print(psi1_H23.result()) +``` + +Initializes the Estimator primitive. + +**Parameters** + +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + +* **session** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + Session in which to call the primitive. + + If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected. + +* **options** (`Union`\[`Dict`, [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.options.Options"), `None`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + +## Attributes + + + +### options + +Return options values for the sampler. :rtype: `Options` :returns: options + + + +### session + +Return session used by this primitive. + +**Return type** + +`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + +**Returns** + +Session used by this primitive, or `None` if session is not used. + + + +### version + +`= 1` + +## Methods + +### run + + + +`run(circuits, observables, parameter_values=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/estimator.py#L257-L291 "view source code") + +Submit a request to the estimator primitive. + +**Parameters** + +* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – a (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. +* **observables** (*Sequence\[BaseOperator | str] | BaseOperator | str*) – Observable objects. +* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. +* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). + +**Return type** + +[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") + +**Returns** + +Submitted job. The result of the job is an instance of `qiskit.primitives.EstimatorResult`. + +**Raises** + +**ValueError** – Invalid arguments are given. + +### set\_options + + + +`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/base_primitive.py#L402-L410 "view source code") + +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/qiskit_ibm_runtime.EstimatorV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.md new file mode 100644 index 00000000000..7e56473f2f6 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.EstimatorV2.md @@ -0,0 +1,127 @@ +--- +title: EstimatorV2 +description: API reference for qiskit_ibm_runtime.EstimatorV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.EstimatorV2 +--- + +# EstimatorV2 + + + +`EstimatorV2(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/estimator.py#L48-L177 "view source code") + +Class for interacting with Qiskit Runtime Estimator primitive service. + +Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. + +The [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") can be used to submit circuits, observables, and parameters to the Estimator primitive. + +Following construction, an estimator is used by calling its [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") method with a list of PUBs (Primitive Unified Blocs). Each PUB contains four values that, together, define a computation unit of work for the estimator to complete: + +* a single `QuantumCircuit`, possibly parametrized, whose final state we define as $\psi(\theta)$, +* one or more observables (specified as any `ObservablesArrayLike`, including `Pauli`, `SparsePauliOp`, `str`) that specify which expectation values to estimate, denoted $H_j$, and +* a collection parameter value sets to bind the circuit against, $\theta_k$. +* an optional target precision for expectation value estimates. + +Here is an example of how the estimator is used. + +```python +from qiskit.circuit.library import RealAmplitudes +from qiskit.quantum_info import SparsePauliOp +from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager +from qiskit_ibm_runtime import QiskitRuntimeService, EstimatorV2 as Estimator + +service = QiskitRuntimeService() +backend = service.least_busy(operational=True, simulator=False) + +psi = RealAmplitudes(num_qubits=2, reps=2) +hamiltonian = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) +theta = [0, 1, 1, 2, 3, 5] + +pm = generate_preset_pass_manager(backend=backend, optimization_level=1) +isa_psi = pm.run(psi) +isa_observables = hamiltonian.apply_layout(isa_psi.layout) + +estimator = Estimator(backend=backend) + +# calculate [ ] +job = estimator.run([(isa_psi, isa_observables, [theta])]) +pub_result = job.result()[0] +print(f"Expectation values: {pub_result.data.evs}") +``` + +Initializes the Estimator primitive. + +**Parameters** + +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + +* **session** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + 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`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + +**Raises** + +**NotImplementedError** – If “q-ctrl” channel strategy is used. + +## Attributes + + + +### options + +Return options + +**Return type** + +`TypeVar`(`OptionsT`, bound= `BaseOptions`) + + + +### session + +Return session used by this primitive. + +**Return type** + +`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + +**Returns** + +Session used by this primitive, or `None` if session is not used. + + + +### version + +`= 2` + +## Methods + +### run + + + +`run(pubs, *, precision=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/estimator.py#L137-L154 "view source code") + +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 + +**Returns** + +Submitted job. + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md index e00db922b50..6d1c306c332 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.IBMBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend -`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L75-L856 "view source code") +`IBMBackend(configuration, service, api_client, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L75-L856 "view source code") Backend class interfacing with an IBM Quantum backend. @@ -352,7 +352,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`__call__()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L506-L508 "view source code") +`__call__()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L506-L508 "view source code") Call self as a function. @@ -364,7 +364,7 @@ Call self as a function. -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L480-L486 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L480-L486 "view source code") Return the acquisition channel for the given qubit. @@ -380,7 +380,7 @@ AcquireChannel -`cancel_session()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L839-L846 "view source code") +`cancel_session()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L839-L846 "view source code") Cancel session. All pending jobs will be cancelled. @@ -392,7 +392,7 @@ Cancel session. All pending jobs will be cancelled. -`check_faulty(circuit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L530-L562 "view source code") +`check_faulty(circuit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L530-L562 "view source code") Check if the input circuit uses faulty qubits or edges. @@ -412,7 +412,7 @@ Check if the input circuit uses faulty qubits or edges. -`close_session()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L848-L856 "view source code") +`close_session()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L848-L856 "view source code") 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. @@ -424,7 +424,7 @@ Close the session so new jobs will no longer be accepted, but existing queued or -`configuration()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L447-L462 "view source code") +`configuration()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L447-L462 "view source code") Return the backend configuration. @@ -444,7 +444,7 @@ The configuration for the backend. -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L488-L501 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L488-L501 "view source code") Return the secondary drive channel for the given qubit @@ -466,7 +466,7 @@ List\[ControlChannel] -`defaults(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L424-L445 "view source code") +`defaults(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L424-L445 "view source code") Return the pulse defaults for the backend. @@ -488,7 +488,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L464-L470 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L464-L470 "view source code") Return the drive channel for the given qubit. @@ -504,7 +504,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L472-L478 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L472-L478 "view source code") Return the measure stimulus channel for the given qubit. @@ -520,7 +520,7 @@ MeasureChannel -`open_session(max_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L823-L832 "view source code") +`open_session(max_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L823-L832 "view source code") Open session @@ -532,7 +532,7 @@ Open session -`properties(refresh=False, datetime=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L348-L398 "view source code") +`properties(refresh=False, datetime=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L348-L398 "view source code") Return the backend properties, subject to optional filtering. @@ -588,7 +588,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L582-L739 "view source code") +`run(circuits, dynamic=None, job_tags=None, init_circuit=None, init_num_resets=None, header=None, shots=None, memory=None, meas_level=None, meas_return=None, rep_delay=None, init_qubits=None, use_measure_esp=None, noise_model=None, seed_simulator=None, **run_config)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L582-L739 "view source code") 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. @@ -681,7 +681,7 @@ This method is used to update the options of a backend. If you need to change an -`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L400-L422 "view source code") +`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L400-L422 "view source code") Return the backend status. @@ -705,7 +705,7 @@ The status of the backend. -`target_history(datetime=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/ibm_backend.py#L338-L346 "view source code") +`target_history(datetime=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/ibm_backend.py#L338-L346 "view source code") A `qiskit.transpiler.Target` object for the backend. :rtype: `Target` :returns: Target with properties found on datetime diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md index 0e636261475..0f226d08c3d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.QiskitRuntimeService.md @@ -10,59 +10,10 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService -`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L64-L1219 "view source code") +`QiskitRuntimeService(channel=None, token=None, url=None, filename=None, name=None, instance=None, proxies=None, verify=None, channel_strategy=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L65-L1177 "view source code") Class for interacting with the Qiskit Runtime service. -Qiskit Runtime is a new architecture offered by IBM Quantum that streamlines computations requiring many iterations. These experiments will execute significantly faster within its improved hybrid quantum/classical process. - -A sample workflow of using the runtime service: - -```python -from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler, Estimator, Options -from qiskit.circuit.library import RealAmplitudes -from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister -from qiskit.quantum_info import SparsePauliOp - -# Initialize account. -service = QiskitRuntimeService() - -# Set options, which can be overwritten at job level. -options = Options(optimization_level=1) - -# 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) - -with Session(service=service, backend="ibmq_qasm_simulator") as session: - # Submit a request to the Sampler primitive within the session. - sampler = Sampler(session=session, options=options) - job = sampler.run(circuits=qc) - print(f"Sampler results: {job.result()}") - - # Submit a request to the Estimator primitive within the session. - estimator = Estimator(session=session, options=options) - job = estimator.run( - circuits=[psi], observables=[H1], parameter_values=[theta] - ) - print(f"Estimator results: {job.result()}") -``` - -The example above uses the dedicated [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") and [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") classes. You can also use the [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method directly to invoke a Qiskit Runtime program. - -If the program has any interim results, you can use the `callback` parameter of the [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method to stream the interim results. Alternatively, you can use the [`RuntimeJob.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. - -The [`run()`](#qiskit_ibm_runtime.QiskitRuntimeService.run "qiskit_ibm_runtime.QiskitRuntimeService.run") method returns a [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") object. You can use its methods to perform tasks like checking job status, getting job result, and canceling job. - QiskitRuntimeService constructor An account is selected in the following order: @@ -141,7 +92,7 @@ self -`active_account()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L708-L714 "view source code") +`active_account()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L649-L655 "view source code") Return the IBM Quantum account currently in use for the session. @@ -157,7 +108,7 @@ A dictionary with information about the account currently in the session. -`backend(name=None, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L817-L847 "view source code") +`backend(name=None, instance=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L758-L788 "view source code") Return a single backend matching the specified filtering. @@ -182,7 +133,7 @@ Backend -`backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L544-L652 "view source code") +`backends(name=None, min_num_qubits=None, instance=None, dynamic_circuits=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L486-L593 "view source code") Return all backends accessible via this account, subject to optional filtering. @@ -241,7 +192,7 @@ The list of available backends that match the filter. -`static delete_account(filename=None, name=None, channel=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L716-L734 "view source code") +`static delete_account(filename=None, name=None, channel=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L657-L675 "view source code") Delete a saved account from disk. @@ -263,7 +214,7 @@ True if the account was deleted. False if no account was found. -`delete_job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L1077-L1094 "view source code") +`delete_job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L1035-L1052 "view source code") Delete a runtime job. @@ -286,7 +237,7 @@ Note that this operation cannot be reversed. -`get_backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L849-L850 "view source code") +`get_backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L790-L791 "view source code") Return a single backend matching the specified filtering. @@ -311,7 +262,7 @@ Backend -`instances()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L1184-L1192 "view source code") +`instances()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L1142-L1150 "view source code") Return the IBM Quantum instances list currently in use for the session. @@ -327,7 +278,7 @@ A list with instances currently in the session. -`job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L960-L979 "view source code") +`job(job_id)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L918-L937 "view source code") Retrieve a runtime job. @@ -337,7 +288,7 @@ Retrieve a runtime job. **Return type** -[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") +`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), `RuntimeJobV2`] **Returns** @@ -352,7 +303,7 @@ Runtime job retrieved. -`jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L981-L1075 "view source code") +`jobs(limit=10, skip=0, backend_name=None, pending=None, program_id=None, instance=None, job_tags=None, session_id=None, created_after=None, created_before=None, descending=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L939-L1033 "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -372,7 +323,7 @@ Retrieve all runtime jobs, subject to optional filtering. **Return type** -`List`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob")] +`List`\[`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), `RuntimeJobV2`]] **Returns** @@ -386,7 +337,7 @@ A list of runtime jobs. -`least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L1147-L1182 "view source code") +`least_busy(min_num_qubits=None, instance=None, filters=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L1105-L1140 "view source code") Return the least busy available backend. @@ -420,7 +371,7 @@ The backend with the fewest number of pending jobs. -`run(program_id, inputs, options=None, callback=None, result_decoder=None, session_id=None, start_session=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L852-L958 "view source code") +`run(program_id, inputs, options=None, callback=None, result_decoder=None, session_id=None, start_session=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L793-L916 "view source code") Execute the runtime program. @@ -447,7 +398,7 @@ Execute the runtime program. **Return type** -[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") +`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), `RuntimeJobV2`] **Returns** @@ -463,7 +414,7 @@ A `RuntimeJob` instance representing the execution. -`static save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, channel_strategy=None, set_as_default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L736-L785 "view source code") +`static save_account(token=None, url=None, instance=None, channel=None, filename=None, name=None, proxies=None, verify=None, overwrite=False, channel_strategy=None, set_as_default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L677-L726 "view source code") Save the account to disk for future use. @@ -489,7 +440,7 @@ Save the account to disk for future use. -`static saved_accounts(default=None, channel=None, filename=None, name=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/qiskit_runtime_service.py#L787-L815 "view source code") +`static saved_accounts(default=None, channel=None, filename=None, name=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/qiskit_runtime_service.py#L728-L756 "view source code") List the accounts saved on disk. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md index 2a367574489..3db3f583788 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeDecoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py#L282-L343 "view source code") +`RuntimeDecoder(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/utils/json.py#L332-L424 "view source code") JSON Decoder used by runtime service. @@ -40,7 +40,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`object_hook(obj)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py#L297-L343 "view source code") +`object_hook(obj)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/utils/json.py#L347-L424 "view source code") Called to decode object. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md index fc1b85bba7e..4e3c707ed16 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeEncoder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py#L196-L279 "view source code") +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/utils/json.py#L207-L329 "view source code") JSON Encoder used by runtime service. @@ -52,7 +52,7 @@ If specified, default is a function that gets called for objects that can’t ot -`default(obj)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/utils/json.py#L199-L279 "view source code") +`default(obj)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/utils/json.py#L210-L329 "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md index 861646b4459..d33aad38e3c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob -`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L55-L752 "view source code") +`RuntimeJob(backend, api_client, client_params, job_id, program_id, service, params=None, creation_date=None, user_callback=None, result_decoder=None, image='', session_id=None, tags=None, version=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L45-L416 "view source code") Representation of a runtime program execution. @@ -49,6 +49,7 @@ RuntimeJob constructor. * **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 @@ -162,7 +163,7 @@ Return the usage estimation infromation for this job. -`backend(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L251-L265 "view source code") +`backend(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L352-L366 "view source code") Return the backend where this job was executed. Retrieve data again if backend is None. @@ -178,7 +179,7 @@ Return the backend where this job was executed. Retrieve data again if backend i -`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L235-L249 "view source code") +`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L172-L186 "view source code") Cancel the job. @@ -195,7 +196,7 @@ Cancel the job. -`cancel_result_streaming()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L352-L356 "view source code") +`cancel_result_streaming()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/base_runtime_job.py#L149-L153 "view source code") Cancel result streaming. @@ -231,7 +232,7 @@ Return whether the job has successfully run. -`error_message()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L276-L283 "view source code") +`error_message()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/base_runtime_job.py#L212-L219 "view source code") Returns the reason if the job failed. @@ -243,11 +244,23 @@ Returns the reason if the job failed. Error message string or `None`. +### errored + + + +`errored()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L201-L203 "view source code") + +Return whether the job has failed. + +**Return type** + +`bool` + ### in\_final\_state -`in_final_state()` +`in_final_state()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L197-L199 "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -259,7 +272,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`interim_results(decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L178-L196 "view source code") +`interim_results(decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L398-L416 "view source code") Return the interim results of the job. @@ -295,7 +308,7 @@ Return a unique id identifying the job. -`logs()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L358-L377 "view source code") +`logs()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L294-L313 "view source code") Return job logs. @@ -319,7 +332,7 @@ Job logs, including standard output and error. -`metrics()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L379-L391 "view source code") +`metrics()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/base_runtime_job.py#L155-L167 "view source code") Return job metrics. @@ -339,7 +352,7 @@ Job metrics, which includes timestamp information. -`properties(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L436-L448 "view source code") +`properties(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/base_runtime_job.py#L198-L210 "view source code") Return the backend properties for this job. @@ -359,7 +372,7 @@ The backend properties used for this job, at the time the job was run, or `None` -`queue_info()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L720-L752 "view source code") +`queue_info()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L260-L292 "view source code") Return queue information for this job. @@ -381,7 +394,7 @@ A `QueueInfo` instance that contains queue information for this job, or `None` i -`queue_position(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L693-L718 "view source code") +`queue_position(refresh=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L233-L258 "view source code") Return the position of the job in the server queue. @@ -405,7 +418,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`result(timeout=None, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L198-L233 "view source code") +`result(timeout=None, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L135-L170 "view source code") Return the results of the job. @@ -444,7 +457,7 @@ Return whether the job is actively running. -`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L267-L274 "view source code") +`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L188-L195 "view source code") Return the status of the job. @@ -460,7 +473,7 @@ Status of this job. -`stream_results(callback, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L322-L350 "view source code") +`stream_results(callback, decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L368-L396 "view source code") Start streaming job results. @@ -487,7 +500,7 @@ Start streaming job results. -`submit()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L393-L405 "view source code") +`submit()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L219-L231 "view source code") Unsupported method. .. note: @@ -509,7 +522,7 @@ to submit a job. -`update_tags(new_tags)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L407-L434 "view source code") +`update_tags(new_tags)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/base_runtime_job.py#L169-L196 "view source code") Update the tags associated with this job. @@ -533,7 +546,7 @@ The new tags associated with this job. -`wait_for_final_state(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_job.py#L285-L320 "view source code") +`wait_for_final_state(timeout=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_job.py#L315-L350 "view source code") Use the websocket server to wait for the final the state of a job. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md index 650a2a9aaec..135f1dffdc9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.RuntimeOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeOptions -`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_options.py#L24-L106 "view source code") +`RuntimeOptions(backend=None, image=None, log_level=None, instance=None, job_tags=None, max_execution_time=None, session_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_options.py#L24-L106 "view source code") Class for representing generic runtime execution options. @@ -90,7 +90,7 @@ RuntimeOptions constructor. -`validate(channel)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/runtime_options.py#L76-L106 "view source code") +`validate(channel)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/runtime_options.py#L76-L106 "view source code") Validate options. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md index e0d643f5588..b3d8fab78d7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Sampler.md @@ -2,135 +2,11 @@ title: Sampler description: API reference for qiskit_ibm_runtime.Sampler in_page_toc_min_heading_level: 1 -python_api_type: class +python_api_type: attribute python_api_name: qiskit_ibm_runtime.Sampler --- # Sampler - - -`Sampler(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/sampler.py#L35-L184 "view source code") - -Class for interacting with Qiskit Runtime Sampler primitive service. - -Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. - -The [`run()`](#qiskit_ibm_runtime.Sampler.run "qiskit_ibm_runtime.Sampler.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, and data is cached for efficiency. - -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** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – - - 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. - -**Return type** - -`Options` - -**Returns** - -options - - - -### session - -Return session used by this primitive. - -**Return type** - -`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] - -**Returns** - -Session used by this primitive, or `None` if session is not used. - -## Methods - -### run - - - -`run(circuits, parameter_values=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/sampler.py#L102-L130 "view source code") - -Submit a request to the sampler primitive. - -**Parameters** - -* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – A (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. -* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. -* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). - -**Return type** - -[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") - -**Returns** - -Submitted job. The result of the job is an instance of `qiskit.primitives.SamplerResult`. - -**Raises** - -**ValueError** – Invalid arguments are given. - -### set\_options - - - -`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/base_primitive.py#L216-L222 "view source code") - -Set options values for the sampler. - -**Parameters** - -**\*\*fields** – The fields to update the options - -**Return type** - -`None` +alias of [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.sampler.SamplerV1") diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.md new file mode 100644 index 00000000000..72375847baf --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV1.md @@ -0,0 +1,134 @@ +--- +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 + + + +`SamplerV1(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/sampler.py#L140-L290 "view source code") + +Class for interacting with Qiskit Runtime Sampler primitive service. + +Qiskit Runtime Sampler primitive service calculates quasi-probability distribution of bitstrings from quantum circuits. + +The [`run()`](#qiskit_ibm_runtime.SamplerV1.run "qiskit_ibm_runtime.SamplerV1.run") method can be used to submit circuits and parameters to the Sampler primitive. + +You are encouraged to use [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") to open a session, during which you can invoke one or more primitives. Jobs submitted within a session are prioritized by the scheduler. + +Example: + +```python +from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister +from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler + +service = QiskitRuntimeService(channel="ibm_cloud") + +# Bell Circuit +qr = QuantumRegister(2, name="qr") +cr = ClassicalRegister(2, name="cr") +qc = QuantumCircuit(qr, cr, name="bell") +qc.h(qr[0]) +qc.cx(qr[0], qr[1]) +qc.measure(qr, cr) + +with Session(service, backend="ibmq_qasm_simulator") as session: + sampler = Sampler(session=session) + + job = sampler.run(qc, shots=1024) + print(f"Job ID: {job.job_id()}") + print(f"Job result: {job.result()}") + + # You can run more jobs inside the session +``` + +Initializes the Sampler primitive. + +**Parameters** + +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + +* **session** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + Session in which to call the primitive. + + If both `session` and `backend` are specified, `session` takes precedence. If neither is specified, and the primitive is created inside a [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") context manager, then the session is used. Otherwise if IBM Cloud channel is used, a default backend is selected. + +* **options** (`Union`\[`Dict`, [`Options`](qiskit_ibm_runtime.options.Options "qiskit_ibm_runtime.options.options.Options"), `None`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + +## Attributes + + + +### options + +Return options values for the sampler. :rtype: `Options` :returns: options + + + +### session + +Return session used by this primitive. + +**Return type** + +`Optional`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session")] + +**Returns** + +Session used by this primitive, or `None` if session is not used. + + + +### version + +`= 1` + +## Methods + +### run + + + +`run(circuits, parameter_values=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/sampler.py#L210-L238 "view source code") + +Submit a request to the sampler primitive. + +**Parameters** + +* **circuits** (*QuantumCircuit | Sequence\[QuantumCircuit]*) – A (parameterized) `QuantumCircuit` or a list of (parameterized) `QuantumCircuit`. +* **parameter\_values** (*Sequence\[float] | Sequence\[Sequence\[float]] | None*) – Concrete parameters to be bound. +* **\*\*kwargs** – Individual options to overwrite the default primitive options. These include the runtime options in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions"). + +**Return type** + +[RuntimeJob](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") + +**Returns** + +Submitted job. The result of the job is an instance of `qiskit.primitives.SamplerResult`. + +**Raises** + +**ValueError** – Invalid arguments are given. + +### set\_options + + + +`set_options(**fields)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/base_primitive.py#L402-L410 "view source code") + +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/qiskit_ibm_runtime.SamplerV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.md new file mode 100644 index 00000000000..dbf5e02f780 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.SamplerV2.md @@ -0,0 +1,101 @@ +--- +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 + + + +`SamplerV2(backend=None, session=None, options=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/sampler.py#L46-L137 "view source code") + +Class for interacting with Qiskit Runtime Sampler primitive service. + +This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1. + +Qiskit Runtime Sampler primitive returns the sampled result according to the specified output type. For example, it returns a bitstring for each shot if measurement level 2 (bits) is requested. + +The [`run()`](#qiskit_ibm_runtime.SamplerV2.run "qiskit_ibm_runtime.SamplerV2.run") method can be used to submit circuits and parameters to the Sampler primitive. + +Initializes the Sampler primitive. + +**Parameters** + +* **backend** (`Union`\[`str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – Backend to run the primitive. This can be a backend name or an [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance. If a name is specified, the default account (e.g. `QiskitRuntimeService()`) is used. + +* **session** (`Union`\[[`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.session.Session"), `str`, [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.ibm_backend.IBMBackend"), `None`]) – + + 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`]) – Primitive options, see `Options` for detailed description. The `backend` keyword is still supported but is deprecated. + +**Raises** + +**NotImplementedError** – If “q-ctrl” channel strategy is used. + +## Attributes + + + +### options + +`SamplerOptions` + +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 + +`= 2` + +## Methods + +### run + + + +`run(pubs, *, shots=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/sampler.py#L97-L124 "view source code") + +Submit a request to the estimator 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 + +**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/qiskit_ibm_runtime.Session.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md index c3bb4cc48e4..7e9b6ebe972 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.Session.md @@ -10,11 +10,11 @@ python_api_name: qiskit_ibm_runtime.Session -`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L40-L336 "view source code") +`Session(service=None, backend=None, max_time=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/session.py#L41-L346 "view source code") -Class for creating a flexible Qiskit Runtime 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. Data used within a session, such as transpiled circuits, is also cached to avoid unnecessary overhead. +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. @@ -22,7 +22,11 @@ For example: ```python from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister -from qiskit_ibm_runtime import Sampler, Session, Options +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") @@ -32,13 +36,15 @@ qc.h(qr[0]) qc.cx(qr[0], qr[1]) qc.measure(qr, cr) -options = Options(optimization_level=3) +pm = generate_preset_pass_manager(backend=backend, optimization_level=1) +isa_circuit = pm.run(qc) -with Session(backend="ibmq_qasm_simulator") as session: - sampler = Sampler(session=session, options=options) - job = sampler.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"Sampler job result: {job.result()}") + print(f"Counts: {pub_result.data.cr.get_counts()}") ``` Session constructor. @@ -89,7 +95,7 @@ Session ID. None if the backend is a simulator. -`backend()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L208-L214 "view source code") +`backend()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/session.py#L218-L224 "view source code") Return backend for this session. @@ -105,7 +111,7 @@ Backend for this session. None if unknown. -`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L194-L198 "view source code") +`cancel()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/session.py#L204-L208 "view source code") Cancel all pending jobs in a session. @@ -117,7 +123,7 @@ Cancel all pending jobs in a session. -`close()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L200-L206 "view source code") +`close()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/session.py#L210-L216 "view source code") 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. @@ -129,7 +135,7 @@ Close the session so new jobs will no longer be accepted, but existing queued or -`details()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L242-L278 "view source code") +`details()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/session.py#L252-L288 "view source code") Return session details. @@ -145,7 +151,7 @@ A dictionary with the sessions details, including -`classmethod from_id(session_id, service=None, backend=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L298-L323 "view source code") +`classmethod from_id(session_id, service=None, backend=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/session.py#L308-L333 "view source code") Construct a Session object with a given session\_id @@ -167,7 +173,7 @@ A new Session with the given `session_id` -`run(program_id, inputs, options=None, callback=None, result_decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L149-L192 "view source code") +`run(program_id, inputs, options=None, callback=None, result_decoder=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/session.py#L159-L202 "view source code") Run a program in the session. @@ -180,7 +186,7 @@ Run a program in the session. **Return type** -[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob") +`Union`\[[`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.runtime_job.RuntimeJob"), `RuntimeJobV2`] **Returns** @@ -190,7 +196,7 @@ Submitted job. -`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/session.py#L216-L240 "view source code") +`status()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/session.py#L226-L250 "view source code") Return current session status. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.md new file mode 100644 index 00000000000..f68a6cc07bd --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlgiers.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeAlgiers` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/algiers/fake_algiers.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_algiers'` + + + +### conf\_filename + +`= 'conf_algiers.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_algiers.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/algiers'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeAlgiers.run "qiskit_ibm_runtime.fake_provider.FakeAlgiers.run") method. + + + +### props\_filename + +`= 'props_algiers.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md index 08c420e0312..03a34ebb1f4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmaden -`FakeAlmaden` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L41-L58 "view source code") +`FakeAlmaden` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L41-L58 "view source code") A fake Almaden backend. @@ -109,7 +109,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -137,7 +137,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md index 2731171efc6..a5c2df868d0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 -`FakeAlmadenV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L21-L38 "view source code") +`FakeAlmadenV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/almaden/fake_almaden.py#L21-L38 "view source code") A fake Almaden V2 backend. @@ -236,7 +236,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -254,7 +254,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -278,7 +278,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -296,7 +296,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -340,7 +340,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.md index 2735b267633..233f04c8670 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonk -`FakeArmonk` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L36-L48 "view source code") +`FakeArmonk` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L36-L48 "view source code") A fake 1 qubit backend. @@ -93,7 +93,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -121,7 +121,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -149,7 +149,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md index 97cea6b3f6e..4a6f4c60c67 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 -`FakeArmonkV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L21-L33 "view source code") +`FakeArmonkV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/armonk/fake_armonk.py#L21-L33 "view source code") A fake 1 qubit backend. @@ -230,7 +230,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -248,7 +248,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -272,7 +272,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -290,7 +290,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -334,7 +334,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.md index f7bb0cd4d3f..c10bc2474ae 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthens -`FakeAthens` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L31-L38 "view source code") +`FakeAthens` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L31-L38 "view source code") A fake 5 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md index bec95b6467c..bbef727e308 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 -`FakeAthensV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L21-L28 "view source code") +`FakeAthensV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/athens/fake_athens.py#L21-L28 "view source code") A fake 5 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.md index 982e308f839..5f79927c2aa 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland -`FakeAuckland` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py#L22-L29 "view source code") +`FakeAuckland` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/auckland/fake_auckland.py#L22-L29 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.md index 8cdf31e5d19..2c797a3b9e5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelem -`FakeBelem` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L31-L38 "view source code") +`FakeBelem` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L31-L38 "view source code") A fake 5 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md index c3417125d30..b08b8cb7b37 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 -`FakeBelemV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L21-L28 "view source code") +`FakeBelemV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/belem/fake_belem.py#L21-L28 "view source code") A fake 5 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md index 8818d7785b1..92ab3d8ef3b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingen -`FakeBoeblingen` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L42-L60 "view source code") +`FakeBoeblingen` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L42-L60 "view source code") A fake Boeblingen backend. @@ -99,7 +99,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -127,7 +127,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -155,7 +155,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md index 84da16aaada..c4641a4b243 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 -`FakeBoeblingenV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L21-L39 "view source code") +`FakeBoeblingenV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/boeblingen/fake_boeblingen.py#L21-L39 "view source code") A fake Boeblingen V2 backend. @@ -236,7 +236,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -254,7 +254,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -278,7 +278,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -296,7 +296,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -340,7 +340,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.md index fcda71f37a1..755ebe31064 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogota -`FakeBogota` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L31-L38 "view source code") +`FakeBogota` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L31-L38 "view source code") A fake 5 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md index d7be2f10516..dea1ebd124b 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 -`FakeBogotaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L21-L28 "view source code") +`FakeBogotaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/bogota/fake_bogota.py#L21-L28 "view source code") A fake 5 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.md new file mode 100644 index 00000000000..0fb739af1a2 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrisbane.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeBrisbane` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/brisbane/fake_brisbane.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_brisbane'` + + + +### conf\_filename + +`= 'conf_brisbane.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_brisbane.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/brisbane'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeBrisbane.run "qiskit_ibm_runtime.fake_provider.FakeBrisbane.run") method. + + + +### props\_filename + +`= 'props_brisbane.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md index 34a9375f2e9..1215378dbd7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklyn -`FakeBrooklyn` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L31-L38 "view source code") +`FakeBrooklyn` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L31-L38 "view source code") A fake Brooklyn backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md index 6c36246a4d3..ed8e528ccbf 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 -`FakeBrooklynV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L21-L28 "view source code") +`FakeBrooklynV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/brooklyn/fake_brooklyn.py#L21-L28 "view source code") A fake Brooklyn V2 backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.md index 167af4fb88f..27f6fdb7375 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlington -`FakeBurlington` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L37-L50 "view source code") +`FakeBurlington` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L37-L50 "view source code") A fake 5 qubit backend. @@ -105,7 +105,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -133,7 +133,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md index 28e9536cf76..f41958456a8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 -`FakeBurlingtonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L21-L34 "view source code") +`FakeBurlingtonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/burlington/fake_burlington.py#L21-L34 "view source code") A fake 5 qubit backend. @@ -232,7 +232,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -250,7 +250,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -274,7 +274,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -292,7 +292,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -336,7 +336,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.md index e369a5a7b99..79376c058da 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairo -`FakeCairo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L31-L38 "view source code") +`FakeCairo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L31-L38 "view source code") A fake 27 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md index 998ef0f99c2..de0ce272343 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 -`FakeCairoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L21-L28 "view source code") +`FakeCairoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/cairo/fake_cairo.py#L21-L28 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.md index 83914bd354e..ff4e2760dd0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridge -`FakeCambridge` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L43-L62 "view source code") +`FakeCambridge` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L43-L62 "view source code") A fake Cambridge backend. @@ -111,7 +111,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -139,7 +139,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md index 3223dbdb144..7fa1cd18aef 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 -`FakeCambridgeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L21-L40 "view source code") +`FakeCambridgeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/cambridge/fake_cambridge.py#L21-L40 "view source code") A fake Cambridge backend. @@ -238,7 +238,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -256,7 +256,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -280,7 +280,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -298,7 +298,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -342,7 +342,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md index f07fdf7e90e..7e3aa329df5 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablanca -`FakeCasablanca` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L31-L38 "view source code") +`FakeCasablanca` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L31-L38 "view source code") A fake 7 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md index 48aa653c74b..8a0c42b17f3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 -`FakeCasablancaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L21-L28 "view source code") +`FakeCasablancaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/casablanca/fake_casablanca.py#L21-L28 "view source code") A fake 7 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.md new file mode 100644 index 00000000000..11717f06bb4 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeCusco.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeCusco` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/cusco/fake_cusco.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_cusco'` + + + +### conf\_filename + +`= 'conf_cusco.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_cusco.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/cusco'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeCusco.run "qiskit_ibm_runtime.fake_provider.FakeCusco.run") method. + + + +### props\_filename + +`= 'props_cusco.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.md index 30b0a3f07d3..27d474074ec 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssex -`FakeEssex` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L39-L54 "view source code") +`FakeEssex` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L39-L54 "view source code") A fake 5 qubit backend. @@ -107,7 +107,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -135,7 +135,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md index f52d617ba21..cf3d05f88c9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 -`FakeEssexV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L21-L36 "view source code") +`FakeEssexV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/essex/fake_essex.py#L21-L36 "view source code") A fake 5 qubit backend. @@ -234,7 +234,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -252,7 +252,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -276,7 +276,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -294,7 +294,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -338,7 +338,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.md index 31d42cf6a34..00632a72829 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva -`FakeGeneva` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py#L22-L29 "view source code") +`FakeGeneva` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/geneva/fake_geneva.py#L22-L29 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md index 6f3f9192fec..e6d7cb79d3a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupe -`FakeGuadalupe` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L32-L39 "view source code") +`FakeGuadalupe` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L32-L39 "view source code") A fake 16 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md index 72644571f69..99a13689d68 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 -`FakeGuadalupeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L22-L29 "view source code") +`FakeGuadalupeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/guadalupe/fake_guadalupe.py#L22-L29 "view source code") A fake 16 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.md index 39ddd171695..7ec9d2ebe60 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoi -`FakeHanoi` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L31-L38 "view source code") +`FakeHanoi` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L31-L38 "view source code") A fake 27 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md index fa54d705a5f..9555bf96f5a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 -`FakeHanoiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L21-L28 "view source code") +`FakeHanoiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/hanoi/fake_hanoi.py#L21-L28 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.md index f4938e2b9aa..4c24a215b76 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakarta -`FakeJakarta` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L31-L38 "view source code") +`FakeJakarta` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L31-L38 "view source code") A fake 7 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md index 1d3cbbab0a7..ac279c7be30 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 -`FakeJakartaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L21-L28 "view source code") +`FakeJakartaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/jakarta/fake_jakarta.py#L21-L28 "view source code") A fake 7 qubit V2 backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md index 8c18616c24d..5c396df9d86 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburg -`FakeJohannesburg` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L41-L58 "view source code") +`FakeJohannesburg` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L41-L58 "view source code") A fake Johannesburg backend. @@ -109,7 +109,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -137,7 +137,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md index 1dca3811fe0..b5b1dadd057 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 -`FakeJohannesburgV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L21-L38 "view source code") +`FakeJohannesburgV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/johannesburg/fake_johannesburg.py#L21-L38 "view source code") A fake Johannesburg V2 backend. @@ -236,7 +236,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -254,7 +254,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -278,7 +278,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -296,7 +296,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -340,7 +340,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.md new file mode 100644 index 00000000000..57f5817b607 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKawasaki.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeKawasaki` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/kawasaki/fake_kawasaki.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_kawasaki'` + + + +### conf\_filename + +`= 'conf_kawasaki.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_kawasaki.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kawasaki'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKawasaki.run "qiskit_ibm_runtime.fake_provider.FakeKawasaki.run") method. + + + +### props\_filename + +`= 'props_kawasaki.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.md index 73b259a39dc..c417c1f5565 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkata -`FakeKolkata` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L31-L38 "view source code") +`FakeKolkata` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L31-L38 "view source code") A fake 27 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md index ee3920cf960..9209204188e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 -`FakeKolkataV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L21-L28 "view source code") +`FakeKolkataV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/kolkata/fake_kolkata.py#L21-L28 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.md new file mode 100644 index 00000000000..5aa84559225 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyiv.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeKyiv` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/kyiv/fake_kyiv.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_kyiv'` + + + +### conf\_filename + +`= 'conf_kyiv.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_kyiv.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kyiv'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKyiv.run "qiskit_ibm_runtime.fake_provider.FakeKyiv.run") method. + + + +### props\_filename + +`= 'props_kyiv.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.md new file mode 100644 index 00000000000..2e502fa880c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeKyoto.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeKyoto` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/kyoto/fake_kyoto.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_kyoto'` + + + +### conf\_filename + +`= 'conf_kyoto.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_kyoto.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/kyoto'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeKyoto.run "qiskit_ibm_runtime.fake_provider.FakeKyoto.run") method. + + + +### props\_filename + +`= 'props_kyoto.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.md index 18966c99e3e..a22813730c1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagos -`FakeLagos` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L31-L38 "view source code") +`FakeLagos` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L31-L38 "view source code") A fake 7 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md index c921bb30bd5..917a12c4e19 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 -`FakeLagosV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L21-L28 "view source code") +`FakeLagosV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/lagos/fake_lagos.py#L21-L28 "view source code") A fake 7 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.md index 7c0cf92b666..2834461ccc4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLima -`FakeLima` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L31-L38 "view source code") +`FakeLima` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L31-L38 "view source code") A fake 5 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md index 5a20d6a5ee2..52f7ac1f34f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 -`FakeLimaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L21-L28 "view source code") +`FakeLimaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/lima/fake_lima.py#L21-L28 "view source code") A fake 5 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.md index edf701d6351..d4f8a2cfd44 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondon -`FakeLondon` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L39-L54 "view source code") +`FakeLondon` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L39-L54 "view source code") A fake 5 qubit backend. @@ -107,7 +107,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -135,7 +135,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md index 2a77cc4075c..b80e5a3c6b0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 -`FakeLondonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L21-L36 "view source code") +`FakeLondonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/london/fake_london.py#L21-L36 "view source code") A fake 5 qubit backend. @@ -234,7 +234,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -252,7 +252,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -276,7 +276,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -294,7 +294,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -338,7 +338,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.md index 98b213f38ac..5519a8ef0e8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattan -`FakeManhattan` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L31-L38 "view source code") +`FakeManhattan` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L31-L38 "view source code") A fake Manhattan backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md index 66e3d53d1af..1e0595bfad0 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 -`FakeManhattanV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L21-L28 "view source code") +`FakeManhattanV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/manhattan/fake_manhattan.py#L21-L28 "view source code") A fake Manhattan backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.md index 74f7f71a6af..c9f5b24402a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManila -`FakeManila` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L31-L38 "view source code") +`FakeManila` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L31-L38 "view source code") A fake 5 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md index 3c13a17354d..9d331bf0287 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 -`FakeManilaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L21-L28 "view source code") +`FakeManilaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/manila/fake_manila.py#L21-L28 "view source code") A fake 5 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md index 1cc5349e4b4..7c20a63700d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourne -`FakeMelbourne` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L38-L95 "view source code") +`FakeMelbourne` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L38-L95 "view source code") A fake 14 qubit backend. @@ -74,7 +74,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L89-L95 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L89-L95 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md index 5752179d450..11a8271f832 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 -`FakeMelbourneV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L29-L35 "view source code") +`FakeMelbourneV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/melbourne/fake_melbourne.py#L29-L35 "view source code") A fake 14 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.md index 758340de903..4c4154493c3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontreal -`FakeMontreal` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L31-L38 "view source code") +`FakeMontreal` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L31-L38 "view source code") A fake 27 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md index e24c1e08383..baa8d59e700 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 -`FakeMontrealV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L21-L28 "view source code") +`FakeMontrealV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/montreal/fake_montreal.py#L21-L28 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.md index fefd67dd44f..dccb5b55335 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbai -`FakeMumbai` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L31-L38 "view source code") +`FakeMumbai` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L31-L38 "view source code") A fake 27 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md index 4628e7b631f..689cd825c93 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 -`FakeMumbaiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L21-L28 "view source code") +`FakeMumbaiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/mumbai/fake_mumbai.py#L21-L28 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.md index 7ed004a8e44..8c567df31d4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobi -`FakeNairobi` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L31-L38 "view source code") +`FakeNairobi` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L31-L38 "view source code") A fake 7 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md index 461ca09c1b8..c9657904c76 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 -`FakeNairobiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L21-L28 "view source code") +`FakeNairobiV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/nairobi/fake_nairobi.py#L21-L28 "view source code") A fake 7 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.md new file mode 100644 index 00000000000..0325e34e52c --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOsaka.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeOsaka` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/osaka/fake_osaka.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_osaka'` + + + +### conf\_filename + +`= 'conf_osaka.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_osaka.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/osaka'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeOsaka.run "qiskit_ibm_runtime.fake_provider.FakeOsaka.run") method. + + + +### props\_filename + +`= 'props_osaka.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.md index fbbec79d7b4..94f26aee188 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo -`FakeOslo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py#L22-L29 "view source code") +`FakeOslo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/oslo/fake_oslo.py#L22-L29 "view source code") A fake 7 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.md index a663c05a4c7..3a6292d7ddb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurense -`FakeOurense` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L37-L50 "view source code") +`FakeOurense` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L37-L50 "view source code") A fake 5 qubit backend. @@ -105,7 +105,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -133,7 +133,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md index 4a65c7f2ec6..0fe87f330f8 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 -`FakeOurenseV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L21-L34 "view source code") +`FakeOurenseV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/ourense/fake_ourense.py#L21-L34 "view source code") A fake 5 qubit backend. @@ -232,7 +232,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -250,7 +250,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -274,7 +274,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -292,7 +292,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -336,7 +336,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.md index f4363561eae..e264746e62f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParis -`FakeParis` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L44-L64 "view source code") +`FakeParis` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L44-L64 "view source code") A fake Paris backend. @@ -101,7 +101,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -129,7 +129,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -157,7 +157,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.md index 20bddd80ad9..32e1ca649d3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 -`FakeParisV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L21-L41 "view source code") +`FakeParisV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/paris/fake_paris.py#L21-L41 "view source code") A fake Paris backend. @@ -238,7 +238,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -256,7 +256,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -280,7 +280,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -298,7 +298,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -342,7 +342,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.md new file mode 100644 index 00000000000..8de4f0e4569 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePeekskill.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakePeekskill` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/peekskill/fake_peekskill.py#L21-L28 "view source code") + +A fake 27 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_peekskill'` + + + +### conf\_filename + +`= 'conf_peekskill.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_peekskill.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/peekskill'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakePeekskill.run "qiskit_ibm_runtime.fake_provider.FakePeekskill.run") method. + + + +### props\_filename + +`= 'props_peekskill.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.md index 5c4ac453e52..6232a37cf18 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth -`FakePerth` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py#L22-L29 "view source code") +`FakePerth` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/perth/fake_perth.py#L22-L29 "view source code") A fake 7 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md index 9c96dcf3b52..c6b80cfeb87 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsie -`FakePoughkeepsie` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L39-L128 "view source code") +`FakePoughkeepsie` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L39-L128 "view source code") A fake Poughkeepsie backend. @@ -78,7 +78,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L122-L128 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L122-L128 "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md index cab29be2a95..c9473e019de 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 -`FakePoughkeepsieV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L29-L36 "view source code") +`FakePoughkeepsieV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py#L29-L36 "view source code") A fake Poughkeepsie backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.md index 99413c085f4..6d3110191a7 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague -`FakePrague` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py#L22-L28 "view source code") +`FakePrague` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/prague/fake_prague.py#L22-L28 "view source code") A fake 33 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.md index 0deceb327aa..4439386a372 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProvider -`FakeProvider` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L142-L211 "view source code") +`FakeProvider` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_provider.py#L152-L221 "view source code") Fake provider containing fake V1 backends. @@ -30,7 +30,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`backends(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L160-L161 "view source code") +`backends(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_provider.py#L170-L171 "view source code") Return a list of backends matching the specified filtering. @@ -53,7 +53,7 @@ list\[Backend] -`get_backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L149-L158 "view source code") +`get_backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_provider.py#L159-L168 "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md index bd71cb19f20..b9b0dacd734 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2 -`FakeProviderForBackendV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L65-L139 "view source code") +`FakeProviderForBackendV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_provider.py#L65-L149 "view source code") Fake provider containing fake V2 backends. @@ -30,7 +30,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L72-L84 "view source code") +`backend(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_provider.py#L72-L84 "view source code") Filter backends in provider by name. @@ -38,7 +38,7 @@ Filter backends in provider by name. -`backends(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_provider.py#L86-L87 "view source code") +`backends(name=None, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_provider.py#L86-L87 "view source code") Return a list of backends matching the specified filtering. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.md new file mode 100644 index 00000000000..9c2d1a10429 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuebec.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeQuebec` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/quebec/fake_quebec.py#L21-L28 "view source code") + +A fake 127 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_quebec'` + + + +### conf\_filename + +`= 'conf_quebec.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_quebec.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/quebec'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeQuebec.run "qiskit_ibm_runtime.fake_provider.FakeQuebec.run") method. + + + +### props\_filename + +`= 'props_quebec.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.md index af26d993790..9456542a500 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuito -`FakeQuito` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py#L31-L38 "view source code") +`FakeQuito` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py#L31-L38 "view source code") A fake 5 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md index 194156b6493..34064cbb89f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 -`FakeQuitoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py#L21-L28 "view source code") +`FakeQuitoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/quito/fake_quito.py#L21-L28 "view source code") A fake 5 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.md index 81179f2ba44..e80c124b0ae 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochester -`FakeRochester` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py#L30-L36 "view source code") +`FakeRochester` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py#L30-L36 "view source code") A fake Rochester backend. @@ -99,7 +99,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -127,7 +127,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md index b25d523c06c..2dd9b222ed6 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 -`FakeRochesterV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py#L21-L27 "view source code") +`FakeRochesterV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/rochester/fake_rochester.py#L21-L27 "view source code") A fake Rochester backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.md index 2d2dc476151..68e1bf0366d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRome -`FakeRome` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py#L31-L38 "view source code") +`FakeRome` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py#L31-L38 "view source code") A fake 5 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md index 622d93c116d..6b2cab59ca1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 -`FakeRomeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py#L21-L28 "view source code") +`FakeRomeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/rome/fake_rome.py#L21-L28 "view source code") A fake 5 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md index d10a03f3b23..29bf8d544b9 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRueschlikon -`FakeRueschlikon` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py#L21-L74 "view source code") +`FakeRueschlikon` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/rueschlikon/fake_rueschlikon.py#L21-L74 "view source code") A fake 16 qubit backend. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.md index ec524ccddcd..76e7a1aa370 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiago -`FakeSantiago` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py#L31-L38 "view source code") +`FakeSantiago` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py#L31-L38 "view source code") A fake Santiago backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md index 47d2e67ac99..f3c8826b77e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 -`FakeSantiagoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py#L21-L28 "view source code") +`FakeSantiagoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/santiago/fake_santiago.py#L21-L28 "view source code") A fake Santiago backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md index 67abf2d9a06..ba73b44b212 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke -`FakeSherbrooke` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py#L21-L28 "view source code") +`FakeSherbrooke` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/sherbrooke/fake_sherbrooke.py#L21-L28 "view source code") A fake 127 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.md index 0f791011c15..8f70ac97610 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingapore -`FakeSingapore` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py#L41-L58 "view source code") +`FakeSingapore` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py#L41-L58 "view source code") A fake Singapore backend. @@ -109,7 +109,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -137,7 +137,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md index 74b8768bb1e..e2a820f9080 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 -`FakeSingaporeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py#L21-L38 "view source code") +`FakeSingaporeV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/singapore/fake_singapore.py#L21-L38 "view source code") A fake Singapore backend. @@ -236,7 +236,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -254,7 +254,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -278,7 +278,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -296,7 +296,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -340,7 +340,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.md index 4e05d4cfa3c..a5c8a529003 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydney -`FakeSydney` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py#L31-L38 "view source code") +`FakeSydney` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py#L31-L38 "view source code") A fake 27 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md index 615c773bbb6..a0e8236d1cb 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 -`FakeSydneyV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py#L21-L28 "view source code") +`FakeSydneyV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/sydney/fake_sydney.py#L21-L28 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.md index 40dbdc95275..7b9aaf1541e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTenerife -`FakeTenerife` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py#L28-L68 "view source code") +`FakeTenerife` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py#L28-L68 "view source code") A fake 5 qubit backend. @@ -76,7 +76,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py#L62-L68 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/tenerife/fake_tenerife.py#L62-L68 "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.md index f67985278d5..4edc22ead5c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTokyo -`FakeTokyo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py#L28-L141 "view source code") +`FakeTokyo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py#L28-L141 "view source code") A fake 20 qubit backend. @@ -78,7 +78,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py#L135-L141 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/tokyo/fake_tokyo.py#L135-L141 "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.md new file mode 100644 index 00000000000..23b55c9178d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorino.md @@ -0,0 +1,377 @@ +--- +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 + + + +`FakeTorino` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/torino/fake_torino.py#L21-L28 "view source code") + +A fake 133 qubit backend. + +FakeBackendV2 initializer. + +## Attributes + + + +### backend\_name + +`= 'fake_torino'` + + + +### conf\_filename + +`= 'conf_torino.json'` + + + +### coupling\_map + +Return the `CouplingMap` object + + + +### defs\_filename + +`= 'defs_torino.json'` + + + +### dirname + +`= '/home/runner/work/qiskit-ibm-runtime/qiskit-ibm-runtime/qiskit_ibm_runtime/fake_provider/backends/torino'` + + + +### dt + +Return the system time resolution of input signals + +This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`Optional`\[`float`] + +**Returns** + +The input signal timestep in seconds. If the backend doesn’t define `dt`, `None` will be returned. + + + +### dtm + +Return the system time resolution of output signals + +**Return type** + +`float` + +**Returns** + +The output signal timestep in seconds. + + + +### instruction\_durations + +Return the `InstructionDurations` object. + + + +### instruction\_schedule\_map + +Return the `InstructionScheduleMap` for the instructions defined in this backend’s target. + + + +### instructions + +A list of Instruction tuples on the backend of the form `(instruction, (qubits)` + +**Return type** + +`List`\[`Tuple`\[`Instruction`, `Tuple`\[`int`]]] + + + +### max\_circuits + +**Return type** + +`None` + + + +### meas\_map + +Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The grouping of measurements which are multiplexed + + + +### num\_qubits + +Return the number of qubits the backend has. + +**Return type** + +`int` + + + +### operation\_names + +A list of instruction names that the backend supports. + +**Return type** + +`List`\[`str`] + + + +### operations + +A list of `Instruction` instances that the backend supports. + +**Return type** + +`List`\[`Instruction`] + + + +### options + +Return the options for the backend + +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](#qiskit_ibm_runtime.fake_provider.FakeTorino.run "qiskit_ibm_runtime.fake_provider.FakeTorino.run") method. + + + +### props\_filename + +`= 'props_torino.json'` + + + +### provider + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +Provider + + + +### target + +A `qiskit.transpiler.Target` object for the backend. + +**Return type** + +Target + + + +### version + +`= 2` + + + +### 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 + + + +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") + +Return the acquisition channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement acquisition line. + +**Return type** + +AcquireChannel + +### control\_channel + + + +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") + +Return the secondary drive channel for the given qubit + +This is typically utilized for controlling multiqubit interactions. This channel is derived from other channels. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Parameters** + +**qubits** (`Iterable`\[`int`]) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. + +**Returns** + +The multi qubit control line. + +**Return type** + +List\[ControlChannel] + +### drive\_channel + + + +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") + +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 + + + +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") + +Return the measure stimulus channel for the given qubit. + +This is required to be implemented if the backend supports Pulse scheduling. + +**Returns** + +The Qubit measurement stimulus line + +**Return type** + +MeasureChannel + +### qubit\_properties + + + +`qubit_properties(qubit)` + +Return QubitProperties for a given qubit. + +If there are no defined or the backend doesn’t support querying these details this method does not need to be implemented. + +**Parameters** + +**qubit** (`Union`\[`int`, `List`\[`int`]]) – The qubit to get the `QubitProperties` object for. This can be a single integer for 1 qubit or a list of qubits and a list of `QubitProperties` objects will be returned in the same order + +**Return type** + +`Union`\[`QubitProperties`, `List`\[`QubitProperties`]] + +**Returns** + +The `QubitProperties` object for the specified qubit. If a list of qubits is provided a list will be returned. If properties are missing for a qubit this can be `None`. + +**Raises** + +**NotImplementedError** – if the backend doesn’t support querying the qubit properties + +### run + + + +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") + +Run on the fake backend using a simulator. + +This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicAer simulator/ BasicSimulator or Aer simulator and returns a `Job` object. + +If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicAer simulator/ BasicSimulator simulator without noise. + +Currently noisy simulation of a pulse job is not supported yet in FakeBackendV2. + +**Parameters** + +* **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of `QuantumCircuit`, `ScheduleBlock`, or `Schedule` objects to run on the backend. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +Job + +**Raises** + +**QiskitError** – If a pulse job is supplied and qiskit-aer is not installed. + +### set\_options + + + +`set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.md index 072908e34b6..58557dc9eac 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeToronto -`FakeToronto` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py#L31-L38 "view source code") +`FakeToronto` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py#L31-L38 "view source code") A fake 27 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md index a5ea3d0dd79..6c12223e178 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 -`FakeTorontoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py#L21-L28 "view source code") +`FakeTorontoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/toronto/fake_toronto.py#L21-L28 "view source code") A fake 27 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.md index 98f2f35d029..452e4cf79cd 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValencia -`FakeValencia` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py#L31-L38 "view source code") +`FakeValencia` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py#L31-L38 "view source code") A fake 5 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md index 54908a211b9..71902091552 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 -`FakeValenciaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py#L21-L28 "view source code") +`FakeValenciaV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/valencia/fake_valencia.py#L21-L28 "view source code") A fake 5 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.md index b7098a7cac0..d04962cfe8a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigo -`FakeVigo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py#L37-L50 "view source code") +`FakeVigo` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py#L37-L50 "view source code") A fake 5 qubit backend. @@ -105,7 +105,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -133,7 +133,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md index 4da4f84551c..4fed4f09d6e 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 -`FakeVigoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py#L21-L34 "view source code") +`FakeVigoV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/vigo/fake_vigo.py#L21-L34 "view source code") A fake 5 qubit backend. @@ -232,7 +232,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -250,7 +250,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -274,7 +274,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -292,7 +292,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -336,7 +336,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.md index 3b6a69f2942..1cadc7f2143 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashington -`FakeWashington` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py#L31-L38 "view source code") +`FakeWashington` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py#L31-L38 "view source code") A fake 127 qubit backend. @@ -89,7 +89,7 @@ BackendConfiguration -`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") +`defaults()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_pulse_backend.py#L29-L33 "view source code") Returns a snapshot of device defaults @@ -117,7 +117,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -145,7 +145,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md index f8411be62da..cd2cab0aa69 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 -`FakeWashingtonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py#L21-L28 "view source code") +`FakeWashingtonV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/washington/fake_washington.py#L21-L28 "view source code") A fake 127 qubit backend. @@ -226,7 +226,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -244,7 +244,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -268,7 +268,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -286,7 +286,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -330,7 +330,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.md index 64de0b96149..84867e154d2 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktown -`FakeYorktown` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py#L39-L54 "view source code") +`FakeYorktown` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py#L39-L54 "view source code") A fake 5 qubit backend. @@ -107,7 +107,7 @@ str -`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") +`properties()` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_qasm_backend.py#L44-L48 "view source code") Returns a snapshot of device properties @@ -135,7 +135,7 @@ Provider -`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") +`run(run_input, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L545-L574 "view source code") Main job in simulator diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md index e43c336f65f..c6926f78e93 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 -`FakeYorktownV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py#L21-L36 "view source code") +`FakeYorktownV2` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/backends/yorktown/fake_yorktown.py#L21-L36 "view source code") A fake 5 qubit backend. @@ -234,7 +234,7 @@ Version of the backend being provided. This is not the same as `BackendV2.versio -`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") +`acquire_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L269-L282 "view source code") Return the acquisition channel for the given qubit. @@ -252,7 +252,7 @@ AcquireChannel -`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") +`control_channel(qubits)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L284-L304 "view source code") Return the secondary drive channel for the given qubit @@ -276,7 +276,7 @@ List\[ControlChannel] -`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") +`drive_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L239-L252 "view source code") Return the drive channel for the given qubit. @@ -294,7 +294,7 @@ DriveChannel -`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") +`measure_channel(qubit)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L254-L267 "view source code") Return the measure stimulus channel for the given qubit. @@ -338,7 +338,7 @@ The `QubitProperties` object for the specified qubit. If a list of qubits is pro -`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") +`run(run_input, **options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/fake_provider/fake_backend.py#L306-L365 "view source code") Run on the fake backend using a simulator. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.md new file mode 100644 index 00000000000..ab02d0340c1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.md @@ -0,0 +1,73 @@ +--- +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 + + + +`DynamicalDecouplingOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/dynamical_decoupling_options.py#L20-L50 "view source code") + +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 + +`UnsetType | bool` + +`= Unset` + + + +### extra\_slack\_distribution + +`UnsetType | Literal['middle', 'edges']` + +`= Unset` + + + +### scheduling\_method + +`UnsetType | Literal['alap', 'asap']` + +`= Unset` + + + +### sequence\_type + +`UnsetType | Literal['XX', 'XpXm', 'XY4']` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md index 04659f16d89..7e72615891c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EnvironmentOptions.md @@ -10,22 +10,22 @@ python_api_name: qiskit_ibm_runtime.options.EnvironmentOptions -`EnvironmentOptions(log_level='WARNING', callback=None, job_tags=)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/environment_options.py#L27-L62 "view source code") +`EnvironmentOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/environment_options.py#L28-L50 "view source code") Options related to the execution environment. **Parameters** -* **log\_level** (`str`) – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. The default level is `WARNING`. +* **log\_level** – logging level to set in the execution environment. The valid log levels are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL`. Default: `WARNING`. -* **callback** (`Optional`\[`Callable`]) – +* **callback** – Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters: > 1. Job ID > 2. Job result. -* **job\_tags** (`Optional`\[`List`]) – 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. +* **job\_tags** – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `qiskit_ibm_runtime.qiskit_runtime_service.jobs()` function call. ## Attributes @@ -37,31 +37,21 @@ Options related to the execution environment. `= None` - - -### log\_level - -`str` - -`= 'WARNING'` - ### job\_tags `List | None` -## Methods - -### validate\_environment\_options +`= None` - + -`static validate_environment_options(environment_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/environment_options.py#L51-L62 "view source code") +### log\_level -Validate that environment options are legal. :raises ValueError: if log\_level is not in LogLevelType. +`Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']` -**Return type** +`= 'WARNING'` -`None` +## Methods diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.md new file mode 100644 index 00000000000..9e64e3be5ba --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.EstimatorOptions.md @@ -0,0 +1,189 @@ +--- +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 + + + +`EstimatorOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/estimator_options.py#L35-L125 "view source code") + +Options for V2 Estimator. + +**Parameters** + +* **default\_precision** – The default precision to use for any PUB or `run()` call that does not specify one. Each estimator pub can specify its own precision. If the `run()` method is given a precision, then that value is used for all PUBs in the `run()` call that do not specify their own. Default: 0.015625 (1 / sqrt(4096). + +* **default\_shots** – + + The total number of shots to use per circuit per configuration. + + + If set, this value overrides [`default_precision`](#qiskit_ibm_runtime.options.EstimatorOptions.default_precision "qiskit_ibm_runtime.options.EstimatorOptions.default_precision"). + + + A configuration is a combination of a specific parameter value binding set and a physical measurement basis. A physical measurement basis groups together some collection of qubit-wise commuting observables for some specific circuit/parameter value set to create a single measurement with basis rotations that is inserted into hardware executions. + + If twirling is enabled, the value of this option will be divided over circuit, randomizations, with a smaller number of shots per randomization. See the [`twirling`](#qiskit_ibm_runtime.options.EstimatorOptions.twirling "qiskit_ibm_runtime.options.EstimatorOptions.twirling") options. + + Default: `None`. + +* **optimization\_level** – + + How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer processing times. + + * 0: no optimization + * 1: light optimization + + Refer to the [Configure runtime compilation for Qiskit Runtime](/run/configure-runtime-compilation). for more information about the optimization levels. + + Default: 1. + +* **resilience\_level** – + + How much resilience to build against errors. Higher levels generate more accurate results, at the expense of longer processing times. + + * 0: No mitigation. + * 1: Minimal mitigation costs. Mitigate error associated with readout errors. + * 2: Medium mitigation costs. Typically reduces bias in estimators but is not guaranteed to be zero bias. + + Refer to the [Configure error mitigation for Qiskit Runtime](/run/configure-error-mitigation). for more information about the error mitigation methods used at each level. + + Default: 1. + +* **seed\_estimator** – Seed used to control sampling. + +* **dynamical\_decoupling** – Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. + +* **resilience** – Advanced resilience options to fine tune the resilience strategy. See [`ResilienceOptionsV2`](qiskit_ibm_runtime.options.ResilienceOptionsV2 "qiskit_ibm_runtime.options.ResilienceOptionsV2") for all available options. + +* **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. + +* **twirling** – Pauli twirling options. See [`TwirlingOptions`](qiskit_ibm_runtime.options.TwirlingOptions "qiskit_ibm_runtime.options.TwirlingOptions") for all available options. + +* **experimental** – Experimental options. + +## Attributes + + + +### default\_precision + +`UnsetType | float` + +`= Unset` + + + +### default\_shots + +`UnsetType | int | None` + +`= Unset` + + + +### dynamical\_decoupling + +`DynamicalDecouplingOptions | Dict` + +`= FieldInfo(annotation=Union[DynamicalDecouplingOptions, Dict], required=False, default_factory=DynamicalDecouplingOptions)` + + + +### environment + +`EnvironmentOptions | Dict` + +`= FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)` + + + +### execution + +`ExecutionOptionsV2 | Dict` + +`= FieldInfo(annotation=Union[ExecutionOptionsV2, Dict], required=False, default_factory=ExecutionOptionsV2)` + + + +### experimental + +`UnsetType | dict` + +`= Unset` + + + +### max\_execution\_time + +`UnsetType | int` + +`= Unset` + + + +### optimization\_level + +`UnsetType | int` + +`= Unset` + + + +### resilience + +`ResilienceOptionsV2 | Dict` + +`= FieldInfo(annotation=Union[ResilienceOptionsV2, Dict], required=False, default_factory=ResilienceOptionsV2)` + + + +### resilience\_level + +`UnsetType | int` + +`= Unset` + + + +### seed\_estimator + +`UnsetType | int` + +`= Unset` + + + +### simulator + +`SimulatorOptions | Dict` + +`= FieldInfo(annotation=Union[SimulatorOptions, Dict], required=False, default_factory=SimulatorOptions)` + + + +### twirling + +`TwirlingOptions | Dict` + +`= FieldInfo(annotation=Union[TwirlingOptions, Dict], required=False, default_factory=TwirlingOptions)` + +## Methods + +### update + + + +`update(**kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/options.py#L106-L111 "view source code") + +Update the options. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md index 390cd6cbe76..8d969721702 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptions.md @@ -10,14 +10,14 @@ python_api_name: qiskit_ibm_runtime.options.ExecutionOptions -`ExecutionOptions(shots=4000, init_qubits=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/execution_options.py#L25-L47 "view source code") +`ExecutionOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/execution_options.py#L40-L52 "view source code") -Execution options. +Execution options for V1 primitives. **Parameters** -* **shots** (`int`) – Number of repetitions of each circuit, for sampling. Default: 4000. -* **init\_qubits** (`bool`) – Whether to reset the qubits to the ground state for each shot. Default: `True`. +* **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 @@ -39,15 +39,3 @@ Execution options. ## Methods -### validate\_execution\_options - - - -`static validate_execution_options(execution_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/execution_options.py#L39-L47 "view source code") - -Validate that execution options are legal. :raises ValueError: if any execution option is not supported - -**Return type** - -`None` - diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.md new file mode 100644 index 00000000000..b87eba05b89 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ExecutionOptionsV2.md @@ -0,0 +1,41 @@ +--- +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 + + + +`ExecutionOptionsV2(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/execution_options.py#L20-L37 "view source code") + +Execution options for V2 primitives. + +**Parameters** + +* **init\_qubits** – Whether to reset the qubits to the ground state for each shot. Default: `True`. +* **rep\_delay** – The repetition delay. This is the delay between a measurement and the subsequent quantum circuit. This is only supported on backends that have `backend.dynamic_reprate_enabled=True`. It must be from the range supplied by `backend.rep_delay_range`. Default is given by `backend.default_rep_delay`. + +## Attributes + + + +### init\_qubits + +`UnsetType | bool` + +`= Unset` + + + +### rep\_delay + +`UnsetType | float` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.md new file mode 100644 index 00000000000..62ec825f85a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.LayerNoiseLearningOptions.md @@ -0,0 +1,63 @@ +--- +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 + + + +`LayerNoiseLearningOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/layer_noise_learning_options.py#L28-L75 "view source code") + +Options for learning layer noise. + + + These options are only used when the resilience level or options specify a technique that requires layer noise learning. + + +**Parameters** + +* **max\_layers\_to\_learn** – The max number of unique layers to learn. A `None` value indicates that there is no limit. If there are more unique layers present, then some layers will not be learned or mitigated. The learned layers are prioritized based on the number of times they occur in a set of run estimator PUBs, and for equally occurring layers are further sorted by the number of two-qubit gates in the layer. +* **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 + +`UnsetType | List[int]` + +`= Unset` + + + +### max\_layers\_to\_learn + +`UnsetType | int | None` + +`= Unset` + + + +### num\_randomizations + +`UnsetType | int` + +`= Unset` + + + +### shots\_per\_randomization + +`UnsetType | int` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.md new file mode 100644 index 00000000000..42724d15dd1 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.MeasureNoiseLearningOptions.md @@ -0,0 +1,45 @@ +--- +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 + + + +`MeasureNoiseLearningOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/measure_noise_learning_options.py#L20-L40 "view source code") + +Options for measurement noise learning. + + + These options are only used when the resilience level or options specify a technique that requires measurement noise learning. + + +**Parameters** + +* **num\_randomizations** – The number of random circuits to draw for the measurement learning experiment. Default: 32. +* **shots\_per\_randomization** – The number of shots to use for the learning experiment per random circuit. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + +## Attributes + + + +### num\_randomizations + +`UnsetType | int` + +`= Unset` + + + +### shots\_per\_randomization + +`UnsetType | int | Literal['auto']` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md index e4f8352ea2d..f86ad5de041 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.Options.md @@ -10,9 +10,9 @@ python_api_name: qiskit_ibm_runtime.options.Options -`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/options.py#L32-L279 "view source code") +`Options(optimization_level=None, resilience_level=None, max_execution_time=None, transpilation=, resilience=, execution=, environment=, simulator=)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/options.py#L172-L404 "view source code") -Options for the primitives. +Options for the primitives, used by V1 primitives. **Parameters** @@ -114,7 +114,7 @@ Options for the primitives. -`static validate_options(options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/options.py#L165-L190 "view source code") +`static validate_options(options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/options.py#L306-L334 "view source code") 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. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.md new file mode 100644 index 00000000000..1fba85712ae --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.PecOptions.md @@ -0,0 +1,50 @@ +--- +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 + + + +`PecOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/pec_options.py#L20-L41 "view source code") + +Probabalistic error cancellation mitigation options. + +**Parameters** + +* **max\_overhead** – The maximum circuit sampling overhead allowed, or `None` for no maximum. + +* **noise\_gain** – + + The amount by which to scale the noise, where: + + * A value of one corresponds to attempting to remove all of the noise. + * A value greater than one corresponds to injecting noise. + * A value between 0 and 1 corresponds to partially removing the noise. + + If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + +## Attributes + + + +### max\_overhead + +`UnsetType | float | None` + +`= Unset` + + + +### noise\_gain + +`UnsetType | float | Literal['auto']` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md index 6430212cf4a..cb07fb971c4 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptions.md @@ -10,16 +10,16 @@ python_api_name: qiskit_ibm_runtime.options.ResilienceOptions -`ResilienceOptions(noise_amplifier=None, noise_factors=None, extrapolator=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/resilience_options.py#L34-L91 "view source code") +`ResilienceOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/resilience_options.py#L104-L141 "view source code") -Resilience options. +Resilience options for V1 primitives. **Parameters** -* **noise\_factors** (`Optional`\[`Sequence`\[`float`]]) – 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** (*DEPRECATED*) – A noise amplification strategy. Currently only +* **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** (`Optional`\[`Literal`\[‘LinearExtrapolator’, ‘QuadraticExtrapolator’, ‘CubicExtrapolator’, ‘QuarticExtrapolator’]]) – 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. +* **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 @@ -27,7 +27,7 @@ Resilience options. ### extrapolator -`Literal['LinearExtrapolator', 'QuadraticExtrapolator', 'CubicExtrapolator', 'QuarticExtrapolator']` +`Literal['LinearExtrapolator', 'QuadraticExtrapolator', 'CubicExtrapolator', 'QuarticExtrapolator'] | None` `= None` @@ -35,7 +35,7 @@ Resilience options. ### noise\_amplifier -`Literal['LocalFoldingAmplifier']` +`Literal['LocalFoldingAmplifier'] | None` `= None` @@ -43,21 +43,9 @@ Resilience options. ### noise\_factors -`Sequence[float]` +`Sequence[float] | None` `= None` ## Methods -### validate\_resilience\_options - - - -`static validate_resilience_options(resilience_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/resilience_options.py#L60-L91 "view source code") - -Validate that resilience options are legal. :raises ValueError: if any resilience option is not supported :raises ValueError: if noise\_amplifier is not in NoiseAmplifierType. :raises ValueError: if extrapolator is not in ExtrapolatorType. :raises ValueError: if extrapolator == “QuarticExtrapolator” and number of noise\_factors \< 5. :raises ValueError: if extrapolator == “CubicExtrapolator” and number of noise\_factors \< 4. - -**Return type** - -`None` - diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.md new file mode 100644 index 00000000000..68c40e0a34a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ResilienceOptionsV2.md @@ -0,0 +1,86 @@ +--- +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 + + + +`ResilienceOptionsV2(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/resilience_options.py#L38-L101 "view source code") + +Resilience options for V2 Estimator. + +**Parameters** + +* **measure\_mitigation** – Whether to enable measurement error mitigation method. Further suboptions are available in [`measure_noise_learning`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning "qiskit_ibm_runtime.options.ResilienceOptionsV2.measure_noise_learning"). Default: True. +* **measure\_noise\_learning** – Additional measurement noise learning options. See [`MeasureNoiseLearningOptions`](qiskit_ibm_runtime.options.MeasureNoiseLearningOptions "qiskit_ibm_runtime.options.MeasureNoiseLearningOptions") for all options. +* **zne\_mitigation** – Whether to turn on Zero Noise Extrapolation error mitigation method. Further suboptions are available in [`zne`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.zne "qiskit_ibm_runtime.options.ResilienceOptionsV2.zne"). Default: False. +* **zne** – Additional zero noise extrapolation mitigation options. See [`ZneOptions`](qiskit_ibm_runtime.options.ZneOptions "qiskit_ibm_runtime.options.ZneOptions") for all options. +* **pec\_mitigation** – Whether to turn on Probabilistic Error Cancellation error mitigation method. Further suboptions are available in [`pec`](#qiskit_ibm_runtime.options.ResilienceOptionsV2.pec "qiskit_ibm_runtime.options.ResilienceOptionsV2.pec"). Default: False. +* **pec** – Additional probabalistic error cancellation mitigation options. See [`PecOptions`](qiskit_ibm_runtime.options.PecOptions "qiskit_ibm_runtime.options.PecOptions") for all options. +* **layer\_noise\_learning** – Layer noise learning options. See [`LayerNoiseLearningOptions`](qiskit_ibm_runtime.options.LayerNoiseLearningOptions "qiskit_ibm_runtime.options.LayerNoiseLearningOptions") for all options. + +## Attributes + + + +### layer\_noise\_learning + +`LayerNoiseLearningOptions | Dict` + +`= FieldInfo(annotation=Union[LayerNoiseLearningOptions, Dict], required=False, default_factory=LayerNoiseLearningOptions)` + + + +### measure\_mitigation + +`UnsetType | bool` + +`= Unset` + + + +### measure\_noise\_learning + +`MeasureNoiseLearningOptions | Dict` + +`= FieldInfo(annotation=Union[MeasureNoiseLearningOptions, Dict], required=False, default_factory=MeasureNoiseLearningOptions)` + + + +### pec + +`PecOptions | Dict` + +`= FieldInfo(annotation=Union[PecOptions, Dict], required=False, default_factory=PecOptions)` + + + +### pec\_mitigation + +`UnsetType | bool` + +`= Unset` + + + +### zne + +`ZneOptions | Dict` + +`= FieldInfo(annotation=Union[ZneOptions, Dict], required=False, default_factory=ZneOptions)` + + + +### zne\_mitigation + +`UnsetType | bool` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.md new file mode 100644 index 00000000000..c545d58ab0b --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SamplerOptions.md @@ -0,0 +1,95 @@ +--- +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 + + + +`SamplerOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/sampler_options.py#L26-L48 "view source code") + +Options for V2 Sampler. + +**Parameters** + +* **default\_shots** – The default number of shots to use if none are specified in the PUBs or in the run method. Default: 4096. +* **dynamical\_decoupling** – Suboptions for dynamical decoupling. See [`DynamicalDecouplingOptions`](qiskit_ibm_runtime.options.DynamicalDecouplingOptions "qiskit_ibm_runtime.options.DynamicalDecouplingOptions") for all available options. +* **execution** – Execution time options. See [`ExecutionOptionsV2`](qiskit_ibm_runtime.options.ExecutionOptionsV2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for all available options. +* **experimental** – Experimental options. + +## Attributes + + + +### default\_shots + +`UnsetType | int` + +`= Unset` + + + +### dynamical\_decoupling + +`DynamicalDecouplingOptions | Dict` + +`= FieldInfo(annotation=Union[DynamicalDecouplingOptions, Dict], required=False, default_factory=DynamicalDecouplingOptions)` + + + +### environment + +`EnvironmentOptions | Dict` + +`= FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)` + + + +### execution + +`ExecutionOptionsV2 | Dict` + +`= FieldInfo(annotation=Union[ExecutionOptionsV2, Dict], required=False, default_factory=ExecutionOptionsV2)` + + + +### experimental + +`UnsetType | dict` + +`= Unset` + + + +### max\_execution\_time + +`UnsetType | int` + +`= Unset` + + + +### simulator + +`SimulatorOptions | Dict` + +`= FieldInfo(annotation=Union[SimulatorOptions, Dict], required=False, default_factory=SimulatorOptions)` + +## Methods + +### update + + + +`update(**kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/options.py#L106-L111 "view source code") + +Update the options. + +**Return type** + +`None` + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md index 008e6406767..e0a0587e47d 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.SimulatorOptions.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions -`SimulatorOptions(noise_model=None, seed_simulator=None, coupling_map=None, basis_gates=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/simulator_options.py#L35-L95 "view source code") +`SimulatorOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/simulator_options.py#L33-L105 "view source code") Simulator options. @@ -18,10 +18,10 @@ For best practice in simulating a backend make sure to pass the basis gates and **Parameters** -* **noise\_model** (`Union`\[`dict`, `NoiseModel`, `None`]) – Noise model for the simulator. -* **seed\_simulator** (`Optional`\[`int`]) – Random seed to control sampling. -* **coupling\_map** (`Union`\[`List`\[`List`\[`int`]], `CouplingMap`, `None`]) – Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interactions, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` -* **basis\_gates** (`Optional`\[`List`\[`str`]]) – List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. If `None`, do not unroll. +* **noise\_model** – Noise model for the simulator. +* **seed\_simulator** – Random seed to control sampling. +* **coupling\_map** – Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interactions, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` +* **basis\_gates** – List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set. ## Attributes @@ -29,33 +29,33 @@ For best practice in simulating a backend make sure to pass the basis gates and ### basis\_gates -`List[str] | None` +`UnsetType | List[str]` -`= None` +`= Unset` ### coupling\_map -`List[List[int]] | CouplingMap | None` +`UnsetType | List[List[int]] | CouplingMap` -`= None` +`= Unset` ### noise\_model -`dict | NoiseModel | None` +`UnsetType | dict | NoiseModel | None` -`= None` +`= Unset` ### seed\_simulator -`int | None` +`UnsetType | int` -`= None` +`= Unset` ## Methods @@ -63,7 +63,7 @@ For best practice in simulating a backend make sure to pass the basis gates and -`set_backend(backend)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/simulator_options.py#L71-L95 "view source code") +`set_backend(backend)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/simulator_options.py#L79-L105 "view source code") Set backend for simulation. This method changes noise\_model, coupling\_map, basis\_gates according to given backend. @@ -73,19 +73,7 @@ Set backend for simulation. This method changes noise\_model, coupling\_map, bas **Raises** -**MissingOptionalLibraryError if qiskit-aer is not found.** – - -**Return type** - -`None` - -### validate\_simulator\_options - - - -`static validate_simulator_options(simulator_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/simulator_options.py#L61-L69 "view source code") - -Validate that simulator options are legal. :raises ValueError: if any simulator option is not supported +**MissingOptionalLibraryError** – if qiskit-aer is not found. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md index dd9a466845f..6b8121d28d1 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TranspilationOptions.md @@ -10,17 +10,17 @@ python_api_name: qiskit_ibm_runtime.options.TranspilationOptions -`TranspilationOptions(skip_transpilation=False, initial_layout=None, layout_method=None, routing_method=None, approximation_degree=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/transpilation_options.py#L41-L97 "view source code") +`TranspilationOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/transpilation_options.py#L38-L75 "view source code") Transpilation options. **Parameters** -* **skip\_transpilation** (`bool`) – Whether to skip transpilation. -* **initial\_layout** (`Union`\[`dict`, `List`, `None`]) – Initial position of virtual qubits on physical qubits. See `qiskit.compiler.transpile` for more information. -* **layout\_method** (`Optional`\[`str`]) – Name of layout selection pass. One of ‘trivial’, ‘dense’, ‘noise\_adaptive’, ‘sabre’. -* **routing\_method** (`Optional`\[`str`]) – Name of routing pass. One of ‘basic’, ‘lookahead’, ‘stochastic’, ‘sabre’, ‘none’. -* **approximation\_degree** (`Optional`\[`float`]) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) +* **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 @@ -28,33 +28,33 @@ Transpilation options. ### approximation\_degree -`float | None` +`UnsetType | float` -`= None` +`= Unset` ### initial\_layout -`dict | List | None` +`UnsetType | dict | List` -`= None` +`= Unset` ### layout\_method -`str | None` +`UnsetType | Literal['trivial', 'dense', 'noise_adaptive', 'sabre']` -`= None` +`= Unset` ### routing\_method -`str | None` +`UnsetType | Literal['basic', 'lookahead', 'stochastic', 'sabre', 'none']` -`= None` +`= Unset` @@ -66,15 +66,3 @@ Transpilation options. ## Methods -### validate\_transpilation\_options - - - -`static validate_transpilation_options(transpilation_options)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/options/transpilation_options.py#L68-L97 "view source code") - -Validate that transpilation options are legal. :raises ValueError: if any transpilation option is not supported :raises ValueError: if layout\_method is not in LayoutMethodType or None. :raises ValueError: if routing\_method is not in RoutingMethodType or None. :raises ValueError: if approximation\_degree in not None or in the range 0.0 to 1.0. - -**Return type** - -`None` - diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.md new file mode 100644 index 00000000000..9a9824f23e0 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.TwirlingOptions.md @@ -0,0 +1,81 @@ +--- +title: TwirlingOptions +description: API reference for qiskit_ibm_runtime.options.TwirlingOptions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.options.TwirlingOptions +--- + +# TwirlingOptions + + + +`TwirlingOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/twirling_options.py#L28-L67 "view source code") + +Twirling options. + +**Parameters** + +* **enable\_gates** – Whether to apply 2-qubit gate twirling. Default: False. + +* **enable\_measure** – Whether to enable twirling of expectation value measurements in Estimator. Default: True. + +* **num\_randomizations** – The number of random samples to use when twirling or peforming sampled mitigation. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + +* **shots\_per\_randomization** – The number of shots to run for each random sample. If “auto”, the value will be chosen automatically based on the input PUBs. Default: “auto”. + +* **strategy** – + + Specify the strategy of twirling qubits in identified layers of 2-qubit twirled gates. Allowed values are + + * If `"active"` only the instruction qubits in each individual twirled layer will be twirled. + * If `"active-circuit"` the union of all instruction qubits in the circuit will be twirled in each twirled layer. + * If `"active-accum"` the union of instructions qubits in the circuit up to the current twirled layer will be twirled in each individual twirled layer. + * If `"all"` all qubits in the input circuit will be twirled in each twirled layer. + + Default: “active-accum”. + +## Attributes + + + +### enable\_gates + +`UnsetType | bool` + +`= Unset` + + + +### enable\_measure + +`UnsetType | bool` + +`= Unset` + + + +### num\_randomizations + +`UnsetType | int | Literal['auto']` + +`= Unset` + + + +### shots\_per\_randomization + +`UnsetType | int | Literal['auto']` + +`= Unset` + + + +### strategy + +`UnsetType | Literal['active', 'active-accum', 'active-circuit', 'all']` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.md new file mode 100644 index 00000000000..be4f426ea26 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.options.ZneOptions.md @@ -0,0 +1,51 @@ +--- +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 + + + +`ZneOptions(*args, **kwargs)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/options/zne_options.py#L35-L88 "view source code") + +Zero noise extrapolation mitigation options. + +**Parameters** + +* **noise\_factors** – Noise factors to use for noise amplification. Default: (1, 3, 5). + +* **extrapolator** – + + Extrapolator(s) to try (in order) for extrapolating to zero noise. One or more of: + + * ”linear” + * ”exponential” + * ”double\_exponential” + * ”polynomial\_degree\_(1 \<= k \<= 7)” + + Default: (“exponential”, “linear”). + +## Attributes + + + +### extrapolator + +`UnsetType | Literal['linear', 'exponential', 'double_exponential', 'polynomial_degree_1', 'polynomial_degree_2', 'polynomial_degree_3', 'polynomial_degree_4', 'polynomial_degree_5', 'polynomial_degree_6', 'polynomial_degree_7'] | Sequence[Literal['linear', 'exponential', 'double_exponential', 'polynomial_degree_1', 'polynomial_degree_2', 'polynomial_degree_3', 'polynomial_degree_4', 'polynomial_degree_5', 'polynomial_degree_6', 'polynomial_degree_7']]` + +`= Unset` + + + +### noise\_factors + +`UnsetType | Sequence[float]` + +`= Unset` + +## Methods + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md index e0a71a02227..379a5ceea42 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna -`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L427-L644 "view source code") +`ALAPScheduleAnalysis(durations)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L427-L644 "view source code") Dynamic circuits as-late-as-possible (ALAP) scheduling analysis pass. @@ -113,7 +113,7 @@ Name of the pass. -`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L448-L467 "view source code") +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L448-L467 "view source code") Run the ASAPSchedule pass on dag. :type dag: `DAGCircuit` :param dag: DAG to schedule. :type dag: DAGCircuit diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md index e09b7e69458..f9d168c2662 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna -`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L299-L424 "view source code") +`ASAPScheduleAnalysis(durations)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L299-L424 "view source code") Dynamic circuits as-soon-as-possible (ASAP) scheduling analysis pass. @@ -113,7 +113,7 @@ Name of the pass. -`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L320-L339 "view source code") +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/scheduler.py#L320-L339 "view source code") Run the ALAPSchedule pass on dag. :type dag: `DAGCircuit` :param dag: DAG to schedule. :type dag: DAGCircuit diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md index c5d6a3e4554..f0e284663e3 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder -`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L38-L633 "view source code") +`BlockBasePadder(schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L38-L633 "view source code") The base class of padding pass. @@ -104,7 +104,7 @@ Name of the pass. -`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") Run the padding pass on `dag`. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md index 2ff10a04170..14017e5b544 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI -`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L133-L359 "view source code") +`DynamicCircuitInstructionDurations(instruction_durations=None, dt=None, enable_patching=True)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L133-L323 "view source code") 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. @@ -36,7 +36,7 @@ Dynamic circuit instruction durations. -`classmethod from_backend(backend)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L155-L203 "view source code") +`classmethod from_backend(backend)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L155-L167 "view source code") Construct a `DynamicInstructionDurations` object from the backend. :type backend: `Backend` :param backend: backend from which durations (gate lengths) and dt are extracted. @@ -52,7 +52,7 @@ DynamicInstructionDurations -`classmethod from_target(target)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L205-L222 "view source code") +`classmethod from_target(target)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L169-L186 "view source code") Construct a `DynamicInstructionDurations` object from the target. :type target: `Target` :param target: target from which durations (gate lengths) and dt are extracted. @@ -113,7 +113,7 @@ Set of units used in this instruction durations. -`update(inst_durations, dt=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L224-L270 "view source code") +`update(inst_durations, dt=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/utils.py#L188-L234 "view source code") Update self with inst\_durations (inst\_durations overwrite self). Overrides the default durations for certain hardcoded instructions. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md index 6b881b783f3..fb7d5bc2a8a 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay -`PadDelay(durations, fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py#L23-L87 "view source code") +`PadDelay(durations, fill_very_end=True, schedule_idle_qubits=False)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/pad_delay.py#L23-L87 "view source code") Padding idle time with Delay instructions. @@ -117,7 +117,7 @@ Name of the pass. -`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") Run the padding pass on `dag`. diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md index 1abfaaccc54..d790e13084c 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec -`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False, dd_barrier=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py#L39-L567 "view source code") +`PadDynamicalDecoupling(durations, dd_sequences, qubits=None, spacings=None, skip_reset_qubits=True, pulse_alignment=16, extra_slack_distribution='middle', sequence_min_length_ratios=None, insert_multiple_cycles=False, coupling_map=None, alt_spacings=None, schedule_idle_qubits=False, dd_barrier=None)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/dynamical_decoupling.py#L39-L567 "view source code") Dynamical decoupling insertion pass for IBM dynamic circuit backends. @@ -253,7 +253,7 @@ Name of the pass. -`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.20/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") +`run(dag)` [GitHub](https://github.com/Qiskit/qiskit-ibm-runtime/tree/stable/0.21/qiskit_ibm_runtime/transpiler/passes/scheduling/block_base_padder.py#L91-L115 "view source code") Run the padding pass on `dag`. diff --git a/docs/api/qiskit-ibm-runtime/release-notes.md b/docs/api/qiskit-ibm-runtime/release-notes.md index cbf1a33db7d..58e74931d0f 100644 --- a/docs/api/qiskit-ibm-runtime/release-notes.md +++ b/docs/api/qiskit-ibm-runtime/release-notes.md @@ -6,15 +6,59 @@ in_page_toc_max_heading_level: 2 -# Qiskit Runtime IBM Client 0.20 release notes +# Qiskit Runtime IBM Client 0.21 release notes - + +## 0.21.1 + + + +### Bug Fixes + +* Fixed a bug where `SamplerV1` and `EstimatorV1` could not be imported because of an issue with how the aliases were defined. + + + + + +## 0.21.0 + + + +### Upgrade Notes + +* Circuits that do not match the target hardware definition are no longer supported by Qiskit Runtime primitives, unless `channel_strategy="q-ctrl"` is used. See the transpilation documentation ([transpile](/transpile)) for instructions to transform circuits and the primitive examples ([run/primitives-examples](/run/primitives-examples)) to see this coupled with operator transformations. + + + +### Deprecation Notes + +* In a future release, `backend` will be a required parameter for [`qiskit_ibm_runtime.Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler"), and [`qiskit_ibm_runtime.Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") if `session` is not specified, even when using the `ibm_cloud` channel. + + It will also be a required parameter for [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") and `qiskit_ibm_runtime.Batch`. + + + + + +### Bug Fixes + +* Fixed an issue with the [`IBMBackend.target`](qiskit_ibm_runtime.IBMBackend#target "qiskit_ibm_runtime.IBMBackend.target") where it would incorrectly exclude supported control flow operations (`IfElseOp`, `WhileLoop`, etc.) if a given backend supported them. + +* 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 @@ -32,55 +76,59 @@ 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. - + + + ### Bug Fixes * Fix assignment of instruction durations when scheduling circuits with control flow. Prior to this fix, the indices for instructions on inner blocks were not mapped to the physical indices in the outer dag. - + ### Other Notes * The `InstructionDurations` durations input is now also required for the constructor of `PadDelay`. - + - + ## 0.19.1 - + + + ### Upgrade Notes * Extend `DynamicCircuitInstructions.from_backend()` to extract and patch durations from both `BackendV1` and `BackendV2` objects. Also add `DynamicCircuitInstructions.from_target()` to use a `Target` object instead. - + - + ### Bug Fixes * Fix the patching of `DynamicCircuitInstructions` for instructions with durations that are not in units of `dt`. -* Fixed an issue with the `qpy.dump()` function, when the `use_symengine` flag was set to a truthy object that evaluated to `True` but was not actually the boolean `True` the generated QPY payload would be corrupt. - - + - + ## 0.19.0 - + - + ### Upgrade Notes @@ -88,15 +136,15 @@ in_page_toc_max_heading_level: 2 * qiskit-ibm-runtime is now compatible with Qiskit versions >= 0.45, including 1.0.0. - + - + ## 0.18.0 - + - + ### New Features @@ -106,31 +154,31 @@ in_page_toc_max_heading_level: 2 * 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()`](qiskit_ibm_runtime.QiskitRuntimeService#runtime "qiskit_ibm_runtime.QiskitRuntimeService.runtime") has been deprecated. - + - + ### Bug Fixes * Many methods in [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "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()`](qiskit_ibm_runtime.RuntimeJob#inputs "qiskit_ibm_runtime.RuntimeJob.inputs"). - + - + ## 0.17.0 - + - + ### New Features @@ -138,9 +186,9 @@ in_page_toc_max_heading_level: 2 * [`details()`](qiskit_ibm_runtime.Session#details "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 @@ -158,65 +206,65 @@ 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 - + ### Prelude 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 +## 0.15.0-1 - + - + ### Bug Fixes * Reverting 0.15.0 changes to [`from_id()`](qiskit_ibm_runtime.Session#from_id "qiskit_ibm_runtime.Session.from_id") because it was a breaking change without proper deprecation. - + - + ## 0.15.0 - + - + ### New Features @@ -253,17 +301,17 @@ 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 @@ -275,1186 +323,11 @@ Sessions are now thread-safe and allow for multiple concurrent interactive exper * The `circuit_indices` and `observable_indices` run inputs for [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") and [`Sampler`](qiskit_ibm_runtime.Sampler "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`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") but will later be updated to better support submitting multiple jobs at once. - -* Arbitrary keys and values are no longer allowed in `Options`. - - - - - -### Deprecation Notes - -* Custom programs are being deprecated as of qiskit-ibm-runtime 0.14.0 and will be removed on November 27, 2023. Users can instead convert their custom programs to use Qiskit Runtime primitives with Quantum Serverless. Refer to the migration guide for instructions: [https://qiskit-extensions.github.io/quantum-serverless/migration/migration\_from\_qiskit\_runtime\_programs.html](https://qiskit-extensions.github.io/quantum-serverless/migration/migration_from_qiskit_runtime_programs.html) - - - - - -## 0.13.0 - - - - - -### New Features - -* Added a new method, [`details()`](qiskit_ibm_runtime.Session#details "qiskit_ibm_runtime.Session.details") that returns information about a session, including: maximum session time, active time remaining, the current state, and whether or not the session is accepting jobs. - - Also added [`status()`](qiskit_ibm_runtime.Session#status "qiskit_ibm_runtime.Session.status"), which returns the current status of the session. - -* At initialization, if not passed in directly, the default `instance` selected by the provider will be logged at the “INFO” level. When running a job, if the backend selected is not in the default instance but in a different instance the user also has access to, that instance will also be logged. - - - - - -### Upgrade Notes - -* [`qiskit_ibm_runtime.Session.close()`](qiskit_ibm_runtime.Session#close "qiskit_ibm_runtime.Session.close") has been updated to mark a `Session` as no longer accepting new jobs. The session won’t accept more jobs but it will continue to run any queued jobs until they are done or the max time expires. This will also happen automatically when the session context manager is exited. When a session that is not accepting jobs has run out of jobs to run, it’s immediately closed, freeing up the backend to run more jobs rather than wait for the interactive timeout. - - The old close method behavior has been moved to a new method, [`qiskit_ibm_runtime.Session.cancel()`](qiskit_ibm_runtime.Session#cancel "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()`](qiskit_ibm_runtime.IBMBackend#target_history "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 - -* If using a `channel_strategy`, only backends that support that `channel_strategy` will be accessible to the user. - -* Added the option to define a default account in the account json file. To select an account as default, define `set_as_default=True` in `QiskitRuntimeService.save_account()`. - -* Added new method `Session.from_id` which creates a new session with a given id. - -* There will now be a warning if a user submits a job that is predicted to exceed their system execution time monthly quota of 10 minutes. This only applies to jobs run on real hardware in the instance `ibm-q/open/main`. If the job does end up exceeding the quota, it will be canceled. - - - - - -### Upgrade Notes - -* Job error messages now include the error code. Error codes can be found in [errors](/errors). - - - - - -## 0.12.1 - - - - - -### New Features - -* Users can use a new environment variable, `USAGE_DATA_OPT_OUT` to opt out of user module usage tracking by setting this value to `True`. Additionally, only certain qiskit modules will be tracked instead of all modules that begin with qiskit or qiskit\_. - -* Users can now pass in a value of `default` to the `channel_strategy` parameter in [`qiskit_ibm_runtime.QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService"). Now, if an account is configured with a certain channel strategy, the user can override it by passing in `default`. - -* The Sampler and Estimator primitives have been enhanced to incorporate custom validation procedures when the channel\_strategy property within the :class:qiskit\_ibm\_runtime.QiskitRuntimeService is configured as “q-ctrl.” This customized validation logic effectively rectifies incorrect input options and safeguards users against inadvertently disabling Q-CTRL’s performance enhancements. - - - - - -### Bug Fixes - -* Retrieving backend properties with [`properties()`](qiskit_ibm_runtime.IBMBackend#properties "qiskit_ibm_runtime.IBMBackend.properties") now supports passing a `datetime` parameter to retrieve properties from a past date. - -* The `noise_factors` and `extrapolator` options in [`qiskit_ibm_runtime.options.ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "qiskit_ibm_runtime.options.ResilienceOptions") will now default to `None` unless `resilience_level` is set to 2. Only options relevant to the resilience level will be set, so when using `resilience_level` 2, `noise_factors` will still default to `(1, 3, 5)` and `extrapolator` will default to `LinearExtrapolator`. Additionally, options with a value of `None` will no longer be sent to the server. - -* Job error messages will no longer be returned in all uppercase. - -* The max\_execution\_time option is now based on system execution time instead of wall clock time. System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled. Simulator jobs continue to use wall clock time. - - - - - -## 0.12.0 - - - - - -### New Features - -* Added a `global_service`, so that if the user defines a QiskitRuntimeService, it will be used by the primitives, even if the service is not passed to them explicitly. For example: - - ```python - from qiskit_ibm_runtime import QiskitRuntimeService, Sampler - service = QiskitRuntimeService(channel="ibm_quantum") - # Sampler._service field will be initialized to ``service`` - sampler = Sampler(backend="ibmq_qasm_simulator") - ``` - -* Added a new method, [`qiskit_ibm_runtime.QiskitRuntimeService.instances()`](qiskit_ibm_runtime.QiskitRuntimeService#instances "qiskit_ibm_runtime.QiskitRuntimeService.instances") that returns all instances(hub/group/project) the user is in. This is only for the `ibm_quantum` channel since the `ibm_cloud` channel does not have multiple instances. - -* Added validations for options on the second level of the dict, i.e., for each of resilience, simulator, execution, and transpilation, check that their options are supported. Otherwise throw an exception. - -* There is a new parameter, `channel_strategy` that can be set in the initialization of [`qiskit_ibm_runtime.QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") or saved in [`qiskit_ibm_runtime.QiskitRuntimeService.save_account()`](qiskit_ibm_runtime.QiskitRuntimeService#save_account "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()`](qiskit_ibm_runtime.RuntimeJob#inputs "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 - -* When running on channel “ibm\_cloud”, it is possible not to specify the backend. In this case, the system selects one of the available backends for this service. Issue #625 [https://github.com/Qiskit/qiskit-ibm-runtime/issues/625](https://github.com/Qiskit/qiskit-ibm-runtime/issues/625) reported that the the backend returned by `job.backend()` was not always the actual backend on which the job was run. This PR fixes this bug. - -* Fixes a race condition in the test test\_cancel\_running\_job() in test\_job.py where job cancellation could not be performed. Refer to #1019 \<[https://github.com/Qiskit/qiskit-ibm-runtime/issues/1019](https://github.com/Qiskit/qiskit-ibm-runtime/issues/1019)>\_ for more details. - -* Previously we added validation when jobs were run to make sure the number of circuits was not greater than the maximum for that backend, `backend.max_circuits`. This limit isn’t actually necessary for primtives run from within a session. - - - - - -## 0.11.3 - - - - - -### New Features - -* Added reason for failure when invoking the method [`error_message()`](qiskit_ibm_runtime.RuntimeJob#error_message "qiskit_ibm_runtime.RuntimeJob.error_message"). - -* Added a new property, [`usage_estimation()`](qiskit_ibm_runtime.RuntimeJob#usage_estimation "qiskit_ibm_runtime.RuntimeJob.usage_estimation") that returns the estimated system execution time, `quantum_seconds`. System execution time represents the amount of time that the system is dedicated to processing your job. - -* Raise an exception if the number of circuits passed to `_run_primitive()` exceeds the number of circuits supported on the backend. - -* There is a new method [`update_tags()`](qiskit_ibm_runtime.RuntimeJob#update_tags "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`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService"), then this is used as a filter in `QiskitRuntimeService.backends()`. If `instance` is not recognized as one of the provider instances, an exception will be raised. Previously, we only issued a warning. - - - - - -## 0.11.2 - - - - - -### New Features - -* If a job has been cancelled, and job.result() is requested, throw an exception rather than returning None. - -* A new method, [`qiskit_ibm_runtime.options.SimulatorOptions.set_backend()`](qiskit_ibm_runtime.options.SimulatorOptions#set_backend "qiskit_ibm_runtime.options.SimulatorOptions.set_backend"), allows users to more easily set simulator options for a backend. - - ```python - from qiskit.providers.fake_provider import FakeManila - from qiskit_aer.noise import NoiseModel - - # Make a noise model - fake_backend = FakeManila() - - # Set options to include the noise model - options = Options() - options.simulator.set_backend(fake_backend) - 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()`](qiskit_ibm_runtime.RuntimeJob#metrics "qiskit_ibm_runtime.RuntimeJob.metrics"), the bss field will be replaced by usage. - - - - - -## 0.11.0 - - - - - -### New Features - -* When retrieving a job with `qiskit_ibm_runtime.IBMRuntimeService.job()` the `params` will no longer be returned from the API. They will instead be loaded loazily when they are actually needed in [`qiskit_ibm_runtime.RuntimeJob.inputs()`](qiskit_ibm_runtime.RuntimeJob#inputs "qiskit_ibm_runtime.RuntimeJob.inputs"). - -* Added warning when the backend is not active in QiskitRuntimeService.run. - -* Support input of type `CouplingMap` when given as simulator option. Previously we supported, for example: - - ```python - options.simulator = {"coupling_map": [[0, 1], [1, 0]]} - ``` - - Now we also support the following: - - ```python - 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`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") or [`qiskit_ibm_runtime.Estimator`](qiskit_ibm_runtime.Estimator "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`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") and [`qiskit_ibm_runtime.Estimator`](qiskit_ibm_runtime.Estimator "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`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") or [`qiskit_ibm_runtime.Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") has been deprecated. Please use the `backend` parameter instead. You can continue to pass a session using the `session` parameter. - - - - - -## 0.10.0 - - - - - -### New Features - -* Python 3.11 is now supported. - - - - - -### Upgrade Notes - -* Added error messages in case the user defines unsupported values for ‘max\_execution\_time’. Previously, this validation was done on the server side. - - - - - -### Bug Fixes - -* Added deserialization of the params of RuntimeJob.inputs. Previously, the circuits were returned in serialized format. Fixes issue [#829](https://github.com/Qiskit/qiskit-ibm-runtime/issues/829). - -* Allow for users to retrieve all backends even if one of the backends has a missing configuration. The backend without a configuration will not be returned. - - - - - -## 0.9.4 - - - - - -### New Features - -* Added methods to validate input options to `transpilation` and `environment` options. - - - - - -### Upgrade Notes - -* When constructing a backend `qiskit.transpiler.Target`, faulty qubits and gates from the backend configuration will be filtered out. - - - - - -### Deprecation Notes - -* The deprecated arguments `circuits`, `parameters`, `service`, and `skip_transpilation` have been removed from [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler"). - - Similarly, the deprecated arguments `circuits`, `observables`, `parameters`, `service`, and `skip_transpilation` have been removed from [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator"). - - In [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService"), the `auth` parameter has been removed. Additionally, the `instance`, `job_tags`, and `max_execution_time` paramters have been removed from [`qiskit_ibm_runtime.QiskitRuntimeService.run()`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run"). They can be passed in through [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") instead. - - Within [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "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`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") is initialized. Instead, the configuration is only loaded and cached during [`get_backend()`](qiskit_ibm_runtime.QiskitRuntimeService#get_backend "qiskit_ibm_runtime.QiskitRuntimeService.get_backend") and [`backends()`](qiskit_ibm_runtime.QiskitRuntimeService#backends "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`](qiskit_ibm_runtime.RuntimeOptions "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()`](qiskit_ibm_runtime.IBMBackend#target_history "qiskit_ibm_runtime.IBMBackend.target_history"). This method is similar to [`target()`](qiskit_ibm_runtime.IBMBackend#target "qiskit_ibm_runtime.IBMBackend.target"). The difference is that the new method enables the user to pass a datetime parameter, to retrieve historical data from the backend. - - - - - -### Upgrade Notes - -* Accept all options on given on level 1 and assign them to the appropriate hierarchical option type. For example, if the user provides `options = {"shots": 10}` as input to Sampler/Estimator, this will be interpreted as `options = {"execution: {"shots": 10}}`. - -* If a job is returned without a backend, retrieving the backend through [`qiskit_ibm_runtime.RuntimeJob.backend()`](qiskit_ibm_runtime.RuntimeJob#backend "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`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") have now been removed. - -* Added a user warning when the user passes an option that is not supported in Options. - - - - - -### Bug Fixes - -* Fixed a bug where the default values for `optimization_level` and for `resilience_level` were not being set correctly. - -* Fixed an issue where if no backend was selected, `optimization_level` and `resilience_level` would default to `None`, causing the job to fail. - -* If an instance is passed in to [`qiskit_ibm_runtime.QiskitRuntimeService.get_backend()`](qiskit_ibm_runtime.QiskitRuntimeService#get_backend "qiskit_ibm_runtime.QiskitRuntimeService.get_backend") and then the backend is used in a session, all jobs within the session will be run from the original instance passed in. - -* Removed additional decomposition of `BlueprintCircuit`s in the JSON encoder. This was introduced as a bugfix, but has since been fixed. Still doing the decomposition led to possible problems if the decomposed circuit was not in the correct basis set of the backend anymore. - - - - - -## 0.9.1 - - - - - -### Upgrade Notes - -* [`qiskit_ibm_runtime.QiskitRuntimeService.jobs()`](qiskit_ibm_runtime.QiskitRuntimeService#jobs "qiskit_ibm_runtime.QiskitRuntimeService.jobs") now has a `backend_name` parameter that can be used to only return jobs run with the specified backend. - -* Allow the user to store account details in a file specified by the user in the parameter. `filename`. The default remains \~/.qiskit/qiskit-ibm.json. Example of usage: Ex: - - ```python - QiskitRuntimeService.save_account(channel="ibm_quantum", - filename="~/my_account_file.json", - name = "my_account", - token="my_token") - service = QiskitRuntimeService(channel="ibm_quantum", - filename="~/my_account_file.json", - name = "my_account",) - ``` - - - - - -### Deprecation Notes - -* `backend` is no longer a supported option when using [`qiskit_ibm_runtime.Session.run()`](qiskit_ibm_runtime.Session#run "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()`](qiskit_ibm_runtime.RuntimeJob#session_id "qiskit_ibm_runtime.RuntimeJob.session_id") and [`tags()`](qiskit_ibm_runtime.RuntimeJob#tags "qiskit_ibm_runtime.RuntimeJob.tags") were added for an easy way to return the session\_id and job\_tags of a job. - - - - - -### Bug Fixes - -* Fixed a bug where jobs that did not run before a session closes are not actually run as a part of that session. Jobs should run as a part of a session even if that session is closed by the exit of the context manager. - -* Fixes the issue wherein submitting a large job fails due to write operation timeout. - - - - - -## 0.8.0 - - - - - -### New Features - -* Python 3.10 is now supported. - -* Advanced resilience options can now be set under `options.resilience`. See [`qiskit_ibm_runtime.options.ResilienceOptions`](qiskit_ibm_runtime.options.ResilienceOptions "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()`](qiskit_ibm_runtime.QiskitRuntimeService#run "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`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") instance is passed to the [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") constructor, the service used to initialize the `IBMBackend` instance is used for the session instead of the default account service. - - - - - -## 0.7.0 - - - - - -### New Features - -* `qiskit_ibm_runtime.Options` class now accepts arbitrary keyword arguments. This allows users to specify new options to the primitive programs without upgrading `qiskit_ibm_runtime`. These arbitrary keyword arguments, however, are not validated. - -* The [`qiskit_ibm_runtime.options.EnvironmentOptions`](qiskit_ibm_runtime.options.EnvironmentOptions "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`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") has also been updated to include these two parameters. - - - - - -### Upgrade Notes - -* This version of qiskit-ibm-runtime requires qiskit-terra version 0.22 or higher. The `requirements.txt` file has been updated accordingly. - - - - - -### Deprecation Notes - -* Qiskit Runtime programs `torch-train`, `torch-infer`, `sample-expval`, `sample-program`, and `quantum_kernal_alignment` have been deprecated due to low usage. - -* Passing `instance` parameter to the [`qiskit_ibm_runtime.QiskitRuntimeService.run()`](qiskit_ibm_runtime.QiskitRuntimeService#run "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`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") has been deprecated. Please pass them inside `options`. - - - - - -### Bug Fixes - -* Fixes the missing section on retrieving jobs in the how-to guide. - - - - - -## 0.7.0rc2 - - - - - -### Upgrade Notes - -* Added a validation check to [`run()`](qiskit_ibm_runtime.Sampler#run "qiskit_ibm_runtime.Sampler.run"). It raises an error if there is no classical bit. - -* [`Sampler`](qiskit_ibm_runtime.Sampler "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`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") class is now a subclass of `qiskit.providers.Job`. - - - - - -### Deprecation Notes - -* `job_id` and `backend` attributes of [`qiskit_ibm_runtime.RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") have been deprecated. Please use [`qiskit_ibm_runtime.RuntimeJob.job_id()`](qiskit_ibm_runtime.RuntimeJob#job_id "qiskit_ibm_runtime.RuntimeJob.job_id") and [`qiskit_ibm_runtime.RuntimeJob.backend()`](qiskit_ibm_runtime.RuntimeJob#backend "qiskit_ibm_runtime.RuntimeJob.backend") methods instead. - -* The `backend_name` attribute in [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") is deprecated and replaced by `backend`. - - - - - -## 0.7.0rc1 - - - - - -### Prelude - -There are significant changes to how primitives are invoked within a session, and the options available to the primitives. Please review the rest of the release notes and the tutorials for full information. - - - - - -### New Features - -* You can now invoke the same or different primitive programs multiple times within a session. For example: - - ```python - from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler, Estimator, Options - from qiskit.test.reference_circuits import ReferenceCircuits - from qiskit.circuit.library import RealAmplitudes - from qiskit.quantum_info import SparsePauliOp - - # Initialize account. - service = QiskitRuntimeService() - - # Set options, which can be overwritten at job level. - options = Options(optimization_level=1) - - # Prepare inputs. - bell = ReferenceCircuits.bell() - psi = RealAmplitudes(num_qubits=2, reps=2) - H1 = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) - theta = [0, 1, 1, 2, 3, 5] - - with Session(service=service, backend="ibmq_qasm_simulator") as session: - # Submit a request to the Sampler primitive within the session. - sampler = Sampler(session=session, options=options) - job = sampler.run(circuits=bell) - print(f"Sampler results: {job.result()}") - - # Submit a request to the Estimator primitive within the session. - estimator = Estimator(session=session, options=options) - job = estimator.run( - circuits=[psi], observables=[H1], parameter_values=[theta] - ) - print(f"Estimator results: {job.result()}") - ``` - -* A new `qiskit_ibm_runtime.Options` class is introduced. This class allows you to auto-complete options related to primitive programs. For example: - - ```python - from qiskit_ibm_runtime import Session, Sampler, Options - from qiskit.test.reference_circuits import ReferenceCircuits - - options = Options() - options.optimization_level = 3 # This can be done using auto-complete. - - with Session(backend="ibmq_qasm_simulator") as session: - # Pass the options to Sampler. - sampler = Sampler(session=session, options=options) - - # Or at job level. - job = sampler.run(circuits=ReferenceCircuits.bell(), shots=4000) - ``` - -* [`qiskit_ibm_runtime.RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") has a new method [`metrics()`](qiskit_ibm_runtime.RuntimeJob#metrics "qiskit_ibm_runtime.RuntimeJob.metrics"). This method returns the metrics of a job, which includes timestamp information. - -* The [`qiskit_ibm_runtime.QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") `channel` can now be stored as an environment variable, `QISKIT_IBM_CHANNEL`. This way, when using Runtime Primitives, the service does not have to be instantiated manually and can instead be created directly from environment variables. - - - - - -### Upgrade Notes - -* Raise `RuntimeJobMaxTimeoutError` when a job runs for too long so that it can be handled appropriately by programs. - -* The experimental parameters `transpilation_settings`, `resilience_settings`, and `max_time` to the :class:\`qiskit\_ibm\_runtime.Sampler and [`qiskit_ibm_runtime.Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") constructors have been removed. You can instead use the `qiskit_ibm_runtime.Options` class to specify the settings, and `max_time` can be specified when starting a new session. For example: - - ```python - from qiskit_ibm_runtime import Session, Sampler, Options - - options = Options() - # This can be done using auto-complete. - option.optimization_level = 3 - options.resilience_level = 1 - - with Session(max_time="2h") as session: - # Pass the options to Sampler. - sampler = Sampler(session=session, options=options) - ``` - -* Since some accounts have many runtime programs, caching a list of all programs on the first call of `programs()` has been removed. Instead, programs will only be cached up to the `limit` given, which has a default value of 20. - - - - - -### Deprecation Notes - -* Invoking [`qiskit_ibm_runtime.Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") and [`qiskit_ibm_runtime.Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") as context managers has been deprecated. You can instead use the qiskit\_ibm\_runtime.Session class to create a new session and invoke one or more primitives within the session. - - As a result, passing input parameters, such as `circuits`, `observables`, and `parameter_values`, as well as `service` to the constructors of `Sampler` and `Estimator` has also been deprecated. The inputs can now be passed to the `run()` method of the primitive classes, and `service` can be passed to [`qiskit_ibm_runtime.Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session") when starting a new session. - -* Passing `skip_transpilation` to the :class:\`qiskit\_ibm\_runtime.Sampler and [`qiskit_ibm_runtime.Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") constructors has been deprecated. You can instead use the `qiskit_ibm_runtime.Options` class to specify this option. For example: - - ```python - from qiskit_ibm_runtime import Options - - options = Options() - # This can be done using auto-complete. - options.transpilation.skip_transpilation = True - ``` - - - - - -### Bug Fixes - -* Fixes issue [#428](https://github.com/Qiskit/qiskit-ibm-runtime/issues/428) by raising the minimum required `qiskit-terra` version to `0.21.0`, since latest version of `qiskit-ibm-runtime` is not compatible with `0.20.0` or earlier of `qiskit-terra`. - - - - - -## 0.6.0 - - - - - -### Upgrade Notes - -* When migrating from `qiskit-ibmq-provider` your `ibm_quantum` channel credentials will get automatically copied over from the qiskitrc file and a qiskit-ibm.json file will get created if one doesn’t exist. You have to just initialize [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") class without passing any parameters to use this copied over default `ibm_quantum` account. - - Ex: - - ```python - from qiskit_ibm_runtime import QiskitRuntimeService - service = QiskitRuntimeService() - ``` - -* `IBMEstimator` class which was deprecated earlier is now removed. Use [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") class going forward. - -* `IBMRuntimeService` class which was deprecated earlier is now removed. Use [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") class going forward. - - - - - -## 0.5.0 - - - - - -### Prelude - -This release leverages the API and Queue enhancements to become more runtime session aware. As a result when using the primitives (sampler and estimator), runtime jobs in the same session will skip to the front of the queue, thereby speeding up the runtime session, once it has started. - - - - - -### New Features - -* The `service` object which is an instance of [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") class can now be accessed from [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class using the `service` property. - - Ex: - - ```python - backend = service.get_backend("ibmq_qasm_simulator") - backend.service # QiskitRuntimeService instance used to instantiate the backend - ``` - - - - - -### Upgrade Notes - -* [`jobs()`](qiskit_ibm_runtime.QiskitRuntimeService#jobs "qiskit_ibm_runtime.QiskitRuntimeService.jobs") has two new parameters, `created_after` and `created_before`. These can be used to filter jobs by creation date in local time. - -* The parameters `circuit_indices` and `observable_indices` when calling `estimator` are now deprecated and will be removed in a future release. You can now pass either indices or objects using the `circuits` and `observables` parameters. - - Ex: - - ```python - with Estimator( - circuits=[qc1, qc2], - observables=[H1, H2, H3], - service=service, - options=options - ) as estimator: - # pass circuits and observables as indices - result = estimator(circuits=[0, 1], observables=[0, 1], parameter_values=[theta1, theta2]) - - # pass circuits and observables as objects - result = estimator(circuits=[qc1, qc2], observables=[H1, H3], parameter_values=[theta1, theta3]) - ``` - -* The parameters `circuit_indices` and `observable_indices` when calling `estimator` are now deprecated and will be removed in a future release. You can now pass either indices or objects using the `circuits` and `observables` parameters. - - Ex: - - ```python - with Sampler( - circuits=[qc1, qc2], - service=service, - options=options - ) as sampler: - # pass circuits as indices - result = sampler(circuits=[0, 1], parameter_values=[theta1, theta2]) - - # pass circuit as objects - result = sampler(circuits=[qc1, qc2], parameter_values=[theta2, theta3]) - ``` - -* The `session_id`, which is the Job ID of the first job in a runtime session can now be used as a filter in [`jobs()`](qiskit_ibm_runtime.QiskitRuntimeService#jobs "qiskit_ibm_runtime.QiskitRuntimeService.jobs") with the parameter `session_id`. - -* [`run()`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") now supports a new parameter, `job_tags`. These tags can be used when filtering jobs with [`jobs()`](qiskit_ibm_runtime.QiskitRuntimeService#jobs "qiskit_ibm_runtime.QiskitRuntimeService.jobs"). - -* [`run()`](qiskit_ibm_runtime.QiskitRuntimeService#run "qiskit_ibm_runtime.QiskitRuntimeService.run") now supports a new parameter, `max_execution_time`, which can be used to override the default program maximum execution time. It should be less than or equal to the program maximum execution time. - -* [`jobs()`](qiskit_ibm_runtime.QiskitRuntimeService#jobs "qiskit_ibm_runtime.QiskitRuntimeService.jobs") has a new parameter, `descending`. This parameter defaults to `True`, where jobs will be returned in descending order based on creation date. - -* `RuntimeJobTimeoutError` is now raised when the `timeout` set in [`result()`](qiskit_ibm_runtime.RuntimeJob#result "qiskit_ibm_runtime.RuntimeJob.result") or [`wait_for_final_state()`](qiskit_ibm_runtime.RuntimeJob#wait_for_final_state "qiskit_ibm_runtime.RuntimeJob.wait_for_final_state") expires. - -* When initializing [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService") and an invalid token is used, `IBMNotAuthorizedError` will be raised instead of `RequestsApiError`. - -* `IBMSampler` class which was deprecated earlier is now removed. Use [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") class going forward. - -* [`qubit_properties()`](qiskit_ibm_runtime.IBMBackend#qubit_properties "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 - -* `IBMRuntimeService` has been renamed to `QiskitRuntimeSerice`. `IBMRuntimeService` class is now deprecated and will be removed in a future release. - - Example: - - Before: - - ```python - from qiskit_ibm_runtime import IBMRuntimeService - service = IBMRuntimeService(channel="ibm_cloud", token="...", instance="...") - ``` - - After: - - ```python - from qiskit_ibm_runtime import QiskitRuntimeService - service = QiskitRuntimeService(channel="ibm_cloud", token="...", instance="...") - ``` - -* `IBMEstimator` class is now deprecated and will be removed in a future release. Use [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") class going forward. - - Example: - - Before: - - ```python - from qiskit_ibm_runtime import IBMRuntimeService, IBMEstimator - service = IBMRuntimeService(channel="ibm_cloud", token="...", instance="...") - - estimator_factory = IBMEstimator(service=service, backend="ibmq_qasm_simulator") - - with estimator_factory(circuits=[qc], observables="...", parameters="...") as estimator: - result = estimator(circuit_indices=[0], ...) - ``` - - After: - - ```python - from qiskit_ibm_runtime import QiskitRuntimeService, Estimator - service = QiskitRuntimeService(channel="ibm_cloud", token="...", instance="...") - - with Estimator( - circuits=[qc], - observables="...", - parameters="...", - service=service, - options={ "backend": "ibmq_qasm_simulator" }, # or IBMBackend<"ibmq_qasm_simulator"> - ) as estimator: - result = estimator(circuit_indices=[0], ...) - ``` - -* `IBMSampler` class is now deprecated and will be removed in a future release. Use [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") class going forward. - - Example: - - Before: - - ```python - from qiskit_ibm_runtime import IBMRuntimeService, IBMSampler - service = IBMRuntimeService(channel="ibm_cloud", token="...", instance="...") - - sampler_factory = IBMSampler(service=service, backend="ibmq_qasm_simulator") - - with sampler_factory(circuits=[qc], parameters="...") as sampler: - result = sampler(circuit_indices=[0], ...) - ``` - - After: - - ```python - from qiskit_ibm_runtime import QiskitRuntimeService, Sampler - service = QiskitRuntimeService(channel="ibm_cloud", token="...", instance="...") - - with Sampler( - circuits=[qc], - parameters="...", - service=service, - options={ "backend": "ibmq_qasm_simulator" }, # or IBMBackend<"ibmq_qasm_simulator"> - ) as sampler: - 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`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService"), [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") and [`Sampler`](qiskit_ibm_runtime.Sampler "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()`](qiskit_ibm_runtime.RuntimeJob#wait_for_final_state "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()`](qiskit_ibm_runtime.RuntimeJob#status "qiskit_ibm_runtime.RuntimeJob.status") was called beforehand. - - - - - -## 0.1.0 - - - - - -### Prelude - -qiskit-ibm-runtime is a new Python API client for accessing the quantum programs, systems and simulators at IBM Quantum via the Qiskit Runtime Service. - -This new package is built upon the work already done in qiskit.providers.ibmq.runtime module in the qiskit-ibmq-provider package and replaces it going forward. The runtime module in qiskit-ibmq-provider package is now deprecated. - -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 - -* qiskit-ibm-runtime package no longer uses the \$HOME/.qiskit/qiskitrc file used by qiskit-ibmq-provider to save credentials. Credentials are now stored in a JSON format in \$HOME/.qiskit/qiskit-ibm.json file when you use `qiskit_ibm_runtime.IBMRuntimeService.save_account()` method. - - You can now save multiple credentials and give an optional name for each credential. - -* Qiskit Runtime service is accessible using an IBM Quantum (legacy) account or an IBM Cloud (cloud) account. qiskit-ibm-runtime enables you to connect to either of these accounts: - - ```python - # Legacy - from qiskit_ibm_runtime import IBMRuntimeService - service = IBMRuntimeService(auth="legacy", token="abc") - - # Cloud - from qiskit_ibm_runtime import IBMRuntimeService - service = IBMRuntimeService(auth="cloud", token="abc", instance="IBM Cloud CRN or Service instance name") - ``` - -* [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class now implements the `qiskit.providers.BackendV2` interface and provides flatter access to the configuration of a backend, for example: - - ```python - # BackendV1: - backend.configuration().n_qubits - - # BackendV2: - backend.num_qubits - ``` - - Only breaking change when compared to BackendV1 is backend.name is now an attribute instead of a method. - - Refer to the [`qiskit_ibm_runtime.IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") class doc string for a list of all available attributes. - -* If you used qiskit.providers.ibmq.AccountProvider.get\_backend method (for example, `provider.get_backend("ibmq_qasm_simulator")`) in the qiskit-ibmq-provider package, it’s equivalent method in this new package is `qiskit_ibm_runtime.IBMRuntimeService.backend()`: - - ```python - service = IBMRuntimeService() - backend = service.backend("ibmq_qasm_simulator") - ``` - -* It is now optional to specify a hub/group/project upfront when connecting to the legacy IBM Quantum account. The hub/group/project is selected in the following order. - - > * hub/group/project if passed via `instance` parameter when initializing `qiskit_ibm_runtime.IBMRuntimeService` - > * the specific hub/group/project required by the backend specified when calling `qiskit_ibm_runtime.IBMRuntimeService.run()` - > * the default set previously via `qiskit_ibm_runtime.IBMRuntimeService.save_account()` - > * a premium hub/group/project in your account - > * open access hub/group/project - -* It is now optional to specify backend\_name in options when executing `qiskit_ibm_runtime.IBMRuntimeService.run()` method when using cloud runtime (IBM Cloud only). The server will automatically pick a backend and return the name. - -* qiskit.providers.ibmq.runtime.IBMRuntimeService.logout method in qiskit-ibmq-provider which was used to clear authorization cache on the server has been removed. - -* Python 3.6 has reached end of life and will no longer be supported in the new qiskit-ibm-runtime package. - -* qiskit.providers.ibmq.runtime.IBMRuntimeService.run\_circuits method in qiskit-ibmq-provider has been removed and will be replaced by the `Sampler` primitive program. - -* `qiskit_ibm_runtime.IBMRuntimeService.run()` method now accepts runtime execution options as [`qiskit_ibm_runtime.RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions") class in addition to already supported Dict. backend\_name, image and log\_level are the currently available options. - -* Final result is also streamed now after interim results when you specify a `callback` to `qiskit_ibm_runtime.IBMRuntimeService.run()` or [`qiskit_ibm_runtime.RuntimeJob.stream_results()`](qiskit_ibm_runtime.RuntimeJob#stream_results "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`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.utils.json.RuntimeEncoder") and [`qiskit_ibm_runtime.utils.json.RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.utils.json.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`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.utils.json.RuntimeEncoder") and [`qiskit_ibm_runtime.utils.json.RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.utils.json.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()`](qiskit_ibm_runtime.RuntimeJob#interim_results "qiskit_ibm_runtime.RuntimeJob.interim_results") method to retrieve runtime program interim results. Note that interim results will only be available for up to two days. - - - - - -### Upgrade Notes - -* In order to be consistent with other properties in [`qiskit_ibm_runtime.RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob") class the job\_id and backend methods have been converted to properties. - -* When uploading a program with `qiskit_ibm_runtime.IBMRuntimeService.upload_program()`, the program description is now optional. - -* When printing programs with `qiskit_ibm_runtime.IBMRuntimeService.pprint_programs()`, `backend_requirements` will now be listed. - - - - - -### Bug Fixes - -* Fixed an issue with JSON encoding and decoding when using `ParameterExpression`s in conjunction with Qiskit Terra 0.19.1 and above. Previously, the `Parameter` instances reconstructed from the JSON output would have different unique identifiers, causing them to seem unequal to the input. They will now have the correct backing identities. - diff --git a/docs/api/qiskit-ibm-runtime/runtime_service.md b/docs/api/qiskit-ibm-runtime/runtime_service.md index 9c91dfe440a..664a47067eb 100644 --- a/docs/api/qiskit-ibm-runtime/runtime_service.md +++ b/docs/api/qiskit-ibm-runtime/runtime_service.md @@ -29,41 +29,49 @@ Qiskit Runtime also has the concept of a session. Jobs submitted within a sessio Below is an example of using primitives within a session: ```python -from qiskit_ibm_runtime import QiskitRuntimeService, Session, Sampler, Estimator, Options +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() -# Set options, which can be overwritten at job level. -options = Options(optimization_level=3) - # 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="qc") +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=service, backend="ibmq_qasm_simulator") as session: +backend = service.least_busy(operational=True, simulator=False) +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, options=options) - job = sampler.run(circuits=qc) - print(f"Sampler results: {job.result()}") + 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, options=options) + estimator = Estimator(session=session) + estimator.options.resilience_level = 1 # Set options. job = estimator.run( - circuits=[psi], observables=[H1], parameter_values=[theta] + [(psi_isa_circuit, isa_observables, theta)] ) - print(f"Estimator results: {job.result()}") + pub_result = job.result()[0] + print(f"Expectation values: {pub_result.data.evs}") ``` ## Backend data @@ -103,44 +111,21 @@ import logging logging.getLogger('qiskit_ibm_runtime').setLevel(logging.WARNING) ``` -### Interim and final results - -Some runtime primitives provide interim results that inform you about the progress of your job. You can choose to stream the interim results and final result when you run the program by passing in the `callback` parameter, or at a later time using the [`RuntimeJob.stream_results()`](qiskit_ibm_runtime.RuntimeJob#stream_results "qiskit_ibm_runtime.RuntimeJob.stream_results") method. For example: - -```python -from qiskit_ibm_runtime import QiskitRuntimeService, Sampler -from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister - -service = QiskitRuntimeService() -backend = service.backend("ibmq_qasm_simulator") - -# Bell Circuit -qr = QuantumRegister(2, name="qr") -cr = ClassicalRegister(2, name="qc") -qc = QuantumCircuit(qr, cr, name="bell") -qc.h(qr[0]) -qc.cx(qr[0], qr[1]) -qc.measure(qr, cr) - -def result_callback(job_id, result): - print(result) - -# Stream results as soon as the job starts running. -job = Sampler(backend).run(qc, callback=result_callback) -print(job.result()) -``` - ## 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")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | -| [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler")(\[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 flexible Qiskit Runtime session. | -| [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend")(configuration, service, api\_client) | Backend class interfacing with an IBM Quantum backend. | -| [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob")(backend, api\_client, ...\[, ...]) | Representation of a runtime program execution. | -| [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions")(\[backend, image, log\_level, ...]) | Class for representing generic runtime execution options. | -| [`RuntimeEncoder`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, ...]) | JSON Encoder used by runtime service. | -| [`RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| [`QiskitRuntimeService`](qiskit_ibm_runtime.QiskitRuntimeService "qiskit_ibm_runtime.QiskitRuntimeService")(\[channel, token, url, ...]) | Class for interacting with the Qiskit Runtime service. | +| [`Estimator`](qiskit_ibm_runtime.Estimator "qiskit_ibm_runtime.Estimator") | alias of [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.estimator.EstimatorV1") | +| [`EstimatorV1`](qiskit_ibm_runtime.EstimatorV1 "qiskit_ibm_runtime.EstimatorV1")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | +| [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.EstimatorV2")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Estimator primitive service. | +| [`Sampler`](qiskit_ibm_runtime.Sampler "qiskit_ibm_runtime.Sampler") | alias of [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.sampler.SamplerV1") | +| [`SamplerV1`](qiskit_ibm_runtime.SamplerV1 "qiskit_ibm_runtime.SamplerV1")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Sampler primitive service. | +| [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.SamplerV2")(\[backend, session, options]) | Class for interacting with Qiskit Runtime Sampler primitive service. | +| [`Session`](qiskit_ibm_runtime.Session "qiskit_ibm_runtime.Session")(\[service, backend, max\_time]) | Class for creating a Qiskit Runtime session. | +| [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend")(configuration, service, api\_client) | Backend class interfacing with an IBM Quantum backend. | +| [`RuntimeJob`](qiskit_ibm_runtime.RuntimeJob "qiskit_ibm_runtime.RuntimeJob")(backend, api\_client, ...\[, ...]) | Representation of a runtime program execution. | +| [`RuntimeOptions`](qiskit_ibm_runtime.RuntimeOptions "qiskit_ibm_runtime.RuntimeOptions")(\[backend, image, log\_level, ...]) | Class for representing generic runtime execution options. | +| [`RuntimeEncoder`](qiskit_ibm_runtime.RuntimeEncoder "qiskit_ibm_runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, ...]) | JSON Encoder used by runtime service. | +| [`RuntimeDecoder`](qiskit_ibm_runtime.RuntimeDecoder "qiskit_ibm_runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | diff --git a/public/api/qiskit-ibm-runtime/0.20/objects.inv b/public/api/qiskit-ibm-runtime/0.20/objects.inv new file mode 100644 index 00000000000..9135aef616b Binary files /dev/null and b/public/api/qiskit-ibm-runtime/0.20/objects.inv differ diff --git a/public/api/qiskit-ibm-runtime/dev/objects.inv b/public/api/qiskit-ibm-runtime/dev/objects.inv index fc888617054..0e15902a753 100644 Binary files a/public/api/qiskit-ibm-runtime/dev/objects.inv and b/public/api/qiskit-ibm-runtime/dev/objects.inv differ diff --git a/public/api/qiskit-ibm-runtime/objects.inv b/public/api/qiskit-ibm-runtime/objects.inv index 9135aef616b..0e15902a753 100644 Binary files a/public/api/qiskit-ibm-runtime/objects.inv and b/public/api/qiskit-ibm-runtime/objects.inv differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_00.png b/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_00.png new file mode 100644 index 00000000000..69d83403d08 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_00.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_01.png b/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_01.png new file mode 100644 index 00000000000..ac2dad8b727 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_01.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_02.png new file mode 100644 index 00000000000..b266634ef2c Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png new file mode 100644 index 00000000000..a26eed7507a Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png new file mode 100644 index 00000000000..0db7b6b93f0 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png new file mode 100644 index 00000000000..47ff556d048 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png new file mode 100644 index 00000000000..5fbd33ac650 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png new file mode 100644 index 00000000000..118ec8d280d Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png new file mode 100644 index 00000000000..677d65078bf Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png new file mode 100644 index 00000000000..5968bd240a1 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png new file mode 100644 index 00000000000..d044d67d611 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png new file mode 100644 index 00000000000..6669b990a37 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png new file mode 100644 index 00000000000..0b66792a672 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png new file mode 100644 index 00000000000..0b66792a672 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png new file mode 100644 index 00000000000..4b07ea377c8 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png new file mode 100644 index 00000000000..bc63d5d05e5 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png new file mode 100644 index 00000000000..38e621e254a Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png new file mode 100644 index 00000000000..b015c553886 Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png new file mode 100644 index 00000000000..5c8b49fcadc Binary files /dev/null and b/public/images/api/qiskit-ibm-runtime/0.20/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png index 82713ca19db..ba2b63ef0c0 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png index b266634ef2c..bd60b6cb95b 100644 Binary files a/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png differ diff --git a/scripts/api-html-artifacts.json b/scripts/api-html-artifacts.json index d7c8344c03b..bccd0c08753 100644 --- a/scripts/api-html-artifacts.json +++ b/scripts/api-html-artifacts.json @@ -33,7 +33,8 @@ "0.7": "https://ibm.box.com/shared/static/t2vuik7bqboata3i34r4a83baabo95xn.zip" }, "qiskit-ibm-runtime": { - "dev": "https://ibm.box.com/shared/static/j4o6bvkmfndk9ib9h5wp2u3sprj9n6tv.zip", + "dev": "https://ibm.box.com/shared/static/pbq3c1ba7uyj6wl4e9kil3bsa2dnd2x8.zip", + "0.21": "https://ibm.box.com/shared/static/p5nc95ypavdaq3sk8g1ebm3h4bc1a846.zip", "0.20": "https://ibm.box.com/shared/static/0bcr09epud50i3czdx791iagumrf5bjz.zip", "0.19": "https://ibm.box.com/shared/static/ojpnzc71aex4d8itnktwbp9m7l15nazs.zip", "0.18": "https://ibm.box.com/shared/static/rbjdfogq8t1a4tquw1bh6gy4qdcv521v.zip", diff --git a/scripts/commands/checkInternalLinks.ts b/scripts/commands/checkInternalLinks.ts index 6e49659edbe..a1edb1d3562 100644 --- a/scripts/commands/checkInternalLinks.ts +++ b/scripts/commands/checkInternalLinks.ts @@ -100,8 +100,10 @@ async function main() { const PROVIDER_GLOBS_TO_LOAD = ["docs/api/qiskit/*.md"]; const RUNTIME_GLOBS_TO_LOAD = [ "docs/api/qiskit/providers_models.md", + "docs/api/qiskit-ibm-runtime/options.md", "docs/run/max-execution-time.mdx", "docs/run/configure-error-mitigation.mdx", + "docs/run/configure-runtime-compilation.mdx", ]; const QISKIT_GLOBS_TO_LOAD = [ "docs/build/circuit-construction.ipynb", diff --git a/scripts/lib/links/ignores.ts b/scripts/lib/links/ignores.ts index c166378ff22..f8b601c44f3 100644 --- a/scripts/lib/links/ignores.ts +++ b/scripts/lib/links/ignores.ts @@ -64,7 +64,7 @@ type FilesToIgnores = { [id: string]: string[] }; const _QPY_IGNORES = ["#f1", "#f2", "#f3", "#id2", "#id4", "#id6", "#id8"]; const _RUNTIME_OBJECT_INV = Object.fromEntries( - ["", "dev/", "0.16/", "0.17/", "0.18/", "0.19/"].map((vers) => [ + ["", "dev/", "0.16/", "0.17/", "0.18/", "0.19/", "0.20/"].map((vers) => [ `public/api/qiskit-ibm-runtime/${vers}objects.inv`, [ `/api/qiskit-ibm-runtime/${vers}qiskit_ibm_runtime.RuntimeEncoder#key_separator`,