Skip to content

Commit

Permalink
api ref
Browse files Browse the repository at this point in the history
  • Loading branch information
renatomello committed Jan 31, 2024
1 parent b4f8a37 commit 1ed2b39
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions doc/source/api-reference/qibo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1271,7 +1271,7 @@ Callbacks
Callbacks provide a way to calculate quantities on the state vector as it
propagates through the circuit. Example of such quantity is the entanglement
entropy, which is currently the only callback implemented in
:class:`qibo.callbacks.EntanglementEntropy`.
:class:`qibo.callbacks.Entanglemententropy`.
The user can create custom callbacks by inheriting the
:class:`qibo.callbacks.Callback` class. The point each callback is
calculated inside the circuit is defined by adding a :class:`qibo.gates.CallbackGate`.
Expand All @@ -1284,7 +1284,7 @@ This can be added similarly to a standard gate and does not affect the state vec
Entanglement entropy
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: qibo.callbacks.EntanglementEntropy
.. autoclass:: qibo.callbacks.Entanglemententropy
:members:
:member-order: bysource

Expand Down Expand Up @@ -1537,18 +1537,24 @@ Shannon entropy
.. autofunction:: qibo.quantum_info.shannon_entropy


Classical Relative Entropy
Classical relative entropy
""""""""""""""""""""""""""

.. autofunction:: qibo.quantum_info.classical_relative_entropy


Classical Rényi Entropy
Classical Rényi entropy
"""""""""""""""""""""""

.. autofunction:: qibo.quantum_info.classical_renyi_entropy


Classical Rényi relative entropy
""""""""""""""""""""""""""""""""

.. autofunction:: qibo.quantum_info.classical_renyi_relative_entropy


Entropy
"""""""

Expand All @@ -1562,7 +1568,7 @@ Entropy
and ``state`` is non-Hermitian, an error will be raised when using `cupy` backend.


Relative Entropy
Relative entropy
""""""""""""""""

.. autofunction:: qibo.quantum_info.relative_entropy
Expand All @@ -1576,13 +1582,19 @@ Relative Entropy
an error will be raised when using `cupy` backend.


Rényi Entropy
Rényi entropy
"""""""""""""

.. autofunction:: qibo.quantum_info.renyi_entropy


Entanglement Entropy
Rényi relative entropy
""""""""""""""""""""""

.. autofunction:: qibo.quantum_info.renyi_relative_entropy


Entanglement entropy
""""""""""""""""""""

.. autofunction:: qibo.quantum_info.entanglement_entropy
Expand Down

0 comments on commit 1ed2b39

Please sign in to comment.