blob: a90883ba841849c0d72c06b68ec2d63af06f2d5e [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
54- DEPTH_TO_SPACE
55
56- DEPTHWISE_CONV_2D, Supported Fused Activation: RELU , RELU6 , TANH, NONE
57
58- DEQUANTIZE
59
60- DIV
61
62- EQUAL
63
64- ELU
65
66- EXP
67
68- FULLY_CONNECTED, Supported Fused Activation: RELU , RELU6 , TANH, NONE
69
Sadik Armagan788e2c62021-02-10 16:26:44 +000070- FLOOR
71
Jan Eilers31a7c892021-01-29 14:18:13 +000072- GATHER
73
74- GREATER
75
76- GREATER_OR_EQUAL
77
78- HARD_SWISH
79
80- LESS
81
82- LESS_OR_EQUAL
83
84- LOCAL_RESPONSE_NORMALIZATION
85
86- LOGICAL_AND
Jan Eilers1121c6b2021-02-19 09:38:03 +000087
Jan Eilers31a7c892021-01-29 14:18:13 +000088- LOGICAL_NOT
Jan Eilers1121c6b2021-02-19 09:38:03 +000089
Jan Eilers31a7c892021-01-29 14:18:13 +000090- LOGICAL_OR
91
92- LOGISTIC
93
94- LOG_SOFTMAX
95
Jan Eilers1121c6b2021-02-19 09:38:03 +000096- LSTM
97
Jan Eilers31a7c892021-01-29 14:18:13 +000098- L2_NORMALIZATION
99
100- L2_POOL_2D
101
102- MAXIMUM
103
104- MAX_POOL_2D, Supported Fused Activation: RELU , RELU6 , TANH, NONE
105
106- MEAN
107
108- MINIMUM
109
110- MUL
111
112- NEG
113
114- NOT_EQUAL
115
116- PAD
117
Jan Eilers1121c6b2021-02-19 09:38:03 +0000118- PRELU
119
Jan Eilers31a7c892021-01-29 14:18:13 +0000120- QUANTIZE
121
Jan Eilers1121c6b2021-02-19 09:38:03 +0000122- RANK
123
124- REDUCE_MAX
125
126- REDUCE_MIN
127
Jan Eilers31a7c892021-01-29 14:18:13 +0000128- RESHAPE
129
130- RESIZE_BILINEAR
131
132- RESIZE_NEAREST_NEIGHBOR
133
134- RELU
135
136- RELU6
137
138- RSQRT
139
140- SOFTMAX
141
Matthew Sloyana35b40b2021-02-05 17:22:28 +0000142- SPACE_TO_BATCH_ND
143
Jan Eilers31a7c892021-01-29 14:18:13 +0000144- SPACE_TO_DEPTH
145
146- SPLIT
147
148- SPLIT_V
149
150- SQRT
151
Jan Eilers1121c6b2021-02-19 09:38:03 +0000152- STRIDED_SLICE
153
Jan Eilers31a7c892021-01-29 14:18:13 +0000154- SUB
155
Jan Eilers1121c6b2021-02-19 09:38:03 +0000156- SUM
157
Jan Eilers31a7c892021-01-29 14:18:13 +0000158- TANH
159
160- TRANSPOSE
161
162- TRANSPOSE_CONV
163
164More machine learning operators will be supported in future releases.
165**/
166}