docs/01_02_deserializer_serializer.dox

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