Quantum circuits on top of tensor network
Project description
English | 简体中文
TensorCircuit is the next generation of quantum software framework 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. It also supports real quantum hardware access and provides CPU/GPU/QPU hybrid deployment solutions since v0.9.
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(allow_state=True, batch=1024, format="count_dict_bin"))
- 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 written in pure Python and can be obtained via pip as:
pip install tensorcircuit
We recommend you install this package with tensorflow also installed as:
pip install tensorcircuit[tensorflow]
Other optional dependencies include [torch]
, [jax]
, [qiskit]
and [cloud]
.
For the nightly build of tensorcircuit with new features, try:
pip uninstall tensorcircuit
pip install tensorcircuit-nightly
We also have Docker support.
Advantages
-
Tensor network simulation engine based
-
JIT, AD, vectorized parallelism compatible
-
GPU support, quantum device access support, hybrid deployment support
-
Efficiency
-
Time: 10 to 10^6+ times acceleration compared to TensorFlow Quantum, Pennylane 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
-
Contributing
Status
This project is released by Tencent Quantum Lab and is created and maintained by Shi-Xin Zhang with current core authors Shi-Xin Zhang and Yu-Qin Chen. We also thank contributions from the lab and the open source community.
Citation
If this project helps in your research, please cite our software whitepaper published in Quantum:
TensorCircuit: a Quantum Software Framework for the NISQ Era
which is also a good introduction to the software.
Guidelines
For contribution guidelines and notes, see CONTRIBUTING.
We welcome issues, PRs, and discussions from everyone, and these are all hosted on GitHub.
License
TensorCircuit is open source, released under the Apache License, Version 2.0.
Contributors
Shixin Zhang 💻 📖 💡 🤔 🚇 🚧 🔬 👀 🌍 ⚠️ ✅ 📢 💬 |
Yuqin Chen 💻 📖 💡 🤔 🔬 ⚠️ ✅ 📢 |
Jiezhong Qiu 💻 💡 🤔 🔬 |
Weitang Li 💻 📖 🤔 🔬 ⚠️ 📢 |
Jiace Sun 💻 📖 💡 🤔 🔬 ⚠️ |
Zhouquan Wan 💻 📖 💡 🤔 🔬 ⚠️ ✅ |
Shuo Liu 💡 🔬 ✅ |
Hao Yu 💻 📖 🚇 ⚠️ ✅ |
Xinghan Yang 📖 🌍 ✅ |
JachyMeow ✅ 🌍 |
Zhaofeng Ye 🎨 |
erertertet 💻 📖 ⚠️ |
Yicong Zheng ✅ |
Zixuan Song 📖 🌍 💻 ⚠️ |
Hao Xie 📖 |
Pramit Singh ⚠️ |
Jonathan Allcock 📖 🤔 📢 |
nealchen2003 📖 |
隐公观鱼 💻 ⚠️ |
WiuYuan 💡 |
Research and Applications
DQAS
For the application of Differentiable Quantum Architecture Search, see applications.
Reference paper: https://arxiv.org/abs/2010.08561 (published in QST).
VQNHE
For the application of Variational Quantum-Neural Hybrid Eigensolver, see applications.
Reference paper: https://arxiv.org/abs/2106.05105 (published in PRL) and https://arxiv.org/abs/2112.10380.
VQEX-MBL
For the application of VQEX on MBL phase identification, see the tutorial.
Reference paper: https://arxiv.org/abs/2111.13719 (published in PRB).
Stark-DTC
For the numerical demosntration of discrete time crystal enabled by Stark many-body localization, see the Floquet simulation demo.
Reference paper: https://arxiv.org/abs/2208.02866 (published in PRL).
EMQAOA-DARBO
For the numerical simulation and hardware experiments with error mitigation on QAOA, see the project repo.
Reference paper: https://arxiv.org/abs/2303.14877.
TenCirChem
TenCirChem is an efficient and versatile quantum computation package for molecular properties. TenCirChem is based on TensorCircuit and is optimized for chemistry applications.
Reference paper: https://arxiv.org/abs/2303.10825.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file tensorcircuit-0.9.1.tar.gz
.
File metadata
- Download URL: tensorcircuit-0.9.1.tar.gz
- Upload date:
- Size: 328.2 kB
- Tags: Source
- Uploaded using 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
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b204bfd7d0ab515a053faaecde08151ec44215a381f986152a683a72c036813 |
|
MD5 | 4307d9a3efb34586d15b4ae42fa315b0 |
|
BLAKE2b-256 | a5a1c407d88d8298b0d83094dfe565b7a9eefa55b0b84968134e0b3119e34244 |
File details
Details for the file tensorcircuit-0.9.1-py3-none-any.whl
.
File metadata
- Download URL: tensorcircuit-0.9.1-py3-none-any.whl
- Upload date:
- Size: 304.7 kB
- Tags: Python 3
- Uploaded using 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
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb0138d6fbb0968d6c78751a200ef757461041f76003add1fbb23632f33e6955 |
|
MD5 | f227c775b5b35908fab69fa5189eaef7 |
|
BLAKE2b-256 | d1671ffb1d900758bd9b739b0e95747d0a519caa3dca7941f6d47f4d63d9c609 |