Skip to content

Commit

Permalink
update gauge_all_simple docstring [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
jcmgray committed Dec 10, 2024
1 parent 9df4fed commit db64610
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion quimb/tensor/tensor_core.py
Original file line number Diff line number Diff line change
@@ -6852,7 +6852,12 @@ def gauge_all_simple(
inplace=False,
):
"""Iterative gauge all the bonds in this tensor network with a 'simple
update' like strategy.
update' like strategy. If gauges are not supplied they are initialized
and then reabsorbed at the end, in which case this method acts as a
kind of conditioning. More usefully, if you supply `gauges` then they
will be updated inplace and *not* absorbed back into the tensor
network, with the assumption that you are using/tracking them
externally.
Parameters
----------
@@ -6880,6 +6885,11 @@ def gauge_all_simple(
Returns
-------
TensorNetwork
See Also
--------
gauge_simple_insert, gauge_simple_remove, gauge_simple_temp,
gauge_all_canonize
"""
tn = self if inplace else self.copy()

0 comments on commit db64610

Please sign in to comment.