Skip to content

Commit

Permalink
Docs update on split semantics.
Browse files Browse the repository at this point in the history
  • Loading branch information
ClaudiaComito committed Apr 28, 2020
1 parent bb04d61 commit 81026e8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

- Update documentation theme to "Read the Docs"
- [#429](https://github.com/helmholtz-analytics/heat/pull/429) Create submodule for Linear Algebra functions
- [#429](https://github.com/helmholtz-analytics/heat/pull/429) Implementated QR
- [#429](https://github.com/helmholtz-analytics/heat/pull/429) Implementated a tiling class to create Square tiles along the diagonal of a 2D matrix
- [#429](https://github.com/helmholtz-analytics/heat/pull/429) Implemented QR
- [#429](https://github.com/helmholtz-analytics/heat/pull/429) Implemented a tiling class to create Square tiles along the diagonal of a 2D matrix
- [#429](https://github.com/helmholtz-analytics/heat/pull/429) Added PyTorch Jitter to inner function of matmul for increased speed
- [#483](https://github.com/helmholtz-analytics/heat/pull/483) Bugfix: Underlying torch tensor moves to the right device on array initialisation
- [#483](https://github.com/helmholtz-analytics/heat/pull/483) Bugfix: DNDarray.cpu() changes heat device to cpu
Expand Down
9 changes: 8 additions & 1 deletion heat/core/manipulations.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 81026e8

Please sign in to comment.