blob: b3caf8cbf85ddf73ea9aa13b9d567537a3d8c087 [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
76- GREATER
77
78- GREATER_OR_EQUAL
79
80- HARD_SWISH
81
82- LESS
83
84- LESS_OR_EQUAL
85
86- LOCAL_RESPONSE_NORMALIZATION
87
88- LOGICAL_AND
Jan Eilers1121c6b2021-02-19 09:38:03 +000089
Jan Eilers31a7c892021-01-29 14:18:13 +000090- LOGICAL_NOT
Jan Eilers1121c6b2021-02-19 09:38:03 +000091
Jan Eilers31a7c892021-01-29 14:18:13 +000092- LOGICAL_OR
93
94- LOGISTIC
95
96- LOG_SOFTMAX
97
Jan Eilers1121c6b2021-02-19 09:38:03 +000098- LSTM
99
Jan Eilers31a7c892021-01-29 14:18:13 +0000100- L2_NORMALIZATION
101
102- L2_POOL_2D
103
104- MAXIMUM
105
106- MAX_POOL_2D, Supported Fused Activation: RELU , RELU6 , TANH, NONE
107
108- MEAN
109
110- MINIMUM
111
Matthew Sloyanaf3a4ef2021-10-22 15:48:12 +0100112- MIRROR_PAD
113
Jan Eilers31a7c892021-01-29 14:18:13 +0000114- MUL
115
116- NEG
117
118- NOT_EQUAL
119
Kevin Mayc7bd7e82021-05-10 12:46:40 +0100120- PACK
121
Jan Eilers31a7c892021-01-29 14:18:13 +0000122- PAD
123
Jan Eilers1121c6b2021-02-19 09:38:03 +0000124- PRELU
125
Jan Eilers31a7c892021-01-29 14:18:13 +0000126- QUANTIZE
127
Jan Eilers1121c6b2021-02-19 09:38:03 +0000128- RANK
129
130- REDUCE_MAX
131
132- REDUCE_MIN
133
Jan Eilers31a7c892021-01-29 14:18:13 +0000134- RESHAPE
135
136- RESIZE_BILINEAR
137
138- RESIZE_NEAREST_NEIGHBOR
139
140- RELU
141
142- RELU6
143
144- RSQRT
145
Matthew Sloyane369dbd2021-08-19 12:05:44 +0100146- SHAPE
147
Jan Eilers31a7c892021-01-29 14:18:13 +0000148- SOFTMAX
149
Matthew Sloyana35b40b2021-02-05 17:22:28 +0000150- SPACE_TO_BATCH_ND
151
Jan Eilers31a7c892021-01-29 14:18:13 +0000152- SPACE_TO_DEPTH
153
154- SPLIT
155
156- SPLIT_V
157
158- SQRT
159
Jan Eilers1121c6b2021-02-19 09:38:03 +0000160- STRIDED_SLICE
161
Jan Eilers31a7c892021-01-29 14:18:13 +0000162- SUB
163
Jan Eilers1121c6b2021-02-19 09:38:03 +0000164- SUM
165
Jan Eilers31a7c892021-01-29 14:18:13 +0000166- TANH
167
168- TRANSPOSE
169
170- TRANSPOSE_CONV
171
Narumol Prangnawaratbd575b22021-08-31 16:53:54 +0100172- UNIDIRECTIONAL_SEQUENCE_LSTM
173
Kevin Mayc7bd7e82021-05-10 12:46:40 +0100174- UNPACK
175
Jan Eilers31a7c892021-01-29 14:18:13 +0000176More machine learning operators will be supported in future releases.
177**/
178}