_images/readme_logo.png

PurpleCaffeine is a software for tracking quantum programs and experiments.

The source code to the project is available on GitHub.

Quickstart

Step 0: install package

Listing 1 pip install
   pip install purplecaffeine

Step 1: run experiment

Listing 2 script.py
   from qiskit.circuit.random import random_circuit
   from qiskit.quantum_info.random import random_pauli
   from qiskit.primitives import Estimator

   from purplecaffeine.core import Trial, LocalStorage
   from purplecaffeine.widget import Widget

   n_qubits = 4
   depth = 3
   shots = 2000

   circuit = random_circuit(n_qubits, depth)
   obs = random_pauli(n_qubits)

   # store experiment data locally in `trials` folder
   local_storage = LocalStorage("./trials")

   # open trial context to track experiment data
   with Trial("Example trial", storage=local_storage) as trial:
       # track some parameters
       trial.add_parameter("estimator", "qiskit.primitives.Estimator")
       trial.add_parameter("depth", depth)
       trial.add_parameter("n_qubits", n_qubits)
       trial.add_parameter("shots", shots)

       # track objects of interest
       trial.add_circuit("circuit", circuit)
       trial.add_operator("obs", obs)

       # run
       exp_value = Estimator().run(circuit, obs, shots=shots).result().values.item()

       # track results of run
       trial.add_metric("exp_value", exp_value)

Step 2: visualize tracked data

Listing 3 script.py
   Widget(local_storage).show()
_images/visualization.png

Serialization

Trials are serialized using Python json module. We’ve implemented custom json.JSONEncoder and json.JSONDecoder to handle quantum computing objects like QuantumCircuit, Backend, Operator, etc.

Encoders and decoders are using pickle module to serialize some classes (Backend). The pickle module is not secure. Only unpickle data you trust. It is possible to construct malicious pickle data which will execute arbitrary code during unpickling. Never unpickle data that could have come from an untrusted source, or that could have been tampered with.

Content