qbraid.runtime.ibm.QiskitRuntimeProvider

class QiskitRuntimeProvider(token=None, instance=None, channel=None, **kwargs)[source]

This class is responsible for managing the interactions and authentications with the IBM Quantum services.

runtime_service

IBM Quantum runtime service.

Type:

qiskit_ibm_runtime.QiskitRuntimeService

Initializes the QiskitRuntimeProvider object with IBM Quantum credentials.

Parameters:

  • token (str, optional) – IBM Cloud API key.

  • instance (str, optional) – The service instance to use. This is the Cloud Resource Name (CRN) or the service name. If set, it will define a default instance for service instantiation. If not set, the service will fetch all instances accessible within the account.

  • channel (ChannelType, optional) – ibm_cloud, ibm_quantum_platform or local. If local, uses testing mode and primitive queries will run on local simulator.

__init__(token=None, instance=None, channel=None, **kwargs)[source]

Initializes the QiskitRuntimeProvider object with IBM Quantum credentials.

Parameters:

  • token (str, optional) – IBM Cloud API key.

  • instance (str, optional) – The service instance to use. This is the Cloud Resource Name (CRN) or the service name. If set, it will define a default instance for service instantiation. If not set, the service will fetch all instances accessible within the account.

  • channel (ChannelType, optional) – ibm_cloud, ibm_quantum_platform or local. If local, uses testing mode and primitive queries will run on local simulator.

Methods

__init__([token, instance, channel])

Initializes the QiskitRuntimeProvider object with IBM Quantum credentials.

get_device(device_id[, instance])

Returns the IBM Quantum provider backends.

get_devices([operational])

Returns the IBM Quantum provider backends.

least_busy([simulator, operational])

Return the least busy IBMQ QPU.

save_config([token, instance, channel, ...])

Saves IBM runtime service account to disk for future use.

Attributes

runtime_service

Returns the IBM Quantum runtime service.