blob: d42caf58abb87839a96a832ecbd488969889030b [file] [log] [blame]
Rickard Bolinfea15162022-07-04 16:19:16 +00001# Copyright (C) 2020-2022 Arm Limited or its affiliates. All rights reserved.
Jonas Ohlsson45e653d2021-07-26 16:13:12 +02002#
3# SPDX-License-Identifier: Apache-2.0
4#
5# Licensed under the Apache License, Version 2.0 (the License); you may
6# not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an AS IS BASIS, WITHOUT
13# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16# Description:
17# The TFLiteSupportedOperators class which is a collection of all TFLite supported operators and parameter checks.
18from collections import defaultdict
19
20import numpy as np
21
22from .data_type import DataType
Fredrik Svedberg88d5b122022-09-16 16:24:55 +020023from .numeric_util import full_shape
Jonas Ohlsson45e653d2021-07-26 16:13:12 +020024from .operation import Op
25from .operation import Padding
26from .supported_operators_util import docstring_format_args
27from .supported_operators_util import list_formatter
28from .tensor import check_quantized_tens_scaling_equal
29from .tflite_mapping import BUILTIN_OPERATOR_UNKNOWN
30from .tflite_mapping import optype_to_builtintype
31
32
33def _optype_formatter(op_list):
34 # Convert internal op types to external names
35 output = map(optype_to_builtintype, op_list)
36 # Remove UNKNOWNs
37 output = (x for x in output if x is not BUILTIN_OPERATOR_UNKNOWN)
38 return list_formatter(output)
39
40
41class TFLiteSupportedOperators:
42 # Categorised lists of supported operators
Fredrik Svedberg11563172022-07-06 14:54:12 +020043 npu_pre_ops = set(
44 (
45 Op.SplitSliceRead,
46 Op.Shape,
47 )
48 )
Jonas Ohlssond8575072022-03-30 10:30:25 +020049 convolution_ops = set(
50 (
51 Op.Conv2DBias,
52 Op.Conv2D,
53 Op.QuantizedConv2D,
54 )
55 )
Jonas Ohlsson45e653d2021-07-26 16:13:12 +020056 depthwise_convolution_ops = set((Op.DepthwiseConv2DBias,))
57 transpose_convolution_ops = set((Op.Conv2DBackpropInput,))
58 convolution_like_ops = convolution_ops | depthwise_convolution_ops | transpose_convolution_ops
59 max_pooling_ops = Op.op_set(Op.is_maxpool_op)
60 avg_pooling_ops = Op.op_set(Op.is_avgpool_op)
61 pooling_ops = set((Op.ReduceSum,)) | max_pooling_ops | avg_pooling_ops
Tim Hall885033b2022-07-21 11:46:03 +010062 resizing_ops = Op.op_set(Op.is_resize_op)
Jonas Ohlssond8575072022-03-30 10:30:25 +020063 fc_vector_products = set(
64 (
65 Op.QuantizedMatMul,
66 Op.MatMul,
67 Op.FullyConnected,
68 )
69 )
Jonas Ohlsson45e653d2021-07-26 16:13:12 +020070 mac_main_ops = (
71 # RNN/LSTM/GRU
72 set((Op.BlockLSTM,))
73 # conv/depthwiseconv/transposeconv
74 | convolution_like_ops
75 # pooling
76 | pooling_ops
77 # resizing/upscaling
78 | resizing_ops
79 # FC layers
80 | fc_vector_products
81 # Mean (converts to depthwise conv)
82 | set((Op.Mean,))
83 )
84 unary_elem_wise_main_ops = Op.op_set(Op.is_unary_elementwise_op)
Jonas Ohlssond8575072022-03-30 10:30:25 +020085 binary_elem_wise_min_max_ops = set(
86 (
87 Op.Minimum,
88 Op.Maximum,
89 )
90 )
91 binary_elem_wise_shift_ops = set(
92 (
93 Op.SHL,
94 Op.SHR,
95 )
96 )
97 binary_elem_wise_add_mul_sub = set(
98 (
99 Op.Add,
100 Op.Mul,
101 Op.Sub,
102 )
103 )
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200104 binary_elem_wise_main_ops = binary_elem_wise_min_max_ops | binary_elem_wise_add_mul_sub | binary_elem_wise_shift_ops
105 elem_wise_main_ops = binary_elem_wise_main_ops | unary_elem_wise_main_ops
106 pad_ops = set((Op.Pad,))
107 supported_int32_tensor_ops = (
Jonas Ohlssond8575072022-03-30 10:30:25 +0200108 set(
109 (
110 Op.ReduceSum,
111 Op.CLZ,
Fredrik Svedberg11563172022-07-06 14:54:12 +0200112 Op.Shape,
Jonas Ohlssond8575072022-03-30 10:30:25 +0200113 )
114 )
115 | binary_elem_wise_add_mul_sub
116 | binary_elem_wise_shift_ops
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200117 )
118
Jonas Ohlssond8575072022-03-30 10:30:25 +0200119 relu_ops = set(
120 (
121 Op.Relu,
122 Op.Relu6,
123 Op.ReluN1To1,
124 Op.Clip,
125 )
126 )
Fredrik Svedberg8ddd4892022-08-19 16:06:04 +0200127 activation_ops = relu_ops | set(
128 (
129 Op.Tanh,
130 Op.Sigmoid,
131 Op.Softmax,
132 Op.HardSwish,
Fredrik Svedberg1cd39492022-09-23 15:38:03 +0200133 Op.LeakyRelu,
Fredrik Svedberg8ddd4892022-08-19 16:06:04 +0200134 Op.Prelu,
135 )
136 )
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200137 npu_post_ops = (
138 # activation functions
139 activation_ops
140 # concatenation write direction
141 | set((Op.ConcatSliceWrite,))
142 # Quantization
143 | set((Op.Quantize,))
144 )
Jonas Ohlssond8575072022-03-30 10:30:25 +0200145 split_ops = set(
146 (
147 Op.Split,
148 Op.SplitV,
149 Op.StridedSlice,
150 Op.Slice,
151 Op.UnpackReshaped,
152 Op.Unpack,
153 )
154 )
155 concat_ops = set(
156 (
157 Op.Concat,
158 Op.ConcatTFLite,
159 Op.PackReshaped,
160 Op.Pack,
161 )
162 )
163 memory_only_ops = (
164 set(
165 (
166 Op.Reshape,
167 Op.QuantizedReshape,
168 Op.Squeeze,
169 Op.ExpandDims,
170 )
171 )
172 | concat_ops
173 | split_ops
174 )
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200175 per_axis_quant_ops = convolution_like_ops # per-axis/channel quantization only currently supported for conv ops
Jonas Ohlssond8575072022-03-30 10:30:25 +0200176 supported_fused_activations = relu_ops | set(
177 (
178 Op.Tanh,
179 Op.Sigmoid,
180 Op.LUT,
181 )
182 )
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200183 supported_operators = npu_pre_ops | mac_main_ops | elem_wise_main_ops | pad_ops | npu_post_ops | memory_only_ops
184 # Supported data types
185 supported_op_dtypes = set((DataType.uint8, DataType.int8, DataType.int16, DataType.int32))
186 supported_faf_dtypes = set((DataType.uint8, DataType.int8, DataType.int16))
187 supported_bias_dtypes = set((DataType.int32, DataType.int64))
188 supported_pad_dtypes = set((DataType.int32, DataType.int64))
189 # Defined ranges for allowed values:
190 tens_dim_range = (1, 65535)
191 stride_range = (1, 3)
192 dilation_range = (1, 2)
193 dilated_height_range = (1, 64)
194 dilated_product_range = (1, 64 * 64)
195 weights_limit = 127 * 65536
196 filter_range = (1, 8)
197 filter_height_range = (1, 256)
198 filter_product_range = (1, 256 * 256)
199 mean_kernel_product = 64 * 64
200 mean_kernel_product_int8 = 16 * 16
201 mean_kernel_product_avgpool = 256 * 256
202
203 def __init__(self):
204 # Setup the generic constraints. Note: the order matters
205 self.generic_constraints = []
206 self.generic_constraints.append(TFLiteSupportedOperators.constraint_tens_dtype)
207 self.generic_constraints.append(TFLiteSupportedOperators.constraint_tens_int32_ops)
208 self.generic_constraints.append(TFLiteSupportedOperators.constraint_tens_dimension)
209 self.generic_constraints.append(TFLiteSupportedOperators.constraint_tens_quant_per_axis)
Fredrik Svedberg88d5b122022-09-16 16:24:55 +0200210 self.generic_constraints.append(TFLiteSupportedOperators.constraint_batch_size)
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200211 self.generic_constraints.append(TFLiteSupportedOperators.constraint_faf)
212 self.generic_constraints.append(TFLiteSupportedOperators.constraint_faf_type)
213
Fredrik Svedberg88d5b122022-09-16 16:24:55 +0200214 # Setup generic constraint exceptions
215 self.generic_constraints_exceptions = defaultdict(list)
216 self.generic_constraints_exceptions[Op.FullyConnected].append(TFLiteSupportedOperators.constraint_batch_size)
217 self.generic_constraints_exceptions[Op.Softmax].append(TFLiteSupportedOperators.constraint_batch_size)
218 self.generic_constraints_exceptions[Op.Reshape].append(TFLiteSupportedOperators.constraint_batch_size)
219 self.generic_constraints_exceptions[Op.Shape].append(TFLiteSupportedOperators.constraint_batch_size)
220 self.generic_constraints_exceptions[Op.Squeeze].append(TFLiteSupportedOperators.constraint_batch_size)
221 for op_type in TFLiteSupportedOperators.split_ops - set((Op.UnpackReshaped,)):
222 self.generic_constraints_exceptions[op_type].append(TFLiteSupportedOperators.constraint_batch_size)
223
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200224 # Setup specific constraints. Note: the order matters
225 self.specific_constraints = defaultdict(list)
226
227 # Conv-like checks:
228 for op_type in TFLiteSupportedOperators.convolution_like_ops:
229 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_stride_range)
230 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_dilation_range)
231 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_dilated_height_range)
232 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_dilated_product_range)
233 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_weights_type)
234 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_weights_const)
235 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_weights_limit)
236 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_bias_type)
237 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_bias_40bit)
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200238 # Depthwise Conv specific checks:
239 for op_type in TFLiteSupportedOperators.depthwise_convolution_ops:
240 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_depth_multiplier)
241 # Transpose Conv specific checks:
242 for op_type in TFLiteSupportedOperators.transpose_convolution_ops:
243 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_tconv_stride)
244 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_tconv_same)
245 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_tconv_valid)
246
247 # Pooling checks:
248 for op_type in TFLiteSupportedOperators.pooling_ops:
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200249 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_stride_range)
250 # AVG pooling specific checks:
251 for op_type in TFLiteSupportedOperators.avg_pooling_ops:
252 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_filter_range)
253 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_filter_height_range_valid_pad)
254 self.specific_constraints[op_type].append(
255 TFLiteSupportedOperators.constraint_filter_product_range_valid_pad
256 )
257 # MAX pooling specific checks:
258 for op_type in TFLiteSupportedOperators.max_pooling_ops:
259 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_filter_height_range)
260 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_filter_product_range)
261
262 # Resizing specific checks:
263 for op_type in TFLiteSupportedOperators.resizing_ops:
Tim Hall885033b2022-07-21 11:46:03 +0100264 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_resize)
265 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_resize_size)
266 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_resize_attrs)
267 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_resize_half_pixel_centers)
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200268
Rickard Bolinfea15162022-07-04 16:19:16 +0000269 # Resize Bilinear specific checks:
270 self.specific_constraints[Op.ResizeBilinear].append(
271 TFLiteSupportedOperators.constraint_resizebi_half_pixel_centers_dims
272 )
273
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200274 # Vector Product specific checks:
275 for op_type in TFLiteSupportedOperators.fc_vector_products:
276 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_weights_type)
277 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_weights_const)
278 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_bias_type)
279 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_bias_40bit)
280
Fredrik Svedberg88d5b122022-09-16 16:24:55 +0200281 # Element-wise checks
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200282 # Binary Min/Max specific checks:
283 for op_type in TFLiteSupportedOperators.binary_elem_wise_min_max_ops:
284 self.specific_constraints[op_type].append(
285 TFLiteSupportedOperators.constraint_matching_quantization_parameters
286 )
287 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_broadcast_shapes)
288 # Binary Add/Mul/Sub specific checks:
289 for op_type in TFLiteSupportedOperators.binary_elem_wise_add_mul_sub:
290 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_broadcast_shapes)
291 # Binary Shift specific checks:
292 for op_type in TFLiteSupportedOperators.binary_elem_wise_shift_ops:
293 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_inputs_int32)
294 self.specific_constraints[op_type].append(TFLiteSupportedOperators.constraint_broadcast_shapes)
295
296 # SHL specific checks:
297 self.specific_constraints[Op.SHL].append(TFLiteSupportedOperators.constraint_output_int32)
298
299 # CLZ specific checks:
300 self.specific_constraints[Op.CLZ].append(TFLiteSupportedOperators.constraint_output_int32)
301
302 # StridedSlice specific checks:
303 self.specific_constraints[Op.StridedSlice].append(
304 TFLiteSupportedOperators.constraint_stridedslice_stride_values
305 )
306
307 # Pad specific checks:
308 self.specific_constraints[Op.Pad].append(TFLiteSupportedOperators.constraint_pad_shape)
309 self.specific_constraints[Op.Pad].append(TFLiteSupportedOperators.constraint_padding_dimensions)
310 self.specific_constraints[Op.Pad].append(TFLiteSupportedOperators.constraint_pad_type)
311
312 # Mean specific checks:
313 self.specific_constraints[Op.Mean].append(TFLiteSupportedOperators.constraint_mean_height_width_product_avgpool)
314 self.specific_constraints[Op.Mean].append(TFLiteSupportedOperators.constraint_mean_height_width_product)
315 self.specific_constraints[Op.Mean].append(TFLiteSupportedOperators.constraint_mean_height_width_product_int8)
James Peet0bb7ad12022-02-15 15:07:54 +0000316 self.specific_constraints[Op.Mean].append(TFLiteSupportedOperators.constraint_mean_height_single_axis)
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200317
Tim Hall3584a9c2021-11-18 22:05:17 +0000318 # Reshape specific checks:
319 self.specific_constraints[Op.Reshape].append(TFLiteSupportedOperators.constraint_reshape_shape_constant)
Johan Alfvén17009392022-08-30 09:14:56 +0200320 self.specific_constraints[Op.Reshape].append(TFLiteSupportedOperators.constraint_reshape_before_mean)
Tim Hall3584a9c2021-11-18 22:05:17 +0000321
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200322 def is_operator_supported(self, op):
323 ext_type = optype_to_builtintype(op.type)
324 if op.type not in TFLiteSupportedOperators.supported_operators:
325 if op.type not in (Op.Placeholder, Op.SubgraphInput, Op.Const):
326 print(f"Info: {ext_type} '{op.name}' is a CPU only op")
327 return False
328
Fredrik Svedberg88d5b122022-09-16 16:24:55 +0200329 op_exceptions = self.generic_constraints_exceptions[op.type]
330 generic_constraints = [constraint for constraint in self.generic_constraints if constraint not in op_exceptions]
331
332 for constraint in generic_constraints + self.specific_constraints[op.type]:
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200333 valid, extra = constraint(op)
334 if not valid:
335 print(f"Warning: {ext_type} '{op.name}' is not supported on the NPU. Placing on CPU instead")
336 print(f" - {constraint.__doc__}")
337 if extra:
338 print(f" {extra}")
339 return False
340
341 return True
342
343 @classmethod
344 @docstring_format_args([list_formatter(supported_op_dtypes)])
345 def constraint_tens_dtype(cls, op):
346 "Tensors must be of type: {}"
347 valid = True
348 extra = []
349 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
350 if not tensors:
351 tensors = [tens for tens in op.inputs if tens]
352 for tens in tensors:
353 if tens.dtype not in cls.supported_op_dtypes:
354 valid = False
355 extra.append(f"Tensor '{tens.name}' has data type: {tens.dtype}")
356 return valid, ", ".join(extra)
357
358 @classmethod
359 @docstring_format_args([_optype_formatter(supported_int32_tensor_ops)])
360 def constraint_tens_int32_ops(cls, op):
361 "Tensors which are int32 are only valid when op type is: {}"
362 valid = True
363 extra = []
364 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
365 if not tensors:
366 tensors = [tens for tens in op.inputs if tens]
367 for tens in tensors:
368 if (tens.dtype == DataType.int32) and (op.type not in cls.supported_int32_tensor_ops):
369 valid = False
370 extra.append(tens.name)
371 extra = ", ".join(extra)
372 return valid, f"Op has int32 tensor(s): {extra}"
373
374 @classmethod
375 @docstring_format_args(tens_dim_range)
376 def constraint_tens_dimension(cls, op):
377 "Tensor dimensions must be in the range [{}, {}]"
378 tens_min, tens_max = cls.tens_dim_range
379 valid = True
380 extra = []
381 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
382 if not tensors:
383 tensors = [tens for tens in op.inputs if tens]
384 for tens in tensors:
385 if not all(tens_min <= dim <= tens_max for dim in tens.shape):
386 valid = False
387 extra.append(f"Tensor '{tens.name}' has shape: {tens.shape}")
388 return valid, ", ".join(extra)
389
390 @classmethod
391 @docstring_format_args([_optype_formatter(per_axis_quant_ops)])
392 def constraint_tens_quant_per_axis(cls, op):
393 "Per-axis quantization is only supported for the following op types: {}"
394 valid = True
395 extra = []
396 if op.type not in cls.per_axis_quant_ops:
397 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
398 for tens in tensors:
Fredrik Svedberg11563172022-07-06 14:54:12 +0200399 if tens.quantization and tens.quantization.is_per_axis():
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200400 valid = False
401 extra.append(tens.name)
402 return valid, "The following tensor(s) have per-axis quantization parameters: " + ", ".join(extra)
403
404 @classmethod
405 @docstring_format_args([_optype_formatter(supported_fused_activations)])
406 def constraint_faf(cls, op):
407 "The fused activation function (if present) must be one of type: {}"
408 if op.activation is None:
409 res = True, "Op has no fused activation function"
410 else:
411 faf = op.activation.op_type
412 valid = faf in cls.supported_fused_activations
413 res = valid, f"Op has its fused activation function as: {faf}"
414 return res
415
416 @classmethod
417 @docstring_format_args([list_formatter(supported_faf_dtypes)])
418 def constraint_faf_type(cls, op):
419 "If a fused activation function is present, the Output tensor must be one of type: {}"
420 if op.activation is None:
421 res = True, "Op has no fused activation function"
422 else:
423 valid = op.ofm.dtype in cls.supported_faf_dtypes
424 ext_type = optype_to_builtintype(op.activation.op_type)
425 res = valid, f"Op has fused activation function {ext_type}, and Output tensor data type: {op.ofm.dtype}"
426 return res
427
428 @classmethod
429 @docstring_format_args(stride_range)
430 def constraint_stride_range(cls, op):
431 "Stride values for both width and height must be in the range [{}, {}]"
432 w, h = op.get_kernel_stride()
433 stride_min, stride_max = cls.stride_range
434 valid = (stride_min <= w <= stride_max) and (stride_min <= h <= stride_max)
435 return valid, f"Op has stride WxH as: {w}x{h}"
436
437 @classmethod
438 @docstring_format_args(dilation_range)
439 def constraint_dilation_range(cls, op):
440 "Dilation factor values for both width and height must be in the range [{}, {}]"
441 w, h = op.get_kernel_dilation()
442 dilation_min, dilation_max = cls.dilation_range
443 valid = (dilation_min <= w <= dilation_max) and (dilation_min <= h <= dilation_max)
444 return valid, f"Op has dilation factor WxH as: {w}x{h}"
445
446 @classmethod
447 @docstring_format_args(dilated_height_range)
448 def constraint_dilated_height_range(cls, op):
449 "Dilated kernel height must be in the range [{}, {}]"
450 h = op.kernel.area_height()
451 dilated_height_min, dilated_height_max = cls.dilated_height_range
452 valid = dilated_height_min <= h <= dilated_height_max
453 return valid, f"Op has dilated kernel height as: {h}"
454
455 @classmethod
456 @docstring_format_args(dilated_product_range)
457 def constraint_dilated_product_range(cls, op):
458 "Product of dilated kernel width and height must be in the range [{}, {}]"
459 product = op.kernel.area_width() * op.kernel.area_height()
460 dilated_product_min, dilated_product_max = cls.dilated_product_range
461 valid = dilated_product_min <= product <= dilated_product_max
462 return valid, f"Op has product of dilated kernel width and height as: {product}"
463
464 @staticmethod
465 def constraint_weights_type(op):
466 "Weight tensor must be 8-bit"
467 weights = op.weights
468 valid = weights.element_size() == 1
469 return valid, f"Tensor '{weights.name}' is {int(weights.element_size() * 8)}-bit"
470
471 @staticmethod
472 def constraint_weights_const(op):
473 "Weight tensor must be constant"
474 weights = op.weights
475 valid = weights.values is not None
476 return valid, f"Tensor '{weights.name}' has non-constant values"
477
478 @classmethod
479 @docstring_format_args([weights_limit])
480 def constraint_weights_limit(cls, op):
481 "The sum of the weights cannot exceed {}"
482 weights = op.weights
483 values = weights.values.astype(np.int64) - weights.quantization.zero_point
484 limit = np.amax(np.sum(np.absolute(values), axis=(0, 1, 2)))
485 valid = limit <= cls.weights_limit
486 return valid, f"Tensor '{weights.name}' has the sum of weights: {limit}"
487
488 @classmethod
489 @docstring_format_args([list_formatter(supported_bias_dtypes)])
490 def constraint_bias_type(cls, op):
491 "Optional Bias tensor must be of type: {}"
492 bias = op.bias
493 if bias:
494 valid = bias.dtype in cls.supported_bias_dtypes
495 return valid, f"Tensor '{bias.name}' has data type: {bias.dtype}"
496 return True, "Op has no bias tensor"
497
498 @staticmethod
499 def constraint_bias_40bit(op):
500 "Optional Bias tensor values must fit within 40-bits"
501 bias = op.bias
502 if bias and bias.dtype == DataType.int64 and bias.values is not None:
Tim Hall8ae29292021-07-28 16:52:03 +0100503 valid = all(len(bin(value)[2:]) <= 40 for value in bias.values)
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200504 return valid, f"Tensor '{bias.name}' has values larger than 40-bits"
505 return True, "Op has no bias tensor, or it fits in 40-bit"
506
507 @staticmethod
508 def constraint_batch_size(op):
509 "IFM Tensor batch size must be 1"
Fredrik Svedberg88d5b122022-09-16 16:24:55 +0200510 valid = True
511 extra = []
512 for tens in (op.ifm, op.ifm2):
513 if tens is not None:
514 batch_size = full_shape(4, tens.shape, 1)[0]
515 if batch_size != 1:
516 valid = False
517 extra.append(f"Tensor '{tens.name}' has batch size: {batch_size}")
518 extra = "\n ".join(extra)
519 return valid, extra
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200520
521 @staticmethod
522 def constraint_depth_multiplier(op):
523 "For depth multipliers > 1, IFM channels must be 1 and OFM channels must be equal to the depth multiplier"
524 depth_multiplier = op.attrs.get("depth_multiplier", 1)
525 if depth_multiplier > 1:
526 ifm_channels = op.ifm.shape[3]
527 ofm_channels = op.ofm.shape[3]
528 valid = (ifm_channels == 1) and (ofm_channels == depth_multiplier)
529 extra = (
530 f"Op has ifm_channels={ifm_channels}, ofm_channels={ofm_channels}"
531 f" and depth_multiplier={depth_multiplier}"
532 )
533 return valid, extra
534 return True, "Op has depth_multiplier=1"
535
536 @staticmethod
537 def constraint_tconv_stride(op):
538 "Stride values for both width and height must be 2"
539 w = op.kernel.stride.x
540 h = op.kernel.stride.y
541 valid = (w == 2) and (h == 2)
542 return valid, f"Op has stride WxH as: {w}x{h}"
543
544 @staticmethod
545 def constraint_tconv_same(op):
546 "SAME padding: OFM dimensions must equal IFM dimensions multiplied by stride"
547 if op.attrs["padding"] == Padding.SAME:
548 w = op.kernel.stride.x
549 h = op.kernel.stride.y
550 ifm_shape = op.ifm.shape
551 ofm_shape = op.ofm.shape
552 valid = (ofm_shape[1] == (ifm_shape[1] * h)) and (ofm_shape[2] == (ifm_shape[2] * w))
553 return valid, f"Op has ifm_shape={ifm_shape}, ofm_shape={ofm_shape} and stride WxH as {w}x{h}"
554 return True, "Op has padding=VALID"
555
556 @staticmethod
557 def constraint_tconv_valid(op):
558 """VALID padding: OFM dimensions must equal IFM dimensions multiplied by stride,
Jonas Ohlssond8575072022-03-30 10:30:25 +0200559 minus difference between kernel size and stride"""
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200560 if op.attrs["padding"] == Padding.VALID:
561 s_w = op.kernel.stride.x
562 s_h = op.kernel.stride.y
563 k_w = op.kernel.width
564 k_h = op.kernel.height
565 ifm_shape = op.ifm.shape
566 ofm_shape = op.ofm.shape
567 height_check = ofm_shape[1] == (ifm_shape[1] * s_h + max(k_h - s_h, 0))
568 width_check = ofm_shape[2] == (ifm_shape[2] * s_w + max(k_w - s_w, 0))
569 valid = height_check and width_check
570 extra = (
571 f"Op has ifm_shape={ifm_shape}, ofm_shape={ofm_shape},"
572 f" stride WxH as {s_w}x{s_h} and kernel WxH as {k_w}x{k_h}"
573 )
574 return valid, extra
575 return True, "Op has padding=SAME"
576
577 @classmethod
578 @docstring_format_args(filter_range)
579 def constraint_filter_range(cls, op):
580 "Kernel filter values for both width and height must be in the range [{}, {}]"
581 if op.attrs["padding"] == Padding.SAME:
582 w = op.kernel.width
583 h = op.kernel.height
584 filter_min, filter_max = cls.filter_range
585 valid = (filter_min <= w <= filter_max) and (filter_min <= h <= filter_max)
586 return valid, f"Op has kernel filter WxH as: {w}x{h}"
587 return True, "Op has padding=VALID"
588
589 @classmethod
590 @docstring_format_args(filter_height_range)
591 def constraint_filter_height_range(cls, op):
592 "Kernel filter height must be in the range [{}, {}]"
593 h = op.kernel.height
594 filter_height_min, filter_height_max = cls.filter_height_range
595 valid = filter_height_min <= h <= filter_height_max
596 return valid, f"Op has kernel filter height as: {h}"
597
598 @classmethod
599 @docstring_format_args(filter_product_range)
600 def constraint_filter_product_range(cls, op):
601 "Product of kernel filter width and height must be in the range [{}, {}]"
602 product = op.kernel.elements_wh()
603 filter_product_min, filter_product_max = cls.filter_product_range
604 valid = filter_product_min <= product <= filter_product_max
605 return valid, f"Op has product of kernel filter width and height as: {product}"
606
607 @staticmethod
608 @docstring_format_args(filter_height_range)
609 def constraint_filter_height_range_valid_pad(op):
610 "VALID padding: Kernel filter height must be in the range [{}, {}]"
611 if op.attrs["padding"] == Padding.VALID:
612 return TFLiteSupportedOperators.constraint_filter_height_range(op)
613 return True, "Op has padding=SAME"
614
615 @staticmethod
616 @docstring_format_args(filter_product_range)
617 def constraint_filter_product_range_valid_pad(op):
618 "VALID padding: Product of kernel filter width and height must be in the range [{}, {}]"
619 if op.attrs["padding"] == Padding.VALID:
620 return TFLiteSupportedOperators.constraint_filter_product_range(op)
621 return True, "Op has padding=SAME"
622
623 @staticmethod
Tim Hall885033b2022-07-21 11:46:03 +0100624 def constraint_resize(op):
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200625 """The width and height of the IFM and OFM must match one of the following criteria:
626 IFM W and H must both be 1
627 IFM must match OFM
Rickard Bolinfea15162022-07-04 16:19:16 +0000628 W and H scaling must be equal and OFM W-1 and H-1 must be 2x/4x/8x IFM W-1 and H-1, if align_corners is True
629 W and H scaling must be equal and OFM W and H must be 2x/4x/8x IFM W and H, if align_corners is False"""
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200630 # Easier to start with False condition as very few cases result in a supported resize
631 valid = False
632 ifm_shape = op.ifm.shape
Tim Hall47c76362022-07-18 21:26:47 +0100633 ifm_shape_h = ifm_shape[1]
634 ifm_shape_w = ifm_shape[2]
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200635 ofm_shape = op.ofm.shape
Tim Hall47c76362022-07-18 21:26:47 +0100636 ofm_shape_h = ofm_shape[1]
637 ofm_shape_w = ofm_shape[2]
638
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200639 align_corners = op.attrs.get("align_corners", False)
640 if len(ifm_shape) == 4:
641 # Valid if IFM W and H are both 1, or IFM and OFM shape are the same
Tim Hall47c76362022-07-18 21:26:47 +0100642 if ((ifm_shape_h == 1) and (ifm_shape_w == 1)) or (ifm_shape == ofm_shape):
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200643 valid = True
644 else:
Rickard Boline546def2022-01-25 15:45:00 +0000645 # Valid if OFM is 2/4/8x IFM (-1 for align corners)
Tim Hall47c76362022-07-18 21:26:47 +0100646 if align_corners:
647 h_upscale_factor = (ofm_shape_h - 1) / (ifm_shape_h - 1)
648 w_upscale_factor = (ofm_shape_w - 1) / (ifm_shape_w - 1)
649 else:
650 h_upscale_factor = ofm_shape_h / ifm_shape_h
651 w_upscale_factor = ofm_shape_w / ifm_shape_w
Rickard Boline546def2022-01-25 15:45:00 +0000652
Tim Hall47c76362022-07-18 21:26:47 +0100653 # could use either height or width. save as int because it is more usable later in graph optimiser
654 op.attrs["upscale_factor"] = int(h_upscale_factor)
655 valid = h_upscale_factor == w_upscale_factor and h_upscale_factor in (2.0, 4.0, 8.0)
Rickard Boline546def2022-01-25 15:45:00 +0000656
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200657 return valid, f"Op has ifm_shape={ifm_shape}, ofm_shape={ofm_shape} and align_corners={align_corners}"
658
659 @staticmethod
Tim Hall885033b2022-07-21 11:46:03 +0100660 def constraint_resize_size(op):
Tim Hall47c76362022-07-18 21:26:47 +0100661 "The size tensor must match the output tensor shape"
662 valid = False
663 ofm_shape = op.ofm.shape
664 size_h, size_w = None, None
665 # check that the size tensor (the second input) exists, is not none, and has the correct values
666 if len(op.inputs) == 2 and op.inputs[1] is not None and len(op.inputs[1].values) == 2:
667 size_h, size_w = op.inputs[1].values
668 # check size and output size match
669 if size_h == ofm_shape[1] and size_w == ofm_shape[2]:
670 valid = True
671
672 return valid, f"Op has size={size_h}x{size_w} and ofm_shape={ofm_shape}."
673
674 @staticmethod
Tim Hall885033b2022-07-21 11:46:03 +0100675 def constraint_resize_attrs(op):
Tim Hall47c76362022-07-18 21:26:47 +0100676 "Both align_corners and half_pixel_centers can't be True"
677 valid = True
678 align_corners = op.attrs.get("align_corners", False)
679 half_pixel_centers = op.attrs.get("half_pixel_centers", False)
680
681 if align_corners and half_pixel_centers:
682 valid = False
683 return valid, "Op has both align_corners and half_pixel_centers set to True."
684
685 @staticmethod
Tim Hall885033b2022-07-21 11:46:03 +0100686 def constraint_resize_half_pixel_centers(op):
Rickard Bolin017b4cc2022-09-23 10:16:48 +0000687 """Half_pixel_centers are only supported for resize bilinear"""
688 valid = True
Rickard Bolinfea15162022-07-04 16:19:16 +0000689 half_pixel_centers = op.attrs.get("half_pixel_centers", False)
690 if half_pixel_centers and op.type != Op.ResizeBilinear:
erik.andersson@arm.comba2555e2021-10-28 14:08:52 +0200691 valid = False
Rickard Bolin017b4cc2022-09-23 10:16:48 +0000692 return valid, f"Op type={op.type} and half_pixel_centers={half_pixel_centers}"
Rickard Bolinfea15162022-07-04 16:19:16 +0000693
694 @staticmethod
695 def constraint_resizebi_half_pixel_centers_dims(op):
696 """Half_pixel_centers for resize bilinear requires that OFM W and H is 2x IFM W and H"""
697 half_pixel_centers = op.attrs.get("half_pixel_centers", False)
698 if not half_pixel_centers:
699 valid = True
700 elif len(op.ifm.shape) >= 3:
701 ifm_h, ifm_w = op.ifm.shape[-3:-1]
702 ofm_h, ofm_w = op.ofm.shape[-3:-1]
703 valid = ofm_h / ifm_h == 2 and ofm_w / ifm_w == 2
704 else:
705 # Unexpected IFM shape
706 valid = False
707 return (
708 valid,
709 f"Op has ifm_shape={op.ifm.shape}, ofm_shape={op.ofm.shape} and half_pixel_centers={half_pixel_centers}",
710 )
erik.andersson@arm.comba2555e2021-10-28 14:08:52 +0200711
712 @staticmethod
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200713 def constraint_pad_shape(op):
714 "The padding tensor must have the shape [3,2] or [4,2]"
715 valid = op.inputs[1].shape in ([3, 2], [4, 2])
716 return valid, f"The pad tensor has the shape: {op.inputs[1].shape}"
717
718 @classmethod
719 @docstring_format_args([list_formatter(supported_pad_dtypes)])
720 def constraint_pad_type(cls, op):
721 "Pad tensor must be of type: {}"
722 pad_tensor = op.inputs[1]
723 valid = pad_tensor.dtype in cls.supported_pad_dtypes
724 return valid, f"Tensor '{pad_tensor.name}' has data type: {pad_tensor.dtype}"
725
726 @staticmethod
727 def constraint_padding_dimensions(op):
728 "The pad tensor can only pad width and height"
729 pad_tensor = op.inputs[1].values
730
731 valid = sum(pad_tensor[-1, :]) == 0
732 if valid and len(pad_tensor) > 3:
733 valid = sum(pad_tensor[0, :]) == 0
734 return valid, f"First dimension padding: {pad_tensor[0,:]}, last dimension padding: {pad_tensor[-1,:]}"
735
736 @staticmethod
737 def constraint_stridedslice_stride_values(op):
738 "All Strides values must be 1"
739 strides = op.inputs[3]
740 valid = all(stride == 1 for stride in strides.values)
741 return valid, f"Op has strides values {strides.values}"
742
743 @staticmethod
744 def constraint_inputs_int32(op):
745 "Both Input data types must be int32"
746 ifm_dtype = op.ifm.dtype
747 ifm2_dtype = op.ifm2.dtype
748 valid = (ifm_dtype == DataType.int32) and (ifm2_dtype == DataType.int32)
749 return valid, f"Op has ifm_dtype={ifm_dtype} and ifm2_dtype={ifm2_dtype}"
750
751 @staticmethod
752 def constraint_output_int32(op):
753 "OFM must be int32"
754 ofm_dtype = op.ofm.dtype
755 valid = ofm_dtype == DataType.int32
756 return valid, f"Op has ofm_dtype={ofm_dtype}"
757
758 @staticmethod
759 def constraint_matching_quantization_parameters(op):
760 "Both Input quantization parameters must match OFM quantization parameters"
761 valid = True
762 extra = []
763 if not check_quantized_tens_scaling_equal(op.ofm, op.ifm):
764 valid = False
765 extra.append(op.ifm.name)
766 if op.ifm2 is not None and not check_quantized_tens_scaling_equal(op.ofm, op.ifm2):
767 valid = False
768 extra.append(op.ifm2.name)
769 extra = ", ".join(extra)
770 return valid, f"Op has tensors with different quantization parameters to the OFM '{op.ofm.name}': {extra}"
771
772 @staticmethod
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200773 def constraint_broadcast_shapes(op):
774 "Broadcasting is only allowed for rank indices with dimension 1, from either IFM1 or IFM2"
775 ifm_shape = op.ifm.shape
776 ifm2_shape = op.ifm2.shape if op.ifm2 else None
777 ofm_shape = op.ofm.shape
778 valid = True
779 if ifm_shape is not None and ifm2_shape is not None:
780 # align trailing dimensions
781 size = min(len(ifm_shape), len(ifm2_shape))
782 for i, i2, o in zip(ifm_shape[-size:], ifm2_shape[-size:], ofm_shape[-size:]):
783 mi = max(i, i2)
784 # Input dimensions should match or one should be of dimension 1
785 # Output dimension should match the largest input dimension, together
786 # with constraint_match_either_shapes ensures broadcast from only one input
787 if not (i == i2 or i == 1 or i2 == 1) or o != mi:
788 valid = False
789 break
790
791 return valid, f"Op has ifm_shape={ifm_shape} and ifm2_shape={ifm2_shape}"
792
793 @classmethod
794 @docstring_format_args([mean_kernel_product_avgpool])
795 def constraint_mean_height_width_product_avgpool(cls, op):
James Peet0bb7ad12022-02-15 15:07:54 +0000796 """Product of height and width must be no greater than {}"""
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200797 shape = op.inputs[0].shape
798 hi = 0 if len(shape) < 4 else 1
799 h, w = shape[hi : hi + 2]
800 max_prod = cls.mean_kernel_product_avgpool
801 return h * w <= max_prod, f"Product of height and width is {h * w}"
802
803 @classmethod
804 @docstring_format_args([mean_kernel_product])
805 def constraint_mean_height_width_product(cls, op):
James Peet0bb7ad12022-02-15 15:07:54 +0000806 """Product of height and width must be no greater than {} when:
807 IFM and OFM have different scale or zero point; or
808 'keep_dims' is True"""
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200809 ifmq, ofmq = op.ifm.quantization, op.ofm.quantization
810 keep_dims = op.attrs.get("keep_dims")
811 # doesn't apply, size is checked by constraint_mean_height_width_product_avgpool
812 if not keep_dims and ifmq.scale_f32 == ofmq.scale_f32 and ifmq.zero_point == ofmq.zero_point:
813 return True, ""
814 shape = op.inputs[0].shape
815 hi = 0 if len(shape) < 4 else 1
816 h, w = shape[hi : hi + 2]
817 max_prod = cls.mean_kernel_product
818 return h * w <= max_prod, f"Product of height and width is {h * w}"
819
Johan Alfvén05916632022-09-06 20:33:22 +0200820 @classmethod
821 @docstring_format_args([mean_kernel_product_int8])
822 def constraint_mean_height_width_product_int8(cls, op):
823 """Product of IFM height and width must be no greater than {} when:
James Peet0bb7ad12022-02-15 15:07:54 +0000824 The IFM shape has 4 dimensions; and
825 The axis indices specify reduction across 2 dimensions; and
826 The axis indices correspond to the width and height dimensions of the IFM; and
827 'keep_dims' is True; and
Jonas Ohlsson45e653d2021-07-26 16:13:12 +0200828 IFM datatype is int8"""
829 shape = op.ifm.shape
830 axis = int(op.inputs[1].values) if op.inputs[1].shape == [] else list(op.inputs[1].values)
831 # doesn't apply, size is checked by constraint_mean_height_width_product_avgpool
832 # and constraint_mean_height_width_product
833 if (
834 len(shape) != 4
835 or op.ifm.dtype != DataType.int8
836 or not op.attrs.get("keep_dims")
837 or axis not in ([1, 2], [2, 1])
838 ):
839 return True, ""
James Peet0bb7ad12022-02-15 15:07:54 +0000840 h = shape[-3]
841 w = shape[-2]
Johan Alfvén05916632022-09-06 20:33:22 +0200842 max_prod = cls.mean_kernel_product_int8
843 return h * w <= max_prod, f"Product of height and width is {h * w}"
Tim Hall3584a9c2021-11-18 22:05:17 +0000844
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000845 @classmethod
James Peet0bb7ad12022-02-15 15:07:54 +0000846 @docstring_format_args([filter_height_range[1], dilated_height_range[1]])
847 def constraint_mean_height_single_axis(cls, op):
848 """For single axis averages across the height dimension:
849 IFM height must be no greater than {} if the IFM and OFM scale and zero point match; otherwise
850 IFM height must be no greater than {} if the IFM and OFM scale or zero point do not match"""
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000851 inp, axis = op.inputs
852 if axis.shape == [] or axis.shape[0] == 1: # single axis
853 axis = int(axis.values) if len(axis.shape) == 0 else int(axis.values[0])
854 else:
James Peet0bb7ad12022-02-15 15:07:54 +0000855 # Multiple axes
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000856 return True, ""
857
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000858 shape = inp.shape
James Peet0bb7ad12022-02-15 15:07:54 +0000859 if len(shape) < 3:
860 # No height dimension present in IFM
861 return True, ""
862 if axis != len(shape) - 3:
863 # Not averaging across the height dimension
864 return True, ""
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000865
James Peet0bb7ad12022-02-15 15:07:54 +0000866 h = shape[axis]
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000867 ifm, ofm = op.get_ifm_ofm()
James Peet0bb7ad12022-02-15 15:07:54 +0000868
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000869 if check_quantized_tens_scaling_equal(ifm, ofm):
James Peet0bb7ad12022-02-15 15:07:54 +0000870 return h <= cls.filter_height_range[1], f"Height is {h}, IFM and OFM quantizations match"
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000871 else:
James Peet0bb7ad12022-02-15 15:07:54 +0000872 return h <= cls.dilated_height_range[1], f"Height is {h}, IFM and OFM quantizations do not match"
Rickard Bolin7d7cb672021-12-07 09:09:14 +0000873
Tim Hall3584a9c2021-11-18 22:05:17 +0000874 @staticmethod
875 def constraint_reshape_shape_constant(op):
876 "Shape must be constant"
877 valid = True
878 extra = []
879
880 reshape_tens = op.inputs[1]
881 if reshape_tens is not None:
882 # constant inputs have either no driving operator or a const one
883 # create a list of non-constant inputs
884 if not (len(reshape_tens.ops) == 0 or reshape_tens.ops[0].type == Op.Const):
885 valid = False
886 extra.append(reshape_tens.name)
887 extra = ", ".join(extra)
888
889 return valid, f"Op has non-const input(s): {extra}"
Johan Alfvén8e1352a2022-08-16 13:04:17 +0200890
891 @staticmethod
Johan Alfvén17009392022-08-30 09:14:56 +0200892 def constraint_reshape_before_mean(op):
893 "Reshape on NPU not supported before MEAN operator"
894 for next_op in op.outputs[0].consumers():
895 if next_op is not None and next_op.type == Op.Mean:
896 return False, ""
897 return True, ""