Skip to main content

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

Project description

QAML-ZIM

Quantum Adiabatic Machine Learning with Zooming IMproved. 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 qamlzim

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 qamlzim

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

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

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

Developing QAML-ZIM

To install qamlzim, 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

qamlzim-1.0.0.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.

qamlzim-1.0.0-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file qamlzim-1.0.0.tar.gz.

File metadata

  • Download URL: qamlzim-1.0.0.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 qamlzim-1.0.0.tar.gz
Algorithm Hash digest
SHA256 fdedd9b77e51aad2f49be5d9500ecd73529141713d12bfe2952c600be652caef
MD5 84864fd9b5146dac1594e68888e8aa6a
BLAKE2b-256 5168e72891a7129949ee6ad3ee6a20f5c29beec50656a730cda788f1b4993c93

See more details on using hashes here.

File details

Details for the file qamlzim-1.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for qamlzim-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7cab24b4f5a2a08172c1e5500f5a1f17e093b79db811165930103291eebbc316
MD5 d12157096886744c8fd3d0e3aeaa6b85
BLAKE2b-256 7f31b7ee625fdda72e50bffaae23a830b961402089b93f1ac8dbf09b35dd3724

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