Skip to main content

GPU-accelerated tensor ring VQA simulation plugin for Qiskit, powered by PyTorch

Project description

qiskit-trev

Python 3.10+ License: MIT codecov Tests

Qiskit TREV is a GPU-accelerated quantum circuit simulation plugin for Qiskit, built on PyTorch. It provides efficient variational quantum algorithm (VQA) simulation using tensor ring (periodic Matrix Product State) representations, powered by PyTorch's GPU acceleration.

Features

  • Tensor Ring Architecture: Efficient quantum state representation using periodic Matrix Product States
  • PyTorch Backend: GPU acceleration via PyTorch tensors and CUDA
  • Qiskit Integration: Works seamlessly as a Qiskit plugin with BackendV2 interface
  • Multiple Measurement Methods:
    • Full Contraction
    • Perfect Sampling
    • Efficient Contraction
    • Right Suffix Contraction
  • Variational Algorithm Support: Built-in parameter-shift rule gradient computation
  • Hamiltonian Operations: Full support for Pauli string Hamiltonians via SparsePauliOp

Requirements

  • Python 3.10+
  • NVIDIA GPU with CUDA support
  • PyTorch with CUDA
  • Qiskit >= 1.0
  • NumPy

Installation

pip install qiskit-trev

For development:

git clone https://github.com/keunjunpark/qiskit-trev.git
cd qiskit-trev
pip install -e ".[dev]"

Tutorials

See the tutorials/ directory for Jupyter notebooks:

  1. Getting Started — Circuits, sampling, and the TREV backend
  2. Expectation Values — Hamiltonians, estimator, and measurement methods
  3. VQE Optimization — Gradient descent and CMA-ES for variational algorithms

Architecture

qiskit_trev/
├── __init__.py               # Public API
├── backend.py                # TREVBackend (Qiskit BackendV2)
├── estimator.py              # TREVEstimator (Qiskit Estimator primitive)
├── sampler.py                # TREVSampler (Qiskit Sampler primitive)
├── tensor_ring/              # Core tensor ring engine
│   ├── state.py              # Tensor ring state representation
│   ├── contraction.py        # Tensor contraction routines
│   └── gates.py              # Gate-to-tensor decomposition
├── measure/                  # Measurement strategies
│   ├── full_contraction.py
│   ├── perfect_sampling.py
│   ├── efficient_contraction.py
│   └── right_suffix.py
└── transpiler/               # TREV-specific transpiler passes
    └── passes.py

How It Differs from TREV

TREV qiskit-trev
Backend PyTorch PyTorch
Interface Custom Circuit API Qiskit BackendV2 / Primitives
Gradients Parameter-shift rule Parameter-shift rule
Ecosystem Standalone Qiskit plugin
Install pip install TREV pip install qiskit-trev

Contributing

Contributions are welcome! Please feel free to submit pull requests, report bugs, or suggest features.

pip install -e ".[dev]"
pytest

License

MIT License

Citation

If you use qiskit-trev in your research, please cite:

@software{qiskit_trev,
  title={qiskit-trev: PyTorch-based Tensor Ring VQA Simulation for Qiskit},
  author={Park, Keunjun},
  url={https://github.com/keunjunpark/qiskit-trev},
}

Acknowledgments

This project builds on TREV.

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

qiskit_trev-0.1.0.tar.gz (45.2 kB view details)

Uploaded Source

Built Distribution

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

qiskit_trev-0.1.0-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file qiskit_trev-0.1.0.tar.gz.

File metadata

  • Download URL: qiskit_trev-0.1.0.tar.gz
  • Upload date:
  • Size: 45.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for qiskit_trev-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9ef0030ef489b6ee52d9615a46f219124cfe6f32bcef784f23db6dc9760b4244
MD5 c53001ef2a18107c3d4d0cfe252d4581
BLAKE2b-256 598af9e0c9822d48b70de02b1644a3ad4607a07ac3b86c2a7eb36e1f369d7fef

See more details on using hashes here.

File details

Details for the file qiskit_trev-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: qiskit_trev-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 40.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for qiskit_trev-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb204f66647a1adfad32caa981c6504bf4f81262114f91830df0c12faf17c8e9
MD5 dd22739955c0e5f1551891f6bf2af1ac
BLAKE2b-256 25239283dcacf24558861304c2c901a13526a14d2125481e95f789d455f53d8e

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