qcompress

Pre-release

This release is a pre-release and may not be stable for production use.

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

Installation

There are a few options for installing QCompress:

To install QCompress using pip, execute:

pip install qcompress

To install QCompress using conda, execute:

conda install -c rigetti -c hsim13372 qcompress

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 .

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

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.

Metadata

Release files for qcompress 0.0.1.dev12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qcompress 0.0.1.dev12
File	Size	Uploaded
qcompress-0.0.1.dev12.tar.gz	180.6 kB	Jan 23, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for qcompress 0.0.1.dev12
File	Interpreter	ABI	Platform	Reset
qcompress-0.0.1.dev12-py2.py3-none-any.whl 114.1 kB Jan 23, 2019	Python 2, Python 3	none	any	Details

Total release size: 294.7 kB

Release files / qcompress-0.0.1.dev12.tar.gz

Download URL	qcompress-0.0.1.dev12.tar.gz
Size	180.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`eb5d97377a1bcbf3af252d2ae63027aadc37fe4ffe9f3b9e15368d1d8a141cb7`
BLAKE2b-256 checksum How to use checksums	`d99affa5d48da7e77276ed3318e520d24994d35b44ffc56da01a95dbad0e6739`
Upload date	Jan 23, 2019
Uploaded using Trusted Publishing? What is 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`

Release files / qcompress-0.0.1.dev12-py2.py3-none-any.whl

Download URL	qcompress-0.0.1.dev12-py2.py3-none-any.whl
Size	114.1 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`c2fce18a5ff49f24752d95b31809227e941aaaf472d04ea80301d58815ea4b28`
BLAKE2b-256 checksum How to use checksums	`98fe4609fb919a3b00bbf74a81fbb63a1e233aae6b51f350f00054a597de55c3`
Upload date	Jan 23, 2019
Uploaded using Trusted Publishing? What is 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`