Skip to main content

Binary Classifier trained with D-Wave's Quantum Annealers.

Project description

QAML-Z

This is a supervised ML algorithm used to train a Binary Classifier on D-Wave's Quantum Annealers. The library has been set up to be compatible with Scikit-Learn's data representation. The algortihm is intended to be generalizable to any Binary ML problem.

In order to run the program you'll need D-Wave credentials, these can be obtained at https://cloud.dwavesys.com/leap/signup/. You'll need a github account in order to sign up. This account will give you the "endpoint_url" and "account_token" referenced below.

Installation

Run the following to install:

$ pip install qamlz

Contributors

Special thanks to everyone who helped me develop this module

  • My PI and Grad student:
    • Javier Duarte and Raghav Kansal (University of California San Diego, La Jolla, CA 92093, USA)
  • All of QMLQCF, with special mentions of:
    • Jean-Roch (California Institute of Technology, Pasadena, CA 91125, USA)
    • Daniel Lidar (University of Southern California, Los Angeles, CA 90007, USA)
    • Gabriel Perdue (Fermi National Accelerator Laboratory, Batavia, IL 60510, USA)
  • Author of the original QAML-Z code:
    • Alexander Zlokapa (Massachusetts Institute of Technology, Cambridge, MA 02139, USA)
  • Mentoring for code practices:
    • Otto Sievert (GoPro, Inc.)

Usage

import qamlz

# Generate the Environment (Data) for the Model
env = qamlz.TrainEnv(X_train, y_train, endpoint_url, account_token)

# Generate the Config (Hyperparameters) for the Model
config = qamlz.ModelConfig()

# Create the Model and begin training
model = qamlz.Model(config, env)
model.train()

Developing QAML-Z

To install qamlz, along with the tools you need to develop and run tests, run the following in your virtualenv:

$ pip install -e .[dev]

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

qamlz-0.2.21.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qamlz-0.2.21-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file qamlz-0.2.21.tar.gz.

File metadata

  • Download URL: qamlz-0.2.21.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.6

File hashes

Hashes for qamlz-0.2.21.tar.gz
Algorithm Hash digest
SHA256 dfcb9685702225a3fc044529ead424191a9c2f84830393603bb2486771945c3f
MD5 94fb1509a42841c1d2ea6c6a052d4d2b
BLAKE2b-256 c551aa27d14c34e210eada80f6158b99cdf4c4b937b90f50eaa0d72c1f4011d5

See more details on using hashes here.

File details

Details for the file qamlz-0.2.21-py3-none-any.whl.

File metadata

  • Download URL: qamlz-0.2.21-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.6

File hashes

Hashes for qamlz-0.2.21-py3-none-any.whl
Algorithm Hash digest
SHA256 9ea6cd67e07eb82478a1e312b65ff7bc58bf110229618a59b34f89b9e32123df
MD5 5714cc1a4337b6161088f959bfb7b044
BLAKE2b-256 a2820d06fe1ab5e1dcd059430dde4377aef204c5574338e9a0b81407464b76cd

See more details on using hashes here.

Supported by

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