Merge remote-tracking branch 'origin/master'

tencent-quantum-lab · Aug 8, 2023 · 12d67fb · 12d67fb
2 parents b9514bf + 1e0b851
commit 12d67fb
Show file tree

Hide file tree

Showing 17 changed files with 79 additions and 3 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -267,7 +267,10 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/45784888?v=4",
       "profile": "https://github.com/PeilinZHENG",
       "contributions": [
-        "tutorial"
+        "tutorial",
+        "code",
+        "test",
+        "doc"
       ]
     }
   ],

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,8 @@
 
 - Add circuit copy method that avoid shallow copy issue `Circuit.copy()`
 
+- Add end to end infrastructures and methods for classical shadow in `shadows.py`
+
 ### Fixed
 
 - improve the `adaptive_vmap` to support internal jit and pytree output

diff --git a/README.md b/README.md
@@ -273,7 +273,7 @@ TensorCircuit is open source, released under the Apache License, Version 2.0.
       <td align="center" valign="top" width="16.66%"><a href="https://github.com/WiuYuan"><img src="https://avatars.githubusercontent.com/u/108848998?v=4?s=100" width="100px;" alt="WiuYuan"/><br /><sub><b>WiuYuan</b></sub></a><br /><a href="#example-WiuYuan" title="Examples">💡</a></td>
       <td align="center" valign="top" width="16.66%"><a href="https://www.linkedin.com/in/felix-xu-16a153196/"><img src="https://avatars.githubusercontent.com/u/61252303?v=4?s=100" width="100px;" alt="Felix Xu"/><br /><sub><b>Felix Xu</b></sub></a><br /><a href="#tutorial-FelixXu35" title="Tutorials">✅</a> <a href="https://github.com/tencent-quantum-lab/tensorcircuit/commits?author=FelixXu35" title="Code">💻</a> <a href="https://github.com/tencent-quantum-lab/tensorcircuit/commits?author=FelixXu35" title="Tests">⚠️</a></td>
       <td align="center" valign="top" width="16.66%"><a href="https://scholar.harvard.edu/hongyehu/home"><img src="https://avatars.githubusercontent.com/u/50563225?v=4?s=100" width="100px;" alt="Hong-Ye Hu"/><br /><sub><b>Hong-Ye Hu</b></sub></a><br /><a href="https://github.com/tencent-quantum-lab/tensorcircuit/commits?author=hongyehu" title="Documentation">📖</a></td>
-      <td align="center" valign="top" width="16.66%"><a href="https://github.com/PeilinZHENG"><img src="https://avatars.githubusercontent.com/u/45784888?v=4?s=100" width="100px;" alt="peilin"/><br /><sub><b>peilin</b></sub></a><br /><a href="#tutorial-PeilinZHENG" title="Tutorials">✅</a></td>
+      <td align="center" valign="top" width="16.66%"><a href="https://github.com/PeilinZHENG"><img src="https://avatars.githubusercontent.com/u/45784888?v=4?s=100" width="100px;" alt="peilin"/><br /><sub><b>peilin</b></sub></a><br /><a href="#tutorial-PeilinZHENG" title="Tutorials">✅</a> <a href="https://github.com/tencent-quantum-lab/tensorcircuit/commits?author=PeilinZHENG" title="Code">💻</a> <a href="https://github.com/tencent-quantum-lab/tensorcircuit/commits?author=PeilinZHENG" title="Tests">⚠️</a> <a href="https://github.com/tencent-quantum-lab/tensorcircuit/commits?author=PeilinZHENG" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

diff --git a/docs/source/api/applications.rst b/docs/source/api/applications.rst
@@ -1,9 +1,13 @@
 tensorcircuit.applications
 ================================================================================
 .. toctree::
+    applications/ai.rst
     applications/dqas.rst
+    applications/finance.rst
     applications/graphdata.rst
     applications/layers.rst
+    applications/optimization.rst
+    applications/physics.rst
     applications/utils.rst
     applications/vags.rst
     applications/van.rst

diff --git a/docs/source/api/applications/ai.rst b/docs/source/api/applications/ai.rst
@@ -0,0 +1,4 @@
+tensorcircuit.applications.ai
+================================================================================
+.. toctree::
+
diff --git a/docs/source/api/applications/finance.rst b/docs/source/api/applications/finance.rst
@@ -0,0 +1,4 @@
+tensorcircuit.applications.finance
+================================================================================
+.. toctree::
+    finance/portfolio.rst
diff --git a/docs/source/api/applications/finance/portfolio.rst b/docs/source/api/applications/finance/portfolio.rst
@@ -0,0 +1,7 @@
+tensorcircuit.applications.finance.portfolio
+================================================================================
+.. automodule:: tensorcircuit.applications.finance.portfolio
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
diff --git a/docs/source/api/applications/optimization.rst b/docs/source/api/applications/optimization.rst
@@ -0,0 +1,7 @@
+tensorcircuit.applications.optimization
+================================================================================
+.. automodule:: tensorcircuit.applications.optimization
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
diff --git a/docs/source/api/applications/physics.rst b/docs/source/api/applications/physics.rst
@@ -0,0 +1,5 @@
+tensorcircuit.applications.physics
+================================================================================
+.. toctree::
+    physics/baseline.rst
+    physics/fss.rst
diff --git a/docs/source/api/applications/physics/baseline.rst b/docs/source/api/applications/physics/baseline.rst
@@ -0,0 +1,7 @@
+tensorcircuit.applications.physics.baseline
+================================================================================
+.. automodule:: tensorcircuit.applications.physics.baseline
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
diff --git a/docs/source/api/applications/physics/fss.rst b/docs/source/api/applications/physics/fss.rst
@@ -0,0 +1,7 @@
+tensorcircuit.applications.physics.fss
+================================================================================
+.. automodule:: tensorcircuit.applications.physics.fss
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
diff --git a/docs/source/api/shadows.rst b/docs/source/api/shadows.rst
@@ -0,0 +1,7 @@
+tensorcircuit.shadows
+================================================================================
+.. automodule:: tensorcircuit.shadows
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
diff --git a/docs/source/api/templates.rst b/docs/source/api/templates.rst
@@ -1,8 +1,10 @@
 tensorcircuit.templates
 ================================================================================
 .. toctree::
+    templates/ansatz.rst
     templates/blocks.rst
     templates/chems.rst
+    templates/conversions.rst
     templates/dataset.rst
     templates/ensemble.rst
     templates/graphs.rst

diff --git a/docs/source/api/templates/ansatz.rst b/docs/source/api/templates/ansatz.rst
@@ -0,0 +1,7 @@
+tensorcircuit.templates.ansatz
+================================================================================
+.. automodule:: tensorcircuit.templates.ansatz
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
diff --git a/docs/source/api/templates/conversions.rst b/docs/source/api/templates/conversions.rst
@@ -0,0 +1,7 @@
+tensorcircuit.templates.conversions
+================================================================================
+.. automodule:: tensorcircuit.templates.conversions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -21,6 +21,7 @@ tensorcircuit
     ./api/noisemodel.rst
     ./api/quantum.rst
     ./api/results.rst
+    ./api/shadows.rst
     ./api/simplify.rst
     ./api/templates.rst
     ./api/torchnn.rst

diff --git a/tensorcircuit/shadows.py b/tensorcircuit/shadows.py
@@ -1,8 +1,10 @@
 """
-Classical Shadows functions
+Classical shadows functions
 """
+
 from typing import Any, Union, Optional, Sequence, Tuple, List
 from string import ascii_letters as ABC
+
 import numpy as np
 
 from .cons import backend, dtypestr, rdtypestr