Skip to content

Commit 3a2bdf7

Browse files
change the doc according to the new refactoring
1 parent f84d0ca commit 3a2bdf7

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

docs/source/api/abstractcircuit.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
tensorcircuit.abstractcircuit
2+
==================================================
3+
.. automodule:: tensorcircuit.abstractcircuit
4+
:members:
5+
:undoc-members:
6+
:show-inheritance:
7+
:inherited-members:

docs/source/infras.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Overview of Modules
1010

1111
**Core Modules:**
1212

13+
- :py:mod:`tensorcircuit.abstractcircuit` and :py:mod:`tensorcircuit.basecircuit`: Hierarchical abstraction of circuit class.
14+
1315
- :py:mod:`tensorcircuit.circuit`: The core object :py:obj:`tensorcircuit.circuit.Circuit`. It supports circuit construction, simulation, representation, and visualization without noise or with noise using the Monte Carlo trajectory approach.
1416

1517
- :py:mod:`tensorcircuit.cons`: Runtime ML backend, dtype and contractor setups. We provide three sets of set methods for global setup, function level setup using function decorators, and context setup using ``with`` context managers. We also include customized contractor infrastructures in this module.
@@ -24,9 +26,7 @@ Overview of Modules
2426

2527
- :py:mod:`tensorcircuit.channels`: Definition of quantum noise channels.
2628

27-
- :py:mod:`tensorcircuit.densitymatrix`: Referenced implementation of ``tc.DMCircuit`` class, with similar set API of ``tc.Circuit`` while simulating the noise in the full form of the density matrix.
28-
29-
- :py:mod:`tensorcircuit.densitymatrix2`: Highly efficient implementation of :py:obj:`tensorcircuit.densitymatrix2.DMCircuit2` class, always preferred than the referenced implementation.
29+
- :py:mod:`tensorcircuit.densitymatrix`: Referenced and highly efficient implementation of ``tc.DMCircuit`` class, with similar set API of ``tc.Circuit`` while simulating the noise in the full form of the density matrix.
3030

3131
**ML Interfaces Related Modules:**
3232

@@ -86,6 +86,18 @@ Inside TensorCircuit, we heavily utilize TensorNetwork-related APIs from the Ten
8686
- We borrow the TensorNetwork's code in /matrixproductstates as ``tc.mps_base`` for bug fixing and jit/AD compatibility, so that we have better support for our MPS based quantum circuit simulator.
8787

8888

89+
Relations of Circuit-like classes
90+
---------------------------------------
91+
92+
.. code-block::
93+
94+
|- Circuit
95+
|- BaseCircuit --- |
96+
AbstractCircuit ---| |- DMCircuitReference --- DMCircuit
97+
|- MPSCircuit
98+
99+
100+
89101
QuOperator/QuVector and MPO/MPS
90102
---------------------------------------------------
91103

docs/source/modules.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
tensorcircuit
22
==================================================
33
.. toctree::
4+
./api/abstractcircuit.rst
45
./api/applications.rst
56
./api/backends.rst
67
./api/basecircuit.rst

0 commit comments

Comments
 (0)