Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 1 | # Copyright (C) 2021 Arm Limited or its affiliates. All rights reserved. |
| 2 | # |
| 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 TosaSupportedOperators class which is a collection of all supported operators and parameter checks. |
| 18 | from collections import defaultdict |
| 19 | |
| 20 | from .data_type import DataType |
| 21 | from .operation import Op |
| 22 | from .supported_operators_util import docstring_format_args |
| 23 | from .supported_operators_util import list_formatter |
| 24 | from .tosa_mapping import optype_to_tosa_op_type |
| 25 | |
| 26 | |
| 27 | class TosaSupportedOperators: |
| 28 | # TODO currently sparsely populated |
| 29 | # Categorised lists of supported operators |
| 30 | convolution_ops = set((Op.Conv2DBias,)) |
Patrik Gustavsson | df99510 | 2021-08-23 15:33:59 +0200 | [diff] [blame] | 31 | depthwise_convolution_ops = set((Op.DepthwiseConv2DBias,)) |
| 32 | convolution_like_ops = convolution_ops | depthwise_convolution_ops |
| 33 | |
| 34 | # TODO depending on what will be committed |
Patrik Gustavsson | c74682c | 2021-08-17 14:26:38 +0200 | [diff] [blame] | 35 | max_pooling_ops = Op.op_set(Op.is_maxpool_op) |
| 36 | avg_pooling_ops = Op.op_set(Op.is_avgpool_op) |
Patrik Gustavsson | df99510 | 2021-08-23 15:33:59 +0200 | [diff] [blame] | 37 | pooling_ops = max_pooling_ops | avg_pooling_ops |
| 38 | fc_vector_products = set((Op.FullyConnected,)) |
Patrik Gustavsson | c74682c | 2021-08-17 14:26:38 +0200 | [diff] [blame] | 39 | |
Patrik Gustavsson | df99510 | 2021-08-23 15:33:59 +0200 | [diff] [blame] | 40 | mac_main_ops = convolution_like_ops | pooling_ops | fc_vector_products |
Patrik Gustavsson | f1580f0 | 2021-09-01 12:43:02 +0200 | [diff] [blame] | 41 | memory_only_ops = set((Op.Reshape, Op.Transpose, Op.Concat, Op.SplitSliceRead,)) |
Patrik Gustavsson | b081d67 | 2021-08-25 13:49:25 +0200 | [diff] [blame] | 42 | binary_elem_wise_add_mul_sub = set((Op.Add, Op.Mul, Op.RescaleMul, Op.Sub,)) |
Patrik Gustavsson | 46408a8 | 2021-09-20 10:47:47 +0200 | [diff] [blame] | 43 | elem_wise_ops = binary_elem_wise_add_mul_sub |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 44 | type_conversion_ops = set((Op.Rescale,)) |
Patrik Gustavsson | 5e26eda | 2021-06-30 09:07:16 +0200 | [diff] [blame] | 45 | relu_ops = set((Op.Clamp, Op.ReluN,)) |
Patrik Gustavsson | f436ada | 2021-09-14 14:56:48 +0200 | [diff] [blame] | 46 | activation_ops = relu_ops | set((Op.Table,)) |
Patrik Gustavsson | e2bfa7e | 2021-09-08 15:04:11 +0200 | [diff] [blame] | 47 | pad_ops = set((Op.Pad,)) |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 48 | |
Patrik Gustavsson | b4936ad | 2021-10-05 13:53:34 +0200 | [diff] [blame] | 49 | rank_unlimited_ops = set((Op.Concat, Op.Reshape, Op.Identity, Op.Pad)) |
Patrik Gustavsson | c2b129d | 2021-09-23 13:52:34 +0200 | [diff] [blame] | 50 | rank6_limited_ops = elem_wise_ops |
Patrik Gustavsson | 008cd10 | 2021-09-24 13:46:42 +0200 | [diff] [blame] | 51 | batch_enabled_ops = rank6_limited_ops | rank_unlimited_ops |
| 52 | large_tens_dims_enabled_ops = batch_enabled_ops | set((Op.SplitSliceRead,)) |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 53 | npu_post_ops = activation_ops |
Patrik Gustavsson | 46408a8 | 2021-09-20 10:47:47 +0200 | [diff] [blame] | 54 | |
Patrik Gustavsson | ef3ebdd | 2021-10-01 11:10:25 +0200 | [diff] [blame] | 55 | supported_operators = ( |
| 56 | mac_main_ops |
| 57 | | type_conversion_ops |
| 58 | | npu_post_ops |
| 59 | | memory_only_ops |
| 60 | | elem_wise_ops |
| 61 | | pad_ops |
| 62 | | set((Op.Identity,)) |
| 63 | ) |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 64 | |
| 65 | # Supported data types |
| 66 | # TODO will differ compared to TensorFlow Lite, currently set to the same |
Patrik Gustavsson | f1580f0 | 2021-09-01 12:43:02 +0200 | [diff] [blame] | 67 | supported_op_dtypes = set((DataType.uint8, DataType.int8, DataType.int16, DataType.int32)) # TODO add bool |
Patrik Gustavsson | f366fb1 | 2021-09-07 13:30:29 +0200 | [diff] [blame] | 68 | tens_dim_range = (1, 65535) # TODO HW limitation, that is to be resolved in SW |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 69 | |
| 70 | def __init__(self): |
| 71 | # Setup the generic constraints. Note: the order matters |
| 72 | self.generic_constraints = [] |
| 73 | self.generic_constraints.append(TosaSupportedOperators.constraint_tens_dtype) |
Patrik Gustavsson | 008cd10 | 2021-09-24 13:46:42 +0200 | [diff] [blame] | 74 | self.generic_constraints.append(TosaSupportedOperators.constraint_tens_dimension) # TODO not supported yet |
| 75 | self.generic_constraints.append(TosaSupportedOperators.constraint_rank) # TODO not supported for all ops yet |
| 76 | self.generic_constraints.append(TosaSupportedOperators.constraint_batch) # TODO not supported for all ops yet |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 77 | |
| 78 | # Setup specific constraints. Note: the order matters |
| 79 | self.specific_constraints = defaultdict(list) |
| 80 | |
Patrik Gustavsson | df99510 | 2021-08-23 15:33:59 +0200 | [diff] [blame] | 81 | self.specific_constraints[Op.Transpose].append(TosaSupportedOperators.constraint_ifm_producer) |
Patrik Gustavsson | e2bfa7e | 2021-09-08 15:04:11 +0200 | [diff] [blame] | 82 | self.specific_constraints[Op.Pad].append(TosaSupportedOperators.constraint_padding_producer) |
Patrik Gustavsson | f436ada | 2021-09-14 14:56:48 +0200 | [diff] [blame] | 83 | self.specific_constraints[Op.Table].append(TosaSupportedOperators.constraint_table_dtype) |
| 84 | self.specific_constraints[Op.Table].append(TosaSupportedOperators.constraint_table_producer) |
Patrik Gustavsson | df99510 | 2021-08-23 15:33:59 +0200 | [diff] [blame] | 85 | |
| 86 | # Depthwise Conv specific checks: |
| 87 | for op_type in TosaSupportedOperators.depthwise_convolution_ops: |
| 88 | self.specific_constraints[op_type].append(TosaSupportedOperators.constraint_depth_multiplier) |
| 89 | |
Patrik Gustavsson | f366fb1 | 2021-09-07 13:30:29 +0200 | [diff] [blame] | 90 | # Avgpool specific checks |
| 91 | for op_type in TosaSupportedOperators.avg_pooling_ops: |
| 92 | self.specific_constraints[op_type].append(TosaSupportedOperators.constraint_padding) |
| 93 | |
Patrik Gustavsson | 8f1f9aa | 2021-06-28 07:41:58 +0200 | [diff] [blame] | 94 | def is_operator_supported(self, op): |
| 95 | ext_type = optype_to_tosa_op_type(op.type) |
| 96 | if op.type not in TosaSupportedOperators.supported_operators: |
| 97 | if op.type not in (Op.Placeholder, Op.SubgraphInput, Op.Const): |
| 98 | print(f"Info: {ext_type} '{op.name}' is not a NPU op") |
| 99 | return False |
| 100 | |
| 101 | for constraint in self.generic_constraints + self.specific_constraints[op.type]: |
| 102 | valid, extra = constraint(op) |
| 103 | if not valid: |
| 104 | print(f"Warning: {ext_type} '{op.name}' is not supported on the NPU") |
| 105 | print(f" - {constraint.__doc__}") |
| 106 | if extra: |
| 107 | print(f" {extra}") |
| 108 | return False |
| 109 | |
| 110 | return True |
| 111 | |
| 112 | # TODO this function is the same for TensorFlow Lite, but input might differ |
| 113 | @classmethod |
| 114 | @docstring_format_args([list_formatter(supported_op_dtypes)]) |
| 115 | def constraint_tens_dtype(cls, op): |
| 116 | "Tensors must be of type: {}" |
| 117 | valid = True |
| 118 | extra = [] |
| 119 | tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens] |
| 120 | if not tensors: |
| 121 | tensors = [tens for tens in op.inputs if tens] |
| 122 | for tens in tensors: |
| 123 | if tens.dtype not in cls.supported_op_dtypes: |
| 124 | valid = False |
| 125 | extra.append(f"Tensor '{tens.name}' has data type: {tens.dtype}") |
| 126 | return valid, ", ".join(extra) |
Patrik Gustavsson | df99510 | 2021-08-23 15:33:59 +0200 | [diff] [blame] | 127 | |
Patrik Gustavsson | f366fb1 | 2021-09-07 13:30:29 +0200 | [diff] [blame] | 128 | # TODO Duplicates check present for TFLite. But it is only temporarily added |
| 129 | # This is for a HW limitation, that is to be resolved in SW later on |
| 130 | @classmethod |
| 131 | @docstring_format_args(tens_dim_range) |
Patrik Gustavsson | 3f22ec2 | 2021-09-21 14:18:44 +0200 | [diff] [blame] | 132 | def constraint_tens_dimension(self, op): |
Patrik Gustavsson | c2b129d | 2021-09-23 13:52:34 +0200 | [diff] [blame] | 133 | "Tensor dimensions must be in the range [{}, {}]" |
Patrik Gustavsson | 3f22ec2 | 2021-09-21 14:18:44 +0200 | [diff] [blame] | 134 | tens_min, tens_max = self.tens_dim_range |
Patrik Gustavsson | f366fb1 | 2021-09-07 13:30:29 +0200 | [diff] [blame] | 135 | valid = True |
| 136 | extra = [] |
Patrik Gustavsson | c2b129d | 2021-09-23 13:52:34 +0200 | [diff] [blame] | 137 | if op.type not in self.large_tens_dims_enabled_ops: |
Patrik Gustavsson | 3f22ec2 | 2021-09-21 14:18:44 +0200 | [diff] [blame] | 138 | tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens] |
| 139 | if not tensors: |
| 140 | tensors = [tens for tens in op.inputs if tens] |
| 141 | for tens in tensors: |
| 142 | if not all(tens_min <= dim <= tens_max for dim in tens.shape): |
| 143 | valid = False |
| 144 | extra.append(f"Tensor '{tens.name}' has shape: {tens.shape}") |
Patrik Gustavsson | f366fb1 | 2021-09-07 13:30:29 +0200 | [diff] [blame] | 145 | return valid, ", ".join(extra) |
| 146 | |
Patrik Gustavsson | e2bfa7e | 2021-09-08 15:04:11 +0200 | [diff] [blame] | 147 | # TODO This is for a HW limitation, that is to be resolved in SW later on |
Patrik Gustavsson | 46408a8 | 2021-09-20 10:47:47 +0200 | [diff] [blame] | 148 | @classmethod |
| 149 | def constraint_rank(self, op): |
Patrik Gustavsson | c2b129d | 2021-09-23 13:52:34 +0200 | [diff] [blame] | 150 | "Tensor rank must be <= 6 or <= 4 depending on operator" |
Patrik Gustavsson | e2bfa7e | 2021-09-08 15:04:11 +0200 | [diff] [blame] | 151 | valid = True |
| 152 | extra = [] |
Patrik Gustavsson | c2b129d | 2021-09-23 13:52:34 +0200 | [diff] [blame] | 153 | if op.type not in self.rank_unlimited_ops: |
| 154 | if op.type in self.rank6_limited_ops: |
| 155 | rank_limit = 6 |
| 156 | else: |
| 157 | rank_limit = 4 |
Patrik Gustavsson | 46408a8 | 2021-09-20 10:47:47 +0200 | [diff] [blame] | 158 | tensors = [tens for tens in op.get_ifm_ifm2_weights_ofm() if tens] |
| 159 | if not tensors: |
| 160 | tensors = [tens for tens in op.inputs if tens] |
| 161 | for tens in tensors: |
| 162 | rank = len(tens.shape) |
Patrik Gustavsson | c2b129d | 2021-09-23 13:52:34 +0200 | [diff] [blame] | 163 | if not rank <= rank_limit: |
Patrik Gustavsson | 46408a8 | 2021-09-20 10:47:47 +0200 | [diff] [blame] | 164 | valid = False |
Patrik Gustavsson | 008cd10 | 2021-09-24 13:46:42 +0200 | [diff] [blame] | 165 | extra.append( |
| 166 | f"Tensor '{tens.name}' has rank: {rank}, rank limit is currently {rank_limit}" |
| 167 | f" for op of type {op.type}" |
| 168 | ) |
Patrik Gustavsson | e2bfa7e | 2021-09-08 15:04:11 +0200 | [diff] [blame] | 169 | return valid, ", ".join(extra) |
| 170 | |
| 171 | # TODO This is for a HW limitation, that is to be resolved in SW later on |
Patrik Gustavsson | 46408a8 | 2021-09-20 10:47:47 +0200 | [diff] [blame] | 172 | @classmethod |
| 173 | def constraint_batch(self, op): |
Patrik Gustavsson | c2b129d | 2021-09-23 13:52:34 +0200 | [diff] [blame] | 174 | "If Tensor rank is 4 batch of ifms/ofm must be 1" |
Patrik Gustavsson | e2bfa7e | 2021-09-08 15:04:11 +0200 | [diff] [blame] | 175 | valid = True |
| 176 | extra = [] |
Patrik Gustavsson | c2b129d | 2021-09-23 13:52:34 +0200 | [diff] [blame] | 177 | if op.type not in self.batch_enabled_ops: |
Patrik Gustavsson | 46408a8 | 2021-09-20 10:47:47 +0200 | [diff] [blame] | 178 | tensors = [tens for tens in op.get_ifm_ifm2_ofm() if tens] |
| 179 | if not tensors: |
| 180 | tensors = [tens for tens in op.inputs if tens] |
| 181 | for tens in tensors: |
| 182 | rank = len(tens.shape) |
| 183 | if rank == 4 and tens.shape[0] != 1: |
| 184 | valid = False |
| 185 | extra.append(f"Tensor '{tens.name}' has rank: 4 and N: {tens.shape[0]}") |
Patrik Gustavsson | e2bfa7e | 2021-09-08 15:04:11 +0200 | [diff] [blame] | 186 | return valid, ", ".join(extra) |
| 187 | |
Patrik Gustavsson | df99510 | 2021-08-23 15:33:59 +0200 | [diff] [blame] | 188 | @staticmethod |
| 189 | def constraint_ifm_producer(cls, op): |
| 190 | "Input must be constant data" |
| 191 | valid = op.ifm.ops and op.ifm.ops[0].type == Op.Const |
| 192 | return valid, "Op has ifm with non-constant data" |
| 193 | |
Patrik Gustavsson | f366fb1 | 2021-09-07 13:30:29 +0200 | [diff] [blame] | 194 | @staticmethod |
| 195 | def constraint_padding(op): |
| 196 | # TODO Only support for when global scaling can be used. |
| 197 | # That is when there is padding no padding |
| 198 | "Avgpool only supported for no padding" |
| 199 | top, left, _, _ = op.attrs["explicit_padding"] |
| 200 | valid = top == 0 and left == 0 |
| 201 | |
| 202 | return valid, "Avgpool with pad_top {top} and pad_left {left}" |
| 203 | |
Patrik Gustavsson | e2bfa7e | 2021-09-08 15:04:11 +0200 | [diff] [blame] | 204 | # TODO limit padding to be const data for now. |
| 205 | # For TFLite it is assumed to be constant. |
| 206 | @staticmethod |
| 207 | def constraint_padding_producer(op): |
| 208 | "Input must be constant data" |
| 209 | valid = op.inputs[1].ops and op.inputs[1].ops[0].type == Op.Const |
| 210 | return valid, "PAD Op with non-constant data padding" |
| 211 | |
Patrik Gustavsson | f366fb1 | 2021-09-07 13:30:29 +0200 | [diff] [blame] | 212 | # TODO duplicates tflite_supported operators, but support for depth multiplier should be added at a later stage |
Patrik Gustavsson | df99510 | 2021-08-23 15:33:59 +0200 | [diff] [blame] | 213 | @staticmethod |
| 214 | def constraint_depth_multiplier(op): |
| 215 | "For depth multipliers > 1, IFM channels must be 1 and OFM channels must be equal to the depth multiplier" |
| 216 | depth_multiplier = op.attrs.get("depth_multiplier", 1) |
| 217 | if depth_multiplier > 1: |
| 218 | ifm_channels = op.ifm.shape[3] |
| 219 | ofm_channels = op.ofm.shape[3] |
| 220 | valid = (ifm_channels == 1) and (ofm_channels == depth_multiplier) |
| 221 | extra = ( |
| 222 | f"Op has ifm_channels={ifm_channels}, ofm_channels={ofm_channels}" |
| 223 | f" and depth_multiplier={depth_multiplier}" |
| 224 | ) |
| 225 | return valid, extra |
| 226 | return True, "Op has depth_multiplier=1" |
Patrik Gustavsson | f436ada | 2021-09-14 14:56:48 +0200 | [diff] [blame] | 227 | |
| 228 | # TODO Table operator support limited to int8 for now. |
| 229 | # For TFLite it is assumed to be constant. |
| 230 | @staticmethod |
| 231 | def constraint_table_dtype(op): |
| 232 | "Only supported is int8" |
| 233 | valid = True |
| 234 | tensors = [op.ifm, op.ofm, op.inputs[1]] |
| 235 | for tens in tensors: |
| 236 | if tens.dtype != DataType.int8: |
| 237 | valid = False |
| 238 | return valid, "Table operator with non int8 tensor" |
| 239 | |
| 240 | # TODO limit table to be constant data for now. |
| 241 | # Can it be non-constant? |
| 242 | @staticmethod |
| 243 | def constraint_table_producer(op): |
| 244 | "Input must be constant data" |
| 245 | valid = op.inputs[1].ops and op.inputs[1].ops[0].type == Op.Const |
| 246 | return valid, "Table Op with non-constant table input" |