Skip to main content

nightly release for tensorcircuit

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

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

tensorcircuit-nightly-0.9.0.dev20230509.tar.gz (298.2 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for tensorcircuit-nightly-0.9.0.dev20230509.tar.gz
Algorithm Hash digest
SHA256 e90a5b681e554b6921fa421ef25f5db29c39ad411490d61ce87f1c072f07004a
MD5 e982e0a011622fc651297b9348a7c026
BLAKE2b-256 160740d408fc9073bf35ecc47fdbf037f764c13e55557c62345b41f97d215268

See more details on using hashes here.

File details

Details for the file tensorcircuit_nightly-0.9.0.dev20230509-py3-none-any.whl.

File metadata

File hashes

Hashes for tensorcircuit_nightly-0.9.0.dev20230509-py3-none-any.whl
Algorithm Hash digest
SHA256 609912f303870fc7b738ee9db2e333a226ab6afed33f0b5edeae93ac3b483032
MD5 906d920d83a71317b9ae86964769501e
BLAKE2b-256 1d39324caeabc9550e5c41644f5c623a95bd4169c6964997c25d0a6c8120469a

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