1 /// Copyright (c) 2020 ARM Limited.
3 /// SPDX-License-Identifier: MIT
5 /// Permission is hereby granted, free of charge, to any person obtaining a copy
6 /// of this software and associated documentation files (the "Software"), to deal
7 /// in the Software without restriction, including without limitation the rights
8 /// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 /// copies of the Software, and to permit persons to whom the Software is
10 /// furnished to do so, subject to the following conditions:
12 /// The above copyright notice and this permission notice shall be included in all
13 /// copies or substantial portions of the Software.
15 /// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 /// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 /// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 /// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 /// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 /// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 @page serializers The ArmNN Serializer and Deserializer
30 @section S8_serializer The ArmNN Serializer
32 The `armnnSerializer` is a library for serializing an Arm NN network to a stream.
34 ## The layers that ArmNN SDK Serializer currently supports.
36 This reference guide provides a list of layers which can be serialized currently by the Arm NN SDK.
40 The Arm NN SDK Serializer currently supports the following layers:
52 - DepthwiseConvolution2d
54 - DetectionPostProcess
61 - InstanceNormalization
90 - TransposeConvolution2d
92 More machine learning layers will be supported in future releases.
96 Some 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:
98 - Equal will deserialize as Comparison
99 - Merger will deserialize as Concat
100 - Greater will deserialize as Comparison
101 - ResizeBilinear will deserialize as Resize
102 - Abs will deserialize as ElementwiseUnary
103 - Rsqrt will deserialize as ElementwiseUnary
106 @section S9_deserializer The ArmNN Deserializer
108 The `armnnDeserializer` is a library for loading neural networks defined by Arm NN FlatBuffers files
109 into the Arm NN runtime.
111 ## The layers that ArmNN SDK Deserializer currently supports.
113 This reference guide provides a list of layers which can be deserialized currently by the Arm NN SDK.
117 The Arm NN SDK Deserialize parser currently supports the following layers:
130 - DepthwiseConvolution2d
132 - DetectionPostProcess
138 - InstanceNormalization
167 - TransposeConvolution2d
170 More machine learning layers will be supported in future releases.
174 Some 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:
176 - Equal will deserialize as Comparison
177 - Merger will deserialize as Concat
178 - Greater will deserialize as Comparison
179 - ResizeBilinear will deserialize as Resize