More API documentation updates

JanLuca · JanLuca · commit 8c462a59dd94 · 2024-03-25T12:01:42.000+01:00
diff --git a/docs/source/api/optimization/basinhopping.rst b/docs/source/api/optimization/basinhopping.rst
@@ -3,7 +3,7 @@
 .. currentmodule:: varipeps.optimization.basinhopping
 
 Implementation of the basinhopping optimizer for the PEPS model (:mod:`varipeps.optimization.basinhopping`)
-==========================================================================================================
+===========================================================================================================
 
 .. automodule:: varipeps.optimization.basinhopping
    :members:
diff --git a/docs/source/api/optimization/index.rst b/docs/source/api/optimization/index.rst
@@ -5,7 +5,7 @@
 .. currentmodule:: varipeps.optimization
 
 Variational optimizer for the PEPS network (:mod:`varipeps.optimization`)
-========================================================================
+=========================================================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/api/optimization/inner_function.rst b/docs/source/api/optimization/inner_function.rst
@@ -3,7 +3,7 @@
 .. currentmodule:: varipeps.optimization.inner_function
 
 Methods to calculate the CTRMG env and expectation value along with the gradient (:mod:`varipeps.optimization.inner_function`)
-=============================================================================================================================
+==============================================================================================================================
 
 .. automodule:: varipeps.optimization.inner_function
    :members:
diff --git a/docs/source/api/optimization/line_search.rst b/docs/source/api/optimization/line_search.rst
@@ -3,7 +3,7 @@
 .. currentmodule:: varipeps.optimization.line_search
 
 Implementation of line search methods for the CTMRG variational optimization (:mod:`varipeps.optimization.line_search`)
-======================================================================================================================
+=======================================================================================================================
 
 .. automodule:: varipeps.optimization.line_search
    :members:
diff --git a/docs/source/api/optimization/optimizer.rst b/docs/source/api/optimization/optimizer.rst
@@ -3,7 +3,7 @@
 .. currentmodule:: varipeps.optimization.optimizer
 
 Implementation of the variational optimizer for the PEPS model (:mod:`varipeps.optimization.optimizer`)
-======================================================================================================
+=======================================================================================================
 
 .. automodule:: varipeps.optimization.optimizer
    :members:
diff --git a/docs/source/api/peps/index.rst b/docs/source/api/peps/index.rst
@@ -5,7 +5,7 @@
 .. currentmodule:: varipeps.peps
 
 Implementation of PEPS structure (:mod:`varipeps.peps`)
-======================================================
+=======================================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/api/peps/tensor.rst b/docs/source/api/peps/tensor.rst
@@ -3,7 +3,7 @@
 .. currentmodule:: varipeps.peps
 
 Single PEPS tensor (:class:`varipeps.peps.PEPS_Tensor`)
-======================================================
+=======================================================
 
 .. autoclass:: PEPS_Tensor
    :members:
diff --git a/docs/source/api/peps/unitcell.rst b/docs/source/api/peps/unitcell.rst
@@ -3,7 +3,7 @@
 .. currentmodule:: varipeps.peps
 
 PEPS Unit cell (:class:`varipeps.peps.PEPS_Unit_Cell`)
-=====================================================
+======================================================
 
 .. autoclass:: PEPS_Unit_Cell
    :members:
diff --git a/docs/source/api/utils/debug_print.rst b/docs/source/api/utils/debug_print.rst
@@ -0,0 +1,11 @@
+.. _varipeps_utils_debug_print:
+
+.. currentmodule:: varipeps.utils.debug_print
+
+Debugging output helpers (:mod:`varipeps.utils.debug_print`)
+============================================================
+
+.. automodule:: varipeps.utils.debug_print
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/utils/index.rst b/docs/source/api/utils/index.rst
@@ -5,12 +5,14 @@
 .. currentmodule:: varipeps.utils
 
 Utility functions (:mod:`varipeps.utils`)
-========================================
+=========================================
 
 .. toctree::
    :maxdepth: 2
 
+   debug_print
    periodic_indices
+   projector_dict
    random
    svd
 
diff --git a/docs/source/api/utils/periodic_indices.rst b/docs/source/api/utils/periodic_indices.rst
@@ -3,7 +3,7 @@
 .. currentmodule:: varipeps.utils.periodic_indices
 
 Helper to calculate perodic indices (:mod:`varipeps.utils.periodic_indices`)
