Skip to main content

Kipu Python Client

The aim of this repository is to host the Python client that will enable customers to interact without platform and the solvers it contains:

  • DCQO
  • DCQC (direct and variational)

Those will be indirectly used as the focus of the library will be to ease the usage by requesting the minimum amount of information required and automate all decisions made in order to achieve user goals (precision, execution time or cost among others).

Authentication

In order to access the platform users will need to log in to it.

import os
from kipu import Client

client = Client(api_key=os.environ["API_KEY"])

This way the communication with the backend will be granted by the use of the API key.

Ising model

the most basic function on the client is the composition of a circuit solving an Ising type of model

$$

H = \sum_i^N h_i\sigma_i^z + \sum_i^N \sum_{j>i}^N J_{ij}\sigma_i^z\sigma_j^z.

$$

By providing the $h$ and $J$ coefficients one can ask the library to compose the corresponding circuit to be executed on a gate-based quantum device.

h = [0.0, ...]
J = {
    "0-1" : 0.01,...
}

qasm_text = client.compose_circuit(h, J)

That way one would retrieve the QASM code of the circuit.

Optimization

Basically, each enabled case translates the problem to be solved to an Ising Hamiltonian whose ground state is solved by the corresponding endpoint. For FEATURE SELECTION for example, given a dataset we will select which one is the target column and the number of assets we would like to select (maximum number).

target_columns = "target"
max_features = 6

client.feature_selection(df, target_columns, max_features)

Metadata

Release files for kipu-client 0.0.3

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

Source distribution (sdist)

Source distribution for kipu-client 0.0.3
File Size Uploaded
kipu_client-0.0.3.tar.gz 5.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for kipu-client 0.0.3
File Interpreter ABI Platform
kipu_client-0.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 12.5 kB

Release files / kipu_client-0.0.3.tar.gz

Download URL kipu_client-0.0.3.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
d1cb79995e8c17a1a93f29fb41345134d48c91a1f1c231abbfce87088be91cd3
BLAKE2b-256 checksum
How to use checksums
93efaf5ccbd76d9ebcc05fef6e1acd309686e42907138a32e373e5b66dd58062
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via pdm/2.12.3 CPython/3.11.6

Release files / kipu_client-0.0.3-py3-none-any.whl

Download URL kipu_client-0.0.3-py3-none-any.whl
Size 7.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3d289b23123335de371141ade8e89d08b04484ebfc3d4b43882a9a3a8f2c3a42
BLAKE2b-256 checksum
How to use checksums
e5f2fd3d1313e5e18e74b7a282e303261bf5fa1d43998a05160c16a4138bf07e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via pdm/2.12.3 CPython/3.11.6

Release history Release notifications | RSS feed

This release

0.0.3 This release

2 release files

0.0.2

2 release files

0.0.1

2 release files

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