Using python packages with your QiskitPattern

In this document, we will learn how to install custom dependencies to your pattern.

Let’s create another file with our new pattern ./source_files/pattern_with_dependencies.py.

For the sake of this example, let’s use the qiskit-experiments package as our custom dependency. We will use randomized benchmarking (RB) circuits from qiskit-experiments, composed with the circuit from the input arguments for measurement.

Here’s what the file would look like:

# source_files/pattern_with_dependencies.py

from quantum_serverless import get_arguments, save_result

from qiskit.primitives import Sampler
from qiskit_experiments.library import StandardRB


arguments = get_arguments()

circuit = arguments.get("circuit")

rb = StandardRB(
    physical_qubits=(1,),
    lengths=list(range(1, 300, 30)),
    seed=42
)
composed = circuit.compose(rb.circuits()[0])

sampler = Sampler()

quasi_dists = sampler.run(composed).result().quasi_dists

print(f"Quasi distribution: {quasi_dists[0]}")

# saving results of a pattern
save_result({
    "quasi_dists": quasi_dists[0]
})

As you can see, we’ve imported our custom dependency, qiskit-experiments, and used its StandardRB module to generate an RB circuit, which we’ve composed with the circuit provided in the input arguments.

Now, let’s create and configure our client

To install a custom dependency that our pattern might use we need to pass it as the dependencies argument to the QiskitPattern class constructor. You can pass multiple dependencies and specify versions.

from quantum_serverless import QiskitFunction

function = QiskitFunction(
    title="pattern-with-dependencies",
    entrypoint="pattern_with_dependencies.py",
    working_dir="./source_files/",
    dependencies=["qiskit-experiments==0.6.0"],
)

⚠ This provider is set up with default credentials to a test cluster intended to run on your machine. For information on setting up infrastructure on your local machine, check out the guide on local infrastructure setup.

from quantum_serverless import ServerlessClient
import os

serverless = ServerlessClient(
    token=os.environ.get("GATEWAY_TOKEN", "awesome_token"),
    host=os.environ.get("GATEWAY_HOST", "http://localhost:8000"),
)
serverless

<ServerlessProvider: gateway-provider>

from qiskit.circuit.random import random_circuit

circuit = random_circuit(2, 2)

serverless.upload(function)

'pattern-with-dependencies'

job = serverless.run("pattern-with-dependencies", arguments={"circuit": circuit})

job.status()

'QUEUED'

job.result()

{'quasi_dists': {'0': 1.0}}