conductorquantum 0.4.0

No project description provided

ConductorQuantum Python Library

The ConductorQuantum Python library provides convenient access to the ConductorQuantum API from Python.

Installation

pip install conductorquantum

Reference

A full reference for this library is available here. The documentation in this repository is maintained manually and is not auto-generated.

Authentication

Authenticate with a single token:

from conductorquantum import ConductorQuantum

client = ConductorQuantum(token="MY_TOKEN")

client.coda.* and the top-level Coda shortcuts require a Coda API token that starts with coda_. If you call a Coda method with any other token, the SDK raises ValueError before sending the request.

Usage

Control: analysis models

import numpy as np

from conductorquantum import ConductorQuantum

client = ConductorQuantum(token="CONTROL_TOKEN")

# Using a file
with open("path/to/file.npy", "rb") as f:
    client.control.models.run(
        model="coulomb-blockade-peak-detector-v1",
        data=f,
    )

# Using a numpy array
arr = np.array([2.643e-12, 2.164e-12, 8.481e-13, ..., 2.320e-11, 2.153e-11, 1.984e-11])
client.control.models.run(
    model="coulomb-blockade-peak-detector-v1",
    data=arr,
)

# Batch peak-detector-v2 traces in one request.
batch = np.stack([arr, arr])
result = client.control.models.batch.run(
    model="coulomb-blockade-peak-detector-v2",
    data=batch,
)
print(result.output["outputs"])

Coda: circuit tools, QPU, agents

from conductorquantum import ConductorQuantum

client = ConductorQuantum(token="coda_YOUR_TOKEN")

result = client.coda.simulate(code="from qiskit import QuantumCircuit\nqc = QuantumCircuit(2)\nqc.h(0)\nqc.cx(0, 1)")

for event in client.coda.agents(messages=[{"role": "user", "content": "Build a Bell state circuit"}]):
    print(event)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

import asyncio

from conductorquantum import AsyncConductorQuantum

client = AsyncConductorQuantum(token="YOUR_TOKEN")


async def main() -> None:
    arr = np.array([2.643e-12, 2.164e-12, 8.481e-13, ..., 2.320e-11, 2.153e-11, 1.984e-11])
    await client.control.models.run(
        model="model",
        data=arr,
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

Control API (models, model results):

from conductorquantum.core.api_error import ApiError

try:
    client.control.models.run(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Coda API (circuit tools, QPU, agents):

from conductorquantum.coda.errors import CodaAPIError, CodaAuthError, CodaTimeoutError

try:
    client.coda.simulate(code="...")
except CodaAuthError as e:
    print(e.status_code, e.detail)
except CodaTimeoutError as e:
    print("Request timed out:", e)
except CodaAPIError as e:
    print(e.status_code, e.detail)

Advanced

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior for the Control API.

client.control.models.run(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 120 second timeout. You can configure this with a timeout option at the client or request level.

from conductorquantum import ConductorQuantum

client = ConductorQuantum(
    ...,
    timeout=20.0,
)


# Override timeout for a specific Control API method
client.control.models.run(..., request_options={
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from conductorquantum import ConductorQuantum

client = ConductorQuantum(
    ...,
    httpx_client=httpx.Client(
        proxies="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Environment Variables

The Coda client respects CODA_API_BASE_URL and CODA_BASE_URL environment variables for overriding the API base URL when no explicit base_url is passed to the constructor.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

The generated-code restriction does not apply to the docs in this repository: README.md and reference.md are maintained manually and can be updated directly.