Docs update on split semantics.

helmholtz-analytics · Apr 28, 2020 · 63bab7e · 63bab7e
1 parent 394e11c
commit 63bab7e
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/heat/core/manipulations.py b/heat/core/manipulations.py
@@ -1196,7 +1196,14 @@ def squeeze(x, axis=None):
     --------
     squeezed : ht.DNDarray
                The input tensor, but with all or a subset of the dimensions of length 1 removed.
-
+               Split semantics: see note below.
+
+    Note:
+    -----
+    Split semantics: if the input tensor is distributed ('x.split is not None'), the output
+    tensor will be distributed along the same dimension. The case where 'x.split = axis'
+    implies a redistribution of the input tensor along the next possible split dimension
+    (cf. 'heat.resplit()') which may affect performance.
 
     Examples:
     >>> import heat as ht