blob: a31917846e5667a361496d2bd54eb54eff76af9e [file] [log] [blame]
Nikhil Rajc377eb82023-08-01 15:00:39 +01001/// Copyright (c) 2021-2023 ARM Limited and Contributors. All rights reserved.
2///
3/// SPDX-License-Identifier: MIT
4///
5
6namespace armnn
7{
8/**
9@page serializer Serializer
10
11The `armnnSerializer` is a library for serializing an Arm NN network to a stream.
12
13@section serializersupport Supported Layers
14
15This reference guide provides a list of layers which can be serialized by the Arm NN SDK.
16
17The Arm NN SDK Serializer currently supports the following layers:
18
19- Activation
20
21- Addition
22
23- ArgMinMax
24
25- BatchMatMul
26
27- BatchToSpaceNd
28
29- BatchNormalization
30
31- Cast
32
33- ChannelShuffle
34
35- Comparison
36
37- Concat
38
39- Constant
40
41- Convolution2d
42
43- Convolution3d
44
45- DepthToSpace
46
47- DepthwiseConvolution2d
48
49- Dequantize
50
51- DetectionPostProcess
52
53- Division
54
55- ElementwiseUnary
56
57- Fill
58
59- Floor
60
61- FullyConnected
62
63- Gather
64
65- GatherNd
66
67- Input
68
69- InstanceNormalization
70
71- L2Normalization
72
73- Logical
74
75- LogSoftmax
76
77- Lstm
78
79- Maximum
80
81- Mean
82
83- Merge
84
85- Minimum
86
87- Multiplication
88
89- Normalization
90
91- Output
92
93- Pad (Constant, Symmetric, Reflect)
94
95- Permute
96
97- Pooling2d
98
99- Pooling3d
100
101- Prelu
102
103- QLstm
104
105- Quantize
106
107- QuantizedLstm
108
109- Rank
110
111- Reduce
112
113- Reshape
114
115- Resize
116
117- ReverseV2
118
119- Shape
120
121- Slice
122
123- Softmax
124
125- SpaceToBatchNd
126
127- SpaceToDepth
128
129- Splitter
130
131- Stack
132
133- StandIn
134
135- StridedSlice
136
137- Subtraction
138
139- Switch
140
141- Transpose
142
143- TransposeConvolution2d
144
145- UnidirectionalSequenceLstm
146
147
148More machine learning layers will be supported in future releases.
149
150@section serializersupportdeprecated Deprecated layers
151
152Some layers have been deprecated and replaced by others layers. In order to maintain backward compatibility, serializations of these deprecated layers will deserialize to the layers that have replaced them, as follows:
153
154- Abs will deserialize as ElementwiseUnary
155- Equal will deserialize as Comparison
156- Greater will deserialize as Comparison
157- Merger will deserialize as Concat
158- ResizeBilinear will deserialize as Resize
159- Rsqrt will deserialize as ElementwiseUnary
160
161**/
162}