mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-08 07:39:33 +01:00
dda59162f1
Fixes #92675 Here we implement a native version of [`einops.rearrange`](https://einops.rocks/api/rearrange/) using first class dims to perform the operations. The string parsing + validation, documentation, and relevant tests are adapted from `einops`. The API is exactly the same as the `einops` API. The main idea is to take the string and convert it to a left and right `ParsedExpression`, and then find a mapping from the axes to first class dims. Once the mapping exists we convert the left expression `composition` list into a `Tensor.__getitem__` index and the right expression `composition` into the `Tensor.order` arguments, and then use this to dynamically create a callable that performs the `rearrange` operation as specified by the pattern. Pull Request resolved: https://github.com/pytorch/pytorch/pull/101957 Approved by: https://github.com/zdevito
245 lines
10 KiB
Python
245 lines
10 KiB
Python
# Owner(s): ["module: functorch"]
|
|
|
|
"""Adapted from https://github.com/arogozhnikov/einops/blob/230ac1526c1f42c9e1f7373912c7f8047496df11/tests/test_parsing.py.
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2018 Alex Rogozhnikov
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
"""
|
|
from typing import Any, Callable, Dict
|
|
from unittest import mock
|
|
|
|
from functorch.einops._parsing import (
|
|
AnonymousAxis, ParsedExpression, parse_pattern, validate_rearrange_expressions, _ellipsis
|
|
)
|
|
from torch.testing._internal.common_utils import TestCase, run_tests
|
|
|
|
mock_anonymous_axis_eq: Callable[[AnonymousAxis, object], bool] = (
|
|
lambda self, other: isinstance(other, AnonymousAxis) and self.value == other.value
|
|
)
|
|
|
|
|
|
class TestAnonymousAxis(TestCase):
|
|
def test_anonymous_axes(self) -> None:
|
|
a, b = AnonymousAxis('2'), AnonymousAxis('2')
|
|
self.assertNotEqual(a, b)
|
|
|
|
with mock.patch.object(AnonymousAxis, '__eq__', mock_anonymous_axis_eq):
|
|
c, d = AnonymousAxis('2'), AnonymousAxis('3')
|
|
self.assertEqual(a, c)
|
|
self.assertEqual(b, c)
|
|
self.assertNotEqual(a, d)
|
|
self.assertNotEqual(b, d)
|
|
self.assertListEqual([a, 2, b], [c, 2, c])
|
|
|
|
|
|
class TestParsedExpression(TestCase):
|
|
def test_elementary_axis_name(self) -> None:
|
|
for name in ['a', 'b', 'h', 'dx', 'h1', 'zz', 'i9123', 'somelongname',
|
|
'Alex', 'camelCase', 'u_n_d_e_r_score', 'unreasonablyLongAxisName']:
|
|
self.assertTrue(ParsedExpression.check_axis_name(name))
|
|
|
|
for name in ['', '2b', '12', '_startWithUnderscore', 'endWithUnderscore_', '_', '...', _ellipsis]:
|
|
self.assertFalse(ParsedExpression.check_axis_name(name))
|
|
|
|
def test_invalid_expressions(self) -> None:
|
|
# double ellipsis should raise an error
|
|
ParsedExpression('... a b c d')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('... a b c d ...')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('... a b c (d ...)')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('(... a) b c (d ...)')
|
|
|
|
# double/missing/enclosed parenthesis
|
|
ParsedExpression('(a) b c (d ...)')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('(a)) b c (d ...)')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('(a b c (d ...)')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('(a) (()) b c (d ...)')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('(a) ((b c) (d ...))')
|
|
|
|
# invalid identifiers
|
|
ParsedExpression('camelCase under_scored cApiTaLs ß ...')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('1a')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('_pre')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('...pre')
|
|
with self.assertRaises(ValueError):
|
|
ParsedExpression('pre...')
|
|
|
|
@mock.patch.object(AnonymousAxis, '__eq__', mock_anonymous_axis_eq)
|
|
def test_parse_expression(self, *mocks: mock.MagicMock) -> None:
|
|
parsed = ParsedExpression('a1 b1 c1 d1')
|
|
self.assertSetEqual(parsed.identifiers, {'a1', 'b1', 'c1', 'd1'})
|
|
self.assertListEqual(parsed.composition, [['a1'], ['b1'], ['c1'], ['d1']])
|
|
self.assertFalse(parsed.has_non_unitary_anonymous_axes)
|
|
self.assertFalse(parsed.has_ellipsis)
|
|
|
|
parsed = ParsedExpression('() () () ()')
|
|
self.assertSetEqual(parsed.identifiers, set())
|
|
self.assertListEqual(parsed.composition, [[], [], [], []])
|
|
self.assertFalse(parsed.has_non_unitary_anonymous_axes)
|
|
self.assertFalse(parsed.has_ellipsis)
|
|
|
|
parsed = ParsedExpression('1 1 1 ()')
|
|
self.assertSetEqual(parsed.identifiers, set())
|
|
self.assertListEqual(parsed.composition, [[], [], [], []])
|
|
self.assertFalse(parsed.has_non_unitary_anonymous_axes)
|
|
self.assertFalse(parsed.has_ellipsis)
|
|
|
|
parsed = ParsedExpression('5 (3 4)')
|
|
self.assertEqual(len(parsed.identifiers), 3)
|
|
self.assertSetEqual({i.value if isinstance(i, AnonymousAxis) else i for i in parsed.identifiers}, {3, 4, 5})
|
|
self.assertListEqual(parsed.composition, [[AnonymousAxis('5')], [AnonymousAxis('3'), AnonymousAxis('4')]])
|
|
self.assertTrue(parsed.has_non_unitary_anonymous_axes)
|
|
self.assertFalse(parsed.has_ellipsis)
|
|
|
|
parsed = ParsedExpression('5 1 (1 4) 1')
|
|
self.assertEqual(len(parsed.identifiers), 2)
|
|
self.assertSetEqual({i.value if isinstance(i, AnonymousAxis) else i for i in parsed.identifiers}, {4, 5})
|
|
self.assertListEqual(parsed.composition, [[AnonymousAxis('5')], [], [AnonymousAxis('4')], []])
|
|
|
|
parsed = ParsedExpression('name1 ... a1 12 (name2 14)')
|
|
self.assertEqual(len(parsed.identifiers), 6)
|
|
self.assertEqual(len(parsed.identifiers - {'name1', _ellipsis, 'a1', 'name2'}), 2)
|
|
self.assertListEqual(
|
|
parsed.composition, [['name1'], _ellipsis, ['a1'], [AnonymousAxis('12')], ['name2', AnonymousAxis('14')]]
|
|
)
|
|
self.assertTrue(parsed.has_non_unitary_anonymous_axes)
|
|
self.assertTrue(parsed.has_ellipsis)
|
|
self.assertFalse(parsed.has_ellipsis_parenthesized)
|
|
|
|
parsed = ParsedExpression('(name1 ... a1 12) name2 14')
|
|
self.assertEqual(len(parsed.identifiers), 6)
|
|
self.assertEqual(len(parsed.identifiers - {'name1', _ellipsis, 'a1', 'name2'}), 2)
|
|
self.assertListEqual(
|
|
parsed.composition, [['name1', _ellipsis, 'a1', AnonymousAxis('12')], ['name2'], [AnonymousAxis('14')]]
|
|
)
|
|
self.assertTrue(parsed.has_non_unitary_anonymous_axes)
|
|
self.assertTrue(parsed.has_ellipsis)
|
|
self.assertTrue(parsed.has_ellipsis_parenthesized)
|
|
|
|
|
|
class TestParsingUtils(TestCase):
|
|
def test_parse_pattern_number_of_arrows(self) -> None:
|
|
axes_lengths: Dict[str, int] = {}
|
|
|
|
too_many_arrows_pattern = "a -> b -> c -> d"
|
|
with self.assertRaises(ValueError):
|
|
parse_pattern(too_many_arrows_pattern, axes_lengths)
|
|
|
|
too_few_arrows_pattern = "a"
|
|
with self.assertRaises(ValueError):
|
|
parse_pattern(too_few_arrows_pattern, axes_lengths)
|
|
|
|
just_right_arrows = "a -> a"
|
|
parse_pattern(just_right_arrows, axes_lengths)
|
|
|
|
def test_ellipsis_invalid_identifier(self) -> None:
|
|
axes_lengths: Dict[str, int] = {"a": 1, _ellipsis: 2}
|
|
pattern = f"a {_ellipsis} -> {_ellipsis} a"
|
|
with self.assertRaises(ValueError):
|
|
parse_pattern(pattern, axes_lengths)
|
|
|
|
def test_ellipsis_matching(self) -> None:
|
|
axes_lengths: Dict[str, int] = {}
|
|
|
|
pattern = "a -> a ..."
|
|
with self.assertRaises(ValueError):
|
|
parse_pattern(pattern, axes_lengths)
|
|
|
|
# raising an error on this pattern is handled by the rearrange expression validation
|
|
pattern = "a ... -> a"
|
|
parse_pattern(pattern, axes_lengths)
|
|
|
|
pattern = "a ... -> ... a"
|
|
parse_pattern(pattern, axes_lengths)
|
|
|
|
def test_left_parenthesized_ellipsis(self) -> None:
|
|
axes_lengths: Dict[str, int] = {}
|
|
|
|
pattern = "(...) -> ..."
|
|
with self.assertRaises(ValueError):
|
|
parse_pattern(pattern, axes_lengths)
|
|
|
|
|
|
class MaliciousRepr:
|
|
def __repr__(self) -> str:
|
|
return "print('hello world!')"
|
|
|
|
|
|
class TestValidateRearrangeExpressions(TestCase):
|
|
def test_validate_axes_lengths_are_integers(self) -> None:
|
|
axes_lengths: Dict[str, Any] = {"a": 1, "b": 2, "c": 3}
|
|
pattern = "a b c -> c b a"
|
|
left, right = parse_pattern(pattern, axes_lengths)
|
|
validate_rearrange_expressions(left, right, axes_lengths)
|
|
|
|
axes_lengths = {"a": 1, "b": 2, "c": MaliciousRepr()}
|
|
left, right = parse_pattern(pattern, axes_lengths)
|
|
with self.assertRaises(TypeError):
|
|
validate_rearrange_expressions(left, right, axes_lengths)
|
|
|
|
def test_non_unitary_anonymous_axes_raises_error(self) -> None:
|
|
axes_lengths: Dict[str, int] = {}
|
|
|
|
left_non_unitary_axis = "a 2 -> 1 1 a"
|
|
left, right = parse_pattern(left_non_unitary_axis, axes_lengths)
|
|
with self.assertRaises(ValueError):
|
|
validate_rearrange_expressions(left, right, axes_lengths)
|
|
|
|
right_non_unitary_axis = "1 1 a -> a 2"
|
|
left, right = parse_pattern(right_non_unitary_axis, axes_lengths)
|
|
with self.assertRaises(ValueError):
|
|
validate_rearrange_expressions(left, right, axes_lengths)
|
|
|
|
def test_identifier_mismatch(self) -> None:
|
|
axes_lengths: Dict[str, int] = {}
|
|
|
|
mismatched_identifiers = "a -> a b"
|
|
left, right = parse_pattern(mismatched_identifiers, axes_lengths)
|
|
with self.assertRaises(ValueError):
|
|
validate_rearrange_expressions(left, right, axes_lengths)
|
|
|
|
mismatched_identifiers = "a b -> a"
|
|
left, right = parse_pattern(mismatched_identifiers, axes_lengths)
|
|
with self.assertRaises(ValueError):
|
|
validate_rearrange_expressions(left, right, axes_lengths)
|
|
|
|
def test_unexpected_axes_lengths(self) -> None:
|
|
axes_lengths: Dict[str, int] = {"c": 2}
|
|
|
|
pattern = "a b -> b a"
|
|
left, right = parse_pattern(pattern, axes_lengths)
|
|
with self.assertRaises(ValueError):
|
|
validate_rearrange_expressions(left, right, axes_lengths)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
run_tests()
|