Skip to content

Commit 40f2d3a

Browse files
committed
Update docs for peps_type argument of random function
1 parent 812aaf9 commit 40f2d3a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

varipeps/peps/unitcell.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,11 @@ def random(
303303
dtype (:term:`type` of :obj:`jax.numpy.number`):
304304
Data type of the PEPS tensors.
305305
max_chi (:obj:`int`):
306-
Maximal allowed bond dimension for the environment tensors
306+
Maximal allowed bond dimension for the environment tensors.
307+
peps_type (:obj:`~varipeps.peps.PEPS_Type`):
308+
Select which type of PEPS state should be generated. For example
309+
selects a square with full transfer tensor, a square with
310+
split-CTMRG env or the triangular PEPS mode.
307311
Keyword args:
308312
seed (:obj:`int`, optional):
309313
Seed for random number generator

0 commit comments

Comments
 (0)