Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

AccountProvider

class AccountProvider(credentials, factory)

GitHub

Bases: qiskit.providers.provider.ProviderV1

Provider for a single IBM Quantum Experience account.

The account provider class provides access to the IBM Quantum Experience services available to this account.

You can access a provider by enabling an account with the IBMQ.enable_account() method, which returns the default provider you have access to:

from qiskit import IBMQ
provider = IBMQ.enable_account(<INSERT_IBM_QUANTUM_EXPERIENCE_TOKEN>)

To select a different provider, use the IBMQ.get_provider() method and specify the hub, group, or project name of the desired provider.

Each provider may offer different services. The main service, IBMQBackendService, is available to all providers and gives access to IBM Quantum Experience devices and simulators.

You can obtain an instance of a service using the service() method or as an attribute of this AccountProvider instance. For example:

backend_service = provider.service('backend')
backend_service = provider.service.backend

Since IBMQBackendService is the main service, some of the backend-related methods are available through this class for convenience.

The backends() method returns all the backends available to this account:

backends = provider.backends()

The get_backend() method returns a backend that matches the filters passed as argument. An example of retrieving a backend that matches a specified name:

simulator_backend = provider.get_backend('ibmq_qasm_simulator')

It is also possible to use the backend attribute to reference a backend. As an example, to retrieve the same backend from the example above:

simulator_backend = provider.backend.ibmq_qasm_simulator
Note

The backend attribute can be used to autocomplete the names of backends available to this provider. To autocomplete, press tab after provider.backend.. This feature may not be available if an error occurs during backend discovery. Also note that this feature is only available in interactive sessions, such as in Jupyter Notebook and the Python interpreter.

AccountProvider constructor.

Parameters

  • credentials (Credentials) – IBM Quantum Experience credentials.
  • factory (IBMQFactory) – IBM Quantum account.

Methods

backends

AccountProvider.backends(name=None, filters=None, **kwargs)

Return all backends accessible via this provider, subject to optional filtering.

Parameters

  • name (Optional[str]) – Backend name to filter by.

  • filters (Optional[Callable[[List[IBMQBackend]], bool]]) –

    More complex filters, such as lambda functions. For example:

    AccountProvider.backends(filters=lambda b: b.configuration().n_qubits > 5)

  • kwargs (Any) –

    Simple filters that specify a True/False criteria in the backend configuration, backends status, or provider credentials. An example to get the operational backends with 5 qubits:

    AccountProvider.backends(n_qubits=5, operational=True)

Return type

List[IBMQBackend]

Returns

The list of available backends that match the filter.

get_backend

AccountProvider.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.

has_service

AccountProvider.has_service(name)

Check if this provider has access to the service.

Parameters

name (str) – Name of the service.

Return type

bool

Returns

Whether the provider has access to the service.

Raises

IBMQInputValueError – If an unknown service name is specified.

run_circuits

AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)

Execute the input circuit(s) on a backend using the runtime service.

Note

This method uses the IBM Quantum runtime service which is not available to all accounts.

Parameters

  • circuits (Union[QuantumCircuit, List[QuantumCircuit]]) – Circuit(s) to execute.
  • backend_name (str) – Name of the backend to execute circuits on. Transpiler options are automatically grabbed from backend configuration and properties unless otherwise specified.
  • shots (Optional[int]) – Number of repetitions of each circuit, for sampling. If not specified, the backend default is used.
  • initial_layout (Union[Layout, Dict, List, None]) – Initial position of virtual qubits on physical qubits.
  • layout_method (Optional[str]) – Name of layout selection pass (‘trivial’, ‘dense’, ‘noise_adaptive’, ‘sabre’). Sometimes a perfect layout can be available in which case the layout_method may not run.
  • routing_method (Optional[str]) – Name of routing pass (‘basic’, ‘lookahead’, ‘stochastic’, ‘sabre’)
  • translation_method (Optional[str]) – Name of translation pass (‘unroller’, ‘translator’, ‘synthesis’)
  • seed_transpiler (Optional[int]) – Sets random seed for the stochastic parts of the transpiler.
  • optimization_level (int) – How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer transpilation time. If None, level 1 will be chosen as default.
  • init_qubits (bool) – Whether to reset the qubits to the ground state for each shot.
  • rep_delay (Optional[float]) – Delay between programs in seconds. Only supported on certain backends (backend.configuration().dynamic_reprate_enabled ). If supported, rep_delay will be used instead of rep_time and must be from the range supplied by the backend (backend.configuration().rep_delay_range). Default is given by backend.configuration().default_rep_delay.
  • transpiler_options (Optional[dict]) – Additional transpiler options.
  • measurement_error_mitigation (bool) – Whether to apply measurement error mitigation.
  • use_measure_esp (Optional[bool]) – Whether to use excited state promoted (ESP) readout for measurements which are the final instruction on a qubit. ESP readout can offer higher fidelity than standard measurement sequences. See here.
  • **run_config – Extra arguments used to configure the circuit execution.

Return type

RuntimeJob

Returns

Runtime job.

service

AccountProvider.service(name)

Return the specified service.

Parameters

name (str) – Name of the service.

Return type

Any

Returns

The specified service.

Raises

  • IBMQInputValueError – If an unknown service name is specified.
  • IBMQNotAuthorizedError – If the account is not authorized to use the service.

services

AccountProvider.services()

Return all available services.

Return type

Dict

Returns

All services available to this provider.

Attributes

backend

Return the backend service.

Return type

IBMQBackendService

Returns

The backend service instance.

experiment

Return the experiment service.

Return type

IBMExperimentService

Returns

The experiment service instance.

Raises

IBMQNotAuthorizedError – If the account is not authorized to use the experiment service.

runtime

Return the runtime service.

Return type

IBMRuntimeService

Returns

The runtime service instance.

Raises

IBMQNotAuthorizedError – If the account is not authorized to use the service.

version

Default value: 1

Was this page helpful?
Report a bug or request content on GitHub.