Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc] Add note about torch.flip returning new tensor and not view. #50041

Closed
wants to merge 5 commits into from
Closed

[doc] Add note about torch.flip returning new tensor and not view. #50041

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f8b19e6
add note in flip, fliplr, flipud docs
kshitij12345 Jan 4, 2021
fc83ea0
address comment: update note
kshitij12345 Jan 6, 2021
7f02b2d
update Note
kshitij12345 Jan 11, 2021
ad47b8b
Merge branch 'master' into doc/flip/returns-new-tensor
kshitij12345 Jan 11, 2021
f6eb4cd
replace array -> tensor
kshitij12345 Jan 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 17 additions & 2 deletions torch/_torch_docs.py
View file
Open in desktop
Expand Up @@ -8472,6 +8472,11 @@ def merge_dicts(*dicts):

Reverse the order of a n-D tensor along given axis in dims.

.. note::
`torch.flip` makes a copy of :attr:`input`'s data. This is different from NumPy's `np.flip`,
which returns a view in constant time. Since copying a tensor's data is more work than viewing that data,
`torch.flip` is expected to be slower than `np.flip`.

Args:
{input}
dims (a list or tuple): axis to flip on
Expand Down Expand Up @@ -8503,7 +8508,12 @@ def merge_dicts(*dicts):
Columns are preserved, but appear in a different order than before.

Note:
Equivalent to input[:,::-1]. Requires the array to be at least 2-D.
Requires the array to be at least 2-D.

.. note::
`torch.fliplr` makes a copy of :attr:`input`'s data. This is different from NumPy's `np.fliplr`,
which returns a view in constant time. Since copying a tensor's data is more work than viewing that data,
`torch.fliplr` is expected to be slower than `np.fliplr`.

Args:
input (Tensor): Must be at least 2-dimensional.
Expand All @@ -8529,7 +8539,12 @@ def merge_dicts(*dicts):
Rows are preserved, but appear in a different order than before.

Note:
Equivalent to input[::-1,...]. Requires the array to be at least 1-D.
Requires the array to be at least 1-D.

.. note::
`torch.flipud` makes a copy of :attr:`input`'s data. This is different from NumPy's `np.flipud`,
which returns a view in constant time. Since copying a tensor's data is more work than viewing that data,
`torch.flipud` is expected to be slower than `np.flipud`.

Args:
input (Tensor): Must be at least 1-dimensional.
Expand Down