Skip to main content

Quantum circuits on top of tensor network

Project description

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(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] and [qiskit].

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

  • 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.

Contributors

Shixin Zhang
Shixin Zhang

💻 📖 💡 🤔 🚇 🚧 🔬 👀 🌍 ⚠️ 📢 💬
Yuqin Chen
Yuqin Chen

💻 📖 💡 🤔 🔬 ⚠️ 📢
Jiezhong Qiu
Jiezhong Qiu

💻 💡 🤔 🔬
Weitang Li
Weitang Li

💻 📖 🤔 🔬 ⚠️ 📢
Jiace Sun
Jiace Sun

💻 📖 💡 🤔 🔬 ⚠️
Zhouquan Wan
Zhouquan Wan

💻 📖 💡 🤔 🔬 ⚠️
Shuo Liu
Shuo Liu

💡 🔬
Hao Yu
Hao Yu

💻 📖 🚇 ⚠️
Xinghan Yang
Xinghan Yang

📖 🌍
JachyMeow
JachyMeow

🌍
Zhaofeng Ye
Zhaofeng Ye

🎨
erertertet
erertertet

💻 📖 ⚠️
Yicong Zheng
Yicong Zheng

Zixuan Song
Zixuan Song

📖 🌍 💻 ⚠️
Hao Xie
Hao Xie

📖
Pramit Singh
Pramit Singh

⚠️
Jonathan Allcock
Jonathan Allcock

📖 🤔 📢
nealchen2003
nealchen2003

📖
隐公观鱼
隐公观鱼

💻 ⚠️
WiuYuan
WiuYuan

💡

Research and Applications

DQAS

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

VQNHE

For the application of Variational Quantum-Neural Hybrid Eigensolver, see applications. Reference paper: https://arxiv.org/pdf/2106.05105.pdf (published in PRL) 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 (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/pdf/2208.02866.pdf (published in PRL).

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

tensorcircuit-0.9.0.tar.gz (321.2 kB view details)

Uploaded Source

Built Distribution

tensorcircuit-0.9.0-py3-none-any.whl (298.8 kB view details)

Uploaded Python 3

File details

Details for the file tensorcircuit-0.9.0.tar.gz.

File metadata

  • Download URL: tensorcircuit-0.9.0.tar.gz
  • Upload date:
  • Size: 321.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

Hashes for tensorcircuit-0.9.0.tar.gz
Algorithm Hash digest
SHA256 a532099dee23870a997f344a252728b2a45789330f6dda316386e70cbb9190de
MD5 b6026c00e415e3a417d28a7aa6e14bc2
BLAKE2b-256 5fb361ddd3daf0cbb7bb56a068bcea6e0f32202138733d38ecd51cd298a38e66

See more details on using hashes here.

File details

Details for the file tensorcircuit-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: tensorcircuit-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 298.8 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

Hashes for tensorcircuit-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08670a8ad4fa4ce2b401387c7f5b5f900a5a0026a68fcf55ac4ae4df72c254b5
MD5 bc71037d1be8ff70c41729fb57b6e409
BLAKE2b-256 82f2c7e7f2193033c38415a536e4f26ceefb71506410cc1a851034bb22f48049

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page