blob: 185d821ec013f7bcd0f3a94f3435eef4f849112a [file] [log] [blame]
Michele Di Giorgio47a89902020-03-09 19:32:33 +00001/*
Pablo Marquez Telloa5d61bf2022-03-17 12:52:02 +00002 * Copyright (c) 2020-2022 Arm Limited.
Michele Di Giorgio47a89902020-03-09 19:32:33 +00003 *
4 * SPDX-License-Identifier: MIT
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to
8 * deal in the Software without restriction, including without limitation the
9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24#ifndef ARM_COMPUTE_NEQLSTMLAYER_H
25#define ARM_COMPUTE_NEQLSTMLAYER_H
26
Michele Di Giorgio47a89902020-03-09 19:32:33 +000027#include "arm_compute/core/Types.h"
28#include "arm_compute/runtime/NEON/functions/NEActivationLayer.h"
Michalis Spyrou173ba9b2020-06-23 17:25:43 +010029#include "arm_compute/runtime/NEON/functions/NEArithmeticAddition.h"
30#include "arm_compute/runtime/NEON/functions/NEArithmeticSubtraction.h"
Michalis Spyrouebcebf12020-10-21 00:04:14 +010031#include "arm_compute/runtime/NEON/functions/NECopy.h"
Pablo Marquez Telloa5d61bf2022-03-17 12:52:02 +000032#include "arm_compute/runtime/NEON/functions/NEDequantizationLayer.h"
Michele Di Giorgio47a89902020-03-09 19:32:33 +000033#include "arm_compute/runtime/NEON/functions/NEGEMMLowpMatrixMultiplyCore.h"
34#include "arm_compute/runtime/NEON/functions/NEGEMMLowpOutputStage.h"
Michalis Spyrou6eb73452020-07-02 17:39:25 +010035#include "arm_compute/runtime/NEON/functions/NEPixelWiseMultiplication.h"
Pablo Marquez Telloa5d61bf2022-03-17 12:52:02 +000036#include "arm_compute/runtime/NEON/functions/NEQuantizationLayer.h"
Michele Di Giorgio47a89902020-03-09 19:32:33 +000037#include "arm_compute/runtime/NEON/functions/NETranspose.h"
Michele Di Giorgio47a89902020-03-09 19:32:33 +000038#include "arm_compute/runtime/common/LSTMParams.h"
Georgios Pinitas40f51a62020-11-21 03:04:18 +000039
Michalis Spyrouebcebf12020-10-21 00:04:14 +010040#include <memory>
Michele Di Giorgio47a89902020-03-09 19:32:33 +000041
42namespace arm_compute
43{
44// Forward declarations
45class ITensor;
Michalis Spyrouebcebf12020-10-21 00:04:14 +010046class ITensorInfo;
47class NEQLSTMLayerNormalizationKernel;
Manuel Bottinicfac51c2021-06-18 15:47:28 +010048namespace cpu
49{
50namespace kernels
51{
52class CpuGemmLowpMatrixAReductionKernel;
53} // namespace kernels
54} // namespace cpu
Michele Di Giorgio47a89902020-03-09 19:32:33 +000055/** Basic function to run @ref NEQLSTMLayer
56 *
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +000057 * This function calls the following kernels:
Michele Di Giorgio47a89902020-03-09 19:32:33 +000058 *
59 * -# @ref NEActivationLayer Activation functions (tanh and logistic)
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +000060 * -# @ref NEArithmeticAddition Elementwise addition
Sheri Zhangfc6744a2021-01-13 15:54:05 +000061 * -# @ref NEArithmeticSubtraction Elementwise subtraction
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +000062 * -# @ref NECopy Copy kernel for copying output_state_out to output
Michele Di Giorgio47a89902020-03-09 19:32:33 +000063 * -# @ref NEGEMMLowpMatrixMultiplyCore Quantized matrix multiplication core. Accumulators are 32-bit integers
Manuel Bottiniae58bdf2021-06-17 17:18:45 +010064 * -# @ref NEGEMMLowpOutputStage Convert 32-bit integers into QSYMM16
Manuel Bottinicfac51c2021-06-18 15:47:28 +010065 * -# @ref cpu::kernels::CpuGemmLowpMatrixAReductionKernel For precomputing effective biases to use
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +000066 * -# @ref NEPixelWiseMultiplication Elementwise multiplication
Michele Di Giorgio47a89902020-03-09 19:32:33 +000067 * -# @ref NETranspose Transpose function for reshaping the weights
68 * */
69class NEQLSTMLayer : public IFunction
70{
71public:
72 /** Default constructor */
73 NEQLSTMLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
74 /** Prevent instances of this class from being copied (As this class contains pointers) */
75 NEQLSTMLayer(const NEQLSTMLayer &) = delete;
Michalis Spyrou770dfeb2020-11-04 18:55:34 +000076 /** Prevent instances of this class from being moved (As this class contains pointers) */
77 NEQLSTMLayer(NEQLSTMLayer &&) = delete;
Michele Di Giorgio47a89902020-03-09 19:32:33 +000078 /** Prevent instances of this class from being copied (As this class contains pointers) */
79 NEQLSTMLayer &operator=(const NEQLSTMLayer &) = delete;
Michalis Spyrou770dfeb2020-11-04 18:55:34 +000080 /** Prevent instances of this class from being moved (As this class contains pointers) */
81 NEQLSTMLayer &operator=(NEQLSTMLayer &&) = delete;
Michalis Spyrouebcebf12020-10-21 00:04:14 +010082 /** Default destructor */
83 ~NEQLSTMLayer();
Michele Di Giorgio47a89902020-03-09 19:32:33 +000084 /** Initialize function's tensors.
85 *
Teresa Charlin62687422021-04-28 10:58:49 +010086 * Valid data layouts:
87 * - All
88 *
89 * Valid data type configurations:
90 * |src0 |src1 - src6 |src7 -src9 |src10 |src11 |dst0 |dst1 - dst2 |
91 * |:-------------|:------------|:------------|:------|:-------------|:------|:-----------------|
92 * |QASYMM8_SIGNED|QASYMM8 |S32 |QSYMM16|QASYMM8_SIGNED|QSYMM16|QASYMM8_SIGNED |
93 *
Michele Di Giorgio47a89902020-03-09 19:32:33 +000094 * @param[in] input Source tensor. Input is a 2D tensor with dimensions [input_size, batch_size]. Data types supported: QASYMM8_SIGNED.
95 * @param[in] input_to_forget_weights 2D weights tensor with dimensions [input_size, num_units]. Data type supported: QSYMM8.
96 * @param[in] input_to_cell_weights 2D weights tensor with dimensions [input_size, num_units]. Data type supported: QSYMM8.
97 * @param[in] input_to_output_weights 2D weights tensor with dimensions [input_size, num_units]. Data type supported: QSYMM8.
98 * @param[in] recurrent_to_forget_weights 2D weights tensor with dimensions [output_size, num_units]. Data type supported: QSYMM8.
99 * @param[in] recurrent_to_cell_weights 2D weights tensor with dimensions [output_size, num_units]. Data type supported: QSYMM8.
100 * @param[in] recurrent_to_output_weights 2D weights tensor with dimensions [output_size, num_units]. Data type supported: QSYMM8.
101 * @param[in] forget_gate_bias 1D weights tensor with dimensions [num_units]. Data type supported: S32.
102 * @param[in] cell_bias 1D weights tensor with dimensions [num_units]. Data type supported: S32.
103 * @param[in] output_gate_bias 1D weights tensor with dimensions [num_units]. Data type supported: S32.
Michele Di Giorgiobeb2d452020-05-11 16:17:51 +0100104 * @param[in] cell_state_in 2D tensor with dimensions [num_units, batch_size]. Data type supported: QSYMM16.
105 * @param[in] output_state_in 2D tensor with dimensions [output_size, batch_size]. Data type supported: Same as @p input.
106 * @param[out] cell_state_out Destination tensor. Output is a 2D tensor with dimensions [num_units, batch_size]. Data type supported: QSYMM16.
107 * @param[out] output_state_out Destination tensor. Output is a 2D tensor with dimensions [output_size, batch_size].Data types supported: Same as @p input.
108 * @param[out] output Destination tensor. Output is a 2D tensor with dimensions [output_size, batch_size].Data types supported: Same as @p input.
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000109 * @param[in] lstm_params Weights tensors used in peephole, CIFG and layer normalization optimizations:
110 * input_intermediate_scale Scale of the intermediate result of matmul, i.e. input to layer normalization, at input gate.
111 * forget_intermediate_scale Scale of the intermediate result of matmul, i.e. input to layer normalization, at forget gate.
112 * cell_intermediate_scale Scale of the intermediate result of matmul, i.e. input to layer normalization, at cell gate.
113 * output_intermediate_scale Scale of the intermediate result of matmul, i.e. input to layer normalization, at output gate.
114 * hidden_state_zero The zero point of the hidden state.
115 * hidden_state_scale The scale of the hidden state.
116 * input_to_input_weights (Optional) 2D weights tensor with dimensions [input_size, num_units]. Data type supported: QSYMM8.
117 * recurrent_to_input_weights (Optional) 2D weights tensor with dimensions [output_size, num_units]. Data type supported: QSYMM8.
118 * cell_to_input_weights (Optional) 1D weights tensor with dimensions [num_units]. Can be nullptr. Data type supported: QSYMM16.
119 * cell_to_forget_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
120 * cell_to_output_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
121 * input_gate_bias (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: S32.
122 * projection_weights (Optional) 2D weights tensor with dimensions [output_size, num_units]. Data type supported: QSYMM8.
123 * projection_bias (Optional) 1D weights tensor with dimensions [output_size]. S32.
124 * input_layer_norm_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
125 * forget_layer_norm_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
126 * cell_layer_norm_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
127 * output_layer_norm_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
128 * cell_threshold (Optional) The clipping threshold for the cell state, such that values are bound within [-cell_clip, cell_clip].
129 * If set to 0.0 then clipping is disabled.
130 * projection_threshold (Optional) The clipping threshold for the output from the projection layer, such that values are bound within
131 * [-proj_clip, proj_clip]. If set to 0.0 then clipping is disabled.
132 */
133 void configure(const ITensor *input,
134 const ITensor *input_to_forget_weights, const ITensor *input_to_cell_weights, const ITensor *input_to_output_weights,
135 const ITensor *recurrent_to_forget_weights, const ITensor *recurrent_to_cell_weights, const ITensor *recurrent_to_output_weights,
136 const ITensor *forget_gate_bias, const ITensor *cell_bias, const ITensor *output_gate_bias,
Sang-Hoon Park840a72c2020-09-23 13:24:13 +0100137 const ITensor *cell_state_in, ITensor *output_state_in,
Michele Di Giorgiobeb2d452020-05-11 16:17:51 +0100138 ITensor *cell_state_out, ITensor *output_state_out, ITensor *output,
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000139 const LSTMParams<ITensor> &lstm_params);
140
141 /** Static function to check if given info will lead to a valid configuration of @ref NEQLSTMLayer
142 *
Michele Di Giorgiobeb2d452020-05-11 16:17:51 +0100143 * @param[in] input Source tensor info. Input is a 2D tensor info with dimensions [input_size, batch_size]. Data types supported: QASYMM8_SIGNED.
144 * @param[in] input_to_forget_weights 2D weights tensor info with dimensions [input_size, num_units]. Data type supported: QSYMM8.
145 * @param[in] input_to_cell_weights 2D weights tensor info with dimensions [input_size, num_units]. Data type supported: QSYMM8.
146 * @param[in] input_to_output_weights 2D weights tensor info with dimensions [input_size, num_units]. Data type supported: QSYMM8.
147 * @param[in] recurrent_to_forget_weights 2D weights tensor info with dimensions [output_size, num_units]. Data type supported: QSYMM8.
148 * @param[in] recurrent_to_cell_weights 2D weights tensor info with dimensions [output_size, num_units]. Data type supported: QSYMM8.
149 * @param[in] recurrent_to_output_weights 2D weights tensor info with dimensions [output_size, num_units]. Data type supported: QSYMM8.
150 * @param[in] forget_gate_bias 1D weights tensor info with dimensions [num_units]. Data type supported: S32.
151 * @param[in] cell_bias 1D weights tensor info with dimensions [num_units]. Data type supported: S32.
152 * @param[in] output_gate_bias 1D weights tensor info with dimensions [num_units]. Data type supported: S32.
153 * @param[in] cell_state_in 2D tensor info with dimensions [num_units, batch_size]. Data type supported: QSYMM16.
154 * @param[in] output_state_in 2D tensor info with dimensions [output_size, batch_size]. Data type supported: Same as @p input.
155 * @param[in] cell_state_out Destination tensor info. Output is a 2D tensor info with dimensions [num_units, batch_size]. Data type supported: QSYMM16.
156 * @param[in] output_state_out Destination tensor info. Output is a 2D tensor info with dimensions [output_size, batch_size].Data types supported: Same as @p input.
157 * @param[in] output Destination tensor info. Output is a 2D tensor info with dimensions [output_size, batch_size].Data types supported: Same as @p input.
158 * @param[in] lstm_params Weights tensors info used in peephole, CIFG and layer normalization optimizations:
159 * input_intermediate_scale Scale of the intermediate result of matmul, i.e. input to layer normalization, at input gate.
160 * forget_intermediate_scale Scale of the intermediate result of matmul, i.e. input to layer normalization, at forget gate.
161 * cell_intermediate_scale Scale of the intermediate result of matmul, i.e. input to layer normalization, at cell gate.
162 * output_intermediate_scale Scale of the intermediate result of matmul, i.e. input to layer normalization, at output gate.
163 * hidden_state_zero The zero point of the hidden state.
164 * hidden_state_scale The scale of the hidden state.
165 * input_to_input_weights (Optional) 2D weights tensor with dimensions [input_size, num_units]. Data type supported: QSYMM8.
166 * recurrent_to_input_weights (Optional) 2D weights tensor with dimensions [output_size, num_units]. Data type supported: QSYMM8.
167 * cell_to_input_weights (Optional) 1D weights tensor with dimensions [num_units]. Can be nullptr. Data type supported: QSYMM16.
168 * cell_to_forget_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
169 * cell_to_output_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
170 * input_gate_bias (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: S32.
171 * projection_weights (Optional) 2D weights tensor with dimensions [output_size, num_units]. Data type supported: QSYMM8.
172 * projection_bias (Optional) 1D weights tensor with dimensions [output_size]. S32.
173 * input_layer_norm_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
174 * forget_layer_norm_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
175 * cell_layer_norm_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
176 * output_layer_norm_weights (Optional) 1D weights tensor with dimensions [num_units]. Data type supported: QSYMM16.
177 * cell_threshold (Optional) The clipping threshold for the cell state, such that values are bound within [-cell_clip, cell_clip].
178 * If set to 0.0 then clipping is disabled.
179 * projection_threshold (Optional) The clipping threshold for the output from the projection layer, such that values are bound within
180 * [-proj_clip, proj_clip]. If set to 0.0 then clipping is disabled.
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000181 * @return a status
182 */
183 static Status validate(const ITensorInfo *input,
184 const ITensorInfo *input_to_forget_weights, const ITensorInfo *input_to_cell_weights, const ITensorInfo *input_to_output_weights,
185 const ITensorInfo *recurrent_to_forget_weights, const ITensorInfo *recurrent_to_cell_weights, const ITensorInfo *recurrent_to_output_weights,
186 const ITensorInfo *forget_gate_bias, const ITensorInfo *cell_bias, const ITensorInfo *output_gate_bias,
187 const ITensorInfo *cell_state_in, const ITensorInfo *output_state_in,
Michele Di Giorgiobeb2d452020-05-11 16:17:51 +0100188 const ITensorInfo *cell_state_out, const ITensorInfo *output_state_out, const ITensorInfo *output,
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000189 const LSTMParams<ITensorInfo> &lstm_params);
190
191 // Inherited methods overridden:
192 void run() override;
193 void prepare() override;
194
195private:
Sang-Hoon Park9230e272020-04-18 00:46:34 +0100196 enum class LayerNormGate : uint8_t
197 {
198 Forget,
199 Cell,
200 Input,
201 Output,
202 Count
203 };
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100204 static constexpr uint8_t _layer_norm_count = static_cast<uint8_t>(LayerNormGate::Count);
205 static constexpr uint32_t _out_state_output_size_dimension_idx = 0;
Sang-Hoon Park9230e272020-04-18 00:46:34 +0100206
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000207 /** Internal method to configure matrix multiplication plus output stage of each gate.
208 *
209 * @param[in] mm Matrix multiplication function to use.
210 * @param[in] outstage Output stage function to use.
211 * @param[in] gemmlowp_info GEMMLowp metadata to be used by the output stage.
212 * @param[in] mm_input Input tensor to matrix multiplication function.
213 * @param[in] mm_weights Weights tensor to matrix multiplication function.
214 * @param[in] bias Bias tensor to matrix multiplication function.
215 * @param[in] outstage_res Tensor to be used for storing the result of the output stage.
216 * @param[in] gemmlowp_scale Real multiplier to be used computing multiplier and shift for requantization.
217 * @param[in] mm_res_info Tensor info to be used to initialize matrix multiplication result tensor.
218 * @param[in] mm_res_info Tensor info to be used to initialize output stage result tensor.
219 *
220 */
221 void configure_mm(NEGEMMLowpMatrixMultiplyCore &mm, NEGEMMLowpOutputStage &outstage, GEMMLowpOutputStageInfo &gemmlowp_info,
222 const ITensor *mm_input, const ITensor *mm_weights, const ITensor *bias, Tensor *mm_res,
223 Tensor *outstage_res, float gemmlowp_scale,
224 const TensorInfo &mm_res_info, const TensorInfo &outstage_tensor_info);
225
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100226 MemoryGroup _memory_group;
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000227
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100228 /** A small internel kernel do the copy between two tensors */
229 class TensorCopyKernel
230 {
231 static constexpr uint32_t max_dimension_supported = 2;
232
233 ITensor *_src{ nullptr };
234 ITensor *_dst{ nullptr };
235 size_t _row_size{};
236 Window _window{};
237
238 public:
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100239 /** Destructor */
240 ~TensorCopyKernel();
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100241 /** Static function to check if given info will lead to a valid configuration of @ref NEQLSTMLayer::TensorCopyKernel
242 *
243 * @param[in] src Source tensor info.
244 * @param[in] dst Destination tensor info
245 *
246 * @return a status
247 */
248 static Status validate(const ITensorInfo &src, const ITensorInfo &dst);
249 /** Set the input and output tensors.
250 *
251 * @param[in] src Source tensor
252 * @param[out] dst Destination tensor
253 */
254 void configure(ITensor &src, ITensor &dst);
255 /** run the kernel */
256 void run();
257 };
258
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000259 // Functions used
Pablo Marquez Telloa5d61bf2022-03-17 12:52:02 +0000260
261 NEDequantizationLayer _dequantize_input_to_forget_weights;
262 NEQuantizationLayer _quantize_input_to_forget_weights;
Manuel Bottinicfac51c2021-06-18 15:47:28 +0100263 NETranspose _transpose_input_to_forget_weights;
264 NETranspose _transpose_input_to_cell_weights;
265 NETranspose _transpose_input_to_output_weights;
266 NETranspose _transpose_input_to_input_weights;
267 NETranspose _transpose_recurrent_to_forget_weights;
268 NETranspose _transpose_recurrent_to_cell_weights;
269 NETranspose _transpose_recurrent_to_output_weights;
270 NETranspose _transpose_recurrent_to_input_weights;
271 NETranspose _transpose_projection_weights;
272 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _input_to_input_reduction;
273 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _recurrent_to_input_reduction;
274 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _input_to_forget_reduction;
275 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _recurrent_to_forget_reduction;
276 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _input_to_cell_reduction;
277 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _recurrent_to_cell_reduction;
278 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _input_to_output_reduction;
279 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _recurrent_to_output_reduction;
280 std::unique_ptr<cpu::kernels::CpuGemmLowpMatrixAReductionKernel> _projection_reduction;
281 NEArithmeticAddition _projection_bias_add;
282 NEGEMMLowpMatrixMultiplyCore _mm_input_to_forget;
283 NEGEMMLowpMatrixMultiplyCore _mm_recurrent_to_forget;
284 NEPixelWiseMultiplication _pixelwise_mul_cell_to_forget;
285 NEGEMMLowpOutputStage _input_to_forget_outstage;
286 NEGEMMLowpOutputStage _recurrent_to_forget_outstage;
287 NEGEMMLowpOutputStage _cell_to_forget_outstage;
288 NEArithmeticAddition _accumulate_input_recurrent_forget;
289 NEArithmeticAddition _accumulate_cell_forget;
290 NEActivationLayer _forget_gate_sigmoid;
291 NEGEMMLowpMatrixMultiplyCore _mm_input_to_cell;
292 NEGEMMLowpOutputStage _input_to_cell_outstage;
293 NEGEMMLowpMatrixMultiplyCore _mm_recurrent_to_cell;
294 NEGEMMLowpOutputStage _recurrent_to_cell_outstage;
295 NEArithmeticAddition _accumulate_input_recurrent_modulation;
296 NEActivationLayer _cell_gate_tanh;
297 NEArithmeticSubtraction _input_gate_sub;
298 NEGEMMLowpMatrixMultiplyCore _mm_input_to_input;
299 NEGEMMLowpOutputStage _input_to_input_outstage;
300 NEGEMMLowpMatrixMultiplyCore _mm_recurrent_to_input;
301 NEGEMMLowpOutputStage _recurrent_to_input_outstage;
302 NEArithmeticAddition _accumulate_input_recurrent_input;
303 NEPixelWiseMultiplication _pixelwise_mul_cell_to_input;
304 NEGEMMLowpOutputStage _cell_to_input_outstage;
305 NEArithmeticAddition _accumulate_cell_input;
306 NEActivationLayer _input_gate_sigmoid;
307 NEPixelWiseMultiplication _pixelwise_mul_forget_cell;
308 NEPixelWiseMultiplication _pixelwise_mul_input_cell;
309 NEArithmeticAddition _add_forget_cell;
310 NEActivationLayer _cell_clip;
311 NEGEMMLowpMatrixMultiplyCore _mm_input_to_output;
312 NEGEMMLowpOutputStage _input_to_output_outstage;
313 NEGEMMLowpMatrixMultiplyCore _mm_recurrent_to_output;
314 NEGEMMLowpOutputStage _recurrent_to_output_outstage;
315 NEArithmeticAddition _accumulate_input_recurrent_output;
316 NEPixelWiseMultiplication _pixelwise_mul_cell_to_output;
317 NEGEMMLowpOutputStage _cell_to_output_outstage;
318 NEArithmeticAddition _accumulate_cell_to_output;
319 NEActivationLayer _output_gate_sigmoid;
320 NEActivationLayer _hidden_tanh;
321 NEPixelWiseMultiplication _pixelwise_mul_hidden;
322 NEGEMMLowpOutputStage _hidden_outstage;
323 NEGEMMLowpMatrixMultiplyCore _mm_projection;
324 NEGEMMLowpOutputStage _projection_outstage;
325 NEArithmeticAddition _accumulate_projection;
326 NEActivationLayer _projection_clip;
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100327
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100328 TensorCopyKernel _projection_bias_copy;
329 TensorCopyKernel _projection_output_to_accumulate_copy;
330 TensorCopyKernel _projection_accumulate_to_output_copy;
331 TensorCopyKernel _hidden_to_output_copy;
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100332
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100333 std::array<std::unique_ptr<NEQLSTMLayerNormalizationKernel>, _layer_norm_count> _layer_norms;
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000334
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100335 NECopy _copy_output;
Michele Di Giorgiobeb2d452020-05-11 16:17:51 +0100336
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000337 // Tensor pointers
Michalis Spyrou173ba9b2020-06-23 17:25:43 +0100338 const ITensor *_input_to_input_weights
339 {
340 nullptr
341 };
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000342 const ITensor *_recurrent_to_input_weights{ nullptr };
343 const ITensor *_projection_bias{ nullptr };
344 const ITensor *_input_to_forget_weights{ nullptr };
345 const ITensor *_input_to_cell_weights{ nullptr };
346 const ITensor *_input_to_output_weights{ nullptr };
347 const ITensor *_recurrent_to_forget_weights{ nullptr };
348 const ITensor *_recurrent_to_cell_weights{ nullptr };
349 const ITensor *_recurrent_to_output_weights{ nullptr };
350 const ITensor *_projection_weights{ nullptr };
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100351 std::array<const ITensor *, _layer_norm_count> _layer_norm_weights{};
352 std::array<const ITensor *, _layer_norm_count> _layer_norm_bias{};
Sang-Hoon Park9230e272020-04-18 00:46:34 +0100353
354 using LayerNormIndexType = typename std::underlying_type<LayerNormGate>::type;
355 inline LayerNormIndexType getGateIndex(LayerNormGate g)
356 {
357 return static_cast<LayerNormIndexType>(g);
358 }
359
360 inline void set_layer_norm_weight(const ITensor *t, LayerNormGate g)
361 {
362 _layer_norm_weights[getGateIndex(g)] = t;
363 }
364
365 inline void set_layer_norm_bias(const ITensor *t, LayerNormGate g)
366 {
367 _layer_norm_bias[getGateIndex(g)] = t;
368 }
369
370 inline const ITensor *get_layer_norm_weight(LayerNormGate g)
371 {
372 return _layer_norm_weights[getGateIndex(g)];
373 }
374
375 inline const ITensor *get_layer_norm_bias(LayerNormGate g)
376 {
377 return _layer_norm_bias[getGateIndex(g)];
378 }
379
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100380 inline std::unique_ptr<NEQLSTMLayerNormalizationKernel> &get_layer_norm(LayerNormGate g)
Sang-Hoon Park9230e272020-04-18 00:46:34 +0100381 {
382 return _layer_norms[getGateIndex(g)];
383 }
384
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100385 void configure_layer_norm(LayerNormGate g, const ITensor *in);
386 static Status validate_layer_norm(const ITensorInfo &in, const ITensorInfo &weight, const ITensorInfo &bias);
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000387
388 // Temporary tensors
Pablo Marquez Telloa5d61bf2022-03-17 12:52:02 +0000389 Tensor _input_to_forget_weights_f32{ nullptr };
390 Tensor _input_to_forget_weights_symm8{ nullptr };
391
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000392 Tensor _input_to_forget_weights_transposed{ nullptr };
393 Tensor _input_to_cell_weights_transposed{ nullptr };
394 Tensor _input_to_output_weights_transposed{ nullptr };
395 Tensor _input_to_input_weights_transposed{ nullptr };
396 Tensor _recurrent_to_forget_weights_transposed{ nullptr };
397 Tensor _recurrent_to_cell_weights_transposed{ nullptr };
398 Tensor _recurrent_to_output_weights_transposed{ nullptr };
399 Tensor _recurrent_to_input_weights_transposed{ nullptr };
400 Tensor _projection_weights_transposed{ nullptr };
401 Tensor _input_to_input_eff_bias{ nullptr };
402 Tensor _recurrent_to_input_eff_bias{ nullptr };
403 Tensor _input_to_forget_eff_bias{ nullptr };
404 Tensor _recurrent_to_forget_eff_bias{ nullptr };
405 Tensor _input_to_cell_eff_bias{ nullptr };
406 Tensor _recurrent_to_cell_eff_bias{ nullptr };
407 Tensor _input_to_output_eff_bias{ nullptr };
408 Tensor _recurrent_to_output_eff_bias{ nullptr };
409 Tensor _projection_reduction_res{ nullptr };
410 Tensor _projection_eff_bias{ nullptr };
411 Tensor _mm_input_to_forget_res{ nullptr };
412 Tensor _mm_recurrent_to_forget_res{ nullptr };
413 Tensor _mul_cell_to_forget_res{ nullptr };
414 Tensor _input_to_forget_outstage_res{ nullptr };
415 Tensor _cell_to_forget_outstage_res{ nullptr };
416 Tensor _recurrent_to_forget_outstage_res{ nullptr };
417 Tensor _forget_gate{ nullptr };
418 Tensor _mm_input_to_cell_res{ nullptr };
419 Tensor _input_to_cell_outstage_res{ nullptr };
420 Tensor _mm_recurrent_to_cell_res{ nullptr };
421 Tensor _recurrent_to_cell_outstage_res{ nullptr };
422 Tensor _cell_gate{ nullptr };
423 Tensor _mul_input_cell_res{ nullptr };
424 Tensor _mm_input_to_input_res{ nullptr };
425 Tensor _input_to_input_outstage_res{ nullptr };
426 Tensor _mm_recurrent_to_input_res{ nullptr };
427 Tensor _mul_cell_to_input_res{ nullptr };
428 Tensor _cell_to_input_outstage_res{ nullptr };
429 Tensor _recurrent_to_input_outstage_res{ nullptr };
430 Tensor _input_gate{ nullptr };
431 Tensor _mm_input_to_output_res{ nullptr };
432 Tensor _input_to_output_outstage_res{ nullptr };
433 Tensor _mm_recurrent_to_output_res{ nullptr };
434 Tensor _mul_cell_to_output_res{ nullptr };
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100435 Tensor _cell_to_output_outstage_res{ nullptr };
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000436 Tensor _recurrent_to_output_outstage_res{ nullptr };
437 Tensor _output_gate{ nullptr };
438 Tensor _hidden_mul_res{ nullptr };
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100439 Tensor _hidden_gate{ nullptr };
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000440 Tensor _mm_projection_res{ nullptr };
441 Tensor _projection_outstage_res{ nullptr };
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100442 Tensor _projection_out_res{ nullptr };
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100443 Tensor _projection_accumulate_res{ nullptr };
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000444 Tensor _ones{ nullptr };
Michalis Spyrouebcebf12020-10-21 00:04:14 +0100445 std::array<Tensor, _layer_norm_count> _layer_norm_output{};
Sang-Hoon Park9230e272020-04-18 00:46:34 +0100446
447 inline Tensor &get_layer_norm_output(LayerNormGate g)
448 {
449 return _layer_norm_output[getGateIndex(g)];
450 }
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000451
452 bool _is_prepared{ false };
453 bool _has_cifg{ false };
454 bool _has_cell_clipping{ false };
455 bool _has_projection{ false };
456 bool _has_projection_clipping{ false };
457 bool _has_peephole{ false };
Sang-Hoon Park9230e272020-04-18 00:46:34 +0100458 bool _has_layer_norm{ false };
Sang-Hoon Parkd5c020a2020-05-06 21:01:19 +0100459 bool _projection_tensor_copy_required{ false };
Pablo Marquez Telloa5d61bf2022-03-17 12:52:02 +0000460 bool _convert_input_to_forget_weights_to_qsymm8{ false };
Michele Di Giorgio47a89902020-03-09 19:32:33 +0000461};
462} // namespace arm_compute
463#endif /* ARM_COMPUTE_NEQLSTMLAYER_H */