Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/tags/v22.11 / . / docs / 05_02_deserializer_serializer.dox
blob: c36e01032355a4f078a26288fdd2ea5caae4a7ae [file] [log] [blame]
Jan Eilers31a7c892021-01-29 14:18:13 +0000[diff] [blame]1/// Copyright (c) 2021 ARM Limited and Contributors. All rights reserved.
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]2///
3/// SPDX-License-Identifier: MIT
4///
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]5
6namespace armnn
7{
8/**
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]9@page serializer Serializer
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]10@tableofcontents
11
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]12The `armnnSerializer` is a library for serializing an Arm NN network to a stream.
13
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]14@section serializersupport Supported Layers
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]15
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]16This reference guide provides a list of layers which can be serialized by the Arm NN SDK.
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]17
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]18@subsection serializersupportflully Fully supported
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]19
20The Arm NN SDK Serializer currently supports the following layers:
21
22- Activation
23- Addition
24- ArgMinMax
Samuel Yapa04f4a12022-08-19 11:14:38 +0100[diff] [blame]25- BatchMatMul
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]26- BatchToSpaceNd
27- BatchNormalization
mathad01b392e982021-04-07 12:07:30 +0100[diff] [blame]28- Cast
Simon Obute51f67772021-09-03 15:50:13 +0100[diff] [blame]29- ChannelShuffle
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]30- Comparison
31- Concat
32- Constant
33- Convolution2d
Matthew Sloyanb63a3112021-09-08 13:05:51 +0100[diff] [blame]34- Convolution3d
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]35- DepthToSpace
36- DepthwiseConvolution2d
37- Dequantize
38- DetectionPostProcess
39- Division
40- ElementwiseUnary
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]41- Fill
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]42- Floor
43- FullyConnected
44- Gather
Teresa Charlin6966bfa2022-04-25 17:14:50 +0100[diff] [blame]45- GatherNd
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]46- Input
47- InstanceNormalization
48- L2Normalization
James Ward590f3f72020-12-02 10:20:48 +0000[diff] [blame]49- Logical
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]50- LogSoftmax
51- Lstm
52- Maximum
53- Mean
54- Merge
55- Minimum
56- Multiplication
57- Normalization
58- Output
Matthew Sloyan2e5d0b22021-10-21 14:05:31 +0100[diff] [blame]59- Pad (Constant, Symmetric, Reflect)
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]60- Permute
61- Pooling2d
Tamas Nyirid998a1c2021-11-05 14:55:33 +0000[diff] [blame]62- Pooling3d
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]63- Prelu
James Ward590f3f72020-12-02 10:20:48 +0000[diff] [blame]64- QLstm
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]65- Quantize
66- QuantizedLstm
James Ward590f3f72020-12-02 10:20:48 +0000[diff] [blame]67- Rank
Jan Eilers1121c6b2021-02-19 09:38:03 +0000[diff] [blame]68- Reduce
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]69- Reshape
70- Resize
Keith Davis3ae3f972021-05-21 16:33:48 +0100[diff] [blame]71- Shape
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]72- Slice
73- Softmax
74- SpaceToBatchNd
75- SpaceToDepth
76- Splitter
77- Stack
78- StandIn
79- StridedSlice
80- Subtraction
81- Switch
James Ward590f3f72020-12-02 10:20:48 +0000[diff] [blame]82- Transpose
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]83- TransposeConvolution2d
Narumol Prangnawarata0162e12021-07-23 14:47:49 +0100[diff] [blame]84- UnidirectionalSequenceLstm
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]85
86More machine learning layers will be supported in future releases.
87
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]88@subsection serializersupportdeprecated Deprecated layers
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]89
90Some 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:
91
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]92- Abs will deserialize as ElementwiseUnary
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]93- Equal will deserialize as Comparison
94- Greater will deserialize as Comparison
95- Merger will deserialize as Concat
96- ResizeBilinear will deserialize as Resize
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]97- Rsqrt will deserialize as ElementwiseUnary
98<br/><br/><br/><br/>
99
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]100@page deserializer Deserializer
101@tableofcontents
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]102
103The `armnnDeserializer` is a library for loading neural networks defined by Arm NN FlatBuffers files
104into the Arm NN runtime.
105
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]106@section deserializersupport Supported Layers
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]107
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]108This reference guide provides a list of layers which can be deserialized by the Arm NN SDK.
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]109
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]110@subsection deserializersupportfully Fully supported
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]111
112The Arm NN SDK Deserialize parser currently supports the following layers:
113
114- Abs
115- Activation
116- Addition
117- ArgMinMax
Samuel Yapa04f4a12022-08-19 11:14:38 +0100[diff] [blame]118- BatchMatMul
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]119- BatchToSpaceNd
120- BatchNormalization
mathad01b392e982021-04-07 12:07:30 +0100[diff] [blame]121- Cast
Simon Obute51f67772021-09-03 15:50:13 +0100[diff] [blame]122- ChannelShuffle
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]123- Concat
124- Comparison
125- Constant
126- Convolution2d
127- DepthToSpace
128- DepthwiseConvolution2d
129- Dequantize
130- DetectionPostProcess
131- Division
James Ward590f3f72020-12-02 10:20:48 +0000[diff] [blame]132- ElementwiseUnary
133- Fill
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]134- Floor
135- FullyConnected
136- Gather
Teresa Charlin6966bfa2022-04-25 17:14:50 +0100[diff] [blame]137- GatherNd
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]138- Input
139- InstanceNormalization
140- L2Normalization
James Ward590f3f72020-12-02 10:20:48 +0000[diff] [blame]141- Logical
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]142- LogSoftmax
143- Lstm
144- Maximum
145- Mean
146- Merge
147- Minimum
148- Multiplication
149- Normalization
150- Output
151- Pad
152- Permute
153- Pooling2d
Teresa Charlin6966bfa2022-04-25 17:14:50 +0100[diff] [blame]154- Pooling3d
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]155- Prelu
156- Quantize
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]157- QLstm
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]158- QuantizedLstm
James Ward590f3f72020-12-02 10:20:48 +0000[diff] [blame]159- Rank
Jan Eilers1121c6b2021-02-19 09:38:03 +0000[diff] [blame]160- Reduce
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]161- Reshape
James Ward590f3f72020-12-02 10:20:48 +0000[diff] [blame]162- Resize
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]163- ResizeBilinear
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]164- Slice
165- Softmax
166- SpaceToBatchNd
167- SpaceToDepth
168- Splitter
169- Stack
170- StandIn
171- StridedSlice
172- Subtraction
173- Switch
Jan Eilers1121c6b2021-02-19 09:38:03 +0000[diff] [blame]174- Transpose
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]175- TransposeConvolution2d
Narumol Prangnawarata0162e12021-07-23 14:47:49 +0100[diff] [blame]176- UnidirectionalSequenceLstm
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]177
178More machine learning layers will be supported in future releases.
179
Jan Eilers1ed388f2021-01-28 14:45:09 +0000[diff] [blame]180@subsection deserializersupportdeprecated Deprecated layers
Ryan OSheaf3a43232020-02-12 16:15:27 +0000[diff] [blame]181
182Some 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:
183
184- Equal will deserialize as Comparison
185- Merger will deserialize as Concat
186- Greater will deserialize as Comparison
187- ResizeBilinear will deserialize as Resize
188
189**/
190}