Skip to main content

A Python framework for the quantum autoencoder algorithm

Project description

Description

QCompress is a Python framework for the quantum autoencoder (QAE) algorithm. Using the code, the user can execute instances of the algorithm on either a quantum simulator or a quantum processor provided by Rigetti Computing’s Quantum Cloud Services. For a more in-depth description of QCompress (including the naming convention for the types of qubits involved in the QAE circuit), click here.

For more information about the algorithm, see Romero et al. Note that we deviate from the training technique used in the original paper and instead introduce two alternative autoencoder training schemes that require lower-depth circuits (see Sim et al).

Features

This code is based on an older version written during Rigetti Computing’s hackathon in April 2018. Since then, we’ve updated and enhanced the code, supporting the following features:

  • Executability on Rigetti’s quantum processor(s)

  • Several training schemes for the autoencoder

  • Use of the RESET operation for the encoding qubits (lowers qubit requirement)

  • User-definable training circuit and/or classical optimization routine

  • [WIP]: Use of parametric compilation (supported but being optimized. Notebook coming soon.)

Installation

To install QCompress using pip:

pip install qcompress

Try executing import qcompress to test the installation in your terminal.

To instead install QCompress from source, clone this repository, cd into it, and run:

git clone https://github.com/hsim13372/QCompress
cd QCompress
python -m pip install -e .

Note that the pyQuil version used requires Python 3.6 or later. For installation on a user QMI, please click here.

Examples

We provide several Jupyter notebooks to demonstrate the utility of QCompress. We recommend going through the notebooks in the order shown in the table (top-down).

Notebook

Feature(s)

qae_h2_demo.ipynb

Simulates the compression of the ground states of the hydrogen molecule. Uses OpenFermion and grove to generate data. Demonstrates the “halfway” training scheme.

qae_two_qubit_demo.ipynb

Simulates the compression of a two-qubit data set. Outlines how to run an instance on an actual device. Demonstrates the “full with reset” training scheme.

run_landscape_scan.ipynb

Shows user how to run landscape scans for small (few-parameter) instances. Demonstrates setup of the “full with no reset” training scheme.

Disclaimer

We note that there is a lot of room for improvement and fixes. Please feel free to submit issues and/or pull requests!

How to cite

When using QCompress for research projects, please cite:

Sukin Sim, Yudong Cao, Jonathan Romero, Peter D. Johnson and Alán Aspuru-Guzik. A framework for algorithm deployment on cloud-based quantum computers. arXiv:1810.10576. 2018.

Authors

Sukin (Hannah) Sim (Harvard), Zapata Computing, Inc.

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

qcompress-0.0.1.dev11.tar.gz (193.8 kB view details)

Uploaded Source

Built Distribution

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

qcompress-0.0.1.dev11-py2.py3-none-any.whl (114.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file qcompress-0.0.1.dev11.tar.gz.

File metadata

  • Download URL: qcompress-0.0.1.dev11.tar.gz
  • Upload date:
  • Size: 193.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for qcompress-0.0.1.dev11.tar.gz
Algorithm Hash digest
SHA256 0070e293b8d4e23a7162d485debf0764f79ea2ab22e93e771ff55a11eba49501
MD5 825278dedf79d2a7ded81bb23b8d0dec
BLAKE2b-256 cc58c586cf8138b9a6c565ab1605db9ecfbc5b5b8c4068141df1f57d2704dd1e

See more details on using hashes here.

File details

Details for the file qcompress-0.0.1.dev11-py2.py3-none-any.whl.

File metadata

  • Download URL: qcompress-0.0.1.dev11-py2.py3-none-any.whl
  • Upload date:
  • Size: 114.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for qcompress-0.0.1.dev11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 27b78c094f038576c97dab60aca10604976f6108ccda3544e3498f9332112000
MD5 c3118d1c265795a3d4b7e077125e01b1
BLAKE2b-256 c5b671533562976c2512e9543763138c98e4c18166d78509e77df843fad73ec9

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