From db646106a10623e92cabc45786b6568c6d958f87 Mon Sep 17 00:00:00 2001 From: Johnnie Gray Date: Tue, 10 Dec 2024 13:00:15 -0800 Subject: [PATCH] update gauge_all_simple docstring [skip ci] --- quimb/tensor/tensor_core.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/quimb/tensor/tensor_core.py b/quimb/tensor/tensor_core.py index 0fc99077..3d45c756 100644 --- a/quimb/tensor/tensor_core.py +++ b/quimb/tensor/tensor_core.py @@ -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()