1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
|
# Owner(s): ["module: unknown"]
import torch
from torch._C import parse_schema
from torch.testing._internal.common_utils import run_tests, TestCase
class TestFunctionSchema(TestCase):
def test_serialize_and_deserialize(self):
schemas = torch._C._jit_get_all_schemas()
# so far we have around 1700 registered schemas
self.assertGreater(len(schemas), 1000)
for schema in schemas:
parsed_schema = parse_schema(str(schema))
self.assertEqual(parsed_schema, schema)
self.assertTrue(parsed_schema.is_backward_compatible_with(schema))
def test_out_schema(self):
schema_with_out = parse_schema(
"any.out(Tensor self, *, Tensor(a!) out) -> Tensor(a!)"
)
self.assertTrue(schema_with_out.arguments[-1].is_out)
schema_without_out = parse_schema(
"any.not_out(Tensor self, Tensor b) -> Tensor"
)
self.assertFalse(schema_without_out.arguments[-1].is_out)
def test_hash_schema(self):
schema1 = parse_schema("any.out(Tensor self, *, Tensor(a!) out) -> Tensor(a!)")
schema2 = parse_schema("any.out(Tensor self, *, Tensor(a!) out) -> Tensor(a!)")
self.assertEqual(hash(schema1), hash(schema2))
schema3 = parse_schema(
"any.not_out(Tensor self, *, Tensor(a!) out) -> Tensor(a!)"
)
self.assertNotEqual(hash(schema2), hash(schema3))
schema4 = parse_schema(
"foo(Tensor self, *, int a, Tensor(a!) out) -> Tensor(a!)"
)
self.assertNotEqual(hash(schema2), hash(schema4))
# schemas with different default value, or different kw-only arg, should have different hash
default_val_schema0 = parse_schema("foo(Tensor self, int a = 2) -> Tensor(a!)")
default_val_schema1 = parse_schema("foo(Tensor self, int a = 3) -> Tensor(a!)")
default_val_schema2 = parse_schema(
"foo(Tensor self, *, int a = 2) -> Tensor(a!)"
)
self.assertNotEqual(hash(default_val_schema0), hash(default_val_schema1))
self.assertNotEqual(hash(default_val_schema0), hash(default_val_schema2))
# schema with different alias annotation should have different hash
alias_schema = parse_schema("foo(Tensor(a!) self, int a = 2) -> Tensor(a!)")
self.assertNotEqual(hash(default_val_schema0), hash(alias_schema))
alias_schema2 = parse_schema("foo(Tensor(b!) self, int a = 2) -> Tensor(a!)")
self.assertNotEqual(hash(alias_schema), hash(alias_schema2))
# schema with different alias infos
alias_schema3 = parse_schema(
"foo(Tensor self, *, int a, int b=1, Tensor(a!) out, Tensor(b!) b) -> Tensor(a!)"
)
alias_schema4 = parse_schema(
"foo(Tensor self, *, int a, int b=1, Tensor(a!) out, Tensor(b!) b) -> Tensor(b!)"
)
alias_schema5 = parse_schema(
"foo(Tensor self, *, int a, int b=1, Tensor(b!) out, Tensor(a!) b) -> Tensor(a!)"
)
self.assertNotEqual(hash(alias_schema3), hash(alias_schema4))
self.assertNotEqual(hash(alias_schema3), hash(alias_schema5))
def test_backward_compatible_structure(self):
old_schema = parse_schema("any.over(Tensor self, *, Tensor b) -> Tensor")
# BC: A new schema without changes.
new_schema = parse_schema("any.over(Tensor self, *, Tensor b) -> Tensor")
self.assertTrue(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema with different name.
new_schema = parse_schema("any_.over(Tensor self, *, Tensor b) -> Tensor")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema with different overload name.
new_schema = parse_schema("any.other(Tensor self, *, Tensor b) -> Tensor")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema that adds vararg.
new_schema = parse_schema("any.over(Tensor self, *, Tensor b, ...) -> Tensor")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema with different number of outputs.
new_schema = parse_schema(
"any.over(Tensor self, *, Tensor b) -> (Tensor, Tensor)"
)
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
def test_backward_compatible_outputs(self):
old_schema = parse_schema("any.over(Tensor self, *, Tensor b) -> Tensor")
# No-BC: A new schema with output becoming of optional type.
new_schema = parse_schema("any.over(Tensor self, *, Tensor b) -> Tensor?")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# BC: (the opposite case) An schema where the output is not of optional type anymore.
self.assertTrue(old_schema.is_backward_compatible_with(new_schema))
# No-BC: A new schema with a different output type.
new_schema = parse_schema("any.over(Tensor self, *, Tensor b) -> int")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema with a different output type.
new_schema = parse_schema("any.over(Tensor self, *, Tensor b) -> Tensor out")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
def test_backward_compatible_arguments(self):
old_schema = parse_schema("any(Tensor self, *, Tensor b, int c) -> Tensor")
# No-BC: A new schema with less arguments.
new_schema = parse_schema("any(Tensor self, *, Tensor b) -> Tensor")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema with more arguments, appended, but no default value.
new_schema = parse_schema(
"any(Tensor self, *, Tensor b, int c, int d) -> Tensor"
)
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# BC: A new schema with more arguments, appended, that have a default value.
new_schema = parse_schema(
"any(Tensor self, *, Tensor b, int c, int d=1) -> Tensor"
)
self.assertTrue(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema with more arguments, not-appended, that have a default value.
new_schema = parse_schema(
"any(Tensor self, int d=1, *, Tensor b, int c) -> Tensor"
)
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# BC: A new schema where old kwargs becomes positional.
new_schema = parse_schema("any(Tensor self, Tensor b, *, int c) -> Tensor")
self.assertTrue(new_schema.is_backward_compatible_with(old_schema))
# BC: (the opposite case) A new schema where an old positional argument becomes kwarg.
self.assertFalse(old_schema.is_backward_compatible_with(new_schema))
# BC: A new schema where all old kwargs become positional.
new_schema = parse_schema("any(Tensor self, Tensor b, int c) -> Tensor")
self.assertTrue(new_schema.is_backward_compatible_with(old_schema))
# BC: (the opposite case) A new schema where all old positional arguments become kwarg.
self.assertFalse(old_schema.is_backward_compatible_with(new_schema))
# No-BC: A new schema where old kwargs appear in different order.
new_schema = parse_schema("any(Tensor self, *, int c, Tensor b) -> Tensor")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# BC: A new schema where argument becomes of type optional.
new_schema = parse_schema("any(Tensor self, *, Tensor b, int? c) -> Tensor")
self.assertTrue(new_schema.is_backward_compatible_with(old_schema))
# BC: A new schema where argument gains a default value.
new_schema = parse_schema("any(Tensor self, *, Tensor b, int c=1) -> Tensor")
self.assertTrue(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema where argument is "renamed".
new_schema = parse_schema(
"any(Tensor self, *, Tensor b, int renamed) -> Tensor"
)
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
# No-BC: A new schema where argument type changes to an incompatible type.
new_schema = parse_schema("any(Tensor self, *, Tensor b, int[] c) -> Tensor")
self.assertFalse(new_schema.is_backward_compatible_with(old_schema))
def test_backward_compatible_with_smart_serialization(self):
# cases where out arg is provided
old_schema = parse_schema(
"foo(Tensor self, *, int a, Tensor(a!) out) -> Tensor(a!)"
)
new_schema_same_out = parse_schema(
"foo(Tensor self, *, int a, int b=1, Tensor(a!) out) -> Tensor(a!)"
)
new_schema_wrong_default = parse_schema(
"foo(Tensor self, *, int b=1, int a, Tensor(a!) out) -> Tensor(a!)"
)
new_schema_more_out = parse_schema(
"foo(Tensor self, *, int a, int b=1, Tensor(a!) out, Tensor(b!) b) -> Tensor(a!)"
)
new_schema_wrong_pos = parse_schema(
"foo(Tensor self, *, int a, int b=1, Tensor(b!) b, Tensor(a!) out) -> Tensor(a!)"
)
self.assertTrue(new_schema_same_out.is_backward_compatible_with(old_schema))
self.assertTrue(new_schema_more_out.is_backward_compatible_with(old_schema))
self.assertFalse(
new_schema_wrong_default.is_backward_compatible_with(old_schema)
)
self.assertFalse(new_schema_wrong_pos.is_backward_compatible_with(old_schema))
# cases where out arg is not provided
old_schema_without_arg = parse_schema("foo(Tensor self, int a, int b=1) -> int")
new_schema_without_arg = parse_schema(
"foo(Tensor self, int a, int b=1, int c=2) -> int"
)
new_schema_without_arg_multiple_default = parse_schema(
"foo(Tensor self, int a, int b=1, int c=2, int d=3) -> int"
)
new_schema_without_arg_wrong_pos = parse_schema(
"foo(Tensor self, int a, int c=2, int b=1) -> int"
)
self.assertTrue(
new_schema_without_arg.is_backward_compatible_with(old_schema_without_arg)
)
self.assertTrue(
new_schema_without_arg_multiple_default.is_backward_compatible_with(
old_schema_without_arg
)
)
self.assertFalse(
new_schema_without_arg_wrong_pos.is_backward_compatible_with(
old_schema_without_arg
)
)
def test_string_optional_parameter_default_value(self):
schema_a = parse_schema('example::op(str? order="NCHW") -> (Tensor)')
schema_b = parse_schema(str(schema_a))
self.assertEqual(schema_a, schema_b)
def test_forward_compatible_arguments_without_out(self):
old_schema = parse_schema("any(Tensor self, int a, int b=1) -> Tensor")
# deleting default arg is FC compatible
new_schema = parse_schema("any(Tensor self, int a) -> Tensor")
is_fc, _ = new_schema.check_forward_compatible_with(old_schema)
self.assertTrue(is_fc)
# adding default arg is FC compatible
new_schema = parse_schema("any(Tensor self, int a, int b=1, int c=1) -> Tensor")
is_fc, _ = new_schema.check_forward_compatible_with(old_schema)
self.assertTrue(is_fc)
# adding default arg with container type is NOT FC compatible
new_schema = parse_schema(
"any(Tensor self, int a, int b=1, int[2] c=1) -> Tensor"
)
is_fc, reason = new_schema.check_forward_compatible_with(old_schema)
self.assertFalse(is_fc)
self.assertEqual(
reason,
"Function schema is not forward compatible since the new argument"
" 'c' of type int[] has a container type as its default value.",
)
# updating the default value of a default arg is NOT FC compatible
new_schema = parse_schema("any(Tensor self, int a, int b=4) -> Tensor")
is_fc, reason = new_schema.check_forward_compatible_with(old_schema)
self.assertFalse(is_fc)
self.assertEqual(
reason, "'b' is not forward compatible with the older version of the schema"
)
# updating the arg name of a default arg is NOT FC compatible
new_schema = parse_schema("any(Tensor self, int a, int c=1) -> Tensor")
is_fc, reason = new_schema.check_forward_compatible_with(old_schema)
self.assertFalse(is_fc)
self.assertEqual(
reason, "'c' is not forward compatible with the older version of the schema"
)
# not adding default arg in the end is NOT FC compatible
new_schema = parse_schema("any(Tensor self, int a, int c=1, int b=1) -> Tensor")
is_fc, reason = new_schema.check_forward_compatible_with(old_schema)
self.assertFalse(is_fc)
self.assertEqual(
reason, "'c' is not forward compatible with the older version of the schema"
)
# making default arg into positional arg is NOT FC compatible
new_schema = parse_schema("any(Tensor self, int a, int b) -> Tensor")
is_fc, reason = new_schema.check_forward_compatible_with(old_schema)
self.assertFalse(is_fc)
self.assertEqual(
reason, "'b' is not forward compatible with the older version of the schema"
)
# making positional arg into default arg is NOT FC compatible
new_schema = parse_schema("any(Tensor self, int a=1, int b=1) -> Tensor")
is_fc, reason = new_schema.check_forward_compatible_with(old_schema)
self.assertFalse(is_fc)
self.assertEqual(
reason, "'a' is not forward compatible with the older version of the schema"
)
def test_forward_compatible_arguments_real_use_case(self):
# this change introduced forward incompatibility in the past
old_slice_schema = parse_schema(
"slice(Tensor(a) self, int dim=0, int start=0, int end=0, int step=1) -> Tensor(a)"
)
new_slice_schema = parse_schema(
"slice(Tensor(a) self, int dim=0, int? start=None, int? end=None, int step=1) -> Tensor(a)"
)
is_fc, reason = new_slice_schema.check_forward_compatible_with(old_slice_schema)
self.assertFalse(is_fc)
self.assertEqual(
reason,
"'start' is not forward compatible with the older version of the schema",
)
def test_forward_compatible_arguments_with_out(self):
old_schema = parse_schema(
"any(Tensor self, *, int a, int b=1, Tensor(a!) out) -> Tensor(a!)"
)
new_schema = parse_schema(
"any(Tensor self, *, int a, Tensor(a!) out) -> Tensor(a!)"
)
is_fc, _ = new_schema.check_forward_compatible_with(old_schema)
self.assertTrue(is_fc)
new_schema = parse_schema(
"any(Tensor self, *, int a, int b=1, int c=1, Tensor(a!) out) -> Tensor(a!)"
)
is_fc, _ = new_schema.check_forward_compatible_with(old_schema)
self.assertTrue(is_fc)
new_schema = parse_schema(
"any(Tensor self, *, int a, Tensor(d!) d, int b=1, Tensor(a!) out) -> Tensor(a!)"
)
is_fc, reason = new_schema.check_forward_compatible_with(old_schema)
self.assertFalse(is_fc)
self.assertEqual(
reason, "Function schema should have the same number of out arguments"
)
def test_schema_error(self):
with self.assertRaisesRegex(
RuntimeError, r"schemas with vararg \(...\) can't have default value args"
):
schema = parse_schema("any.foo(int arg1, int arg2=0, ...)")
def test_tensor_list_alias_annotation_properly_parsed(self):
schema_str = "foo(Tensor self, *, Tensor(a!)[] out) -> ()"
schema = parse_schema(schema_str)
self.assertTrue(schema.arguments[-1].alias_info.is_write)
self.assertEqual(str(schema), schema_str)
def test_tensor_option_arguments_properly_parsed(self):
schema_str = (
"_to_copy(Tensor self, *, ScalarType? dtype=None, Layout? layout=None, Device? device=None, "
"bool? pin_memory=None, bool non_blocking=False, MemoryFormat? memory_format=None) -> Tensor"
)
schema = parse_schema(schema_str)
# fake type of MemoryFormat? is int?
self.assertEqual(schema.arguments[-1].type.str(), "int?")
# fake type of Layout? is int?
self.assertEqual(schema.arguments[2].type.str(), "int?")
# fake type of Device? is Device?
self.assertEqual(schema.arguments[3].type.str(), "Device?")
# print real types in FunctionSchema
self.assertEqual(str(schema), schema_str)
def test_sym_int_argument_properly_parsed(self):
schema_str = "sym_size.int(Tensor self, int dim) -> SymInt"
schema = parse_schema(schema_str)
# fake type of SymInt is int
self.assertEqual(schema.returns[-1].type.str(), "int")
# real type of SymInt is SymInt
self.assertEqual(schema.returns[-1].real_type.str(), "SymInt")
# print real types in FunctionSchema
self.assertEqual(str(schema), schema_str)
if __name__ == "__main__":
run_tests()
|
