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 - Reshape
  63 - Resize
  64 - Slice
  65 - Softmax
  66 - SpaceToBatchNd
  67 - SpaceToDepth
  68 - Splitter
  69 - Stack
  70 - StandIn
  71 - StridedSlice
  72 - Subtraction
  73 - Switch
  74 - Transpose
  75 - TransposeConvolution2d
  76
  77 More machine learning layers will be supported in future releases.
  78
  79 @subsection serializersupportdeprecated Deprecated layers
  80
  81 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:
  82
  83 - Abs will deserialize as ElementwiseUnary
  84 - Equal will deserialize as Comparison
  85 - Greater will deserialize as Comparison
  86 - Merger will deserialize as Concat
  87 - ResizeBilinear will deserialize as Resize
  88 - Rsqrt will deserialize as ElementwiseUnary
  89 <br/><br/><br/><br/>
  90
  91 @page deserializer Deserializer
  92 @tableofcontents
  93
  94 The `armnnDeserializer` is a library for loading neural networks defined by Arm NN FlatBuffers files
  95 into the Arm NN runtime.
  96
  97 @section deserializersupport Supported Layers
  98
  99 This reference guide provides a list of layers which can be deserialized by the Arm NN SDK.
 100
 101 @subsection deserializersupportfully Fully supported
 102
 103 The Arm NN SDK Deserialize parser currently supports the following layers:
 104
 105 - Abs
 106 - Activation
 107 - Addition
 108 - ArgMinMax
 109 - BatchToSpaceNd
 110 - BatchNormalization
 111 - Concat
 112 - Comparison
 113 - Constant
 114 - Convolution2d
 115 - DepthToSpace
 116 - DepthwiseConvolution2d
 117 - Dequantize
 118 - DetectionPostProcess
 119 - Division
 120 - ElementwiseUnary
 121 - Fill
 122 - Floor
 123 - FullyConnected
 124 - Gather
 125 - Input
 126 - InstanceNormalization
 127 - L2Normalization
 128 - Logical
 129 - LogSoftmax
 130 - Lstm
 131 - Maximum
 132 - Mean
 133 - Merge
 134 - Minimum
 135 - Multiplication
 136 - Normalization
 137 - Output
 138 - Pad
 139 - Permute
 140 - Pooling2d
 141 - Prelu
 142 - Quantize
 143 - QLstm
 144 - QuantizedLstm
 145 - Rank
 146 - Reshape
 147 - Resize
 148 - ResizeBilinear
 149 - Rsqrt
 150 - Slice
 151 - Softmax
 152 - SpaceToBatchNd
 153 - SpaceToDepth
 154 - Splitter
 155 - Stack
 156 - StandIn
 157 - StridedSlice
 158 - Subtraction
 159 - Switch
 160 - TransposeConvolution2d
 161
 162 More machine learning layers will be supported in future releases.
 163
 164 @subsection deserializersupportdeprecated Deprecated layers
 165
 166 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:
 167
 168 - Equal will deserialize as Comparison
 169 - Merger will deserialize as Concat
 170 - Greater will deserialize as Comparison
 171 - ResizeBilinear will deserialize as Resize
 172
 173 **/
 174 }