tensorcircuit

English | 简体中文

TensorCircuit is the next generation of quantum circuit simulators with support for automatic differentiation, just-in-time compiling, hardware acceleration, and vectorized parallelism.

TensorCircuit is built on top of modern machine learning frameworks and is machine learning backend agnostic. It is specifically suitable for highly efficient simulations of quantum-classical hybrid paradigm and variational quantum algorithms.

Getting Started

Please begin with Quick Start.

For more information and introductions, please refer to helpful example scripts and full documentation. API docstrings and test cases in tests are also informative.

The following are some minimal demos.

Circuit manipulation:

import tensorcircuit as tc
c = tc.Circuit(2)
c.H(0)
c.CNOT(0,1)
c.rx(1, theta=0.2)
print(c.wavefunction())
print(c.expectation_ps(z=[0, 1]))
print(c.sample())

Runtime behavior customization:

tc.set_backend("tensorflow")
tc.set_dtype("complex128")
tc.set_contractor("greedy")

Automatic differentiations with jit:

def forward(theta):
    c = tc.Circuit(2)
    c.R(0, theta=theta, alpha=0.5, phi=0.8)
    return tc.backend.real(c.expectation((tc.gates.z(), [0])))

g = tc.backend.grad(forward)
g = tc.backend.jit(g)
theta = tc.array_to_tensor(1.0)
print(g(theta))

Install

The package is purely written in Python and can be obtained via pip as:

pip install tensorcircuit

We also have Docker support.

Advantages

Tensor network simulation engine based
JIT, AD, vectorized parallelism compatible, GPU support
Efficiency
- Time: 10 to 10^6 times acceleration compared to tfq or qiskit
- Space: 600+ qubits 1D VQE workflow (converged energy inaccuracy: < 1%)
Elegance
- Flexibility: customized contraction, multiple ML backend/interface choices, multiple dtype precisions
- API design: quantum for humans, less code, more power

Citing TensorCircuit

This project is released by Tencent Quantum Lab and is currently maintained by Shi-Xin Zhang with contributions from the lab and open source community.

If this project helps in your research, please cite our software whitepaper:

TensorCircuit: a Quantum Software Framework for the NISQ Era

which is also a good introduction for the software.

Contributing

For contribution guidelines and notes, see CONTRIBUTING.

We welcome issues, PRs, and discussions from everyone, and these are all hosted on GitHub.

Researches and Applications

DQAS

For the application of Differentiable Quantum Architecture Search, see applications. Reference paper: https://arxiv.org/pdf/2010.08561.pdf.

VQNHE

For the application of Variational Quantum-Neural Hybrid Eigensolver, see applications. Reference paper: https://arxiv.org/pdf/2106.05105.pdf and https://arxiv.org/pdf/2112.10380.pdf.

VQEX - MBL

For the application of VQEX on MBL phase identification, see the tutorial. Reference paper: https://arxiv.org/pdf/2111.13719.pdf.

Release files for tensorcircuit 0.2.0

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

Source distribution (sdist)

Source distribution for tensorcircuit 0.2.0
File	Size	Uploaded
tensorcircuit-0.2.0.tar.gz	227.2 kB	Jun 21, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for tensorcircuit 0.2.0
File	Interpreter	ABI	Platform	Reset
tensorcircuit-0.2.0-py3-none-any.whl 195.8 kB Jun 21, 2022	Python 3	none	any	Details

Total release size:422.9 kB

Release files / tensorcircuit-0.2.0.tar.gz

Download URL	tensorcircuit-0.2.0.tar.gz
Size	227.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`e1a1a9d8a3e0a588bba696d28dc3a81a397736c5985aff00266dcdab73c16e55`
BLAKE2b-256 checksum How to use checksums	`02a6892d33924df0830170805f7c6da60b7b522530d65a5bd75e9d568e755a6d`
Upload date	Jun 21, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.8.0`

Release files / tensorcircuit-0.2.0-py3-none-any.whl

Download URL	tensorcircuit-0.2.0-py3-none-any.whl
Size	195.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b1f8bde5e0e4485a00cde7d5dcc034d0bcd82603699840043b3ad194f21e537f`
BLAKE2b-256 checksum How to use checksums	`7a78a0353c9887c5b6b8de98e3b9910341db490c6a960db9376317b46e5dbee2`
Upload date	Jun 21, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/1.5.0 colorama/0.4.4 CPython/3.8.0`