Skip to main content

Stability Client verify process License Code style: Black Python Qiskit

Qiskit Serverless client

diagram

Installation

To install the latest release of the client, run:

pip install qiskit-serverless

Ray is an optional dependency, needed only for the Ray runner. Install it with the ray extra:

pip install qiskit-serverless[ray]

To install an editable package from source, run:

pip install -r requirements.txt -r requirements-dev.txt
pip install -e .

Documentation

Full docs can be found at https://qiskit.github.io/qiskit-serverless/

Usage

Step 1: write function in ./src/function.py

import ray

from qiskit_serverless import get_arguments, save_result

from qiskit import QuantumCircuit
from qiskit.circuit.random import random_circuit
from qiskit.primitives import StatevectorSampler as Sampler
from qiskit.quantum_info import SparsePauliOp

# 1. let's annotate out function to convert it
# to distributed async function
# using Ray's `ray.remote` decorator
@ray.remote
def distributed_sample(circuit: QuantumCircuit):
    """Calculates quasi dists as a distributed function."""
    return Sampler().run([(circuit)]).result()[0].data.meas.get_counts()

# 2. our program will have one arguments
# `circuits` which will store list of circuits
# we want to sample in parallel.
# Let's use `get_arguments` function
# to access all program arguments
arguments = get_arguments()
circuits = arguments.get("circuits", [])

# 3. run our functions in a loop
# and get execution references back
function_references = [
    distributed_sample.remote(circuit)
    for circuit in circuits
]

# 4. `ray.get` will collect all
# results from distributed functions
collected_results = ray.get(function_references)

# 5. `save_result` will save results of program execution
# so we can access it later
save_result({
    "quasi_dists": collected_results
})

Step 2: run function

from qiskit_serverless import ServerlessClient, QiskitFunction
from qiskit.circuit.random import random_circuit

client = ServerlessClient(
    token="<TOKEN>",
    host="<GATEWAY_ADDRESS>",
)

# create function
function = QiskitFunction(
    title="Quickstart",
    entrypoint="program.py",
    working_dir="./src"
)
client.upload(function)

# create inputs to our program
circuits = []
for _ in range(3):
    circuit = random_circuit(3, 2)
    circuit.measure_all()
    circuits.append(circuit)

# run program
my_function = client.get("Quickstart")
job = my_function.run(circuits=circuits)

Step 3: monitor job status

job.status()
# 'DONE'

# or wait until the job ends, checking less often while nothing changes
job.wait_for_final_state(timeout=600)
# 'DONE'

# or get logs
job.logs()

Step 4: get results

job.result()
# {'quasi_dists': [
# {'101': 902, '011': 66, '110': 2, '111': 37, '100': 17},
# {'100': 626, '101': 267, '001': 49, '000': 82},
# {'010': 145, '100': 126, '011': 127, '001': 89, '110': 173, '111': 166, '000': 94, '101': 104}
# ]}

Metadata

Release files for qiskit-serverless 0.38.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qiskit-serverless 0.38.0
File Size Uploaded Provenance Actions
qiskit_serverless-0.38.0.tar.gz 89.7 kB Without provenance Details for qiskit_serverless-0.38.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qiskit-serverless 0.38.0
File Interpreter ABI Platform Actions
qiskit_serverless-0.38.0-py3-none-any.whl Python 3 none any Details for qiskit_serverless-0.38.0-py3-none-any.whl

Total release size: 202.4 kB

Release files / qiskit_serverless-0.38.0.tar.gz

Download URL qiskit_serverless-0.38.0.tar.gz
Size 89.7 kB
Tags Source
SHA-256 checksum
How to use checksums
1c226cedfe7b4a254882f388ee547bb8ea5b1ab5630976144969fe64f7d13714
BLAKE2b-256 checksum
How to use checksums
0bbebab5be109a6c96ac3f4003f67876bfc19ccbf61a86a04b5e4c929274e96a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / qiskit_serverless-0.38.0-py3-none-any.whl

Download URL qiskit_serverless-0.38.0-py3-none-any.whl
Size 112.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7f833c2cdb6a65463343ff0f284785b4746155aa3cdda921378cb9f114e0545d
BLAKE2b-256 checksum
How to use checksums
afb06e7f60360a807c1fcc2074d627bc074d53c94628b4eb3225f28381e6bb21
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for qiskit-serverless 0.38.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.38.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page