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.7.0.tar.gz (10.2 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.7.0-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qamlz-0.7.0.tar.gz
  • Upload date:
  • Size: 10.2 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.7.0.tar.gz
Algorithm Hash digest
SHA256 583cc919a52cdd14d7232855931e87884fa35269d200365e21805d2b7aee0eb8
MD5 26cec7ac3def8b29729b8f562334276c
BLAKE2b-256 3dd5c758c6a019f3d8ec2409f4214e946810152509fb0400b791d756ffb5bd8f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qamlz-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 15.6 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 18900b61c700e26922dd232e880a8ad6f15e7d0782f0bfb1e4bec7919f6afdd2
MD5 6b6db3135dae5e472d6660a697efba6e
BLAKE2b-256 70ca612260e4fec05551c2c2e8755d9d9f7ab7a94b76de5aea7aa0b10bb0b699

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