Core module (qiskit_serverless.core)

Qiskit Serverless core module classes and functions

Core abstractions

ServerlessClient([name, host, version, ...])	A client for connecting to a specified host.
IBMServerlessClient([token, name])	A client for connecting to the IBM serverless host.
BaseClient(name[, host, token])	A client class for specifying custom compute resources.
RayClient(host)	RayClient.
LocalClient()	LocalClient.
Job(job_id, job_service[, raw_data])	Job.
save_result(result)	Saves job results.
QiskitPattern(title[, provider, entrypoint, ...])	[Deprecated since version 0.10.0] Use QiskitFunction instead.
QiskitFunction(title[, provider, ...])	Serverless QiskitPattern.
Target([cpu, gpu, qpu, mem, resources, ...])	Qiskit Serverless target.
CircuitMeta(num_qubits, depth)	Circuit metainformation.
fetch_execution_meta(*args, **kwargs)	Extracts meta information from function arguments.
distribute_task([target])	Wraps local function as remote executable function.
distribute_program([provider, dependencies, ...])	Decorator for distributed program.
distribute_qiskit_function([provider, ...])	[Experimental] QiskitFunction decorator to turn function into remotely executable program.
get(object_refs, *[, timeout])	Get results from distributed tasks.
put(value, **kwargs)	Puts object into shared distributed storage
get_refs_by_status(object_refs, **kwargs)	Get references by status.
is_running_in_serverless()	Return True if running as a Qiskit serverless program, False otherwise.