Skip to content

Commit

Permalink
update to v2.2.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Quleaf committed Sep 5, 2022
1 parent 9c11f35 commit 9a5ad8a
Show file tree
Hide file tree
Showing 120 changed files with 8,558 additions and 1,849 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ English | [简体中文](README_CN.md)
- [Install PaddlePaddle](#install-paddlepaddle)
- [Install Paddle Quantum](#install-paddle-quantum)
- [Environment setup for Quantum Chemistry module](#environment_setup_for_quantum_chemistry_module)
- [Run programs](#run-programs)
- [Run Example](#run-example)
- [Introduction and developments](#introduction-and-developments)
- [Quick start](#quick-start)
- [Tutorials](#tutorials)
Expand All @@ -18,7 +18,7 @@ English | [简体中文](README_CN.md)
- [Copyright and License](#copyright-and-license)
- [References](#references)

[Paddle Quantum (量桨)](https://qml.baidu.com/) is a quantum machine learning (QML) toolkit developed based on Baidu PaddlePaddle. It provides a platform to construct and train quantum neural networks (QNNs) with easy-to-use QML development kits supporting combinatorial optimization, quantum chemistry and other cutting-edge quantum applications, making PaddlePaddle the first deep learning framework in China that supports quantum machine learning.
[Paddle Quantum (量桨)](https://qml.baidu.com/) is the world's first cloud-integrated quantum machine learning platform based on Baidu PaddlePaddle. It supports the building and training of quantum neural networks, making PaddlePaddle the first deep learning framework in China. Paddle Quantum is feature-rich and easy to use. It provides comprehensive API documentation and tutorials help users get started right away.

<p align="center">
<a href="https://qml.baidu.com/">
Expand All @@ -33,7 +33,7 @@ English | [简体中文](README_CN.md)
</a>
<!-- PyPI -->
<a href="https://pypi.org/project/paddle-quantum/">
<img src="https://img.shields.io/badge/pypi-v2.2.0-orange.svg?style=flat-square&logo=pypi"/>
<img src="https://img.shields.io/badge/pypi-v2.2.1-orange.svg?style=flat-square&logo=pypi"/>
</a>
<!-- Python -->
<a href="https://www.python.org/">
Expand All @@ -55,7 +55,7 @@ Paddle Quantum aims at establishing a bridge between artificial intelligence (AI
## Features

- Easy-to-use
- Many online learning resources (Nearly 40 tutorials)
- Many online learning resources (Nearly 50 tutorials)
- High efficiency in building QNN with various QNN templates
- Automatic differentiation
- Versatile
Expand All @@ -71,7 +71,7 @@ Paddle Quantum aims at establishing a bridge between artificial intelligence (AI

### Install PaddlePaddle

This dependency will be automatically satisfied when users install Paddle Quantum. Please refer to [PaddlePaddle](https://www.paddlepaddle.org.cn/install/quick)'s official installation and configuration page. This project requires PaddlePaddle 2.2.0+.
This dependency will be automatically satisfied when users install Paddle Quantum. Please refer to [PaddlePaddle](https://www.paddlepaddle.org.cn/install/quick)'s official installation and configuration page. This project requires PaddlePaddle 2.2.0 to 2.3.0.

### Install Paddle Quantum

Expand Down Expand Up @@ -151,6 +151,7 @@ We provide tutorials covering quantum simulation, machine learning, combinatoria
8. [Hamiltonian Simulation with Product Formula](./tutorials/quantum_simulation/HamiltonianSimulation_EN.ipynb)
9. [Simulate the Spin Dynamics on a Heisenberg Chain](./tutorials/quantum_simulation/SimulateHeisenberg_EN.ipynb)
10. [Distributed Variational Quantum Eigensolver Based on Schmidt Decomposition](./tutorials/quantum_simulation/DistributedVQE_EN.ipynb)
11. [Quantum Signal Processing and Quantum Singular Value Transformation](./tutorials/quantum_simulation/QSP_and_QSVT_EN.ipynb)

- [Machine Learning](./tutorials/machine_learning)
1. [Encoding Classical Data into Quantum States](./tutorials/machine_learning/DataEncoding_EN.ipynb)
Expand All @@ -160,6 +161,8 @@ We provide tutorials covering quantum simulation, machine learning, combinatoria
5. [Quantum Autoencoder](./tutorials/machine_learning/QAutoencoder_EN.ipynb)
6. [Quantum GAN](./tutorials/machine_learning/QGAN_EN.ipynb)
7. [Variational Quantum Singular Value Decomposition (VQSVD)](./tutorials/machine_learning/VQSVD_EN.ipynb)
8. [Data Encoding Analysis](./tutorials/machine_learning/EncodingAnalysis_EN.ipynb)
9. [Quantum Neural Network Approximating Functions](./tutorials/machine_learning/QApproximating_EN.ipynb)

- [Combinatorial Optimization](./tutorials/combinatorial_optimization)
1. [Quantum Approximation Optimization Algorithm (QAOA)](./tutorials/combinatorial_optimization/QAOA_EN.ipynb)
Expand Down
14 changes: 9 additions & 5 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
- [Copyright and License](#copyright-and-license)
- [References](#references)

[Paddle Quantum(量桨)](https://qml.baidu.com/)是基于百度飞桨开发的量子机器学习工具集,支持量子神经网络的搭建与训练,提供易用的量子机器学习开发套件与量子优化、量子化学等前沿量子应用工具集,使得百度飞桨也因此成为国内首个支持量子机器学习的深度学习框架
[Paddle Quantum(量桨)](https://qml.baidu.com/)是基于百度飞桨研发的全球首个云量一体的量子机器学习平台。量桨支持量子神经网络的搭建与训练等功能,使得百度飞桨也因此成为国内首个支持量子机器学习的深度学习框架。量桨具备轻松上手、功能丰富等特点,提供了完善的API文档和用例教程,使用户可以快速入门和上手

<p align="center">
<a href="https://qml.baidu.com/">
Expand All @@ -34,7 +34,7 @@
</a>
<!-- PyPI -->
<a href="https://pypi.org/project/paddle-quantum/">
<img src="https://img.shields.io/badge/pypi-v2.2.0-orange.svg?style=flat-square&logo=pypi"/>
<img src="https://img.shields.io/badge/pypi-v2.2.1-orange.svg?style=flat-square&logo=pypi"/>
</a>
<!-- Python -->
<a href="https://www.python.org/">
Expand All @@ -55,7 +55,7 @@
## 特色

- 轻松上手
- 丰富的在线学习资源(近 40 篇教程案例)
- 丰富的在线学习资源(近 50 篇教程案例)
- 通过模板高效搭建量子神经网络
- 自动微分框架
- 功能丰富
Expand All @@ -71,7 +71,7 @@

### 安装 PaddlePaddle

当用户安装 Paddle Quantum 时会自动下载安装这个关键依赖包。关于 PaddlePaddle 更全面的安装信息请参考 [PaddlePaddle](https://www.paddlepaddle.org.cn/install/quick) 安装配置页面。此项目需求 PaddlePaddle 2.2.0+
当用户安装 Paddle Quantum 时会自动下载安装这个关键依赖包。关于 PaddlePaddle 更全面的安装信息请参考 [PaddlePaddle](https://www.paddlepaddle.org.cn/install/quick) 安装配置页面。此项目需求 PaddlePaddle 2.2.0 到 2.3.0

### 安装 Paddle Quantum

Expand All @@ -80,6 +80,7 @@
```bash
pip install paddle-quantum
```

用户也可以选择下载全部文件后进行本地安装,

```bash
Expand All @@ -88,7 +89,6 @@ cd quantum
pip install -e .
```


### 量子化学模块的环境设置

我们的量子化学模块是基于 `Psi4` 进行开发的,所以在运行量子化学模块之前需要先行安装该 Python 包。
Expand Down Expand Up @@ -160,6 +160,8 @@ Paddle Quantum(量桨)建立起了人工智能与量子计算的桥梁,为
8. [利用 Product Formula 模拟时间演化](./tutorials/quantum_simulation/HamiltonianSimulation_CN.ipynb)
9. [模拟一维海森堡链的自旋动力学](./tutorials/quantum_simulation/SimulateHeisenberg_CN.ipynb)
10. [基于施密特分解的分布式变分量子本征求解器](./tutorials/quantum_simulation/DistributedVQE_CN.ipynb)
11. [量子信号处理与量子奇异值变换](./tutorials/quantum_simulation/QSP_and_QSVT_CN.ipynb)


- [机器学习](./tutorials/machine_learning)
1. [量子态编码经典数据](./tutorials/machine_learning/DataEncoding_CN.ipynb)
Expand All @@ -169,6 +171,8 @@ Paddle Quantum(量桨)建立起了人工智能与量子计算的桥梁,为
5. [量子变分自编码器(Quantum Autoencoder)](./tutorials/machine_learning/QAutoencoder_CN.ipynb)
6. [量子生成对抗网络(Quantum GAN)](./tutorials/machine_learning/QGAN_CN.ipynb)
7. [变分量子奇异值分解(VQSVD)](./tutorials/machine_learning/VQSVD_CN.ipynb)
8. [数据编码分析](./tutorials/machine_learning/EncodingAnalysis_CN.ipynb)
9. [量子神经网络模拟函数](./tutorials/machine_learning/QApproximating_CN.ipynb)

- [组合优化](./tutorials/combinatorial_optimization)
1. [量子近似优化算法(QAOA)](./tutorials/combinatorial_optimization/QAOA_CN.ipynb)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Baidu Inc'

# The full version, including alpha/beta/rc tags
release = '2.2.0'
release = '2.2.1'


# -- General configuration ---------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/source/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Paddle Quantum
=======================

`Paddle Quantum <https://github.com/PaddlePaddle/Quantum>`__\ is a quantum machine learning toolkit developed based on Baidu PaddlePaddle. It provides a platform to construct and train quantum neural networks (QNN) with easy-to-use QML development kits supporting combinatorial optimization, quantum chemistry and other cutting-edge quantum applications, making PaddlePaddle the first deep learning framework in China that supports quantum machine learning.
`Paddle Quantum <https://github.com/PaddlePaddle/Quantum>`__\ is the world's first cloud-integrated quantum machine learning platform based on Baidu PaddlePaddle. It supports the building and training of quantum neural networks, making PaddlePaddle the first deep learning framework in China. Paddle Quantum is feature-rich and easy to use. It provides comprehensive API documentation and tutorials help users get started right away.

.. figure:: https://release-data.cdn.bcebos.com/Paddle%20Quantum.png
:target: https://github.com/PaddlePaddle/Quantum
Expand All @@ -19,7 +19,7 @@ Features

- Easy-to-use

- Many online learning resources (Nearly 40 tutorials)
- Many online learning resources (Nearly 50 tutorials)
- High efficiency in building QNN with various QNN templates
- Automatic differentiation

Expand All @@ -45,7 +45,7 @@ Install
Install PaddlePaddle
~~~~~~~~~~~~~~~~~~~~

This dependency will be automatically satisfied when users install Paddle Quantum. Please refer to `PaddlePaddle <https://www.paddlepaddle.org.cn/install/quick>`__ Install and configuration page. This project requires PaddlePaddle 2.2.0+.
This dependency will be automatically satisfied when users install Paddle Quantum. Please refer to `PaddlePaddle <https://www.paddlepaddle.org.cn/install/quick>`__ Install and configuration page. This project requires PaddlePaddle 2.2.0 to 2.3.0.

.. _header-n19:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/locale/en/LC_MESSAGES/introduction.po
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ msgid ""
"This dependency will be automatically satisfied when users install Paddle"
" Quantum. Please refer to `PaddlePaddle "
"<https://www.paddlepaddle.org.cn/install/quick>`__ Install and "
"configuration page. This project requires PaddlePaddle 2.2.0+."
"configuration page. This project requires PaddlePaddle 2.2.0 to 2.3.0."
msgstr ""

#: ../../source/introduction.rst:53
Expand Down
1 change: 1 addition & 0 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@
paddle_quantum.shadow
paddle_quantum.trotter
paddle_quantum.visual
paddle_quantum.qsvt
7 changes: 7 additions & 0 deletions docs/source/paddle_quantum.qsvt.qsp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
paddle\_quantum.qsvt.qsp
============================

.. automodule:: paddle_quantum.qsvt.qsp
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/paddle_quantum.qsvt.qsp_utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
paddle\_quantum.qsvt.qsp\_utils
===============================

.. automodule:: paddle_quantum.qsvt.qsp_utils
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/paddle_quantum.qsvt.qsvt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
paddle\_quantum.qsvt.qsvt
============================

.. automodule:: paddle_quantum.qsvt.qsvt
:members:
:undoc-members:
:show-inheritance:
16 changes: 16 additions & 0 deletions docs/source/paddle_quantum.qsvt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
paddle\_quantum.qsvt
============================

.. automodule:: paddle_quantum.qsvt
:members:
:undoc-members:
:show-inheritance:

.. rubric:: Submodules

.. toctree::
:maxdepth: 4

paddle_quantum.qsvt.qsp_utils
paddle_quantum.qsvt.qsp
paddle_quantum.qsvt.qsvt
12 changes: 6 additions & 6 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ Tutorials
---------

We provide use cases covering quantum simulation, machine learning, combinatorial optimization, local operations and classical communication (LOCC), and other popular quantum machine learning research topics.
Similar to the \ `quick start guide </quick-start/overview.html>`__\ , you can read each tutorial `online </tutorials/overview.html>`__ or download and run `Jupyter Notebooks <https://github.com/PaddlePaddle/Quantum/tree/master/tutorial>`__\ locally.
Similar to the \ `quick start guide </quick-start/overview.html>`__\ , you can read each tutorial `online </tutorials/overview.html>`__ or download and run `Jupyter Notebooks <https://github.com/PaddlePaddle/Quantum/tree/master/tutorials>`__\ locally.
For interested developers, we recommend them to download Jupyter Notebooks and play around with it. Here are the tutorial categories:

- `Quantum Simulation <https://github.com/PaddlePaddle/Quantum/blob/master/tutorial/quantum_simulation>`__
- `Machine Learning <https://github.com/PaddlePaddle/Quantum/blob/master/tutorial/machine_learning>`__
- `Combinatorial Optimization <https://github.com/PaddlePaddle/Quantum/blob/master/tutorial/combinatorial_optimization>`__
- `LOCCNet <https://github.com/PaddlePaddle/Quantum/blob/master/tutorial/locc>`__
- `QNN Research <https://github.com/PaddlePaddle/Quantum/blob/master/tutorial/qnn_research>`__
- `Quantum Simulation <https://github.com/PaddlePaddle/Quantum/blob/master/tutorials/quantum_simulation>`__
- `Machine Learning <https://github.com/PaddlePaddle/Quantum/blob/master/tutorials/machine_learning>`__
- `Combinatorial Optimization <https://github.com/PaddlePaddle/Quantum/blob/master/tutorials/combinatorial_optimization>`__
- `LOCCNet <https://github.com/PaddlePaddle/Quantum/blob/master/tutorials/locc>`__
- `QNN Research <https://github.com/PaddlePaddle/Quantum/blob/master/tutorials/qnn_research>`__

With the latest LOCCNet module, Paddle Quantum can efficiently simulate distributed quantum information processing tasks. Interested readers can
start with this `tutorial on LOCCNet </tutorials/loccnet/loccnet-framework.html>`__. In addition, Paddle Quantum supports quantum neural
Expand Down
2 changes: 1 addition & 1 deletion docs_zh_CN/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Baidu Inc'

# The full version, including alpha/beta/rc tags
release = '2.2.0'
release = '2.2.1'


# -- General configuration ---------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs_zh_CN/source/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Paddle Quantum(量桨)
=======================

`Paddle Quantum(量桨) <https://github.com/PaddlePaddle/Quantum>`__\ 是基于百度飞桨开发的量子机器学习工具集,支持量子神经网络的搭建与训练,提供易用的量子机器学习开发套件与量子优化、量子化学等前沿量子应用工具集,使得百度飞桨也因此成为国内首个支持量子机器学习的深度学习框架
`Paddle Quantum(量桨) <https://github.com/PaddlePaddle/Quantum>`__\ 是基于百度飞桨研发的全球首个云量一体的量子机器学习平台。量桨支持量子神经网络的搭建与训练等功能,使得百度飞桨也因此成为国内首个支持量子机器学习的深度学习框架。量桨具备轻松上手、功能丰富等特点,提供了完善的API文档和用例教程,使用户可以快速入门和上手

.. figure:: https://release-data.cdn.bcebos.com/Paddle%20Quantum.png
:target: https://github.com/PaddlePaddle/Quantum
Expand All @@ -19,7 +19,7 @@ Paddle Quantum(量桨)

- 轻松上手

- 丰富的在线学习资源(近 40 篇教程案例)
- 丰富的在线学习资源(近 50 篇教程案例)
- 通过模板高效搭建量子神经网络
- 自动微分框架

Expand Down Expand Up @@ -47,7 +47,7 @@ Paddle Quantum(量桨)

当用户安装 Paddle Quantum 时会自动下载安装这个关键依赖包。关于 PaddlePaddle 更全面的安装信息请参考
`PaddlePaddle <https://www.paddlepaddle.org.cn/install/quick>`__
安装配置页面。此项目需求 PaddlePaddle 2.2.0+
安装配置页面。此项目需求 PaddlePaddle 2.2.0 到 2.3.0

.. _header-n19:

Expand Down
1 change: 1 addition & 0 deletions docs_zh_CN/source/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@
paddle_quantum.shadow
paddle_quantum.trotter
paddle_quantum.visual
paddle_quantum.qsvt
Loading

0 comments on commit 9a5ad8a

Please sign in to comment.