blob: 16431be79d070537f9da9858e936d2ae859a0ed6 [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# Internal representation of a Neural Network Operation.
Louis Verhaarde8a5a782020-11-02 18:04:27 +010018import copy
Louis Verhaardaee5d752020-09-30 09:01:52 +020019from collections import namedtuple
20from enum import Enum
Dwight Lidman9b43f842020-12-08 17:56:44 +010021from typing import Any
22from typing import Dict
23from typing import List
Louis Verhaarde8a5a782020-11-02 18:04:27 +010024from typing import Optional
Louis Verhaardebf4af62021-01-27 15:57:57 +010025from typing import Tuple
Dwight Lidman9b43f842020-12-08 17:56:44 +010026from typing import TYPE_CHECKING
Tim Hall79d07d22020-04-27 18:20:16 +010027
Michael McGeagh528a56d2020-12-16 11:33:21 +000028from .errors import VelaError
Tim Hall4ed38bc2020-10-20 18:54:20 +010029from .numeric_util import full_shape
patrik.gustavssoneeb85152020-12-21 17:10:40 +000030from .shape4d import Shape4D
Tim Hall4ed38bc2020-10-20 18:54:20 +010031
Patrik Gustavsson2349d422020-12-01 16:02:29 +010032
Dwight Lidman9b43f842020-12-08 17:56:44 +010033if TYPE_CHECKING:
34 from .tensor import Tensor
35
Tim Hall4ed38bc2020-10-20 18:54:20 +010036PointXY = namedtuple("PointXY", "x y")
37PointXYZ = namedtuple("PointXYZ", "x y z")
38
Tim Hall79d07d22020-04-27 18:20:16 +010039
Louis Verhaardaee5d752020-09-30 09:01:52 +020040class NpuBlockType(Enum):
Tim Hall79d07d22020-04-27 18:20:16 +010041 Default = 0
42 ConvolutionMxN = 1
43 VectorProduct = 2
44 Pooling = 3
45 ConvolutionDepthWise = 4
46 ElementWise = 5
Fredrik Svedberga0c36242020-06-03 15:43:31 +020047 ReduceSum = 6
Tim Hall79d07d22020-04-27 18:20:16 +010048
49
Tim Hall4ed38bc2020-10-20 18:54:20 +010050class Kernel:
Louis Verhaarde8a5a782020-11-02 18:04:27 +010051 """
52 Kernel information for NPU operations
53 """
54
55 def __init__(self, w: int, h: int, stride_x: int = 1, stride_y: int = 1, dilation_x: int = 1, dilation_y: int = 1):
56 assert stride_x > 0 and stride_y > 0
57 assert dilation_x > 0 and dilation_y > 0
Tim Hall4ed38bc2020-10-20 18:54:20 +010058 self.width = w
59 self.height = h
Louis Verhaarde8a5a782020-11-02 18:04:27 +010060 self.stride = PointXY(stride_x, stride_y)
61 self.dilation = PointXY(dilation_x, dilation_y)
Tim Hall4ed38bc2020-10-20 18:54:20 +010062
Louis Verhaarde8a5a782020-11-02 18:04:27 +010063 def elements_wh(self) -> int:
Tim Hall4ed38bc2020-10-20 18:54:20 +010064 return self.width * self.height
65
Louis Verhaarde8a5a782020-11-02 18:04:27 +010066 def area_width(self) -> int:
Tim Hall4ed38bc2020-10-20 18:54:20 +010067 return (self.width - 1) * self.dilation.x + 1
68
Louis Verhaarde8a5a782020-11-02 18:04:27 +010069 def area_height(self) -> int:
Tim Hall4ed38bc2020-10-20 18:54:20 +010070 return (self.height - 1) * self.dilation.y + 1
71
Louis Verhaardebf4af62021-01-27 15:57:57 +010072 def dilated_wh(self) -> Tuple[int, int]:
73 """Returns the dilated kernel width/height"""
74 return self.dilation.x * (self.width - 1) + 1, self.dilation.y * (self.height - 1) + 1
75
Louis Verhaarde8a5a782020-11-02 18:04:27 +010076 def __str__(self):
77 return f"w={self.width}, h={self.height}, stride={tuple(self.stride)}, dilation={tuple(self.dilation)}"
78
Tim Hall4ed38bc2020-10-20 18:54:20 +010079
Louis Verhaardaee5d752020-09-30 09:01:52 +020080# Classifies operators of type Custom
81class CustomType(Enum):
82 ThirdPartyOp = 0 # Third party custom op
83 NpuOp = 1 # NPU op
84 ExistingNpuOp = 2 # NPU op that was part of the input network
85
86
87TensorIndices = namedtuple("TensorIndices", ["ifms", "weights", "biases"])
88
89NO_INDICES = TensorIndices([], [], [])
90IFM_INDICES = TensorIndices([0], [], [])
91IFM_WEIGHTS_INDICES = TensorIndices([0], [1], [])
92IFM_WEIGHTS_BIAS_INDICES = TensorIndices([0], [1], [2])
93IFM_IFM2_INDICES = TensorIndices([0, 1], [], [])
94CONV2D_BACKPROP_INDICES = TensorIndices([2], [1], [3])
95TRANSPOSE_CONV_INDICES = TensorIndices([0], [1], [3])
96CONCAT_INDICES = TensorIndices([1, 2], [], [])
97SPLIT_IFM_INDICES = TensorIndices([1], [], [])
98BLOCK_LSTM_INDICES = TensorIndices([3], [4], [])
99
100
101# Static information related to operation codes
102class OperatorInfo:
103 __slots__ = ("id", "block_type", "indices", "is_unary")
104 _id = 0
105
106 def __init__(self, block_type=NpuBlockType.Default, indices=NO_INDICES, is_unary=False):
107 OperatorInfo._id += 1
108 self.id = OperatorInfo._id
109 self.block_type = block_type
110 self.indices = indices # Indices of the different tensor purposes
111 self.is_unary = is_unary # Classifies elementwise operators
112
113
114# Internally used operation codes
115class Op(Enum):
116 Abs = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_INDICES, is_unary=True)
117 Add = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_IFM2_INDICES)
118 AddN = OperatorInfo()
119 Any = OperatorInfo()
120 ArgMax = OperatorInfo()
121 ArgMin = OperatorInfo()
122 AvgPool = OperatorInfo(block_type=NpuBlockType.Pooling, indices=IFM_INDICES)
123 BatchMatMul = OperatorInfo()
124 BatchToSpaceND = OperatorInfo()
125 BidirectionalSequenceLstm = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_INDICES)
126 BidirectionalSequenceRnn = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_INDICES)
127 BlockLSTM = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=BLOCK_LSTM_INDICES)
128
129 CLZ = OperatorInfo(
130 block_type=NpuBlockType.ElementWise, indices=IFM_INDICES, is_unary=True
131 ) # NPU specific operation
132 Call = OperatorInfo()
133 Cast = OperatorInfo()
134 Ceil = OperatorInfo()
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100135 Clip = OperatorInfo() # NPU specific fused activation function for clipping between activation.min/max
Louis Verhaardaee5d752020-09-30 09:01:52 +0200136 Concat = OperatorInfo(indices=CONCAT_INDICES)
137 ConcatEmbeddings = OperatorInfo()
138 ConcatSliceWrite = OperatorInfo(indices=IFM_INDICES)
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100139 ConcatTFLite = OperatorInfo(indices=CONCAT_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200140 Const = OperatorInfo() # Constant tensor, only used in CPU subgraphs
141 Conv2D = OperatorInfo(block_type=NpuBlockType.ConvolutionMxN, indices=IFM_WEIGHTS_INDICES)
142 Conv2DBackpropInput = OperatorInfo(block_type=NpuBlockType.ConvolutionMxN, indices=CONV2D_BACKPROP_INDICES)
143 Conv2DBackpropInputSwitchedBias = OperatorInfo(
144 block_type=NpuBlockType.ConvolutionMxN, indices=TRANSPOSE_CONV_INDICES
145 )
146 Conv2DBias = OperatorInfo(block_type=NpuBlockType.ConvolutionMxN, indices=IFM_WEIGHTS_BIAS_INDICES)
147 Cos = OperatorInfo()
Tim Hall42abec12021-02-04 21:31:57 +0000148 Cumsum = OperatorInfo()
Louis Verhaardaee5d752020-09-30 09:01:52 +0200149 Custom = OperatorInfo() # Custom 3rd party operator, only used in CPU subgraphs
150 CustomNpuOp = OperatorInfo() # NPU custom operator, only used in CPU subgraphs
151 DMA = OperatorInfo()
152 Delegate = OperatorInfo()
153 Densify = OperatorInfo()
154 DepthToSpace = OperatorInfo()
155 DepthwiseConv2DBias = OperatorInfo(block_type=NpuBlockType.ConvolutionDepthWise, indices=IFM_WEIGHTS_BIAS_INDICES)
Louis Verhaard04f8c002020-10-09 11:40:21 +0200156 Dequantize = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200157 Div = OperatorInfo()
158 Elu = OperatorInfo()
159 EmbeddingLookup = OperatorInfo()
160 EmbeddingLookupSparse = OperatorInfo()
161 Equal = OperatorInfo()
162 Exp = OperatorInfo()
163 ExpandDims = OperatorInfo(indices=IFM_INDICES)
164 FakeQuantWithMinMaxArgs = OperatorInfo()
165 Fill = OperatorInfo()
166 Floor = OperatorInfo()
167 FloorDiv = OperatorInfo()
168 FloorMod = OperatorInfo()
169 FullyConnected = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_BIAS_INDICES)
170 GatherNd = OperatorInfo()
171 GatherV2 = OperatorInfo()
172 Greater = OperatorInfo()
173 GreaterEqual = OperatorInfo()
Diqing Zhong189f7482021-01-26 12:12:51 +0100174 HardSwish = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200175 HashtableLookup = OperatorInfo()
176 Identity = OperatorInfo()
177 If = OperatorInfo()
178 L2Norm = OperatorInfo()
179 L2Pool2D = OperatorInfo()
180 LRN = OperatorInfo()
181 LSHProjection = OperatorInfo()
182 LeakyRelu = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_INDICES, is_unary=True)
183 Less = OperatorInfo()
184 LessEqual = OperatorInfo()
185 Log = OperatorInfo()
186 LogSoftmax = OperatorInfo()
187 LogicalAnd = OperatorInfo()
188 LogicalNot = OperatorInfo()
189 LogicalOr = OperatorInfo()
190 Lstm = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_INDICES)
191 LUT = OperatorInfo() # NPU specific, operator has LUT, only used in fused activation functions
192 MatMul = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_INDICES)
193 MatrixDiag = OperatorInfo()
194 MatrixSetDiag = OperatorInfo()
195 Max = OperatorInfo()
196 MaxPool = OperatorInfo(block_type=NpuBlockType.Pooling, indices=IFM_INDICES)
197 Maximum = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_IFM2_INDICES)
198 Mean = OperatorInfo()
199 Min = OperatorInfo()
200 Minimum = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_IFM2_INDICES)
201 MirrorPad = OperatorInfo()
202 Mul = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_IFM2_INDICES)
203 Neg = OperatorInfo()
204 NonMaxSuppressionV4 = OperatorInfo()
205 NonMaxSuppressionV5 = OperatorInfo()
206 NotEqual = OperatorInfo()
207 OneHot = OperatorInfo()
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100208 Pack = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200209 PackReshaped = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardae2d5532020-12-11 17:19:54 +0100210 Pad = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200211 PadV2 = OperatorInfo()
212 Placeholder = OperatorInfo() # Only used in CPU subgraphs
213 Pow = OperatorInfo()
214 Prelu = OperatorInfo()
215 Prod = OperatorInfo()
Louis Verhaard04f8c002020-10-09 11:40:21 +0200216 Quantize = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200217 QuantizedAvgPool = OperatorInfo(block_type=NpuBlockType.Pooling, indices=IFM_INDICES)
218 QuantizedConv2D = OperatorInfo(block_type=NpuBlockType.ConvolutionMxN, indices=IFM_WEIGHTS_INDICES)
219 QuantizedMatMul = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_INDICES)
220 QuantizedMaxPool = OperatorInfo(block_type=NpuBlockType.Pooling, indices=IFM_INDICES)
221 QuantizedReshape = OperatorInfo(indices=IFM_INDICES)
222 Range = OperatorInfo()
223 Rank = OperatorInfo()
224 ReduceSum = OperatorInfo(block_type=NpuBlockType.ReduceSum, indices=IFM_INDICES)
225 Relu = OperatorInfo(indices=IFM_INDICES)
226 Relu6 = OperatorInfo(indices=IFM_INDICES)
227 ReluN1To1 = OperatorInfo(indices=IFM_INDICES)
Fredrik Svedberge82be7c2021-01-18 15:21:03 +0100228 RescaleAdd = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_IFM2_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200229 Reshape = OperatorInfo(indices=IFM_INDICES)
230 ResizeBilinear = OperatorInfo(block_type=NpuBlockType.Pooling, indices=IFM_INDICES)
231 ResizeNearestNeighbor = OperatorInfo()
232 ReverseSequence = OperatorInfo()
233 ReverseV2 = OperatorInfo()
234 Rnn = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_INDICES)
235 Round = OperatorInfo()
236 Rsqrt = OperatorInfo()
237 SHL = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_IFM2_INDICES) # NPU specific operation
238 SHR = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_IFM2_INDICES) # NPU specific operation
239 ScatterNd = OperatorInfo()
240 SegmentSum = OperatorInfo()
241 Select = OperatorInfo()
242 SelectV2 = OperatorInfo()
243 Shape = OperatorInfo()
244 Sigmoid = OperatorInfo(indices=IFM_INDICES)
245 SignBit = OperatorInfo()
246 Sin = OperatorInfo()
247 SkipGram = OperatorInfo()
248 Slice = OperatorInfo(indices=IFM_INDICES)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100249 Softmax = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200250 SpaceToBatchND = OperatorInfo()
251 SpaceToDepth = OperatorInfo()
252 SparseToDense = OperatorInfo()
253 Split = OperatorInfo(indices=SPLIT_IFM_INDICES)
254 SplitSliceRead = OperatorInfo(indices=IFM_INDICES)
Jacob Bohline3de4e52020-11-27 14:52:06 +0100255 SplitV = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200256 Sqrt = OperatorInfo()
257 Square = OperatorInfo()
258 SquaredDifference = OperatorInfo()
259 Squeeze = OperatorInfo(indices=IFM_INDICES)
260 StridedSlice = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200261 Sub = OperatorInfo(block_type=NpuBlockType.ElementWise, indices=IFM_IFM2_INDICES)
262 SubgraphInput = OperatorInfo() # Only used in CPU subgraphs
263 Sum = OperatorInfo()
264 Svdf = OperatorInfo()
265 Tanh = OperatorInfo(indices=IFM_INDICES)
266 Tile = OperatorInfo()
267 TopKV2 = OperatorInfo()
268 Transpose = OperatorInfo()
269 UnidirectionalSequenceLstm = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_INDICES)
270 UnidirectionalSequenceRnn = OperatorInfo(block_type=NpuBlockType.VectorProduct, indices=IFM_WEIGHTS_INDICES)
271 Unique = OperatorInfo()
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100272 Unpack = OperatorInfo(indices=IFM_INDICES)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200273 UnpackReshaped = OperatorInfo(indices=IFM_INDICES)
274 Where = OperatorInfo()
275 While = OperatorInfo()
276 ZerosLike = OperatorInfo()
277
278 @property
279 def info(self):
280 return self.value
281
282 @property
283 def npu_block_type(self):
284 return self.info.block_type
285
286 def is_conv2d_op(self):
287 return self.info.block_type == NpuBlockType.ConvolutionMxN
288
289 def is_depthwise_conv2d_op(self):
290 return self.info.block_type == NpuBlockType.ConvolutionDepthWise
291
292 def is_pool_op(self):
293 return self.info.block_type == NpuBlockType.Pooling
294
295 def is_maxpool_op(self):
296 return self in (Op.MaxPool, Op.QuantizedMaxPool)
297
298 def is_avgpool_op(self):
299 return self in (Op.QuantizedAvgPool, Op.AvgPool)
300
301 def is_elementwise_op(self):
302 return self.info.block_type == NpuBlockType.ElementWise
303
304 def is_unary_elementwise_op(self):
305 return self.info.block_type == NpuBlockType.ElementWise and self.info.is_unary
306
307 def is_binary_elementwise_op(self):
308 return self.info.block_type == NpuBlockType.ElementWise and not self.info.is_unary
309
310 def is_relu_op(self):
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100311 return self in (Op.Relu, Op.Relu6, Op.ReluN1To1, Op.Clip)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200312
313 def is_activation_op(self):
Diqing Zhong189f7482021-01-26 12:12:51 +0100314 return self.is_relu_op() or self in (Op.Tanh, Op.Sigmoid, Op.Softmax, Op.LUT, Op.HardSwish)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200315
316 def is_split_op(self):
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100317 return self in (Op.Split, Op.SplitV, Op.StridedSlice, Op.Slice, Op.UnpackReshaped, Op.Unpack)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200318
319 def is_concat_op(self):
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100320 return self in (Op.Concat, Op.ConcatTFLite, Op.PackReshaped, Op.Pack)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200321
322 def needs_bias(self):
323 return bool(self.info.indices.biases)
324
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100325 def needs_shapes(self):
326 return bool(self.info.indices.ifms)
327
Louis Verhaardaee5d752020-09-30 09:01:52 +0200328 @classmethod
329 def op_set(cls, predicate):
330 # Returns the set of all operator codes that fulfill the given predicate
331 return {op_type for op_type in Op if predicate(op_type)}
332
333 def __str__(self):
334 return self.name
335
336 __repr__ = __str__
337
338 def __lt__(self, other):
339 return self.value.id < other.value.id
340
341
Michael McGeagh16895482020-12-14 15:51:20 +0000342class Padding(Enum):
343 SAME = 0
344 VALID = 1
Louis Verhaardae2d5532020-12-11 17:19:54 +0100345 EXPLICIT = 2 # Padding is specified in a PAD operation (only used for NPU operations)
Michael McGeagh16895482020-12-14 15:51:20 +0000346
347
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100348class ActivationFunction:
349 """Fused activation function"""
350
351 def __init__(self, op_type: Op):
352 self.op_type = op_type # The activation operation to be performed
353 # min/max are optional; if present they are non-quantized values
354 self.min: Optional[float] = None
355 self.max: Optional[float] = None
356 # Table lookup index, only applicable for Op.LUT activation, 0-7
357 self.lut_index: int = 0
358
359 def clone(self):
360 res = copy.copy(self)
361 return res
362
363
364def create_activation_function(op_type: Op) -> ActivationFunction:
365 """Creates activation function with min/max depending on op_type"""
366 act = ActivationFunction(op_type)
367 if op_type == Op.Relu:
368 act.min = 0.0
369 elif op_type == Op.Relu6:
370 act.min = 0.0
371 act.max = 6.0
372 elif op_type == Op.ReluN1To1:
373 act.min = -1.0
374 act.max = 1.0
375 elif op_type == Op.Tanh:
376 act.min = -1.0
377 act.max = 1.0
378 elif op_type == Op.Sigmoid:
379 act.min = 0.0
380 act.max = 1.0
Diqing Zhong189f7482021-01-26 12:12:51 +0100381 elif op_type == Op.HardSwish:
382 act.min = 0.0
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100383 return act
384
385
patrik.gustavssoneeb85152020-12-21 17:10:40 +0000386def get_slice_offsets(input_shape: List[int], offset_tens: int, offset_mask: int, is_begin: bool = True):
Louis Verhaardfa2f92a2020-09-21 11:56:18 +0200387 # For strided slice operator: get start or end offsets
388 offsets = len(input_shape) * [0] if is_begin else input_shape[:]
389 for idx in range(len(input_shape)):
390 # If the i:th bit in the mask is set then the value on offset_tens[i] should be ignored
391 if (offset_mask & (1 << idx)) == 0:
392 offsets[idx] = offset_tens.values[idx]
393 if offsets[idx] < 0:
394 # Convert offset to positive value
395 offsets[idx] += input_shape[idx]
396 return offsets
397
398
Tim Hall79d07d22020-04-27 18:20:16 +0100399class Operation:
400 """Class representing a Neural Network operation. Has a name, a type,
Dwight Lidmanc6ac1942020-10-02 14:55:45 +0200401 input and output tensors, as well as an attribute dictionary."""
Tim Hall79d07d22020-04-27 18:20:16 +0100402
Fredrik Svedberga0c36242020-06-03 15:43:31 +0200403 __slots__ = (
404 "type",
405 "name",
406 "op_index",
407 "attrs",
408 "inputs",
409 "outputs",
410 "flops",
411 "scheduled_pass",
412 "run_on_npu",
Louis Verhaardaee5d752020-09-30 09:01:52 +0200413 "activation",
414 "memory_function",
415 "forced_output_quantization",
Fredrik Svedberga0c36242020-06-03 15:43:31 +0200416 "activation_lut",
Tim Hall4ed38bc2020-10-20 18:54:20 +0100417 "_kernel",
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100418 "ifm_shapes",
419 "ofm_shapes",
Fredrik Svedberge82be7c2021-01-18 15:21:03 +0100420 "rescale",
Patrik Gustavssone3b1b912021-02-09 15:38:46 +0100421 "read_offsets",
Fredrik Svedberga0c36242020-06-03 15:43:31 +0200422 )
Tim Hall79d07d22020-04-27 18:20:16 +0100423
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100424 def __init__(self, op_type: Op, name: str):
Tim Hall79d07d22020-04-27 18:20:16 +0100425 self.type = op_type
426 self.name = name
Dwight Lidman9b43f842020-12-08 17:56:44 +0100427 self.attrs: Dict[str, Any] = {}
428 self.inputs: List[Tensor] = []
429 self.outputs: List[Tensor] = []
Tim Hall79d07d22020-04-27 18:20:16 +0100430 self.flops = 0
431 self.run_on_npu = True
Louis Verhaardaee5d752020-09-30 09:01:52 +0200432 # Fused activation function. If not none: operator code.
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100433 self.activation: Optional[ActivationFunction] = None
Louis Verhaardaee5d752020-09-30 09:01:52 +0200434 # Fused memory function, if not None: operator code
435 self.memory_function = None
436 # If not none: contains QuantizationParameters to be used as output quantization
437 # (which overrides the ofm tensor's quantization), used in LUT
438 self.forced_output_quantization = None
Tim Hall79d07d22020-04-27 18:20:16 +0100439 self.scheduled_pass = None
Tim Hallc8310b12020-06-17 14:53:11 +0100440 self.op_index = None # input network operator index
Fredrik Svedberga0c36242020-06-03 15:43:31 +0200441 self.activation_lut = None
Tim Hall4ed38bc2020-10-20 18:54:20 +0100442 self._kernel = None
patrik.gustavssoneeb85152020-12-21 17:10:40 +0000443 self.ifm_shapes: List[Shape4D] = []
444 self.ofm_shapes: List[Shape4D] = []
Fredrik Svedberge82be7c2021-01-18 15:21:03 +0100445 # If not none: contains rescale to be used as output scaling
446 # (which overrides the ofm tensor's scale)
447 self.rescale = None
Patrik Gustavssone3b1b912021-02-09 15:38:46 +0100448 self.read_offsets: List[Shape4D] = [None, None] # offset for [ifm, ifm2]
Tim Hall79d07d22020-04-27 18:20:16 +0100449
450 def clone(self, suffix="_clone"):
451 res = Operation(self.type, self.name + suffix)
452
453 res.attrs = dict(self.attrs)
454 res.inputs = list(self.inputs)
455 res.outputs = list(self.outputs)
456 res.flops = self.flops
Louis Verhaardaee5d752020-09-30 09:01:52 +0200457 res.run_on_npu = self.run_on_npu
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100458 res.activation = None if self.activation is None else self.activation.clone()
Louis Verhaardaee5d752020-09-30 09:01:52 +0200459 res.memory_function = self.memory_function
460 res.forced_output_quantization = self.forced_output_quantization
Tim Hall79d07d22020-04-27 18:20:16 +0100461 res.scheduled_pass = self.scheduled_pass
Tim Hallc8310b12020-06-17 14:53:11 +0100462 res.op_index = None # not relevant as not part of input network
Patrik Gustavssone3b1b912021-02-09 15:38:46 +0100463 res.read_offsets = list(self.read_offsets)
Tim Hall79d07d22020-04-27 18:20:16 +0100464
465 return res
466
467 def __str__(self):
Louis Verhaardaee5d752020-09-30 09:01:52 +0200468 return "<nng.Operation '{}' type={}>".format(self.name, self.type)
Tim Hall79d07d22020-04-27 18:20:16 +0100469
470 __repr__ = __str__
471
Michael McGeagh65fd9982020-10-20 11:49:28 +0100472 def get_kernel_size(self):
Tim Hall4ed38bc2020-10-20 18:54:20 +0100473 weights = self.weights
474 if weights and self.type.npu_block_type in (NpuBlockType.ConvolutionDepthWise, NpuBlockType.ConvolutionMxN):
475 weight_shape = full_shape(4, weights.shape, 1)
Michael McGeagh65fd9982020-10-20 11:49:28 +0100476 h = weight_shape[-4]
477 w = weight_shape[-3]
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100478 elif self.type.npu_block_type in (NpuBlockType.Pooling, NpuBlockType.ReduceSum) and "ksize" in self.attrs:
479 h, w = self.attrs["ksize"][1:3]
Tim Hall4ed38bc2020-10-20 18:54:20 +0100480 else:
Michael McGeagh65fd9982020-10-20 11:49:28 +0100481 h = self.attrs.get("filter_height", 1)
482 w = self.attrs.get("filter_width", 1)
483 return w, h
484
485 def get_kernel_stride(self):
486 if "strides" in self.attrs:
487 _, h, w, _ = self.attrs["strides"]
488 else:
489 h = self.attrs.get("stride_h", 1)
490 w = self.attrs.get("stride_w", 1)
491 return w, h
492
493 def get_kernel_dilation(self):
494 if "dilation" in self.attrs:
495 _, h, w, _ = self.attrs["dilation"]
496 else:
497 h = self.attrs.get("dilation_h_factor", 1)
498 w = self.attrs.get("dilation_w_factor", 1)
499 return w, h
500
501 @property
502 def kernel(self):
503 k_w, k_h = self.get_kernel_size()
504 s_w, s_h = self.get_kernel_stride()
505 d_w, d_h = self.get_kernel_dilation()
506 self._kernel = Kernel(k_w, k_h, s_w, s_h, d_w, d_h)
Tim Hall4ed38bc2020-10-20 18:54:20 +0100507 return self._kernel
508
Tim Hall79d07d22020-04-27 18:20:16 +0100509 def get_ifm_ifm2_weights_ofm(self):
Louis Verhaardaee5d752020-09-30 09:01:52 +0200510 return self.ifm, self.ifm2, self.weights, self.ofm
Tim Hall79d07d22020-04-27 18:20:16 +0100511
512 def get_ifm_weights_biases_ofm(self):
Louis Verhaardaee5d752020-09-30 09:01:52 +0200513 return self.ifm, self.weights, self.bias, self.ofm
Tim Hall79d07d22020-04-27 18:20:16 +0100514
Jacob Bohlin49d92122020-08-19 14:36:46 +0200515 def get_ifm_ifm2_weights_biases_ofm(self):
Louis Verhaardaee5d752020-09-30 09:01:52 +0200516 return self.ifm, self.ifm2, self.weights, self.bias, self.ofm
Jacob Bohlin49d92122020-08-19 14:36:46 +0200517
Louis Verhaardaee5d752020-09-30 09:01:52 +0200518 def get_ifm_ofm(self):
519 return self.ifm, self.ofm
Jacob Bohlin49d92122020-08-19 14:36:46 +0200520
Louis Verhaardaee5d752020-09-30 09:01:52 +0200521 @property
522 def ifm(self):
523 # Gets the IFM tensor, or None if not applicable
524 return self.get_input(self.type.info.indices.ifms, 0)
Jacob Bohlin49d92122020-08-19 14:36:46 +0200525
Louis Verhaardaee5d752020-09-30 09:01:52 +0200526 @property
527 def ifm2(self):
528 # Gets the IFM2 tensor, or None if not applicable
529 return self.get_input(self.type.info.indices.ifms, 1)
Louis Verhaard98a34992020-09-01 10:39:04 +0200530
Louis Verhaardaee5d752020-09-30 09:01:52 +0200531 @property
532 def bias(self):
533 # Gets the bias tensor, or None if not applicable
534 return self.get_input(self.type.info.indices.biases, 0)
535
536 @property
537 def weights(self):
538 # Gets the weight tensor, or None if not applicable
539 return self.get_input(self.type.info.indices.weights, 0)
540
541 def get_ifm_tensors(self):
542 # Gets the IFM tensors, or empty list if not applicable
543 return self._index_list_to_tensors(self.type.info.indices.ifms)
544
545 def get_weight_tensors(self):
546 # Gets the weight tensors, or empty list if not applicable
547 return self._index_list_to_tensors(self.type.info.indices.weights)
548
549 def get_bias_tensors(self):
550 # Gets the bias tensors, or empty list if not applicable
551 return self._index_list_to_tensors(self.type.info.indices.biases)
552
553 def _index_list_to_tensors(self, index_list):
554 return [self.inputs[ix] for ix in index_list if ix < len(self.inputs)]
555
556 def get_input(self, index_list, ix):
557 if ix >= len(index_list):
558 return None
559 if index_list[ix] >= len(self.inputs):
560 return None
561 return self.inputs[index_list[ix]]
562
563 @property
564 def ofm(self):
565 # Gets the OFM tensor, or None if not applicable
566 return self.outputs[0] if self.outputs else None
Tim Hall79d07d22020-04-27 18:20:16 +0100567
568 def get_concat_inputs_axis(self):
Louis Verhaardaee5d752020-09-30 09:01:52 +0200569 assert self.type.is_concat_op()
Tim Hall79d07d22020-04-27 18:20:16 +0100570
Louis Verhaardaee5d752020-09-30 09:01:52 +0200571 if self.type == Op.Concat:
Tim Hall79d07d22020-04-27 18:20:16 +0100572 axis_tensor = self.inputs[0]
573 inputs = self.inputs[1:]
Louis Verhaardaee5d752020-09-30 09:01:52 +0200574 elif self.type == Op.ConcatTFLite:
Tim Hall79d07d22020-04-27 18:20:16 +0100575 inputs = self.inputs
576 axis = self.attrs["axis"]
Louis Verhaardaee5d752020-09-30 09:01:52 +0200577 elif self.type == Op.PackReshaped:
Tim Hall79d07d22020-04-27 18:20:16 +0100578 # Requires fixup_pack_input to be called before this point
579 inputs = self.inputs
580 axis = self.attrs["axis"]
581 assert len(self.inputs) == self.attrs["values_count"]
582 else:
Louis Verhaardaee5d752020-09-30 09:01:52 +0200583 assert len(axis_tensor.ops) == 1 and axis_tensor.ops[0].type == Op.Const
Tim Hall79d07d22020-04-27 18:20:16 +0100584 axis = int(axis_tensor.values)
585
586 return inputs, axis
587
Louis Verhaardb2fb2122020-06-04 15:51:24 +0200588 def get_dilation_h_w(self):
589 _, dilation_h, dilation_w, _ = self.attrs.get("dilation", (1, 1, 1, 1))
590 return dilation_h, dilation_w
591
Tim Hall79d07d22020-04-27 18:20:16 +0100592 def get_split_inputs_axis(self):
Louis Verhaardaee5d752020-09-30 09:01:52 +0200593 assert self.type.is_split_op()
Tim Hall79d07d22020-04-27 18:20:16 +0100594
595 offset_start = None
596 offset_end = None
597 axis = None
Louis Verhaardaee5d752020-09-30 09:01:52 +0200598 if self.type == Op.Split:
Tim Hall79d07d22020-04-27 18:20:16 +0100599 num_splits = self.attrs.get("num_splits")
600 axis_tens = self.inputs[0]
Louis Verhaardaee5d752020-09-30 09:01:52 +0200601 assert len(axis_tens.ops) == 1 and axis_tens.ops[0].type == Op.Const
Tim Hall79d07d22020-04-27 18:20:16 +0100602 axis = int(axis_tens.values)
603 input_tens = self.inputs[1]
604 outputs = self.outputs
605 assert num_splits == len(outputs)
606
Louis Verhaardaee5d752020-09-30 09:01:52 +0200607 elif self.type == Op.SplitV:
Charles Xu53d47522020-05-04 11:32:05 +0200608 num_splits = self.attrs.get("num_splits")
609 input_tens = self.inputs[0]
610 size_tens = self.inputs[1]
Louis Verhaardaee5d752020-09-30 09:01:52 +0200611 assert len(size_tens.ops) == 1 and size_tens.ops[0].type == Op.Const
Charles Xu53d47522020-05-04 11:32:05 +0200612 sizes = size_tens.values
Patrik Gustavsson271ddc32020-09-01 09:15:27 +0200613
Charles Xu53d47522020-05-04 11:32:05 +0200614 axis_tens = self.inputs[2]
Louis Verhaardaee5d752020-09-30 09:01:52 +0200615 assert len(axis_tens.ops) == 1 and axis_tens.ops[0].type == Op.Const
Charles Xu53d47522020-05-04 11:32:05 +0200616 axis = int(axis_tens.values)
Patrik Gustavsson271ddc32020-09-01 09:15:27 +0200617
618 for idx, size in enumerate(sizes):
619 # One but only one size might be set to -1, indicating that size should be inferred
620 if size == -1:
621 sizes[idx] = input_tens.shape[axis] - (sum(sizes) + 1)
622 break
623
Charles Xu53d47522020-05-04 11:32:05 +0200624 outputs = self.outputs
625 assert num_splits == len(outputs)
626 assert sum(sizes) == input_tens.shape[axis]
627
Louis Verhaardaee5d752020-09-30 09:01:52 +0200628 elif self.type == Op.Slice:
Tim Hall79d07d22020-04-27 18:20:16 +0100629 input_tens, begin_tens, size_tens = self.inputs
630 outputs = self.outputs
631 offset_start = [0] * len(input_tens.shape)
632 offset_end = [0] * len(input_tens.shape)
633
634 for idx in range(len(begin_tens.values)):
635 # Check if the op should slice in dimension idx
636 if size_tens.values[idx] != input_tens.shape[idx]:
637 offset_start[idx] = begin_tens.values[idx]
638 offset_end[idx] = size_tens.values[idx] + offset_start[idx]
639
Louis Verhaardaee5d752020-09-30 09:01:52 +0200640 elif self.type == Op.StridedSlice:
Tim Hall79d07d22020-04-27 18:20:16 +0100641 input_tens, begin_tens, end_tens, strides_tens = self.inputs
642 outputs = self.outputs
Tim Hall79d07d22020-04-27 18:20:16 +0100643
644 # Extract masks
645 begin_mask = self.attrs["begin_mask"]
646 ellipsis_mask = self.attrs["ellipsis_mask"]
647 end_mask = self.attrs["end_mask"]
648 new_axis_mask = self.attrs["new_axis_mask"]
649 shrink_axis_mask = self.attrs["shrink_axis_mask"]
Patrik Gustavssoncf728902020-04-30 08:57:23 +0200650
651 # shrink_axis_mask/new_axis_mask/ellipsis_mask is not supported by the Operation class but the operation
Tim Hall79d07d22020-04-27 18:20:16 +0100652 # may have the attribute modified and handled in the graph optimization phase.
Patrik Gustavssoncf728902020-04-30 08:57:23 +0200653 assert shrink_axis_mask == new_axis_mask == ellipsis_mask == 0
Louis Verhaardfa2f92a2020-09-21 11:56:18 +0200654 offset_start = get_slice_offsets(input_tens.shape, begin_tens, begin_mask, is_begin=True)
655 offset_end = get_slice_offsets(input_tens.shape, end_tens, end_mask, is_begin=False)
Louis Verhaardaee5d752020-09-30 09:01:52 +0200656 elif self.type == Op.UnpackReshaped:
Tim Hall79d07d22020-04-27 18:20:16 +0100657 # Requires fixup_unpack_output to be called before this point
658 input_tens = self.inputs[0]
659 outputs = self.outputs
660 axis = self.attrs["axis"]
661 num_splits = self.attrs["num"]
662 # Number of outputs have to equal the value of the dimension to unpack
663 assert num_splits == len(outputs) == input_tens.shape[axis]
664 else:
665 assert False
666
667 return input_tens, outputs, axis, offset_start, offset_end
Fredrik Svedberga0c36242020-06-03 15:43:31 +0200668
669 def set_activation_lut(self, lut_tensor):
Louis Verhaarde8a5a782020-11-02 18:04:27 +0100670 self.activation = ActivationFunction(Op.LUT)
Fredrik Svedberga0c36242020-06-03 15:43:31 +0200671 self.activation_lut = lut_tensor
Michael McGeaghc5b549b2020-08-07 11:54:28 +0100672 self.add_input_tensor(lut_tensor)
Michael McGeagh5778ffd2020-08-06 17:31:02 +0100673
674 def add_input_tensor(self, tens):
675 self.inputs.append(tens)
676 if self not in tens.consumer_list:
677 tens.consumer_list.append(self)
678
Jacob Bohlin67e0d8f2020-08-20 10:53:02 +0200679 def set_input_tensor(self, tens, idx):
680 tens_to_remove = self.inputs[idx]
681 if tens_to_remove in tens.consumer_list:
682 tens.consumer_list.remove(tens_to_remove)
683
684 self.inputs[idx] = tens
685 if self not in tens.consumer_list:
686 tens.consumer_list.append(self)
687
Michael McGeagh5778ffd2020-08-06 17:31:02 +0100688 def set_output_tensor(self, tens):
689 tens.ops = [self]
690 self.outputs = [tens]
Jacob Bohlina41cd4d2020-08-26 18:21:28 +0200691
Louis Verhaard98a34992020-09-01 10:39:04 +0200692 def get_output_quantization(self):
Louis Verhaardaee5d752020-09-30 09:01:52 +0200693 if self.forced_output_quantization is not None:
694 return self.forced_output_quantization
695 return self.ofm.quantization
Michael McGeagh528a56d2020-12-16 11:33:21 +0000696
697 def error(self, msg):
698 """
699 Raises a VelaError exception for errors encountered when parsing an Operation
700
701 :param self: Operation object that resulted in the error
702 :param msg: str object that contains a description of the specific error encountered
703 """
704
705 def _print_tensors(tensors):
706 lines = []
707 for idx, tens in enumerate(tensors):
708 tens_name = getattr(tens, "name", "Not a Tensor")
709 lines.append(f" {idx} = {tens_name}")
710 return lines
711
712 if self.op_index is None:
713 lines = [f"Invalid {self.type} (name = {self.name}) operator in the internal representation. {msg}"]
714 else:
715 lines = [f"Invalid {self.type} (op_index = {self.op_index}) operator in the input network. {msg}"]
716
717 lines += [" Input tensors:"]
718 lines += _print_tensors(self.inputs)
719
720 lines += [" Output tensors:"]
721 lines += _print_tensors(self.outputs)
722
723 raise VelaError("\n".join(lines))
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100724
725 def set_ifm_ofm_shapes(self):
patrik.gustavssoneeb85152020-12-21 17:10:40 +0000726 self.ifm_shapes = []
727 self.ofm_shapes = []
728
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100729 ifm_tensor, ifm2_tensor, weight_tensor, ofm_tensor = self.get_ifm_ifm2_weights_ofm()
730
731 # set all shapes to op, as 4D
732 if self.type == Op.FullyConnected:
Patrik Gustavsson2c2522d2021-01-29 11:51:31 +0100733 if len(self.ifm.shape) == 2:
734 self.ifm_shapes.append(Shape4D([self.ifm.shape[0], 1, 1, self.ifm.shape[1]]))
735 else:
736 # Special case, handled in graph optimization
737 self.ifm_shapes.append(Shape4D(ifm_tensor.get_full_shape()))
738 if len(self.ofm.shape) == 2:
739 self.ofm_shapes.append(Shape4D([self.ofm.shape[0], 1, 1, self.ofm.shape[1]]))
740 else:
741 self.ofm_shapes.append(Shape4D(ofm_tensor.get_full_shape()))
742 if self.type == Op.Softmax:
patrik.gustavssoneeb85152020-12-21 17:10:40 +0000743 self.ifm_shapes.append(Shape4D(ifm_tensor.get_full_shape()))
744 self.ofm_shapes.append(Shape4D(ofm_tensor.get_full_shape()))
Patrik Gustavssonda2b0032021-02-04 16:28:29 +0100745 elif self.type.is_split_op() or self.type.is_concat_op():
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100746 for inp in self.inputs:
747 if inp is not None:
patrik.gustavssoneeb85152020-12-21 17:10:40 +0000748 self.ifm_shapes.append(Shape4D(full_shape(4, inp.shape, 1)))
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100749 else:
750 self.ifm_shapes.append(None)
751 for out in self.outputs:
752 if out is not None:
patrik.gustavssoneeb85152020-12-21 17:10:40 +0000753 self.ofm_shapes.append(Shape4D(full_shape(4, out.shape, 1)))
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100754 else:
755 self.ofm_shapes.append(None)
756 else:
Patrik Gustavssonda2b0032021-02-04 16:28:29 +0100757 if ifm_tensor is not None:
758 self.ifm_shapes.append(Shape4D(full_shape(4, ifm_tensor.shape, 1)))
Patrik Gustavsson2349d422020-12-01 16:02:29 +0100759 if ifm2_tensor is not None:
patrik.gustavssoneeb85152020-12-21 17:10:40 +0000760 self.ifm_shapes.append(Shape4D(full_shape(4, ifm2_tensor.shape, 1)))
Patrik Gustavssonda2b0032021-02-04 16:28:29 +0100761 if ofm_tensor is not None:
762 self.ofm_shapes.append(Shape4D(full_shape(4, ofm_tensor.shape, 1)))