Rename remaining artifacts from peps_ad to varipeps

Author: JanLuca

docs/source/api/ctmrg/routine.rst

@@ -2,8 +2,8 @@
 
 .. currentmodule:: varipeps.ctmrg
 
-Calculate the new converged CTMRG tensors (:func:`varipeps.ctmrg.calc_ctmrg_env` and :func:`peps_ad.ctmrg.calc_ctmrg_env_custom_rule`)
-======================================================================================================================================
+Calculate the new converged CTMRG tensors (:func:`varipeps.ctmrg.calc_ctmrg_env` and :func:`varipeps.ctmrg.calc_ctmrg_env_custom_rule`)
+=======================================================================================================================================
 
 .. autofunction:: calc_ctmrg_env
 

varipeps/config.py

@@ -5,7 +5,7 @@
 
 from typing import TypeVar, Tuple, Any, Type
 
-T_PEPS_AD_Config = TypeVar("T_PEPS_AD_Config", bound="PEPS_AD_Config")
+T_VariPEPS_Config = TypeVar("T_VariPEPS_Config", bound="VariPEPS_Config")
 
 
 @unique
@@ -38,7 +38,7 @@ class Wavevector_Type(IntEnum):
 
 @dataclass
 @register_pytree_node_class
-class PEPS_AD_Config:
+class VariPEPS_Config:
     """
     Config class for peps-ad module. Normally only the blow created instance
     :obj:`config` is used.
@@ -239,13 +239,13 @@ def tree_flatten(self) -> Tuple[Tuple[Any, ...], Tuple[Any, ...]]:
 
     @classmethod
     def tree_unflatten(
-        cls: Type[T_PEPS_AD_Config],
+        cls: Type[T_VariPEPS_Config],
         aux_data: Tuple[Any, ...],
         children: Tuple[Any, ...],
-    ) -> T_PEPS_AD_Config:
+    ) -> T_VariPEPS_Config:
         (data_dict,) = aux_data
 
         return cls(**data_dict)
 
 
-config = PEPS_AD_Config()
+config = VariPEPS_Config()

varipeps/contractions/apply.py

@@ -12,7 +12,7 @@
 
 from varipeps.peps import PEPS_Tensor
 from varipeps import varipeps_config
-from varipeps.config import PEPS_AD_Config
+from varipeps.config import VariPEPS_Config
 from varipeps.utils.func_cache import Checkpointing_Cache
 
 from .definitions import Definitions, Definition
@@ -43,7 +43,7 @@ def apply_contraction(
     *,
     disable_identity_check: bool = False,
     custom_definition: Optional[Definition] = None,
-    config: PEPS_AD_Config = varipeps_config,
+    config: VariPEPS_Config = varipeps_config,
     _jitable: bool = False,
 ) -> jnp.ndarray:
     """
@@ -70,7 +70,7 @@ def apply_contraction(
       custom_definition (:obj:`~varipeps.contractions.apply.Definition`, optional):
         Use a custom definition for the contraction which is not defined in the
         :class:`varipeps.contractions.Definitions` class.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
     Returns:

varipeps/ctmrg/absorption.py

@@ -18,8 +18,8 @@
     calc_bottom_projectors,
 )
 from varipeps.expectation.one_site import calc_one_site_single_gate_obj
-from varipeps.config import PEPS_AD_Config
-from varipeps.global_state import PEPS_AD_Global_State
+from varipeps.config import VariPEPS_Config
+from varipeps.global_state import VariPEPS_Global_State
 
 
 from typing import Sequence, Tuple, List, Dict, Literal