-===========================================================================
+============================================================================
 
 .. automodule:: varipeps.utils.periodic_indices
    :members:
diff --git a/docs/source/api/utils/projector_dict.rst b/docs/source/api/utils/projector_dict.rst
@@ -0,0 +1,11 @@
+.. _varipeps_utils_projector_dict:
+
+.. currentmodule:: varipeps.utils.projector_dict
+
+CTM projector management helpers (:mod:`varipeps.utils.projector_dict`)
+=======================================================================
+
+.. automodule:: varipeps.utils.projector_dict
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/utils/random.rst b/docs/source/api/utils/random.rst
@@ -5,7 +5,7 @@
 .. currentmodule:: varipeps.utils.random
 
 Random number helpers (:mod:`varipeps.utils.random`)
-===================================================
+====================================================
 
 .. automodule:: varipeps.utils.random
    :members:
diff --git a/docs/source/api/utils/svd.rst b/docs/source/api/utils/svd.rst
@@ -3,7 +3,7 @@
 .. currentmodule:: varipeps.utils.svd
 
 SVD helpers (:mod:`varipeps.utils.svd`)
-======================================
+=======================================
 
 .. automodule:: varipeps.utils.svd
    :members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -118,7 +118,7 @@ def linkcode_resolve(domain, info):
     try:
         filename = inspect.getsourcefile(obj)
         lines = inspect.getsourcelines(obj)
-    except TypeError:
+    except (TypeError, OSError):
         # e.g. object is a typing.Union
         return None
 
diff --git a/varipeps/mapping/honeycomb.py b/varipeps/mapping/honeycomb.py
@@ -615,16 +615,16 @@ def autosave_wrapper(
         tensors: jnp.ndarray,
         unitcell: PEPS_Unit_Cell,
         counter: Optional[int] = None,
-        max_trunc_error_list: Optional[float] = None,
+        auxiliary_data: Optional[Dict[str, Any]] = None,
     ) -> None:
         if counter is not None:
             cls.save_to_file(
                 f"{str(filename)}.{counter}",
                 tensors,
                 unitcell,
-                max_trunc_error_list=max_trunc_error_list,
+                auxiliary_data=auxiliary_data
             )
         else:
             cls.save_to_file(
-                filename, tensors, unitcell, max_trunc_error_list=max_trunc_error_list
+                filename, tensors, unitcell, auxiliary_data=auxiliary_data
             )
diff --git a/varipeps/mapping/kagome.py b/varipeps/mapping/kagome.py
@@ -504,7 +504,7 @@ def load_from_file(
         path: PathLike,
         *,
         return_config: bool = False,
-        return_max_trunc_error_list: bool = False,
+        return_auxiliary_data: bool = False,
     ) -> Union[
         Tuple[List[jnp.ndarray], PEPS_Unit_Cell],
         Tuple[List[jnp.ndarray], PEPS_Unit_Cell, varipeps.config.VariPEPS_Config],
@@ -620,18 +620,18 @@ def autosave_wrapper(
         tensors: jnp.ndarray,
         unitcell: PEPS_Unit_Cell,
         counter: Optional[int] = None,
-        max_trunc_error_list: Optional[float] = None,
+        auxiliary_data: Optional[Dict[str, Any]] = None,
     ) -> None:
         if counter is not None:
             cls.save_to_file(
                 f"{str(filename)}.{counter}",
                 tensors,
                 unitcell,
-                max_trunc_error_list=max_trunc_error_list,
+                auxiliary_data=auxiliary_data
             )
         else:
             cls.save_to_file(
-                filename, tensors, unitcell, max_trunc_error_list=max_trunc_error_list
+                filename, tensors, unitcell, auxiliary_data=auxiliary_data
             )
 
 
diff --git a/varipeps/mapping/maple_leaf.py b/varipeps/mapping/maple_leaf.py
diff --git a/varipeps/mapping/square_kagome.py b/varipeps/mapping/square_kagome.py
diff --git a/varipeps/mapping/triangular.py b/varipeps/mapping/triangular.py
diff --git a/varipeps/optimization/line_search.py b/varipeps/optimization/line_search.py
diff --git a/varipeps/optimization/optimizer.py b/varipeps/optimization/optimizer.py
diff --git a/varipeps/peps/tensor.py b/varipeps/peps/tensor.py
diff --git a/varipeps/peps/unitcell.py b/varipeps/peps/unitcell.py
