Skip to main content

Python client for Kipu platform

Project description

Kipu Python Client

The aim of this repository is to host the Python client that will enable customers to interact with out 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 orther 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(user=os.environ["USER"], password=os.environ["PASS"])

This user login will provide a token (expiring token) so that secured backends can be accessed. In case the token expires, simply by calling the token refresh functionality one can continue working.

client.refresh_token()

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kipu_client-0.0.1.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

kipu_client-0.0.1-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file kipu_client-0.0.1.tar.gz.

File metadata

  • Download URL: kipu_client-0.0.1.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.12.3 CPython/3.11.6

File hashes

Hashes for kipu_client-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ac9521b04e43387333e61e2a9275a17b17bcd44f781ce3f4d72fe9bafdbee65b
MD5 eead43cb239ede487617f329f0bba2ed
BLAKE2b-256 3789c6812b415bf475544a668ef8df7f3a358699a86b61b140372a85b71f2b86

See more details on using hashes here.

File details

Details for the file kipu_client-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: kipu_client-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: pdm/2.12.3 CPython/3.11.6

File hashes

Hashes for kipu_client-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a76461ac829870d216258fb9b0a55f4bba4e7eeb15354470a4916c2c5287fcb1
MD5 9f807483c22ba28faaade2902b1537a0
BLAKE2b-256 be24efd3b8f4e32e417668d03cf616833736a4e8817c4bd20981d3c45a9ee325

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page