Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ClaudiaComito committed May 4, 2020
1 parent 2b56c16 commit 6ca24b8
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions heat/core/manipulations.py
Original file line number Diff line number Diff line change
Expand Up @@ -1198,19 +1198,6 @@ def squeeze(x, axis=None):
The input tensor, but with all or a subset of the dimensions of length 1 removed.
Split semantics: see note below.
Note:
-----
Split semantics: a distributed tensor will keep its original split dimension after "squeezing",
which, depending on the squeeze axis, may result in a lower numerical 'split' value, as in:
>>> x.shape
(10, 1, 12, 13)
>>> x.split
2
>>> x.squeeze().shape
(10, 12, 13)
>>> x.squeeze().split
1
Examples:
---------
>>> import heat as ht
Expand Down Expand Up @@ -1240,6 +1227,19 @@ def squeeze(x, axis=None):
Traceback (most recent call last):
...
ValueError: Dimension along axis 1 is not 1 for shape (1, 3, 1, 5)
Note:
-----
Split semantics: a distributed tensor will keep its original split dimension after "squeezing",
which, depending on the squeeze axis, may result in a lower numerical 'split' value, as in:
>>> x.shape
(10, 1, 12, 13)
>>> x.split
2
>>> x.squeeze().shape
(10, 12, 13)
>>> x.squeeze().split
1
"""

# Sanitize input
Expand Down

0 comments on commit 6ca24b8

Please sign in to comment.