--- title: qiskit_ibm_runtime (latest version) description: API reference for qiskit_ibm_runtime in the latest version of qiskit-ibm-runtime source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit-ibm-runtime/runtime-service --- # IBM Quantum Compute (formerly Qiskit Runtime) Client `qiskit_ibm_runtime` Modules related to IBM Quantum Compute (formerly Qiskit Runtime) Client. IBM Quantum Compute (formerly 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 IBM Quantum Compute 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. IBM Quantum Compute also has the concept of a session. Jobs submitted within a session are prioritized by the scheduler. A session allows you to make iterative calls to the quantum computer more efficiently. Below is an example of using primitives within a session: ```python from qiskit_ibm_runtime import QiskitRuntimeService, Session from qiskit_ibm_runtime import SamplerV2 as Sampler from qiskit_ibm_runtime import EstimatorV2 as Estimator from qiskit.circuit.library import real_amplitudes from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister from qiskit.quantum_info import SparsePauliOp from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager # Initialize account. service = QiskitRuntimeService() # Prepare inputs. psi = real_amplitudes(num_qubits=2, reps=2) H1 = SparsePauliOp.from_list([("II", 1), ("IZ", 2), ("XI", 3)]) theta = [0, 1, 1, 2, 3, 5] # Bell Circuit qr = QuantumRegister(2, name="qr") cr = ClassicalRegister(2, name="cr") qc = QuantumCircuit(qr, cr, name="bell") qc.h(qr[0]) qc.cx(qr[0], qr[1]) qc.measure(qr, cr) backend = service.least_busy(operational=True, simulator=False) pm = generate_preset_pass_manager(target=backend.target, optimization_level=1) bell_isa_circuit = pm.run(qc) psi_isa_circuit = pm.run(psi) isa_observables = H1.apply_layout(psi_isa_circuit.layout) with Session(backend=backend) as session: # Submit a request to the Sampler primitive within the session. sampler = Sampler(mode=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(mode=session) estimator.options.resilience_level = 1 # Set options. job = estimator.run( [(psi_isa_circuit, isa_observables, theta)] ) pub_result = job.result()[0] print(f"Expectation values: {pub_result.data.evs}") ``` ## Local testing mode You can validate your quantum programs before sending them to a physical system using the local testing mode. The local testing mode is activated if one of the fake backends in `qiskit_ibm_runtime.fake_provider` or a Qiskit Aer backend instance is used when instantiating a primitive or a session. For example: ```python from qiskit_aer import AerSimulator from qiskit.circuit.library import real_amplitudes from qiskit.circuit import QuantumCircuit, QuantumRegister, ClassicalRegister from qiskit.quantum_info import SparsePauliOp from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager from qiskit_ibm_runtime import Session from qiskit_ibm_runtime import SamplerV2 as Sampler from qiskit_ibm_runtime.fake_provider import FakeManilaV2 # Bell Circuit qc = QuantumCircuit(2) qc.h(0) qc.cx(0, 1) qc.measure_all() # Run the sampler job locally using FakeManilaV2 fake_manila = FakeManilaV2() pm = generate_preset_pass_manager(backend=fake_manila, optimization_level=1) isa_qc = pm.run(qc) sampler = Sampler(backend=fake_manila) result = sampler.run([isa_qc]).result() # Run the sampler job locally using AerSimulator. # Session syntax is supported but ignored. aer_sim = AerSimulator() pm = generate_preset_pass_manager(backend=aer_sim, optimization_level=1) isa_qc = pm.run(qc) with Session(backend=aer_sim) as session: sampler = Sampler(mode=session) result = sampler.run([isa_qc]).result() ``` ## Backend data [`QiskitRuntimeService`](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service "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`](/docs/api/qiskit-ibm-runtime/ibm-backend "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 IBM Quantum Compute service. This is done by initializing a [`QiskitRuntimeService`](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service "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()`](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service#save_account "qiskit_ibm_runtime.QiskitRuntimeService.save_account") method to save the credentials on disk. IBM Quantum Compute is available on IBM Cloud, and you can specify the channel with `channel="ibm_cloud"` or `channel="ibm_quantum_platform"`. ### IBM Quantum Compute Jobs When you use the `run()` method of the [`Sampler`](/docs/api/qiskit-ibm-runtime/sampler "qiskit_ibm_runtime.Sampler") or [`Estimator`](/docs/api/qiskit-ibm-runtime/estimator "qiskit_ibm_runtime.Estimator") to invoke the primitive, a [`RuntimeJobV2`](/docs/api/qiskit-ibm-runtime/runtime-job-v2 "qiskit_ibm_runtime.RuntimeJobV2") instance is returned. This class has all the basic job methods, such as [`RuntimeJobV2.status()`](/docs/api/qiskit-ibm-runtime/runtime-job-v2#status "qiskit_ibm_runtime.RuntimeJobV2.status"), [`RuntimeJobV2.result()`](/docs/api/qiskit-ibm-runtime/runtime-job-v2#result "qiskit_ibm_runtime.RuntimeJobV2.result"), and [`RuntimeJobV2.cancel()`](/docs/api/qiskit-ibm-runtime/runtime-job-v2#cancel "qiskit_ibm_runtime.RuntimeJobV2.cancel"). ### Logging `qiskit-ibm-runtime` uses the `qiskit_ibm_runtime` logger. Two environment variables can be used to control the logging: > - **`QISKIT_IBM_RUNTIME_LOG_LEVEL`: Specifies the log level to use.** > > If an invalid level is set, the log level defaults to `WARNING`. The valid log levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL` (case-insensitive). If the environment variable is not set, then the parent logger’s level is used, which also defaults to `WARNING`. > > - **`QISKIT_IBM_RUNTIME_LOG_FILE`: Specifies the name of the log file to use. If specified,** > > messages will be logged to the file only. Otherwise messages will be logged to the standard error (usually the screen). For more advanced use, you can modify the logger itself. For example, to manually set the level to `WARNING`: ```python import logging logging.getLogger('qiskit_ibm_runtime').setLevel(logging.WARNING) ``` ## Classes | | | | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`QiskitRuntimeService`](/docs/api/qiskit-ibm-runtime/qiskit-runtime-service "qiskit_ibm_runtime.QiskitRuntimeService") | Class for interacting with the IBM Quantum Compute (formerly Qiskit Runtime) service. | | [`Estimator`](/docs/api/qiskit-ibm-runtime/estimator "qiskit_ibm_runtime.Estimator") | alias of [`EstimatorV2`](/docs/api/qiskit-ibm-runtime/estimator-v2 "qiskit_ibm_runtime.estimator.EstimatorV2") | | [`EstimatorV2`](/docs/api/qiskit-ibm-runtime/estimator-v2 "qiskit_ibm_runtime.EstimatorV2") | EstimatorV2 primitive for IBM Quantum Compute (formerly Qiskit Runtime). | | [`Sampler`](/docs/api/qiskit-ibm-runtime/sampler "qiskit_ibm_runtime.Sampler") | alias of [`SamplerV2`](/docs/api/qiskit-ibm-runtime/sampler-v2 "qiskit_ibm_runtime.sampler.SamplerV2") | | [`SamplerV2`](/docs/api/qiskit-ibm-runtime/sampler-v2 "qiskit_ibm_runtime.SamplerV2") | SamplerV2 primitive for IBM Quantum Compute (formerly Qiskit Runtime). | | [`Executor`](/docs/api/qiskit-ibm-runtime/executor "qiskit_ibm_runtime.Executor") | Class for running [`QuantumProgram`](/docs/api/qiskit-ibm-runtime/quantum-program-quantum-program "qiskit_ibm_runtime.quantum_program.QuantumProgram")\s. | | [`Session`](/docs/api/qiskit-ibm-runtime/session "qiskit_ibm_runtime.Session") | Class for creating a IBM Quantum Compute (formerly Qiskit Runtime) session. | | [`Batch`](/docs/api/qiskit-ibm-runtime/batch "qiskit_ibm_runtime.Batch") | Class for running jobs in batch execution mode. | | [`IBMBackend`](/docs/api/qiskit-ibm-runtime/ibm-backend "qiskit_ibm_runtime.IBMBackend") | Backend class interfacing with an IBM Quantum Compute (formerly Qiskit Runtime) backend. | | [`RuntimeJobV2`](/docs/api/qiskit-ibm-runtime/runtime-job-v2 "qiskit_ibm_runtime.RuntimeJobV2") | Representation of a IBM Quantum Compute (formerly Qiskit Runtime) V2 primitive execution. | | [`RuntimeEncoder`](/docs/api/qiskit-ibm-runtime/runtime-encoder "qiskit_ibm_runtime.RuntimeEncoder") | JSON Encoder used by IBM Quantum Compute service. | | [`RuntimeDecoder`](/docs/api/qiskit-ibm-runtime/runtime-decoder "qiskit_ibm_runtime.RuntimeDecoder") | JSON Decoder used by IBM Quantum Compute service. |