qbraid.runtime

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

Data Types

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(name[, description])	Class representing a single noise model.
NoiseModelSet()	Class managing a registry of noise models.
ValidationLevel(value[, names, module, ...])	Enumeration for program validation levels in qBraid runtime.

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

RuntimeOptions(**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, options])	Abstract interface for quantum devices.
QuantumJob(job_id[, device])	Abstract interface for job-like classes.
QuantumProvider()	Abstract base class for managing interactions and authentication with various quantum service providers.
Result(device_id, job_id, success, data, ...)	Represents the results of a quantum job.
ResultData()	Abstract base class for runtime results linked to a specific ExperimentType.
GateModelResultData([measurement_counts, ...])	Class for storing and accessing the results of a gate model quantum job.
AhsResultData([measurement_counts, measurements])	Class for storing and accessing the results of an analog Hamiltonian simulation job.
AhsShotResult(success[, pre_sequence, ...])	Class for storing the results of a single shot in an analog Hamiltonian simulation job.
AnnealingResultData([solutions, num_solutions])	Class for storing and accessing the results of an annealing job.

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 Experiment type.

Submodules

aws	Mdule submiting and managing quantm tasks through AWS and Amazon Braket supported devices.
ibm	Module submitting and managing jobs through IBM and IBM backends.
ionq	Mdule submiting and managing jobs through the IonQ API.
oqc	Module for submitting and managing jobs through OQC and OQC backends.
native	Module providing interface for submitting and managing quantum jobs through (native) qBraid APIs.
schemas	Module defining qBraid runtime schemas.