@@ -61,7 +61,7 @@ def _get_ctmrg_2x2_structure(
     return view_tensors, view_tensor_objs
 
 
-def _post_process_CTM_tensors(a: jnp.ndarray, config: PEPS_AD_Config) -> jnp.ndarray:
+def _post_process_CTM_tensors(a: jnp.ndarray, config: VariPEPS_Config) -> jnp.ndarray:
     a = a / jnp.linalg.norm(a)
     a_abs = jnp.abs(a)
     a_abs_max = jnp.max(a_abs)
@@ -98,8 +98,8 @@ def new_phase(ph, curr_x, curr_x_abs):
 def do_left_absorption(
     peps_tensors: Sequence[jnp.ndarray],
     unitcell: PEPS_Unit_Cell,
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> PEPS_Unit_Cell:
     """
     Calculate the left CTMRG tensors after one absorption step and returns
@@ -110,10 +110,10 @@ def do_left_absorption(
         The sequence of unique PEPS tensors the unitcell consists of.
       unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
         The unitcell to work on.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.
@@ -197,8 +197,8 @@ class definition for details.
 def do_right_absorption(
     peps_tensors: Sequence[jnp.ndarray],
     unitcell: PEPS_Unit_Cell,
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> PEPS_Unit_Cell:
     """
     Calculate the right CTMRG tensors after one absorption step and returns
@@ -209,10 +209,10 @@ def do_right_absorption(
         The sequence of unique PEPS tensors the unitcell consists of.
       unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
         The unitcell to work on.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.
@@ -300,8 +300,8 @@ class definition for details.
 def do_top_absorption(
     peps_tensors: Sequence[jnp.ndarray],
     unitcell: PEPS_Unit_Cell,
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> PEPS_Unit_Cell:
     """
     Calculate the top CTMRG tensors after one absorption step and returns
@@ -312,10 +312,10 @@ def do_top_absorption(
         The sequence of unique PEPS tensors the unitcell consists of.
       unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
         The unitcell to work on.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.
@@ -399,8 +399,8 @@ class definition for details.
 def do_bottom_absorption(
     peps_tensors: Sequence[jnp.ndarray],
     unitcell: PEPS_Unit_Cell,
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> PEPS_Unit_Cell:
     """
     Calculate the bottom CTMRG tensors after one absorption step and returns
@@ -411,10 +411,10 @@ def do_bottom_absorption(
         The sequence of unique PEPS tensors the unitcell consists of.
       unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
         The unitcell to work on.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.
@@ -599,8 +599,8 @@ def gauge_fix_ctmrg_tensors(
 def do_absorption_step(
     peps_tensors: Sequence[jnp.ndarray],
     unitcell: PEPS_Unit_Cell,
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> PEPS_Unit_Cell:
     """
     Calculate the all CTMRG tensors after one absorption step and returns
@@ -611,10 +611,10 @@ def do_absorption_step(
         The sequence of unique PEPS tensors the unitcell consists of.
       unitcell (:obj:`~varipeps.peps.PEPS_Unit_Cell`):
         The unitcell to work on.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.

varipeps/ctmrg/projectors.py

@@ -15,8 +15,8 @@
     Top_Projectors,
     Bottom_Projectors,
 )
-from varipeps.config import Projector_Method, PEPS_AD_Config
-from varipeps.global_state import PEPS_AD_Global_State
+from varipeps.config import Projector_Method, VariPEPS_Config
+from varipeps.global_state import VariPEPS_Global_State
 
 from typing import Sequence, Tuple, TypeVar
 
@@ -312,8 +312,8 @@ def _left_projectors_workhorse(
 def calc_left_projectors(
     peps_tensors: Sequence[Sequence[jnp.ndarray]],
     peps_tensor_objs: Sequence[Sequence[PEPS_Tensor]],
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> Left_Projectors:
     """
     Calculate the left projectors for the CTMRG method.
@@ -324,10 +324,10 @@ def calc_left_projectors(
         to the x axis, the column (second) index to y.
       peps_tensor_objs (:term:`sequence` of :term:`sequence` of :obj:`~varipeps.peps.PEPS_Tensor`):
         Nested list of the PEPS tensor objects. Same format as for `peps_tensors`.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.
@@ -430,8 +430,8 @@ def _right_projectors_workhorse(
 def calc_right_projectors(
     peps_tensors: Sequence[Sequence[jnp.ndarray]],
     peps_tensor_objs: Sequence[Sequence[PEPS_Tensor]],
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> Right_Projectors:
     """
     Calculate the right projectors for the CTMRG method.
@@ -442,10 +442,10 @@ def calc_right_projectors(
         to the x axis, the column (second) index to y.
       peps_tensor_objs (:term:`sequence` of :term:`sequence` of :obj:`~varipeps.peps.PEPS_Tensor`):
         Nested list of the PEPS tensor objects. Same format as for `peps_tensors`.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.
@@ -548,8 +548,8 @@ def _top_projectors_workhorse(
 def calc_top_projectors(
     peps_tensors: Sequence[Sequence[jnp.ndarray]],
     peps_tensor_objs: Sequence[Sequence[PEPS_Tensor]],
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> Top_Projectors:
     """
     Calculate the top projectors for the CTMRG method.
@@ -560,10 +560,10 @@ def calc_top_projectors(
         to the x axis, the column (second) index to y.
       peps_tensor_objs (:term:`sequence` of :term:`sequence` of :obj:`~varipeps.peps.PEPS_Tensor`):
         Nested list of the PEPS tensor objects. Same format as for `peps_tensors`.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.
@@ -666,8 +666,8 @@ def _bottom_projectors_workhorse(
 def calc_bottom_projectors(
     peps_tensors: Sequence[Sequence[jnp.ndarray]],
     peps_tensor_objs: Sequence[Sequence[PEPS_Tensor]],
-    config: PEPS_AD_Config,
-    state: PEPS_AD_Global_State,
+    config: VariPEPS_Config,
+    state: VariPEPS_Global_State,
 ) -> Bottom_Projectors:
     """
     Calculate the bottom projectors for the CTMRG method.
@@ -678,10 +678,10 @@ def calc_bottom_projectors(
         to the x axis, the column (second) index to y.
       peps_tensor_objs (:term:`sequence` of :term:`sequence` of :obj:`~varipeps.peps.PEPS_Tensor`):
         Nested list of the PEPS tensor objects. Same format as for `peps_tensors`.
-      config (:obj:`~varipeps.config.PEPS_AD_Config`):
+      config (:obj:`~varipeps.config.VariPEPS_Config`):
         Global configuration object of the variPEPS library. Please see its
         class definition for details.
-      state (:obj:`~varipeps.global_state.PEPS_AD_Global_State`):
+      state (:obj:`~varipeps.global_state.VariPEPS_Global_State`):
         Global state object of the variPEPS library. It is used to transport
         a common state across different parts of the framework. Please see its
         class definition for details.

varipeps/global_state.py

@@ -6,12 +6,12 @@
 
 from .config import Projector_Method
 
-T_PEPS_AD_Global_State = TypeVar("T_PEPS_AD_Global_State", bound="PEPS_AD_Global_State")
+T_VariPEPS_Global_State = TypeVar("T_VariPEPS_Global_State", bound="VariPEPS_Global_State")
 
 
 @dataclass
 @register_pytree_node_class
-class PEPS_AD_Global_State:
+class VariPEPS_Global_State:
     """
     Class to track internal global state. Values of the instance of this
     class should not be modified by users.
@@ -30,13 +30,13 @@ def tree_flatten(self) -> Tuple[Tuple[Any, ...], Tuple[Any, ...]]:
 
     @classmethod
     def tree_unflatten(
-        cls: Type[T_PEPS_AD_Global_State],
+        cls: Type[T_VariPEPS_Global_State],
         aux_data: Tuple[Any, ...],
         children: Tuple[Any, ...],
-    ) -> T_PEPS_AD_Global_State:
+    ) -> T_VariPEPS_Global_State:
         (data_dict,) = aux_data
 
         return cls(**data_dict)
 
 
-global_state = PEPS_AD_Global_State()
+global_state = VariPEPS_Global_State()

varipeps/mapping/honeycomb.py

@@ -506,7 +506,7 @@ def load_from_file(
         return_auxiliary_data: bool = False,
     ) -> Union[
         Tuple[List[jnp.ndarray], PEPS_Unit_Cell],
-        Tuple[List[jnp.ndarray], PEPS_Unit_Cell, varipeps.config.PEPS_AD_Config],
+        Tuple[List[jnp.ndarray], PEPS_Unit_Cell, varipeps.config.VariPEPS_Config],
     ]:
         """
         Load Honeycomb PEPS tensors and unit cell from a HDF5 file.
@@ -528,7 +528,7 @@ def load_from_file(
             Return dictionary with string indexed auxiliary data which has been
             should be stored along the other data in the file.
         Returns:
-          :obj:`tuple`\ (:obj:`list`\ (:obj:`jax.numpy.ndarray`), :obj:`~varipeps.peps.PEPS_Unit_Cell`) or :obj:`tuple`\ (:obj:`list`\ (:obj:`jax.numpy.ndarray`), :obj:`~varipeps.peps.PEPS_Unit_Cell`, :obj:`~varipeps.config.PEPS_AD_Config`):
+          :obj:`tuple`\ (:obj:`list`\ (:obj:`jax.numpy.ndarray`), :obj:`~varipeps.peps.PEPS_Unit_Cell`) or :obj:`tuple`\ (:obj:`list`\ (:obj:`jax.numpy.ndarray`), :obj:`~varipeps.peps.PEPS_Unit_Cell`, :obj:`~varipeps.config.VariPEPS_Config`):
             The tuple with the list of the PESS tensors and the PEPS unitcell
             is returned. If ``return_config = True``. the config is returned
             as well. If ``return_auxiliary_data = True``. the auxiliary data is
@@ -570,7 +570,7 @@ def load_from_group(
         return_config: bool = False,
     ) -> Union[
         Tuple[List[jnp.ndarray], PEPS_Unit_Cell],
-        Tuple[List[jnp.ndarray], PEPS_Unit_Cell, varipeps.config.PEPS_AD_Config],
+        Tuple[List[jnp.ndarray], PEPS_Unit_Cell, varipeps.config.VariPEPS_Config],
     ]:
         """
         Load the unit cell from a HDF5 group which is be passed to the method.
@@ -585,7 +585,7 @@ def load_from_group(
             Missing config flags in the file uses the default values from the
             config object.
         Returns:
-          :obj:`tuple`\ (:obj:`list`\ (:obj:`jax.numpy.ndarray`), :obj:`~varipeps.peps.PEPS_Unit_Cell`) or :obj:`tuple`\ (:obj:`list`\ (:obj:`jax.numpy.ndarray`), :obj:`~varipeps.peps.PEPS_Unit_Cell`, :obj:`~varipeps.config.PEPS_AD_Config`):
+          :obj:`tuple`\ (:obj:`list`\ (:obj:`jax.numpy.ndarray`), :obj:`~varipeps.peps.PEPS_Unit_Cell`) or :obj:`tuple`\ (:obj:`list`\ (:obj:`jax.numpy.ndarray`), :obj:`~varipeps.peps.PEPS_Unit_Cell`, :obj:`~varipeps.config.VariPEPS_Config`):
             The tuple with the list of the PESS tensors and the PEPS unitcell
             is returned. If ``return_config = True``. the config is returned
             as well.