blob: 5bf2c45980b8fcd5d366514d64205b3627df19ab [file] [log] [blame]
Louis Verhaardebf4af62021-01-27 15:57:57 +01001# Copyright (C) 2020-2021 Arm Limited or its affiliates. All rights reserved.
Tim Hall79d07d22020-04-27 18:20:16 +01002#
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.
Tim Hall79d07d22020-04-27 18:20:16 +010016# Description:
17# The SupportedOperators class which is a collection of all supported operators and parameter checks.
Michael McGeagh1f951fc2020-10-14 09:30:02 +010018from collections import defaultdict
19
Charles Xu87c13502020-08-06 12:17:26 +020020import numpy as np
21
Tim Hallc30f4952020-06-15 20:47:35 +010022from .data_type import BaseType
23from .data_type import DataType
Dwight Lidman8359a472020-09-28 15:53:40 +020024from .numeric_util import is_integer
Louis Verhaardfa2f92a2020-09-21 11:56:18 +020025from .operation import get_slice_offsets
Louis Verhaardaee5d752020-09-30 09:01:52 +020026from .operation import Op
Michael McGeagh16895482020-12-14 15:51:20 +000027from .operation import Padding
Tim Hall93582962020-09-09 21:58:15 +010028from .tensor import check_quantized_tens_scaling_equal
Michael McGeagh837dc1b2020-11-10 12:38:25 +000029from .tflite_mapping import BUILTIN_OPERATOR_UNKNOWN
Michael McGeagh219ec072020-11-09 11:11:26 +000030from .tflite_mapping import optype_to_builtintype
Louis Verhaardfa2f92a2020-09-21 11:56:18 +020031
32
Michael McGeagh37ded342020-10-01 15:37:44 +010033# Custom decorator function to allow formatting docstrings containing "{}"
34def docstring_format_args(args):
35 def docstring(func):
36 func.__doc__ = func.__doc__.format(*args)
37 return func
38
39 return docstring
40
41
Michael McGeagh34d29172020-11-25 12:36:23 +000042def _list_formatter(arg):
43 # Order and join into a string representation
44 return ", ".join(sorted(map(str, arg)))
45
46
Michael McGeagh837dc1b2020-11-10 12:38:25 +000047def _optype_formatter(op_list):
48 # Convert internal op types to external names
49 output = map(optype_to_builtintype, op_list)
50 # Remove UNKNOWNs
51 output = (x for x in output if x is not BUILTIN_OPERATOR_UNKNOWN)
Michael McGeagh34d29172020-11-25 12:36:23 +000052 return _list_formatter(output)
Michael McGeagh837dc1b2020-11-10 12:38:25 +000053
54
Tim Hall79d07d22020-04-27 18:20:16 +010055class SupportedOperators:
Michael McGeagh1eeea512020-09-30 14:23:09 +010056 # Categorised lists of supported operators
Louis Verhaardaee5d752020-09-30 09:01:52 +020057 npu_pre_ops = set((Op.SplitSliceRead,))
58 convolution_ops = set((Op.Conv2DBias, Op.Conv2D, Op.QuantizedConv2D,))
59 depthwise_convolution_ops = set((Op.DepthwiseConv2DBias,))
60 transpose_convolution_ops = set((Op.Conv2DBackpropInput,))
Michael McGeagh1f951fc2020-10-14 09:30:02 +010061 convolution_like_ops = convolution_ops | depthwise_convolution_ops | transpose_convolution_ops
Louis Verhaardaee5d752020-09-30 09:01:52 +020062 max_pooling_ops = Op.op_set(Op.is_maxpool_op)
63 avg_pooling_ops = Op.op_set(Op.is_avgpool_op)
64 pooling_ops = set((Op.ReduceSum,)) | max_pooling_ops | avg_pooling_ops
65 resizing_ops = set((Op.ResizeBilinear,))
66 fc_vector_products = set((Op.QuantizedMatMul, Op.MatMul, Op.FullyConnected,))
Michael McGeagh1eeea512020-09-30 14:23:09 +010067 mac_main_ops = (
68 # RNN/LSTM/GRU
Louis Verhaardaee5d752020-09-30 09:01:52 +020069 set((Op.BlockLSTM,))
Michael McGeagh1f951fc2020-10-14 09:30:02 +010070 # conv/depthwiseconv/transposeconv
71 | convolution_like_ops
Michael McGeagh1eeea512020-09-30 14:23:09 +010072 # pooling
73 | pooling_ops
74 # resizing/upscaling
75 | resizing_ops
76 # FC layers
77 | fc_vector_products
Dwight Lidman4f728c02020-12-17 15:14:45 +010078 # Mean (converts to depthwise conv)
79 | set((Op.Mean,))
Michael McGeagh1eeea512020-09-30 14:23:09 +010080 )
Louis Verhaardaee5d752020-09-30 09:01:52 +020081 unary_elem_wise_main_ops = Op.op_set(Op.is_unary_elementwise_op)
82 binary_elem_wise_min_max_ops = set((Op.Minimum, Op.Maximum,))
83 binary_elem_wise_shift_ops = set((Op.SHL, Op.SHR,))
84 binary_elem_wise_add_mul_sub = set((Op.Add, Op.Mul, Op.Sub,))
Michael McGeagh1eeea512020-09-30 14:23:09 +010085 binary_elem_wise_main_ops = binary_elem_wise_min_max_ops | binary_elem_wise_add_mul_sub | binary_elem_wise_shift_ops
86 elem_wise_main_ops = binary_elem_wise_main_ops | unary_elem_wise_main_ops
Erik Anderssonf27a8b62020-12-10 14:58:23 +010087 pad_ops = set((Op.Pad,))
Michael McGeagh37ded342020-10-01 15:37:44 +010088 supported_int32_tensor_ops = (
Louis Verhaardaee5d752020-09-30 09:01:52 +020089 set((Op.ReduceSum, Op.CLZ,)) | binary_elem_wise_add_mul_sub | binary_elem_wise_shift_ops
Michael McGeagh37ded342020-10-01 15:37:44 +010090 )
Michael McGeagh65fd9982020-10-20 11:49:28 +010091 relu_ops = Op.op_set(Op.is_relu_op)
Diqing Zhong189f7482021-01-26 12:12:51 +010092 activation_ops = relu_ops | set((Op.Tanh, Op.Sigmoid, Op.Softmax, Op.HardSwish))
Michael McGeagh1eeea512020-09-30 14:23:09 +010093 npu_post_ops = (
Michael McGeagh1eeea512020-09-30 14:23:09 +010094 # activation functions
Louis Verhaardaee5d752020-09-30 09:01:52 +020095 activation_ops
96 # concatenation write direction
97 | set((Op.ConcatSliceWrite,))
98 # Quantization
99 | set((Op.Quantize,))
Michael McGeagh1eeea512020-09-30 14:23:09 +0100100 )
Louis Verhaardaee5d752020-09-30 09:01:52 +0200101 split_ops = set((Op.Split, Op.SplitV, Op.StridedSlice, Op.Slice, Op.UnpackReshaped, Op.Unpack,))
102 concat_ops = set((Op.Concat, Op.ConcatTFLite, Op.PackReshaped, Op.Pack,))
Louis Verhaard3d22f3c2021-02-03 08:43:54 +0100103 memory_only_ops = set((Op.Reshape, Op.QuantizedReshape,)) | concat_ops | split_ops
Dwight Lidman4f728c02020-12-17 15:14:45 +0100104 shapeless_input_ops = binary_elem_wise_main_ops | set((Op.Split, Op.SplitV, Op.Mean))
Dwight Lidmanc7187432020-11-16 17:40:46 +0100105 per_axis_quant_ops = convolution_like_ops # per-axis/channel quantization only currently supported for conv ops
Michael McGeagh65fd9982020-10-20 11:49:28 +0100106 supported_fused_activations = relu_ops | set((Op.Tanh, Op.Sigmoid, Op.LUT,))
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100107 supported_operators = npu_pre_ops | mac_main_ops | elem_wise_main_ops | pad_ops | npu_post_ops | memory_only_ops
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100108 # Supported data types
109 supported_op_dtypes = set((DataType.uint8, DataType.int8, DataType.int16, DataType.int32))
Louis Verhaardc7761512021-02-03 10:22:38 +0100110 supported_faf_dtypes = set((DataType.uint8, DataType.int8, DataType.int16))
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100111 supported_bias_dtypes = set((DataType.int32, DataType.int64))
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100112 supported_pad_dtypes = set((DataType.int32, DataType.int64))
Michael McGeagh37ded342020-10-01 15:37:44 +0100113 # Defined ranges for allowed values:
114 tens_dim_range = (1, 65535)
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100115 stride_range = (1, 3)
116 dilation_range = (1, 2)
117 dilated_height_range = (1, 64)
118 dilated_product_range = (1, 64 * 64)
119 weights_limit = 127 * 65536
Michael McGeagh65fd9982020-10-20 11:49:28 +0100120 filter_range = (1, 8)
121 filter_height_range = (1, 256)
122 filter_product_range = (1, 256 * 256)
Dwight Lidman4f728c02020-12-17 15:14:45 +0100123 mean_kernel_product = 64 * 64
124 mean_kernel_product_int8 = 16 * 16
Dwight Lidman95b279f2021-03-26 10:53:28 +0100125 mean_kernel_product_avgpool = 256 * 256
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100126 # Supported consumers
Louis Verhaard1a92f782021-02-09 16:08:26 +0100127 supported_pad_consumers = convolution_ops | depthwise_convolution_ops | pooling_ops
Michael McGeagh1eeea512020-09-30 14:23:09 +0100128
Fredrik Svedberg880e7352020-08-25 11:31:47 +0200129 def __init__(self):
Michael McGeagh184b2502020-10-09 17:19:52 +0100130 # Setup the generic constraints. Note: the order matters
Michael McGeagh37ded342020-10-01 15:37:44 +0100131 self.generic_constraints = []
Michael McGeagh65fd9982020-10-20 11:49:28 +0100132 self.generic_constraints.append(SupportedOperators.constraint_tens_no_dynamic)
Michael McGeagh37ded342020-10-01 15:37:44 +0100133 self.generic_constraints.append(SupportedOperators.constraint_tens_defined_shape)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100134 self.generic_constraints.append(SupportedOperators.constraint_tens_output_scalar)
135 self.generic_constraints.append(SupportedOperators.constraint_tens_input_scalar)
Michael McGeagh37ded342020-10-01 15:37:44 +0100136 self.generic_constraints.append(SupportedOperators.constraint_tens_shape_size)
137 self.generic_constraints.append(SupportedOperators.constraint_tens_dtype)
Michael McGeagh184b2502020-10-09 17:19:52 +0100138 self.generic_constraints.append(SupportedOperators.constraint_tens_int32_ops)
Michael McGeagh37ded342020-10-01 15:37:44 +0100139 self.generic_constraints.append(SupportedOperators.constraint_tens_dimension)
Dwight Lidman8359a472020-09-28 15:53:40 +0200140 self.generic_constraints.append(SupportedOperators.constraint_tens_quant_none_check)
Michael McGeagh184b2502020-10-09 17:19:52 +0100141 self.generic_constraints.append(SupportedOperators.constraint_tens_quant_scale)
Dwight Lidmanc7187432020-11-16 17:40:46 +0100142 self.generic_constraints.append(SupportedOperators.constraint_tens_quant_per_axis)
Michael McGeagh184b2502020-10-09 17:19:52 +0100143 self.generic_constraints.append(SupportedOperators.constraint_faf)
Louis Verhaardc7761512021-02-03 10:22:38 +0100144 self.generic_constraints.append(SupportedOperators.constraint_faf_type)
Louis Verhaard9a0cff12021-01-08 11:17:33 +0100145 self.generic_constraints.append(SupportedOperators.constraint_quant_scale_inf)
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100146
Michael McGeagh65fd9982020-10-20 11:49:28 +0100147 # Setup specific constraints. Note: the order matters
148 self.specific_constraints = defaultdict(list)
149
150 # Conv-like checks:
151 for op_type in SupportedOperators.convolution_like_ops:
152 self.specific_constraints[op_type].append(SupportedOperators.constraint_stride_type)
153 self.specific_constraints[op_type].append(SupportedOperators.constraint_stride_range)
154 self.specific_constraints[op_type].append(SupportedOperators.constraint_dilation_type)
155 self.specific_constraints[op_type].append(SupportedOperators.constraint_dilation_range)
156 self.specific_constraints[op_type].append(SupportedOperators.constraint_dilated_height_range)
157 self.specific_constraints[op_type].append(SupportedOperators.constraint_dilated_product_range)
158 self.specific_constraints[op_type].append(SupportedOperators.constraint_weights_type)
159 self.specific_constraints[op_type].append(SupportedOperators.constraint_weights_const)
160 self.specific_constraints[op_type].append(SupportedOperators.constraint_weights_limit)
161 self.specific_constraints[op_type].append(SupportedOperators.constraint_bias_type)
162 self.specific_constraints[op_type].append(SupportedOperators.constraint_bias_40bit)
163 self.specific_constraints[op_type].append(SupportedOperators.constraint_batch_size)
164 # Depthwise Conv specific checks:
165 for op_type in SupportedOperators.depthwise_convolution_ops:
166 self.specific_constraints[op_type].append(SupportedOperators.constraint_depth_multiplier)
167 # Transpose Conv specific checks:
168 for op_type in SupportedOperators.transpose_convolution_ops:
169 self.specific_constraints[op_type].append(SupportedOperators.constraint_tconv_stride)
170 self.specific_constraints[op_type].append(SupportedOperators.constraint_tconv_same)
171 self.specific_constraints[op_type].append(SupportedOperators.constraint_tconv_valid)
172
173 # Pooling checks:
174 for op_type in SupportedOperators.pooling_ops:
175 self.specific_constraints[op_type].append(SupportedOperators.constraint_batch_size)
176 self.specific_constraints[op_type].append(SupportedOperators.constraint_stride_type)
177 self.specific_constraints[op_type].append(SupportedOperators.constraint_stride_range)
178 # AVG pooling specific checks:
179 for op_type in SupportedOperators.avg_pooling_ops:
180 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_in_out_types)
181 self.specific_constraints[op_type].append(SupportedOperators.constraint_filter_type)
182 self.specific_constraints[op_type].append(SupportedOperators.constraint_filter_range)
183 self.specific_constraints[op_type].append(SupportedOperators.constraint_filter_height_range_valid_pad)
184 self.specific_constraints[op_type].append(SupportedOperators.constraint_filter_product_range_valid_pad)
185 # MAX pooling specific checks:
186 for op_type in SupportedOperators.max_pooling_ops:
187 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_in_out_types)
188 self.specific_constraints[op_type].append(SupportedOperators.constraint_filter_type)
189 self.specific_constraints[op_type].append(SupportedOperators.constraint_filter_height_range)
190 self.specific_constraints[op_type].append(SupportedOperators.constraint_filter_product_range)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100191
192 # Resizing specific checks:
193 for op_type in SupportedOperators.resizing_ops:
194 self.specific_constraints[op_type].append(SupportedOperators.constraint_resize)
195
196 # Vector Product specific checks:
197 for op_type in SupportedOperators.fc_vector_products:
198 self.specific_constraints[op_type].append(SupportedOperators.constraint_weights_type)
199 self.specific_constraints[op_type].append(SupportedOperators.constraint_weights_const)
200 self.specific_constraints[op_type].append(SupportedOperators.constraint_bias_type)
201 self.specific_constraints[op_type].append(SupportedOperators.constraint_bias_40bit)
202
203 # Concat specific checks:
204 for op_type in (Op.Concat, Op.ConcatTFLite):
205 self.specific_constraints[op_type].append(SupportedOperators.constraint_axis_exists)
206 self.specific_constraints[op_type].append(SupportedOperators.constraint_axis_valid)
207 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_dimensionality)
208 self.specific_constraints[op_type].append(SupportedOperators.constraint_valid_dimensions)
209
210 # Element-wise checks:
211 for op_type in SupportedOperators.elem_wise_main_ops:
212 self.specific_constraints[op_type].append(SupportedOperators.constraint_elemwise_batch_size)
213 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_either_shapes)
214 # Unary specific checks:
215 for op_type in SupportedOperators.unary_elem_wise_main_ops:
216 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_in_out_types)
217 # Binary Min/Max specific checks:
218 for op_type in SupportedOperators.binary_elem_wise_min_max_ops:
219 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_in_out_types)
220 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_quantization_parameters)
Andreas Nevalainend059d8b2020-11-19 14:40:35 +0100221 self.specific_constraints[op_type].append(SupportedOperators.constraint_broadcast_shapes)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100222 # Binary Add/Mul/Sub specific checks:
223 for op_type in SupportedOperators.binary_elem_wise_add_mul_sub:
224 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_inputs_types)
225 self.specific_constraints[op_type].append(SupportedOperators.constraint_matching_signed)
226 self.specific_constraints[op_type].append(SupportedOperators.constraint_unsigned_valid)
Andreas Nevalainend059d8b2020-11-19 14:40:35 +0100227 self.specific_constraints[op_type].append(SupportedOperators.constraint_broadcast_shapes)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100228 # Binary Shift specific checks:
229 for op_type in SupportedOperators.binary_elem_wise_shift_ops:
230 self.specific_constraints[op_type].append(SupportedOperators.constraint_inputs_int32)
Andreas Nevalainend059d8b2020-11-19 14:40:35 +0100231 self.specific_constraints[op_type].append(SupportedOperators.constraint_broadcast_shapes)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100232
233 # SHL specific checks:
234 self.specific_constraints[Op.SHL].append(SupportedOperators.constraint_output_int32)
235
236 # CLZ specific checks:
237 self.specific_constraints[Op.CLZ].append(SupportedOperators.constraint_output_int32)
238
239 # Softmax specific checks:
240 self.specific_constraints[Op.Softmax].append(SupportedOperators.constraint_matching_shapes)
241 self.specific_constraints[Op.Softmax].append(SupportedOperators.constraint_matching_in_out_types)
Patrik Gustavsson2fa15882020-11-13 09:02:31 +0100242 self.specific_constraints[Op.Softmax].append(SupportedOperators.constraint_beta_value_range)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100243
244 # SplitV specific checks:
245 self.specific_constraints[Op.SplitV].append(SupportedOperators.constraint_splitv_inferred)
246
247 # StridedSlice specific checks:
248 self.specific_constraints[Op.StridedSlice].append(SupportedOperators.constraint_stridedslice_input_count)
249 self.specific_constraints[Op.StridedSlice].append(SupportedOperators.constraint_stridedslice_inputs_const)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100250 self.specific_constraints[Op.StridedSlice].append(SupportedOperators.constraint_stridedslice_stride_values)
251 self.specific_constraints[Op.StridedSlice].append(SupportedOperators.constraint_ellipsis_mask)
252 self.specific_constraints[Op.StridedSlice].append(SupportedOperators.constraint_axis_masks)
253 self.specific_constraints[Op.StridedSlice].append(SupportedOperators.constraint_slice_ranges)
254
255 # LeakyRelu specific checks:
256 self.specific_constraints[Op.LeakyRelu].append(SupportedOperators.constraint_alpha_valid)
Tim Hall79d07d22020-04-27 18:20:16 +0100257
Dwight Lidman0dd21c72020-11-24 13:45:50 +0100258 # FullyConnected specific checks:
259 self.specific_constraints[Op.FullyConnected].append(SupportedOperators.constraint_fc_output_2d)
erik.andersson@arm.com0cbb1662021-02-22 15:47:07 +0100260 self.specific_constraints[Op.FullyConnected].append(SupportedOperators.constraint_keep_dim_ifm_ofm)
Dwight Lidman0dd21c72020-11-24 13:45:50 +0100261
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100262 # Pad specific checks:
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100263 self.specific_constraints[Op.Pad].append(SupportedOperators.constraint_pad_input_count)
264 self.specific_constraints[Op.Pad].append(SupportedOperators.constraint_pad_shape)
265 self.specific_constraints[Op.Pad].append(SupportedOperators.constraint_padding_dimensions)
266 self.specific_constraints[Op.Pad].append(SupportedOperators.constraint_pad_type)
267 self.specific_constraints[Op.Pad].append(SupportedOperators.constraint_pad_constant)
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100268
Diqing Zhong189f7482021-01-26 12:12:51 +0100269 # HardSwish specific checks:
270 self.specific_constraints[Op.HardSwish].append(SupportedOperators.constraint_input_8bit)
271 self.specific_constraints[Op.HardSwish].append(SupportedOperators.constraint_matching_in_out_types)
Dwight Lidman4f728c02020-12-17 15:14:45 +0100272 # Mean specific checks:
273 self.specific_constraints[Op.Mean].append(SupportedOperators.constraint_input_8bit)
Dwight Lidman4f728c02020-12-17 15:14:45 +0100274 self.specific_constraints[Op.Mean].append(SupportedOperators.constraint_mean_input_dims)
275 self.specific_constraints[Op.Mean].append(SupportedOperators.constraint_mean_axis)
Dwight Lidman95b279f2021-03-26 10:53:28 +0100276 self.specific_constraints[Op.Mean].append(SupportedOperators.constraint_mean_height_width_product_avgpool)
Dwight Lidman4f728c02020-12-17 15:14:45 +0100277 self.specific_constraints[Op.Mean].append(SupportedOperators.constraint_mean_height_width_product)
278 self.specific_constraints[Op.Mean].append(SupportedOperators.constraint_mean_height_width_product_int8)
Diqing Zhong189f7482021-01-26 12:12:51 +0100279
Tim Hall79d07d22020-04-27 18:20:16 +0100280 def is_operator_supported(self, op):
Michael McGeagh219ec072020-11-09 11:11:26 +0000281 ext_type = optype_to_builtintype(op.type)
Michael McGeagh1eeea512020-09-30 14:23:09 +0100282 if op.type not in SupportedOperators.supported_operators:
Louis Verhaard5f2ea2f2020-10-15 08:39:44 +0200283 if op.type not in (Op.Placeholder, Op.SubgraphInput, Op.Const):
Michael McGeagh219ec072020-11-09 11:11:26 +0000284 print(f"Info: {ext_type} '{op.name}' is a CPU only op")
Tim Hall79d07d22020-04-27 18:20:16 +0100285 return False
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100286
Michael McGeagh65fd9982020-10-20 11:49:28 +0100287 for constraint in self.generic_constraints + self.specific_constraints[op.type]:
Michael McGeagh37ded342020-10-01 15:37:44 +0100288 valid, extra = constraint(op)
289 if not valid:
Michael McGeagh219ec072020-11-09 11:11:26 +0000290 print(f"Warning: {ext_type} '{op.name}' is not supported on the NPU. Placing on CPU instead")
Michael McGeagh65fd9982020-10-20 11:49:28 +0100291 print(f" - {constraint.__doc__}")
Michael McGeagh37ded342020-10-01 15:37:44 +0100292 if extra:
Michael McGeagh65fd9982020-10-20 11:49:28 +0100293 print(f" {extra}")
Michael McGeagh37ded342020-10-01 15:37:44 +0100294 return False
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100295
Tim Hall79d07d22020-04-27 18:20:16 +0100296 return True
297
Michael McGeagh37ded342020-10-01 15:37:44 +0100298 @staticmethod
Michael McGeagh65fd9982020-10-20 11:49:28 +0100299 def constraint_tens_no_dynamic(op):
300 "Input(s) and Output tensors must not be dynamic"
301 valid = True
302 extra = []
303 tensors = [tens for tens in op.inputs + op.outputs if tens]
304 for tens in tensors:
305 if (tens.shape == []) and (tens.values is None):
306 valid = False
307 extra.append(tens.name)
308 extra = ", ".join(extra)
309 return valid, f"Op has dynamic tensor(s): {extra}"
310
311 @staticmethod
Michael McGeagh37ded342020-10-01 15:37:44 +0100312 def constraint_tens_defined_shape(op):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100313 "Input(s) and Output tensors must have a defined shape"
Michael McGeagh37ded342020-10-01 15:37:44 +0100314 valid = True
315 extra = []
Michael McGeagh184b2502020-10-09 17:19:52 +0100316 tensors = [tens for tens in op.inputs + op.outputs if tens]
317 for tens in tensors:
318 if not tens.has_fully_defined_shape():
319 valid = False
Michael McGeagh65fd9982020-10-20 11:49:28 +0100320 extra.append(f"Tensor '{tens.name}' has shape: {tens.shape}")
Michael McGeagh184b2502020-10-09 17:19:52 +0100321 return valid, ", ".join(extra)
Michael McGeagh37ded342020-10-01 15:37:44 +0100322
Michael McGeagh184b2502020-10-09 17:19:52 +0100323 @staticmethod
Michael McGeagh65fd9982020-10-20 11:49:28 +0100324 def constraint_tens_output_scalar(op):
325 "Output tensors cannot be scalar"
326 ofm = op.ofm
327 valid = ofm.shape != []
328 return valid, f"Output Tensor '{ofm.name}' is scalar"
Michael McGeagh184b2502020-10-09 17:19:52 +0100329
330 @classmethod
Michael McGeagh34d29172020-11-25 12:36:23 +0000331 @docstring_format_args([_optype_formatter(shapeless_input_ops)])
Michael McGeagh65fd9982020-10-20 11:49:28 +0100332 def constraint_tens_input_scalar(cls, op):
333 "Scalar Input tensors are only valid for op type: {}"
Michael McGeagh184b2502020-10-09 17:19:52 +0100334 valid = True
335 extra = []
336 tensors = [tens for tens in op.inputs if tens]
337 for tens in tensors:
338 if (tens.shape == []) and (op.type not in cls.shapeless_input_ops):
339 valid = False
340 extra.append(tens.name)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100341 extra = ", ".join(extra)
342 return valid, f"Op has scalar input tensor(s): {extra}"
Tim Hall79d07d22020-04-27 18:20:16 +0100343
Michael McGeagh37ded342020-10-01 15:37:44 +0100344 @staticmethod
345 def constraint_tens_shape_size(op):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100346 "Input(s) and Output tensors must not be greater than 4D"
Michael McGeagh37ded342020-10-01 15:37:44 +0100347 valid = True
348 extra = []
Michael McGeagh184b2502020-10-09 17:19:52 +0100349 tensors = [tens for tens in op.inputs + op.outputs if tens]
350 for tens in tensors:
351 if len(tens.shape) > 4:
352 valid = False
Michael McGeagh65fd9982020-10-20 11:49:28 +0100353 extra.append(f"Tensor '{tens.name}' has shape: {tens.shape}")
Michael McGeagh184b2502020-10-09 17:19:52 +0100354 return valid, ", ".join(extra)
Tim Hall79d07d22020-04-27 18:20:16 +0100355
Michael McGeagh37ded342020-10-01 15:37:44 +0100356 @classmethod
Michael McGeagh34d29172020-11-25 12:36:23 +0000357 @docstring_format_args([_list_formatter(supported_op_dtypes)])
Michael McGeagh37ded342020-10-01 15:37:44 +0100358 def constraint_tens_dtype(cls, op):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100359 "Tensors must be of type: {}"
Michael McGeagh37ded342020-10-01 15:37:44 +0100360 valid = True
361 extra = []
362 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
Michael McGeagh65fd9982020-10-20 11:49:28 +0100363 if not tensors:
364 tensors = [tens for tens in op.inputs if tens]
Michael McGeagh37ded342020-10-01 15:37:44 +0100365 for tens in tensors:
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100366 if tens.dtype not in cls.supported_op_dtypes:
Michael McGeagh184b2502020-10-09 17:19:52 +0100367 valid = False
Michael McGeagh65fd9982020-10-20 11:49:28 +0100368 extra.append(f"Tensor '{tens.name}' has data type: {tens.dtype}")
Michael McGeagh184b2502020-10-09 17:19:52 +0100369 return valid, ", ".join(extra)
370
371 @classmethod
Michael McGeagh34d29172020-11-25 12:36:23 +0000372 @docstring_format_args([_optype_formatter(supported_int32_tensor_ops)])
Michael McGeagh184b2502020-10-09 17:19:52 +0100373 def constraint_tens_int32_ops(cls, op):
374 "Tensors which are int32 are only valid when op type is: {}"
375 valid = True
376 extra = []
377 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
Michael McGeagh65fd9982020-10-20 11:49:28 +0100378 if not tensors:
379 tensors = [tens for tens in op.inputs if tens]
Michael McGeagh184b2502020-10-09 17:19:52 +0100380 for tens in tensors:
381 if (tens.dtype == DataType.int32) and (op.type not in cls.supported_int32_tensor_ops):
382 valid = False
383 extra.append(tens.name)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100384 extra = ", ".join(extra)
385 return valid, f"Op has int32 tensor(s): {extra}"
Andreas Nevalaineneadb1662020-09-01 15:36:26 +0200386
Michael McGeagh37ded342020-10-01 15:37:44 +0100387 @classmethod
388 @docstring_format_args(tens_dim_range)
389 def constraint_tens_dimension(cls, op):
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100390 "Tensor dimensions must be in the range [{}, {}]"
Michael McGeagh37ded342020-10-01 15:37:44 +0100391 tens_min, tens_max = cls.tens_dim_range
392 valid = True
393 extra = []
394 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
Michael McGeagh65fd9982020-10-20 11:49:28 +0100395 if not tensors:
396 tensors = [tens for tens in op.inputs if tens]
Michael McGeagh37ded342020-10-01 15:37:44 +0100397 for tens in tensors:
Michael McGeagh184b2502020-10-09 17:19:52 +0100398 if not all(tens_min <= dim <= tens_max for dim in tens.shape):
399 valid = False
Michael McGeagh65fd9982020-10-20 11:49:28 +0100400 extra.append(f"Tensor '{tens.name}' has shape: {tens.shape}")
Michael McGeagh184b2502020-10-09 17:19:52 +0100401 return valid, ", ".join(extra)
Tim Hall79d07d22020-04-27 18:20:16 +0100402
Dwight Lidman8359a472020-09-28 15:53:40 +0200403 @staticmethod
404 def constraint_tens_quant_none_check(op):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100405 "Input(s), Output and Weight tensors must have quantization parameters"
Dwight Lidman8359a472020-09-28 15:53:40 +0200406 valid = True
407 extra = []
408 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
409 for tens in tensors:
410 if tens.quantization is None:
411 valid = False
Michael McGeagh65fd9982020-10-20 11:49:28 +0100412 extra.append(tens.name)
413 extra = ", ".join(extra)
414 return valid, f"Op has tensors with missing quantization parameters: {extra}"
Dwight Lidman8359a472020-09-28 15:53:40 +0200415
Michael McGeagh184b2502020-10-09 17:19:52 +0100416 @staticmethod
417 def constraint_tens_quant_scale(op):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100418 "Input(s), Output and Weight tensors with quantization scales must be finite"
Michael McGeagh184b2502020-10-09 17:19:52 +0100419 valid = True
420 extra = []
421 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
422 for tens in tensors:
423 if (tens.quantization.scale_f32 is not None) and np.isinf(tens.quantization.scale_f32).any():
424 valid = False
Michael McGeagh65fd9982020-10-20 11:49:28 +0100425 extra.append(f"Tensor '{tens.name}' has quantization scale: {tens.quantization.scale_f32}")
Michael McGeagh184b2502020-10-09 17:19:52 +0100426 return valid, ", ".join(extra)
427
428 @classmethod
Michael McGeagh34d29172020-11-25 12:36:23 +0000429 @docstring_format_args([_optype_formatter(per_axis_quant_ops)])
Dwight Lidmanc7187432020-11-16 17:40:46 +0100430 def constraint_tens_quant_per_axis(cls, op):
431 "Per-axis quantization is only supported for the following op types: {}"
432 valid = True
433 extra = []
434 if op.type not in cls.per_axis_quant_ops:
435 tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens]
436 for tens in tensors:
437 if tens.quantization.is_per_axis():
438 valid = False
439 extra.append(tens.name)
440 return valid, "The following tensor(s) have per-axis quantization parameters: " + ", ".join(extra)
441
Dwight Lidman0dd21c72020-11-24 13:45:50 +0100442 @staticmethod
443 def constraint_fc_output_2d(op):
444 "The output tensor(s) must have 2D shape"
445 valid = True
446 extra = []
447 for tens in op.outputs:
448 if len(tens.shape) != 2:
449 valid = False
450 extra.append(f"Tensor '{tens.name}' is {len(tens.shape)}D")
451 return valid, ", ".join(extra)
452
Dwight Lidmanc7187432020-11-16 17:40:46 +0100453 @classmethod
Michael McGeagh34d29172020-11-25 12:36:23 +0000454 @docstring_format_args([_optype_formatter(supported_fused_activations)])
Michael McGeagh184b2502020-10-09 17:19:52 +0100455 def constraint_faf(cls, op):
456 "The fused activation function (if present) must be one of type: {}"
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100457 if op.activation is None:
458 res = True, "Op has no fused activation function"
459 else:
460 faf = op.activation.op_type
461 valid = faf in cls.supported_fused_activations
462 res = valid, f"Op has its fused activation function as: {faf}"
463 return res
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100464
Louis Verhaardc7761512021-02-03 10:22:38 +0100465 @classmethod
466 @docstring_format_args([_list_formatter(supported_faf_dtypes)])
467 def constraint_faf_type(cls, op):
468 "If a fused activation function is present, the Output tensor must be one of type: {}"
469 if op.activation is None:
470 res = True, "Op has no fused activation function"
471 else:
472 valid = op.ofm.dtype in cls.supported_faf_dtypes
473 ext_type = optype_to_builtintype(op.activation.op_type)
474 res = valid, f"Op has fused activation function {ext_type}, and Output tensor data type: {op.ofm.dtype}"
475 return res
476
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100477 @staticmethod
478 def constraint_stride_type(op):
479 "Stride values for both width and height must be integer types"
Michael McGeagh65fd9982020-10-20 11:49:28 +0100480 w, h = op.get_kernel_stride()
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100481 valid = is_integer(w) and is_integer(h)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100482 return valid, f"Op has stride WxH as: {repr(w)}x{repr(h)}"
Michael McGeagh184b2502020-10-09 17:19:52 +0100483
Michael McGeagh1eeea512020-09-30 14:23:09 +0100484 @classmethod
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100485 @docstring_format_args(stride_range)
486 def constraint_stride_range(cls, op):
487 "Stride values for both width and height must be in the range [{}, {}]"
Michael McGeagh65fd9982020-10-20 11:49:28 +0100488 w, h = op.get_kernel_stride()
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100489 stride_min, stride_max = cls.stride_range
490 valid = (stride_min <= w <= stride_max) and (stride_min <= h <= stride_max)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100491 return valid, f"Op has stride WxH as: {w}x{h}"
Tim Hall79d07d22020-04-27 18:20:16 +0100492
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100493 @staticmethod
494 def constraint_dilation_type(op):
495 "Dilation factor values for both width and height must be integer types"
Michael McGeagh65fd9982020-10-20 11:49:28 +0100496 w, h = op.get_kernel_dilation()
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100497 valid = is_integer(w) and is_integer(h)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100498 return valid, f"Op has dilation factor WxH as: {repr(w)}x{repr(h)}"
Tim Hall79d07d22020-04-27 18:20:16 +0100499
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100500 @classmethod
501 @docstring_format_args(dilation_range)
502 def constraint_dilation_range(cls, op):
503 "Dilation factor values for both width and height must be in the range [{}, {}]"
Michael McGeagh65fd9982020-10-20 11:49:28 +0100504 w, h = op.get_kernel_dilation()
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100505 dilation_min, dilation_max = cls.dilation_range
506 valid = (dilation_min <= w <= dilation_max) and (dilation_min <= h <= dilation_max)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100507 return valid, f"Op has dilation factor WxH as: {w}x{h}"
Tim Hall79d07d22020-04-27 18:20:16 +0100508
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100509 @classmethod
510 @docstring_format_args(dilated_height_range)
511 def constraint_dilated_height_range(cls, op):
512 "Dilated kernel height must be in the range [{}, {}]"
Michael McGeagh65fd9982020-10-20 11:49:28 +0100513 h = op.kernel.area_height()
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100514 dilated_height_min, dilated_height_max = cls.dilated_height_range
515 valid = dilated_height_min <= h <= dilated_height_max
Michael McGeagh65fd9982020-10-20 11:49:28 +0100516 return valid, f"Op has dilated kernel height as: {h}"
Jacob Bohlin49d92122020-08-19 14:36:46 +0200517
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100518 @classmethod
519 @docstring_format_args(dilated_product_range)
520 def constraint_dilated_product_range(cls, op):
521 "Product of dilated kernel width and height must be in the range [{}, {}]"
Michael McGeagh65fd9982020-10-20 11:49:28 +0100522 product = op.kernel.area_width() * op.kernel.area_height()
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100523 dilated_product_min, dilated_product_max = cls.dilated_product_range
524 valid = dilated_product_min <= product <= dilated_product_max
Michael McGeagh65fd9982020-10-20 11:49:28 +0100525 return valid, f"Op has product of dilated kernel width and height as: {product}"
Andreas Nevalainenf0c59bf2020-08-26 10:56:23 +0200526
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100527 @staticmethod
528 def constraint_weights_type(op):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100529 "Weight tensor must be 8-bit"
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100530 weights = op.weights
531 valid = weights.element_size() == 1
Michael McGeagh65fd9982020-10-20 11:49:28 +0100532 return valid, f"Tensor '{weights.name}' is {int(weights.element_size() * 8)}-bit"
Andreas Nevalainenf0c59bf2020-08-26 10:56:23 +0200533
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100534 @staticmethod
Michael McGeagh65fd9982020-10-20 11:49:28 +0100535 def constraint_weights_const(op):
536 "Weight tensor must be constant"
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100537 weights = op.weights
538 valid = weights.values is not None
Michael McGeagh65fd9982020-10-20 11:49:28 +0100539 return valid, f"Tensor '{weights.name}' has non-constant values"
Andreas Nevalainen8854dc92020-09-24 13:43:00 +0200540
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100541 @classmethod
542 @docstring_format_args([weights_limit])
543 def constraint_weights_limit(cls, op):
544 "The sum of the weights cannot exceed {}"
545 weights = op.weights
546 values = weights.quant_values.astype(np.int64) - weights.quantization.zero_point
547 limit = np.amax(np.sum(np.absolute(values), axis=(0, 1, 2)))
548 valid = limit <= cls.weights_limit
Michael McGeagh65fd9982020-10-20 11:49:28 +0100549 return valid, f"Tensor '{weights.name}' has the sum of weights: {limit}"
Andreas Nevalainenf0c59bf2020-08-26 10:56:23 +0200550
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100551 @classmethod
Michael McGeagh34d29172020-11-25 12:36:23 +0000552 @docstring_format_args([_list_formatter(supported_bias_dtypes)])
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100553 def constraint_bias_type(cls, op):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100554 "Optional Bias tensor must be of type: {}"
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100555 bias = op.bias
556 if bias:
557 valid = bias.dtype in cls.supported_bias_dtypes
Michael McGeagh65fd9982020-10-20 11:49:28 +0100558 return valid, f"Tensor '{bias.name}' has data type: {bias.dtype}"
559 return True, "Op has no bias tensor"
Tim Hall79d07d22020-04-27 18:20:16 +0100560
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100561 @staticmethod
562 def constraint_bias_40bit(op):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100563 "Optional Bias tensor values must fit within 40-bits"
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100564 bias = op.bias
Fredrik Svedbergbdf09f92020-11-18 11:30:21 +0100565 if bias and bias.dtype == DataType.int64 and bias.quant_values is not None:
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100566 valid = all(len(bin(quant_value)[2:]) <= 40 for quant_value in bias.quant_values)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100567 return valid, f"Tensor '{bias.name}' has values larger than 40-bits"
568 return True, "Op has no bias tensor, or it fits in 40-bit"
Andreas Nevalainend8c032d2020-09-11 10:25:09 +0200569
Michael McGeagh1f951fc2020-10-14 09:30:02 +0100570 @staticmethod
571 def constraint_batch_size(op):
572 "IFM Tensor batch size must be 1"
573 ifm = op.ifm
574 valid = ifm.shape[0] == 1
Michael McGeagh65fd9982020-10-20 11:49:28 +0100575 return valid, f"Tensor '{ifm.name}' has batch size: {ifm.shape[0]}"
576
577 @staticmethod
578 def constraint_quant_scale_inf(op):
Louis Verhaard9a0cff12021-01-08 11:17:33 +0100579 "Input and Output tensors must have quantization scales that fit within float32 precision"
580 if op.ofm is not None and op.ofm.is_quantized():
581 ofm_scale = op.ofm.quantization.scale_f32
582 if ofm_scale < np.finfo(np.float32).tiny:
583 return (
584 False,
585 f"The quantization scale of the output tensor is {ofm_scale}, "
586 + f"minimum supported is: {np.finfo(np.float32).tiny}",
587 )
588 if op.ifm is not None and op.ifm.is_quantized():
589 ifm_scale = op.ifm.quantization.scale_f32
590 if np.isinf(ifm_scale / ofm_scale):
591 return (
592 False,
593 f"IFM scale divided by OFM scale is infinite, ifm_scale={ifm_scale} ofm_scale={ofm_scale}",
594 )
595 return True, "Op's quantization is ok"
Michael McGeagh65fd9982020-10-20 11:49:28 +0100596
597 @staticmethod
598 def constraint_depth_multiplier(op):
599 "For depth multipliers > 1, IFM channels must be 1 and OFM channels must be equal to the depth multiplier"
600 depth_multiplier = op.attrs.get("depth_multiplier", 1)
601 if depth_multiplier > 1:
602 ifm_channels = op.ifm.shape[3]
603 ofm_channels = op.ofm.shape[3]
604 valid = (ifm_channels == 1) and (ofm_channels == depth_multiplier)
605 extra = (
606 f"Op has ifm_channels={ifm_channels}, ofm_channels={ofm_channels}"
607 f" and depth_multiplier={depth_multiplier}"
608 )
609 return valid, extra
610 return True, "Op has depth_multiplier=1"
611
612 @staticmethod
613 def constraint_tconv_stride(op):
614 "Stride values for both width and height must be 2"
615 w = op.kernel.stride.x
616 h = op.kernel.stride.y
617 valid = (w == 2) and (h == 2)
618 return valid, f"Op has stride WxH as: {w}x{h}"
619
620 @staticmethod
621 def constraint_tconv_same(op):
622 "SAME padding: OFM dimensions must equal IFM dimensions multiplied by stride"
Michael McGeagh16895482020-12-14 15:51:20 +0000623 if op.attrs["padding"] == Padding.SAME:
Michael McGeagh65fd9982020-10-20 11:49:28 +0100624 w = op.kernel.stride.x
625 h = op.kernel.stride.y
626 ifm_shape = op.ifm.shape
627 ofm_shape = op.ofm.shape
628 valid = (ofm_shape[1] == (ifm_shape[1] * h)) and (ofm_shape[2] == (ifm_shape[2] * w))
629 return valid, f"Op has ifm_shape={ifm_shape}, ofm_shape={ofm_shape} and stride WxH as {w}x{h}"
630 return True, "Op has padding=VALID"
631
632 @staticmethod
633 def constraint_tconv_valid(op):
634 """VALID padding: OFM dimensions must equal IFM dimensions multiplied by stride,
635 minus difference between kernel size and stride"""
Michael McGeagh16895482020-12-14 15:51:20 +0000636 if op.attrs["padding"] == Padding.VALID:
Michael McGeagh65fd9982020-10-20 11:49:28 +0100637 s_w = op.kernel.stride.x
638 s_h = op.kernel.stride.y
639 k_w = op.kernel.width
640 k_h = op.kernel.height
641 ifm_shape = op.ifm.shape
642 ofm_shape = op.ofm.shape
643 height_check = ofm_shape[1] == (ifm_shape[1] * s_h + max(k_h - s_h, 0))
644 width_check = ofm_shape[2] == (ifm_shape[2] * s_w + max(k_w - s_w, 0))
645 valid = height_check and width_check
646 extra = (
647 f"Op has ifm_shape={ifm_shape}, ofm_shape={ofm_shape},"
648 f" stride WxH as {s_w}x{s_h} and kernel WxH as {k_w}x{k_h}"
649 )
650 return valid, extra
651 return True, "Op has padding=SAME"
652
653 @staticmethod
654 def constraint_matching_in_out_types(op):
655 "IFM and OFM data types must match"
656 ifm_dtype = op.ifm.dtype
657 ofm_dtype = op.ofm.dtype
658 valid = ifm_dtype == ofm_dtype
659 return valid, f"Op has ifm_dtype={ifm_dtype} and ofm_dtype={ofm_dtype}"
660
661 @staticmethod
Patrik Gustavsson2fa15882020-11-13 09:02:31 +0100662 def constraint_beta_value_range(op):
663 "Beta value needs to be positive"
664 beta = op.attrs.get("beta", 1.0)
665 valid = beta >= 0
666 return valid, f"Op has beta={beta}"
667
668 @staticmethod
Michael McGeagh65fd9982020-10-20 11:49:28 +0100669 def constraint_filter_type(op):
670 "Kernel filter values for both width and height must be integer types"
671 w = op.kernel.width
672 h = op.kernel.height
673 valid = is_integer(w) and is_integer(h)
674 return valid, f"Op has kernel filter WxH as: {repr(w)}x{repr(h)}"
675
676 @classmethod
677 @docstring_format_args(filter_range)
678 def constraint_filter_range(cls, op):
679 "Kernel filter values for both width and height must be in the range [{}, {}]"
Michael McGeagh16895482020-12-14 15:51:20 +0000680 if op.attrs["padding"] == Padding.SAME:
Michael McGeagh65fd9982020-10-20 11:49:28 +0100681 w = op.kernel.width
682 h = op.kernel.height
683 filter_min, filter_max = cls.filter_range
684 valid = (filter_min <= w <= filter_max) and (filter_min <= h <= filter_max)
685 return valid, f"Op has kernel filter WxH as: {w}x{h}"
686 return True, "Op has padding=VALID"
687
688 @classmethod
689 @docstring_format_args(filter_height_range)
690 def constraint_filter_height_range(cls, op):
691 "Kernel filter height must be in the range [{}, {}]"
692 h = op.kernel.height
693 filter_height_min, filter_height_max = cls.filter_height_range
694 valid = filter_height_min <= h <= filter_height_max
695 return valid, f"Op has kernel filter height as: {h}"
696
697 @classmethod
698 @docstring_format_args(filter_product_range)
699 def constraint_filter_product_range(cls, op):
700 "Product of kernel filter width and height must be in the range [{}, {}]"
701 product = op.kernel.elements_wh()
702 filter_product_min, filter_product_max = cls.filter_product_range
703 valid = filter_product_min <= product <= filter_product_max
704 return valid, f"Op has product of kernel filter width and height as: {product}"
705
706 @staticmethod
707 @docstring_format_args(filter_height_range)
708 def constraint_filter_height_range_valid_pad(op):
709 "VALID padding: Kernel filter height must be in the range [{}, {}]"
Michael McGeagh16895482020-12-14 15:51:20 +0000710 if op.attrs["padding"] == Padding.VALID:
Michael McGeagh65fd9982020-10-20 11:49:28 +0100711 return SupportedOperators.constraint_filter_height_range(op)
712 return True, "Op has padding=SAME"
713
714 @staticmethod
715 @docstring_format_args(filter_product_range)
716 def constraint_filter_product_range_valid_pad(op):
717 "VALID padding: Product of kernel filter width and height must be in the range [{}, {}]"
Michael McGeagh16895482020-12-14 15:51:20 +0000718 if op.attrs["padding"] == Padding.VALID:
Michael McGeagh65fd9982020-10-20 11:49:28 +0100719 return SupportedOperators.constraint_filter_product_range(op)
720 return True, "Op has padding=SAME"
721
722 @staticmethod
723 def constraint_resize(op):
724 """The width and height of the IFM and OFM must match one of the following criteria:
725 IFM W and H must both be 1
726 IFM must match OFM
727 OFM W and H must be 2x IFM -1, if align_corners is True
728 OFM W and H must be 2x IFM, if align_corners is False"""
729 # Easier to start with False condition as very few cases result in a supported resize
730 valid = False
731 ifm_shape = op.ifm.shape
732 ofm_shape = op.ofm.shape
733 align_corners = op.attrs.get("align_corners", False)
734 if len(ifm_shape) == 4:
735 # Valid if IFM W and H are both 1, or IFM and OFM shape are the same
736 if ((ifm_shape[1] == 1) and (ifm_shape[2] == 1)) or (ifm_shape == ofm_shape):
737 valid = True
738 else:
739 upscaled_shape = np.array(ifm_shape[1:3])
740 out_shape = np.array(ofm_shape[1:3])
741 while (upscaled_shape < out_shape).all():
742 upscaled_shape *= 2
743 if align_corners:
744 upscaled_shape -= 1
745 # Valid if OFM is 2x IFM (-1 for align corners)
746 if np.array_equal(out_shape, upscaled_shape):
747 valid = True
748 break
749 return valid, f"Op has ifm_shape={ifm_shape}, ofm_shape={ofm_shape} and align_corners={align_corners}"
750
751 @staticmethod
752 def constraint_matching_shapes(op):
753 "IFM and OFM shapes must match"
754 ifm_shape = op.ifm.shape
755 ofm_shape = op.ofm.shape
756 valid = ifm_shape == ofm_shape
757 return valid, f"Op has ifm_shape={ifm_shape} and ofm_shape={ofm_shape}"
758
759 @staticmethod
760 def constraint_splitv_inferred(op):
761 "Only one size is allowed to be inferred"
Jacob Bohline3de4e52020-11-27 14:52:06 +0100762 sizes = op.inputs[1].values
Michael McGeagh65fd9982020-10-20 11:49:28 +0100763 valid = np.count_nonzero(sizes == -1) <= 1
764 return valid, f"Op has multiple inferred sizes (-1): {sizes}"
765
766 @staticmethod
767 def constraint_axis_exists(op):
768 "Axis attribute must exist"
769 axis = op.attrs.get("axis")
770 valid = axis is not None
771 return valid, f"Op has axis={axis}"
772
773 @staticmethod
774 def constraint_axis_valid(op):
775 "Axis attribute must be in the range [0, <ofm_dimensions>)"
776 dims = len(op.ofm.shape)
777 axis = op.attrs["axis"]
778 axis += dims if axis < 0 else 0
779 valid = 0 <= axis < dims
780 return valid, f"Op has ofm_dimensions={dims} and axis attribute is: {axis}"
781
782 @staticmethod
783 def constraint_matching_dimensionality(op):
784 "All Input dimensionalities must match OFM dimensionality"
785 valid = True
786 extra = []
787 ofm_dim = len(op.ofm.shape)
788 tensors = [tens for tens in op.inputs if tens]
789 for tens in tensors:
790 dim = len(tens.shape)
791 if dim != ofm_dim:
792 valid = False
793 extra.append(f"Tensor '{tens.name}' has dimension: {dim}")
794 extra = ", ".join(extra)
795 return valid, f"Op has ofm_dimension={ofm_dim} and the list of mismatching inputs are: {extra}"
796
797 @staticmethod
798 def constraint_valid_dimensions(op):
799 "All Input dimensions must match OFM dimension in all axes except the one defined by the axis attribute"
800 valid = True
801 extra = []
802 ofm_shape = op.ofm.shape
803 ofm_dim = len(ofm_shape)
804 axis = op.attrs["axis"]
805 axis += ofm_dim if axis < 0 else 0
806 tensors = [tens for tens in op.inputs if tens]
807 for tens in tensors:
808 if any(tens.shape[dim] != ofm_shape[dim] for dim in range(ofm_dim) if dim != axis):
809 valid = False
810 extra.append(f"Tensor '{tens.name}' has shape: {tens.shape}")
811 extra = ", ".join(extra)
812 return valid, f"Op has axis={axis}, ofm_shape={ofm_shape} and the list of mismatching inputs are: {extra}"
813
814 @staticmethod
815 def constraint_stridedslice_input_count(op):
816 "Exactly 4 Input tensors are required"
817 inputs = len(op.inputs)
818 valid = inputs == 4
819 return valid, f"Op has {inputs} inputs"
820
821 @staticmethod
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100822 def constraint_pad_input_count(op):
823 "Number of input tensors must be exactly 2"
824 inputs = len(op.inputs)
825 valid = inputs == 2
826 return valid, f"Op has {inputs} inputs"
827
828 @staticmethod
829 def constraint_pad_shape(op):
Louis Verhaardc822d622021-03-11 14:59:06 +0100830 "The padding tensor must have the shape [3,2] or [4,2]"
831 valid = op.inputs[1].shape in ([3, 2], [4, 2])
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100832 return valid, f"The pad tensor has the shape: {op.inputs[1].shape}"
833
834 @classmethod
835 @docstring_format_args([_list_formatter(supported_pad_dtypes)])
836 def constraint_pad_type(cls, op):
837 "Pad tensor must be of type: {}"
838 pad_tensor = op.inputs[1]
839 valid = pad_tensor.dtype in cls.supported_pad_dtypes
840 return valid, f"Tensor '{pad_tensor.name}' has data type: {pad_tensor.dtype}"
841
842 @staticmethod
843 def constraint_padding_dimensions(op):
844 "The pad tensor can only pad width and height"
845 pad_tensor = op.inputs[1].values
Louis Verhaardc822d622021-03-11 14:59:06 +0100846
847 valid = sum(pad_tensor[-1, :]) == 0
848 if valid and len(pad_tensor) > 3:
849 valid = sum(pad_tensor[0, :]) == 0
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100850 return valid, f"First dimension padding: {pad_tensor[0,:]}, last dimension padding: {pad_tensor[-1,:]}"
851
852 @staticmethod
853 def constraint_pad_constant(op):
Louis Verhaard3d22f3c2021-02-03 08:43:54 +0100854 "The padding tensor must be constant"
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100855 pad_tensor = op.inputs[1].values
856 valid = pad_tensor is not None
857 return valid, f"Op has non-constant padding tensor: {op.inputs[1].values}"
858
Louis Verhaardebf4af62021-01-27 15:57:57 +0100859 @staticmethod
Michael McGeagh65fd9982020-10-20 11:49:28 +0100860 def constraint_stridedslice_inputs_const(op):
861 "Begin, End and Stride Input tensors must be constant"
862 valid = True
863 extra = []
864 _, begin, end, strides = op.inputs
865 if begin.values is None:
866 valid = False
867 extra.append(f"Begin tensor '{begin.name}'")
868 if end.values is None:
869 valid = False
870 extra.append(f"End tensor '{end.name}'")
871 if strides.values is None:
872 valid = False
873 extra.append(f"Stride tensor '{strides.name}'")
874 extra = ", ".join(extra)
875 return valid, f"Op has non-constant tensors: {extra}"
876
877 @staticmethod
Michael McGeagh65fd9982020-10-20 11:49:28 +0100878 def constraint_stridedslice_stride_values(op):
879 "All Strides values must be 1"
880 strides = op.inputs[3]
881 valid = all(stride == 1 for stride in strides.values)
882 return valid, f"Op has strides values {strides.values}"
Tim Hall79d07d22020-04-27 18:20:16 +0100883
Michael McGeagh65fd9982020-10-20 11:49:28 +0100884 @staticmethod
885 def constraint_ellipsis_mask(op):
886 "ellipsis_mask must be 0"
887 ellipsis = op.attrs["ellipsis_mask"]
888 valid = ellipsis == 0
889 return valid, f"Op has ellipsis mask as: {ellipsis}"
Jacob Bohlincf7da102020-05-20 09:03:40 +0200890
Michael McGeagh65fd9982020-10-20 11:49:28 +0100891 @staticmethod
892 def constraint_axis_masks(op):
893 "new_axis_mask and shrink_axis_mask cannot both be set"
894 new_axis = op.attrs["new_axis_mask"]
895 shrink_axis = op.attrs["shrink_axis_mask"]
896 valid = (new_axis == 0) or (shrink_axis == 0)
897 return valid, f"Op has new_axis_mask={new_axis} and shrink_axis_mask={shrink_axis}"
Jacob Bohlincf7da102020-05-20 09:03:40 +0200898
Michael McGeagh65fd9982020-10-20 11:49:28 +0100899 @staticmethod
900 def constraint_slice_ranges(op):
901 "Slice 'end' values must be greater than 'begin' values"
902 ifm, begin, end, _ = op.inputs
903 # Calculate offset begin/end
904 offset_begin = get_slice_offsets(ifm.shape, begin, op.attrs["begin_mask"], is_begin=True)
905 offset_end = get_slice_offsets(ifm.shape, end, op.attrs["end_mask"], is_begin=False)
906 # Check "end - begin" doesn't result in any zero or negative elements
907 valid = all((e - b) > 0 for b, e in zip(offset_begin, offset_end))
908 return valid, f"Op has begin_values={begin.values} and end_values={end.values}"
Tim Hall79d07d22020-04-27 18:20:16 +0100909
Michael McGeagh65fd9982020-10-20 11:49:28 +0100910 @staticmethod
911 def constraint_matching_inputs_types(op):
912 "Both Input data types must match"
913 ifm_dtype = op.ifm.dtype
914 ifm2_dtype = op.ifm2.dtype
915 valid = ifm_dtype == ifm2_dtype
916 return valid, f"Op has ifm_dtype={ifm_dtype} and ifm2_dtype={ifm2_dtype}"
Tim Hall79d07d22020-04-27 18:20:16 +0100917
Michael McGeagh65fd9982020-10-20 11:49:28 +0100918 @staticmethod
919 def constraint_matching_signed(op):
920 "For IFM that are signed, OFM must also be signed"
921 valid = True
922 ifm_dtype = op.ifm.dtype
923 ofm_dtype = op.ofm.dtype
924 if ifm_dtype.type & BaseType.Signed:
925 valid = bool(ofm_dtype.type & BaseType.Signed)
926 return valid, f"Op has ifm_dtype={ifm_dtype} and ofm_dtype={ofm_dtype}"
Tim Hall79d07d22020-04-27 18:20:16 +0100927
Michael McGeagh65fd9982020-10-20 11:49:28 +0100928 @staticmethod
929 def constraint_unsigned_valid(op):
930 "For IFM that are unsigned, OFM must either be the same type or int32"
931 valid = True
932 ifm_dtype = op.ifm.dtype
933 ofm_dtype = op.ofm.dtype
934 if ifm_dtype.type & BaseType.Unsigned:
935 valid = (ifm_dtype == ofm_dtype) or (ofm_dtype == DataType.int32)
936 return valid, f"Op has ifm_dtype={ifm_dtype} and ofm_dtype={ofm_dtype}"
Tim Hall79d07d22020-04-27 18:20:16 +0100937
Michael McGeagh65fd9982020-10-20 11:49:28 +0100938 @staticmethod
939 def constraint_inputs_int32(op):
940 "Both Input data types must be int32"
941 ifm_dtype = op.ifm.dtype
942 ifm2_dtype = op.ifm2.dtype
943 valid = (ifm_dtype == DataType.int32) and (ifm2_dtype == DataType.int32)
944 return valid, f"Op has ifm_dtype={ifm_dtype} and ifm2_dtype={ifm2_dtype}"
Tim Hall79d07d22020-04-27 18:20:16 +0100945
Michael McGeagh65fd9982020-10-20 11:49:28 +0100946 @staticmethod
947 def constraint_output_int32(op):
948 "OFM must be int32"
949 ofm_dtype = op.ofm.dtype
950 valid = ofm_dtype == DataType.int32
951 return valid, f"Op has ofm_dtype={ofm_dtype}"
Dwight Lidman42fed942020-05-29 09:37:03 +0200952
Michael McGeagh65fd9982020-10-20 11:49:28 +0100953 @staticmethod
Diqing Zhong189f7482021-01-26 12:12:51 +0100954 def constraint_input_8bit(op):
955 "IFM must be int8 or uint8"
956 ifm_dtype = op.ifm.dtype
957 valid = (ifm_dtype == DataType.int8) or (ifm_dtype == DataType.uint8)
958 return valid, f"Op has ifm_dtype={ifm_dtype}"
959
960 @staticmethod
Michael McGeagh65fd9982020-10-20 11:49:28 +0100961 def constraint_matching_quantization_parameters(op):
962 "Both Input quantization parameters must match OFM quantization parameters"
963 valid = True
964 extra = []
965 if not check_quantized_tens_scaling_equal(op.ofm, op.ifm):
966 valid = False
967 extra.append(op.ifm.name)
Erik Anderssonf27a8b62020-12-10 14:58:23 +0100968 if op.ifm2 is not None and not check_quantized_tens_scaling_equal(op.ofm, op.ifm2):
Michael McGeagh65fd9982020-10-20 11:49:28 +0100969 valid = False
970 extra.append(op.ifm2.name)
971 extra = ", ".join(extra)
972 return valid, f"Op has tensors with different quantization parameters to the OFM '{op.ofm.name}': {extra}"
Dwight Lidman8359a472020-09-28 15:53:40 +0200973
Michael McGeagh65fd9982020-10-20 11:49:28 +0100974 @staticmethod
975 def constraint_elemwise_batch_size(op):
976 "Batch size must be 1 for Input tensors with more than 2 dimensions"
977 valid = True
978 extra = []
979 for tens in (op.ifm, op.ifm2):
980 # Unary ops have ifm2 as None
981 if tens is not None:
982 if (len(tens.shape) > 2) and (tens.shape[0] != 1):
983 valid = False
984 extra.append(tens.name)
985 extra = ", ".join(extra)
986 return valid, f"Op has invalid input tensors: {extra}"
Jacob Bohlin49d92122020-08-19 14:36:46 +0200987
Michael McGeagh65fd9982020-10-20 11:49:28 +0100988 @staticmethod
989 def constraint_matching_either_shapes(op):
990 "At least one Input's shape must match the OFM's shape"
991 ifm_shape = op.ifm.shape
992 ifm2_shape = op.ifm2.shape if op.ifm2 else None
993 ofm_shape = op.ofm.shape
994 valid = (ifm_shape == ofm_shape) or (ifm2_shape == ofm_shape)
995 return valid, f"Op has ifm_shape={ifm_shape}, ifm2_shape={ifm2_shape} and ofm_shape={ofm_shape}"
Andreas Nevalainend8c032d2020-09-11 10:25:09 +0200996
Michael McGeagh65fd9982020-10-20 11:49:28 +0100997 @staticmethod
Andreas Nevalainend059d8b2020-11-19 14:40:35 +0100998 def constraint_broadcast_shapes(op):
999 "Broadcasting is only allowed for rank indices with dimension 1, from either IFM1 or IFM2"
1000 ifm_shape = op.ifm.shape
1001 ifm2_shape = op.ifm2.shape if op.ifm2 else None
1002 ofm_shape = op.ofm.shape
1003 valid = True
1004 if ifm_shape is not None and ifm2_shape is not None:
1005 # align trailing dimensions
1006 size = min(len(ifm_shape), len(ifm2_shape))
1007 for i, i2, o in zip(ifm_shape[-size:], ifm2_shape[-size:], ofm_shape[-size:]):
1008 mi = max(i, i2)
1009 # Input dimensions should match or one should be of dimension 1
1010 # Output dimension should match the largest input dimension, together
1011 # with constraint_match_either_shapes ensures broadcast from only one input
1012 if not (i == i2 or i == 1 or i2 == 1) or o != mi:
1013 valid = False
1014 break
1015
1016 return valid, f"Op has ifm_shape={ifm_shape} and ifm2_shape={ifm2_shape}"
1017
1018 @staticmethod
Michael McGeagh65fd9982020-10-20 11:49:28 +01001019 def constraint_alpha_valid(op):
1020 "Alpha must not be negative"
1021 alpha = op.attrs["alpha"]
1022 valid = alpha >= 0
1023 return valid, f"Op has alpha={alpha}"
erik.andersson@arm.com0cbb1662021-02-22 15:47:07 +01001024
1025 @staticmethod
1026 def constraint_keep_dim_ifm_ofm(op):
1027 "The IFM and OFM must have the same number of dimensions if keep_num_dims is set to true"
1028 valid = True
1029 if op.attrs.get("keep_num_dims"):
1030 valid = len(op.ifm.shape) == len(op.ofm.shape)
1031 return valid, f"Op has ifm shape={op.ifm.shape} and ofm shape={op.ofm.shape}"
Dwight Lidman4f728c02020-12-17 15:14:45 +01001032
Dwight Lidman95b279f2021-03-26 10:53:28 +01001033 @staticmethod
Dwight Lidman4f728c02020-12-17 15:14:45 +01001034 def constraint_mean_input_dims(op):
1035 "Input tensor must be at least 2D"
1036 dims = len(op.inputs[0].shape)
1037 return 2 <= dims <= 4, f"Input is {dims}D"
1038
1039 @staticmethod
1040 def constraint_mean_axis(op):
1041 "Axis indices must correspond to height and width axes"
1042 dims = len(op.inputs[0].shape)
1043 axis = op.inputs[1].values if op.inputs[1].shape == [] else list(op.inputs[1].values)
1044 if dims == 2 or dims == 3:
1045 valid = axis in (0, 1, [0, 1], [1, 0])
1046 elif dims == 4:
1047 valid = axis in (1, 2, [1, 2], [2, 1])
1048 return valid, f"Axis is {axis}"
1049
1050 @classmethod
Dwight Lidman95b279f2021-03-26 10:53:28 +01001051 @docstring_format_args([mean_kernel_product_avgpool])
1052 def constraint_mean_height_width_product_avgpool(cls, op):
1053 """Product of height and width can be at most {}"""
1054 shape = op.inputs[0].shape
1055 hi = 0 if len(shape) < 4 else 1
1056 h, w = shape[hi : hi + 2]
1057 max_prod = cls.mean_kernel_product_avgpool
1058 return h * w <= max_prod, f"Product of height and width is {h * w}"
1059
1060 @classmethod
Dwight Lidman4f728c02020-12-17 15:14:45 +01001061 @docstring_format_args([mean_kernel_product])
1062 def constraint_mean_height_width_product(cls, op):
Dwight Lidman95b279f2021-03-26 10:53:28 +01001063 """Product of height and width can be at most {} when IFM and OFM have different scale or zero point,
1064 or keep_dims is True"""
1065 ifmq, ofmq = op.ifm.quantization, op.ofm.quantization
1066 keep_dims = op.attrs.get("keep_dims")
1067 # doesn't apply, size is checked by constraint_mean_height_width_product_avgpool
1068 if not keep_dims and ifmq.scale_f32 == ofmq.scale_f32 and ifmq.zero_point == ofmq.zero_point:
1069 return True, ""
Dwight Lidman4f728c02020-12-17 15:14:45 +01001070 shape = op.inputs[0].shape
1071 hi = 0 if len(shape) < 4 else 1
1072 h, w = shape[hi : hi + 2]
1073 max_prod = cls.mean_kernel_product
1074 return h * w <= max_prod, f"Product of height and width is {h * w}"
1075
1076 @classmethod
1077 @docstring_format_args([mean_kernel_product_int8])
1078 def constraint_mean_height_width_product_int8(cls, op):
1079 """Product of IFM height and width can be at most {} when the following are true:
1080 IFM dimensions are 4,
1081 Axis indices are 1 and 2,
1082 keep_dims is set to True and
1083 IFM datatype is int8"""
1084 shape = op.ifm.shape
1085 axis = op.inputs[1].values if op.inputs[1].shape == [] else list(op.inputs[1].values)
Dwight Lidman95b279f2021-03-26 10:53:28 +01001086 # doesn't apply, size is checked by constraint_mean_height_width_product_avgpool
1087 # and constraint_mean_height_width_product
Dwight Lidman4f728c02020-12-17 15:14:45 +01001088 if (
1089 len(shape) != 4
1090 or op.ifm.dtype != DataType.int8
1091 or not op.attrs.get("keep_dims")
1092 or axis not in ([1, 2], [2, 1])
1093 ):
1094 return True, ""
1095 hi = 0 if len(shape) < 4 else 1
1096 h, w = shape[hi : hi + 2]
1097 max_prod = cls.mean_kernel_product_int8
1098 return h * w <= max_prod, f"Product of height and width is {h * w}"