Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

IBMProvider

class IBMProvider(*args, **kwargs)

Provider interface needed for supporting features like IBM Quantum

This interface is the subset of QiskitRuntimeService needed for all features of Qiskit Experiments. Another provider could implement this interface to support these features as well.

Methods

active_account()

Return the IBM Quantum account information currently in use

This method returns the current account information in a dictionary format. It is used to copy the credentials for use with qiskit-ibm-experiment without requiring specifying the credentials for the provider and qiskit-ibm-experiment separately It should include "url" and "token" as keys for the authentication to work.

Returns:

A dictionary with information about the account currently in the session.

Return type:

dict[str, str] | None

job(job_id)

Retrieve a job object using its job ID

Parameters:

job_id (str) – Job ID.

Returns:

The retrieved job

Return type:

BaseJob | ExtendedJob