blob: 625b2539925d61186cc1bb9a109e7020788addac [file] [log] [blame]
Jan Eilers31a7c892021-01-29 14:18:13 +00001/// Copyright (c) 2021 ARM Limited and Contributors. All rights reserved.
2///
3/// SPDX-License-Identifier: MIT
4///
5
6namespace armnn
7{
8/**
9@page delegate TfLite Delegate
10@tableofcontents
11
12
13@section delegateintro About the delegate
14'armnnDelegate' is a library for accelerating certain TensorFlow Lite (TfLite) operators on Arm hardware. It can be
15integrated in TfLite using its delegation mechanism. TfLite will then delegate the execution of operators supported by
16Arm NN to Arm NN.
17
18The main difference to our @ref S6_tf_lite_parser is the amount of operators you can run with it. If none of the active
19backends support an operation in your model you won't be able to execute it with our parser. In contrast to that, TfLite
20only delegates operations to the armnnDelegate if it does support them and otherwise executes them itself. In other
21words, every TfLite model can be executed and every operation in your model that we can accelerate will be accelerated.
22That is the reason why the armnnDelegate is our recommended way to accelerate TfLite models.
23
24If you need help building the armnnDelegate, please take a look at our [build guide](delegate/BuildGuideNative.md).
25An example how to setup TfLite to integrate the armnnDelegate can be found in this
26guide: [Integrate the delegate into python](delegate/IntegrateDelegateIntoPython.md)
27
28
29@section delegatesupport Supported Operators
30This reference guide provides a list of TensorFlow Lite operators the Arm NN SDK currently supports.
31
32@subsection delegatefullysupported Fully supported
33
34The Arm NN SDK TensorFlow Lite delegate currently supports the following operators:
35
36- ABS
37
38- ADD
39
40- ARGMAX
41
42- ARGMIN
43
44- AVERAGE_POOL_2D, Supported Fused Activation: RELU , RELU6 , TANH, NONE
45
Matthew Sloyana35b40b2021-02-05 17:22:28 +000046- BATCH_TO_SPACE_ND
47
Sadik Armagan937565b2021-04-21 14:03:28 +010048- CAST
49
Jan Eilers31a7c892021-01-29 14:18:13 +000050- CONCATENATION, Supported Fused Activation: RELU , RELU6 , TANH, NONE
51
52- CONV_2D, Supported Fused Activation: RELU , RELU6 , TANH, NONE
53
Matthew Sloyan81ec9942021-10-12 10:26:30 +010054- CONV_3D, Supported Fused Activation: RELU , RELU6 , TANH, NONE
55
Jan Eilers31a7c892021-01-29 14:18:13 +000056- DEPTH_TO_SPACE
57
58- DEPTHWISE_CONV_2D, Supported Fused Activation: RELU , RELU6 , TANH, NONE
59
60- DEQUANTIZE
61
62- DIV
63
64- EQUAL
65
66- ELU
67
68- EXP
69
70- FULLY_CONNECTED, Supported Fused Activation: RELU , RELU6 , TANH, NONE
71
Sadik Armagan788e2c62021-02-10 16:26:44 +000072- FLOOR
73
Jan Eilers31a7c892021-01-29 14:18:13 +000074- GATHER
75
Teresa Charlind5c0ed22022-04-25 18:23:41 +010076- GATHER_ND
77
Jan Eilers31a7c892021-01-29 14:18:13 +000078- GREATER
79
80- GREATER_OR_EQUAL
81
82- HARD_SWISH
83
84- LESS
85
86- LESS_OR_EQUAL
87
88- LOCAL_RESPONSE_NORMALIZATION
89
90- LOGICAL_AND
Jan Eilers1121c6b2021-02-19 09:38:03 +000091
Jan Eilers31a7c892021-01-29 14:18:13 +000092- LOGICAL_NOT
Jan Eilers1121c6b2021-02-19 09:38:03 +000093
Jan Eilers31a7c892021-01-29 14:18:13 +000094- LOGICAL_OR
95
96- LOGISTIC
97
98- LOG_SOFTMAX
99
Jan Eilers1121c6b2021-02-19 09:38:03 +0000100- LSTM
101
Jan Eilers31a7c892021-01-29 14:18:13 +0000102- L2_NORMALIZATION
103
104- L2_POOL_2D
105
106- MAXIMUM
107
108- MAX_POOL_2D, Supported Fused Activation: RELU , RELU6 , TANH, NONE
109
110- MEAN
111
112- MINIMUM
113
Matthew Sloyanaf3a4ef2021-10-22 15:48:12 +0100114- MIRROR_PAD
115
Jan Eilers31a7c892021-01-29 14:18:13 +0000116- MUL
117
118- NEG
119
120- NOT_EQUAL
121
Kevin Mayc7bd7e82021-05-10 12:46:40 +0100122- PACK
123
Jan Eilers31a7c892021-01-29 14:18:13 +0000124- PAD
125
Jan Eilers1121c6b2021-02-19 09:38:03 +0000126- PRELU
127
Jan Eilers31a7c892021-01-29 14:18:13 +0000128- QUANTIZE
129
Jan Eilers1121c6b2021-02-19 09:38:03 +0000130- RANK
131
132- REDUCE_MAX
133
134- REDUCE_MIN
135
Jan Eilers31a7c892021-01-29 14:18:13 +0000136- RESHAPE
137
138- RESIZE_BILINEAR
139
140- RESIZE_NEAREST_NEIGHBOR
141
142- RELU
143
144- RELU6
145
146- RSQRT
147
Matthew Sloyane369dbd2021-08-19 12:05:44 +0100148- SHAPE
149
Jan Eilers31a7c892021-01-29 14:18:13 +0000150- SOFTMAX
151
Matthew Sloyana35b40b2021-02-05 17:22:28 +0000152- SPACE_TO_BATCH_ND
153
Jan Eilers31a7c892021-01-29 14:18:13 +0000154- SPACE_TO_DEPTH
155
156- SPLIT
157
158- SPLIT_V
159
160- SQRT
161
Jan Eilers1121c6b2021-02-19 09:38:03 +0000162- STRIDED_SLICE
163
Jan Eilers31a7c892021-01-29 14:18:13 +0000164- SUB
165
Jan Eilers1121c6b2021-02-19 09:38:03 +0000166- SUM
167
Jan Eilers31a7c892021-01-29 14:18:13 +0000168- TANH
169
170- TRANSPOSE
171
172- TRANSPOSE_CONV
173
Narumol Prangnawaratbd575b22021-08-31 16:53:54 +0100174- UNIDIRECTIONAL_SEQUENCE_LSTM
175
Kevin Mayc7bd7e82021-05-10 12:46:40 +0100176- UNPACK
177
Jan Eilers31a7c892021-01-29 14:18:13 +0000178More machine learning operators will be supported in future releases.
179**/
180}