Skip to main content

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

Project description

QAML-Z

warning This package is no longer being supported, instead use qamlzim.

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

Uploaded Source

Built Distribution

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

qamlz-1.2.1-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qamlz-1.2.1.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for qamlz-1.2.1.tar.gz
Algorithm Hash digest
SHA256 ac8dfefa070f6b33e04bade16e340cdbda21b4c5dabf22d09e7e5e06e40f5a08
MD5 b9823c7a36912a3584a66dea1251fbcf
BLAKE2b-256 3b03800864f0520b62a508d2d9159bc3b061e2308d04505133eb91fc193dd208

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qamlz-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for qamlz-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d1cabf3e5204f2d19826017aad7b0027bb16537f7bb104da49910796340cc8f2
MD5 aa67ce47d09ba61f59695af60b28d296
BLAKE2b-256 04d8dcfd16b234ba32f9c8725353f05be4d055fb31699a13ca68c5f2f14f0392

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