qbraid.runtime

Module providing unified interface for interacting with various quantum provider APIs.

Data Types

DeviceActionType(value[, names, module, ...])

Enumeration for the quantum device action types supported natively by qBraid.

DeviceStatus(value[, names, module, ...])

Enumeration for representing various operational statuses of devices.

JobStatus(value[, names, module, qualname, ...])

Enum for the status of processes (i.e. quantum jobs / tasks) resulting from any run() method.

NoiseModel(value[, names, module, qualname, ...])

Enumeration representing various noise models for quantum simulators.

Functions

display_jobs_from_data(job_data[, message])

Displays a list of quantum jobs submitted by user, tabulated by job ID, the date/time it was submitted, and status.

Classes

Session(*args[, base_url, headers, ...])

Custom session with handling of request urls and authentication.

Options(**kwargs)

Manages qBraid-specific options with controlled defaults and dynamic fields.

TargetProfile(**data)

Encapsulates read-only configuration settings for a quantum device, along with additional data necessary to formulate the runtime protocol(s) used to submit quantum jobs to the device within a specified environment for a given provider.

QuantumDevice(profile[, scheme])

Abstract interface for quantum devices.

QuantumJob(job_id[, device])

Abstract interface for job-like classes.

QuantumProvider()

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

QuantumJobResult([result])

Result of a quantum job.

GateModelJobResult([result])

Abstract interface for gate model quantum job results.

Exceptions

JobStateError

Class for errors raised due to the state of a quantum job

ProgramValidationError

Base class for errors raised while validating a quantum program.

QbraidRuntimeError

Base class for errors raised while submitting a quantum job.

ResourceNotFoundError

Exception raised when the desired resource could not be found.

DeviceProgramTypeMismatchError(program, ...)

Exception raised when the program type does not match the device action type.

Submodules

braket

Mdule submiting and managing quantm tasks through AWS and Amazon Braket supported devices.

qiskit

Module submitting and managing jobs through IBM and IBM backends.

native

Module providing interface for submitting and managing quantum jobs through (native) qBraid APIs.

ionq

Mdule submiting and managing jobs through the IonQ API.

oqc

Module for submitting and managing jobs through OQC and OQC backends.