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.2.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

kipu_client-0.0.2-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kipu_client-0.0.2.tar.gz
  • Upload date:
  • Size: 5.3 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.2.tar.gz
Algorithm Hash digest
SHA256 7280e5b46d28e470b673a241a410ef169cb0c245adbb15908f83603f3e96941f
MD5 557904a358a08e020905dc7fc722f949
BLAKE2b-256 ad8487573b1bc0e61c1e81334fedf2fd1e195755d29b673e88a89d4f9621489b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kipu_client-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 6.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6674cbf1e2a62175947d2775a561aec06b96e5f3554544bd9b074979948f1381
MD5 0cb16895142a03a86d2c58218a65475c
BLAKE2b-256 502c1267a55285bd4eda8ead66d11858d50e73ef7e9ff00a2b9044658dbb3907

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