Skip to content

prevent feature wrapping if the feature is not the primary operand #6095

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.

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

Merged
merged 4 commits into from
Sep 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/prototype-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ jobs:
id: setup
run: exit 0

- name: Run prototype features tests
shell: bash
run: |
pytest \
--durations=20 \
--cov=torchvision/prototype/features \
--cov-report=term-missing \
test/test_prototype_features*.py

- name: Run prototype datasets tests
if: success() || ( failure() && steps.setup.conclusion == 'success' )
shell: bash
Expand Down
72 changes: 72 additions & 0 deletions test/test_prototype_features.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import torch
from torchvision.prototype import features


def test_isinstance():
assert isinstance(
features.Label([0, 1, 0], categories=["foo", "bar"]),
torch.Tensor,
)


def test_wrapping_no_copy():
tensor = torch.tensor([0, 1, 0], dtype=torch.int64)
label = features.Label(tensor, categories=["foo", "bar"])

assert label.data_ptr() == tensor.data_ptr()


def test_to_wrapping():
tensor = torch.tensor([0, 1, 0], dtype=torch.int64)
label = features.Label(tensor, categories=["foo", "bar"])

label_to = label.to(torch.int32)

assert type(label_to) is features.Label
assert label_to.dtype is torch.int32
assert label_to.categories is label.categories


def test_to_feature_reference():
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the test case that makes sure we actually fix #6094.

tensor = torch.tensor([0, 1, 0], dtype=torch.int64)
label = features.Label(tensor, categories=["foo", "bar"]).to(torch.int32)

tensor_to = tensor.to(label)

assert type(tensor_to) is torch.Tensor
assert tensor_to.dtype is torch.int32


def test_clone_wrapping():
tensor = torch.tensor([0, 1, 0], dtype=torch.int64)
label = features.Label(tensor, categories=["foo", "bar"])

label_clone = label.clone()

assert type(label_clone) is features.Label
assert label_clone.data_ptr() != label.data_ptr()
assert label_clone.categories is label.categories


def test_other_op_no_wrapping():
tensor = torch.tensor([0, 1, 0], dtype=torch.int64)
label = features.Label(tensor, categories=["foo", "bar"])

# any operation besides .to() and .clone() will do here
output = label * 2

assert type(output) is torch.Tensor


def test_new_like():
tensor = torch.tensor([0, 1, 0], dtype=torch.int64)
label = features.Label(tensor, categories=["foo", "bar"])

# any operation besides .to() and .clone() will do here
output = label * 2

label_new = features.Label.new_like(label, output)

assert type(label_new) is features.Label
assert label_new.data_ptr() == output.data_ptr()
assert label_new.categories is label.categories
7 changes: 7 additions & 0 deletions torchvision/prototype/features/_feature.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,13 @@ def __torch_function__(
with DisableTorchFunction():
output = func(*args, **kwargs)

# The __torch_function__ protocol will invoke this method on all types involved in the computation by walking
# the MRO upwards. For example, `torch.Tensor(...).to(features.Image(...))` will invoke
# `features.Image.__torch_function__` first. The check below makes sure that we do not try to wrap in such a
# case.
if not isinstance(args[0], cls):
return output
Comment on lines +96 to +97
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although the behavior should be kept for all ops where we might wrap, right now this only applies to torch.Tensor.to. torch.Tensor.clone does not accept any inputs and thus this method will only be invoked in case the data to clone is actually a feature. All other ops will be handled by the else branch which performs no wrapping.

Thus, we could also merge this into the torch.Tensor.to branch for now, but will need to put it back where it is right now as soon as we special case another op that takes tensors as inputs. I would keep it were it is, but won't oppose putting it elsewhere for now.


if func is torch.Tensor.clone:
return cls.new_like(args[0], output)
elif func is torch.Tensor.to:
Expand Down