blob: c57fcc9f2137f3ab4746f9b217bc3b7f37885adc [file] [log] [blame]
Manuel Bottini10c53f12019-07-17 16:11:53 +01001/*
Manuel Bottini2b84be52020-04-08 10:15:51 +01002 * Copyright (c) 2019-2020 ARM Limited.
Manuel Bottini10c53f12019-07-17 16:11:53 +01003 *
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
25#include "arm_compute/runtime/CL/functions/CLLSTMLayerQuantized.h"
26
27#include "arm_compute/core/Utils.h"
28#include "arm_compute/core/Validate.h"
29#include "arm_compute/core/utils/quantization/AsymmHelpers.h"
30
31#include <cmath>
32#include <memory>
33#include <tuple>
34
35namespace arm_compute
36{
37namespace
38{
39// Quantization info structures used in the LSTMQuantize layer
40const QuantizationInfo qasymm(1.f / 128.f, 128);
41const QuantizationInfo qsymm_3(8.f / 32768.f, 0); // qsymm16 with 3 integer bit
42const QuantizationInfo qsymm_4(16.f / 32768.f, 0); // qsymm16 with 4 integer bit
43const QuantizationInfo qsymm_0(1.f / 32768.f, 0); // qsymm16 with 0 integer bit
44} // namespace
45
46CLLSTMLayerQuantized::CLLSTMLayerQuantized(std::shared_ptr<IMemoryManager> memory_manager)
47 : _memory_group(std::move(memory_manager)), _gemmlowp(), _output_stage(), _transpose_weights(), _concat_input_weights(), _concat_recurrent_weights(), _concat_weights(), _concat_inputs(),
48 _concat_bias(), _sigmoid_forget_gate(), _sigmoid_input_gate(), _sigmoid_output_gate(), _tanh_modulation_gate(), _tanh_output_state(), _add_cell_state_tmps(), _add2(), _mul_forget_gate_cell_state(),
49 _mul_input_gate_input_mod_gate(), _mul_output_state_tmp_output_gate(), _slice_input_tensor(), _slice_forget_tensor(), _slice_cell_tensor(), _slice_output_tensor(), _dequantize(), _quantize(),
50 _input_to_input_weights(nullptr), _input_to_forget_weights(nullptr), _input_to_cell_weights(nullptr), _input_to_output_weights(nullptr), _recurrent_to_input_weights(nullptr),
51 _recurrent_to_forget_weights(nullptr), _recurrent_to_cell_weights(nullptr), _recurrent_to_output_weights(nullptr), _input_gate_bias(nullptr), _forget_gate_bias(nullptr), _cell_bias(nullptr),
52 _output_gate_bias(nullptr), _recurrent_weights(), _input_weights(), _weights(), _input(), _weights_transposed(), _output_highp(), _output_lowp(), _bias(), _forget_gate_input(), _input_gate_input(),
53 _output_gate_input(), _input_modulation_gate_input(), _forget_gate_output(), _input_gate_output(), _output_gate_output(), _input_modulation_gate_output(), _cell_state_tmp1(), _cell_state_tmp2(),
54 _output_state_tmp(), _output_state_out_symm(), _output_state_out_f32(), _is_prepared(false)
55{
56}
57
58void CLLSTMLayerQuantized::configure(const ICLTensor *input,
59 const ICLTensor *input_to_input_weights, const ICLTensor *input_to_forget_weights, const ICLTensor *input_to_cell_weights, const ICLTensor *input_to_output_weights,
60 const ICLTensor *recurrent_to_input_weights, const ICLTensor *recurrent_to_forget_weights, const ICLTensor *recurrent_to_cell_weights, const ICLTensor *recurrent_to_output_weights,
61 const ICLTensor *input_gate_bias, const ICLTensor *forget_gate_bias, const ICLTensor *cell_bias, const ICLTensor *output_gate_bias,
62 ICLTensor *cell_state_in, const ICLTensor *output_state_in,
63 ICLTensor *cell_state_out, ICLTensor *output_state_out)
64{
Manuel Bottini2b84be52020-04-08 10:15:51 +010065 configure(CLKernelLibrary::get().get_compile_context(), input, input_to_input_weights, input_to_forget_weights, input_to_cell_weights, input_to_output_weights, recurrent_to_input_weights,
66 recurrent_to_forget_weights, recurrent_to_cell_weights, recurrent_to_output_weights, input_gate_bias, forget_gate_bias, cell_bias, output_gate_bias, cell_state_in, output_state_in, cell_state_out,
67 output_state_out);
68}
69
70void CLLSTMLayerQuantized::configure(const CLCompileContext &compile_context, const ICLTensor *input,
71 const ICLTensor *input_to_input_weights, const ICLTensor *input_to_forget_weights, const ICLTensor *input_to_cell_weights, const ICLTensor *input_to_output_weights,
72 const ICLTensor *recurrent_to_input_weights, const ICLTensor *recurrent_to_forget_weights, const ICLTensor *recurrent_to_cell_weights, const ICLTensor *recurrent_to_output_weights,
73 const ICLTensor *input_gate_bias, const ICLTensor *forget_gate_bias, const ICLTensor *cell_bias, const ICLTensor *output_gate_bias,
74 ICLTensor *cell_state_in, const ICLTensor *output_state_in,
75 ICLTensor *cell_state_out, ICLTensor *output_state_out)
76{
Manuel Bottini10c53f12019-07-17 16:11:53 +010077 ARM_COMPUTE_ERROR_ON_NULLPTR(input, input_to_input_weights, input_to_forget_weights, input_to_cell_weights, input_to_output_weights,
78 recurrent_to_input_weights, recurrent_to_forget_weights, recurrent_to_cell_weights, recurrent_to_output_weights,
79 input_gate_bias, forget_gate_bias, cell_bias, output_gate_bias, cell_state_in, output_state_in, cell_state_out, output_state_out);
80
81 ARM_COMPUTE_ERROR_THROW_ON(CLLSTMLayerQuantized::validate(input->info(), input_to_input_weights->info(), input_to_forget_weights->info(), input_to_cell_weights->info(),
82 input_to_output_weights->info(),
83 recurrent_to_input_weights->info(), recurrent_to_forget_weights->info(), recurrent_to_cell_weights->info(), recurrent_to_output_weights->info(),
84 input_gate_bias->info(), forget_gate_bias->info(), cell_bias->info(), output_gate_bias->info(), cell_state_in->info(), output_state_in->info(), cell_state_out->info(), output_state_out->info()));
85
86 const int input_size = input->info()->dimension(0);
87 const int batch_size = input->info()->dimension(1);
88 const int output_size = input_to_input_weights->info()->dimension(1);
89
90 const QuantizationInfo qweights = input_to_input_weights->info()->quantization_info(); // Weights quantization
91
92 auto_init_if_empty(*cell_state_out->info(), TensorInfo(TensorShape(batch_size, output_size), 1, DataType::QSYMM16, qsymm_4));
93 auto_init_if_empty(*output_state_out->info(), TensorInfo(TensorShape(batch_size, output_size), 1, DataType::QASYMM8, qasymm));
94
95 _input_to_input_weights = input_to_input_weights;
96 _input_to_forget_weights = input_to_forget_weights;
97 _input_to_cell_weights = input_to_cell_weights;
98 _input_to_output_weights = input_to_output_weights;
99 _recurrent_to_input_weights = recurrent_to_input_weights;
100 _recurrent_to_forget_weights = recurrent_to_forget_weights;
101 _recurrent_to_cell_weights = recurrent_to_cell_weights;
102 _recurrent_to_output_weights = recurrent_to_output_weights;
103 _input_gate_bias = input_gate_bias;
104 _forget_gate_bias = forget_gate_bias;
105 _cell_bias = cell_bias;
106 _output_gate_bias = output_gate_bias;
107
108 // Weights concatenation
109 std::vector<const ICLTensor *> inputs_weights_vector;
110 inputs_weights_vector.emplace_back(input_to_input_weights);
111 inputs_weights_vector.emplace_back(input_to_forget_weights);
112 inputs_weights_vector.emplace_back(input_to_cell_weights);
113 inputs_weights_vector.emplace_back(input_to_output_weights);
114
115 std::vector<const ICLTensor *> recurrent_weights_vector;
116 recurrent_weights_vector.emplace_back(recurrent_to_input_weights);
117 recurrent_weights_vector.emplace_back(recurrent_to_forget_weights);
118 recurrent_weights_vector.emplace_back(recurrent_to_cell_weights);
119 recurrent_weights_vector.emplace_back(recurrent_to_output_weights);
120
121 _input_weights.allocator()->init(TensorInfo(TensorShape(input_size, 4 * output_size), 1, DataType::QASYMM8, qweights));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100122 _concat_input_weights.configure(compile_context, inputs_weights_vector, &_input_weights, Window::DimY);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100123
124 _recurrent_weights.allocator()->init(TensorInfo(TensorShape(output_size, 4 * output_size), 1, DataType::QASYMM8, qweights));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100125 _concat_recurrent_weights.configure(compile_context, recurrent_weights_vector, &_recurrent_weights, Window::DimY);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100126
127 std::vector<const ICLTensor *> weights_vector;
128 weights_vector.emplace_back(&_recurrent_weights);
129 weights_vector.emplace_back(&_input_weights);
130
131 _weights.allocator()->init(TensorInfo(TensorShape(output_size + input_size, 4 * output_size), 1, DataType::QASYMM8, qweights));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100132 _concat_weights.configure(compile_context, weights_vector, &_weights, Window::DimX);
133 _transpose_weights.configure(compile_context, &_weights, &_weights_transposed);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100134
135 // Input concatenation
136 std::vector<const ICLTensor *> input_vector;
137 input_vector.emplace_back(input);
138 input_vector.emplace_back(output_state_in);
139
140 _memory_group.manage(&_input);
141 _input.allocator()->init(TensorInfo(TensorShape(output_size + input_size, batch_size), 1, DataType::QASYMM8, qasymm));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100142 _concat_inputs.configure(compile_context, input_vector, &_input, Window::DimX);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100143
144 // Bias concatenation
145 std::vector<const ICLTensor *> bias_vector;
146 bias_vector.emplace_back(input_gate_bias);
147 bias_vector.emplace_back(forget_gate_bias);
148 bias_vector.emplace_back(cell_bias);
149 bias_vector.emplace_back(output_gate_bias);
150
151 _bias.allocator()->init(TensorInfo(TensorShape(4 * output_size), 1, DataType::S32));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100152 _concat_bias.configure(compile_context, bias_vector, &_bias, Window::DimX);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100153
154 // Invert the offset for gemmlowp
155 _input.info()->set_quantization_info(QuantizationInfo(qasymm.uniform().scale, -qasymm.uniform().offset));
156 _weights_transposed.info()->set_quantization_info(QuantizationInfo(qweights.uniform().scale, -qweights.uniform().offset));
157
158 // Run gemmlowp
159 _memory_group.manage(&_output_highp);
160 _output_highp.allocator()->init(TensorInfo(TensorShape(4 * output_size, batch_size), 1, DataType::S32));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100161 _gemmlowp.configure(compile_context, &_input, &_weights_transposed, nullptr, &_output_highp);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100162 _input.allocator()->allocate();
163
164 // Set the offset back
165 _input.info()->set_quantization_info(QuantizationInfo(qasymm.uniform().scale, qasymm.uniform().offset));
166 _weights_transposed.info()->set_quantization_info(QuantizationInfo(qweights.uniform().scale, qweights.uniform().offset));
167
168 // multiplier = (input_scale * weights_scale) / output_scale (2 ^ (-12))
169 _output_lowp.allocator()->init(TensorInfo(_output_highp.info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_3));
170
171 const float multiplier = 4096.f * qasymm.uniform().scale * qweights.uniform().scale;
172 int output_multiplier = 0;
173 int output_shift = 0;
Manuel Bottini07263982019-10-17 18:37:26 +0100174 quantization::calculate_quantized_multiplier(multiplier, &output_multiplier, &output_shift);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100175
176 _memory_group.manage(&_output_lowp);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100177 _output_stage.configure(compile_context, &_output_highp, &_bias, &_output_lowp, output_multiplier, output_shift);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100178 _output_highp.allocator()->allocate();
179 _bias.allocator()->allocate();
180
181 // Get the gate tensors
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100182 if(batch_size > 1)
183 {
184 _memory_group.manage(&_input_gate_input);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100185 _slice_input_tensor.configure(compile_context, &_output_lowp, &_input_gate_input, { 0, 0 }, { output_size, batch_size });
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100186 _memory_group.manage(&_forget_gate_input);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100187 _slice_forget_tensor.configure(compile_context, &_output_lowp, &_forget_gate_input, { output_size, 0 }, { 2 * output_size, batch_size });
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100188 _memory_group.manage(&_input_modulation_gate_input);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100189 _slice_cell_tensor.configure(compile_context, &_output_lowp, &_input_modulation_gate_input, { 2 * output_size, 0 }, { 3 * output_size, batch_size });
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100190 _memory_group.manage(&_output_gate_input);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100191 _slice_output_tensor.configure(compile_context, &_output_lowp, &_output_gate_input, { 3 * output_size, 0 }, { 4 * output_size, batch_size });
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100192 _output_lowp.allocator()->allocate();
193 }
194 else
195 {
196 _memory_group.manage(&_input_gate_input);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100197 _slice_input_tensor.configure(compile_context, &_output_lowp, &_input_gate_input, { 0 }, { output_size });
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100198 _memory_group.manage(&_forget_gate_input);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100199 _slice_forget_tensor.configure(compile_context, &_output_lowp, &_forget_gate_input, { output_size }, { 2 * output_size });
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100200 _memory_group.manage(&_input_modulation_gate_input);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100201 _slice_cell_tensor.configure(compile_context, &_output_lowp, &_input_modulation_gate_input, { 2 * output_size }, { 3 * output_size });
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100202 _memory_group.manage(&_output_gate_input);
Manuel Bottini2b84be52020-04-08 10:15:51 +0100203 _slice_output_tensor.configure(compile_context, &_output_lowp, &_output_gate_input, { 3 * output_size }, { 4 * output_size });
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100204 _output_lowp.allocator()->allocate();
205 }
Manuel Bottini10c53f12019-07-17 16:11:53 +0100206
207 // Forget gate
208 _memory_group.manage(&_forget_gate_output);
209 _forget_gate_output.allocator()->init(TensorInfo(_forget_gate_input.info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_0));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100210 _sigmoid_forget_gate.configure(compile_context, &_forget_gate_input, &_forget_gate_output, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::LOGISTIC));
Manuel Bottini10c53f12019-07-17 16:11:53 +0100211 _forget_gate_input.allocator()->allocate();
212
213 // Input gate
214 _memory_group.manage(&_input_gate_output);
215 _input_gate_output.allocator()->init(TensorInfo(_input_gate_input.info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_0));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100216 _sigmoid_input_gate.configure(compile_context, &_input_gate_input, &_input_gate_output, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::LOGISTIC));
Manuel Bottini10c53f12019-07-17 16:11:53 +0100217 _input_gate_input.allocator()->allocate();
218
219 // Input modulation gate equation
220 _memory_group.manage(&_input_modulation_gate_output);
221 _input_modulation_gate_output.allocator()->init(TensorInfo(_input_modulation_gate_input.info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_0));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100222 _tanh_modulation_gate.configure(compile_context, &_input_modulation_gate_input, &_input_modulation_gate_output, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::TANH, 1.0f, 1.0f));
Manuel Bottini10c53f12019-07-17 16:11:53 +0100223 _input_modulation_gate_input.allocator()->allocate();
224
225 // Output gate
226 _memory_group.manage(&_output_gate_output);
227 _output_gate_output.allocator()->init(TensorInfo(_output_gate_input.info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_0));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100228 _sigmoid_output_gate.configure(compile_context, &_output_gate_input, &_output_gate_output, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::LOGISTIC));
Manuel Bottini10c53f12019-07-17 16:11:53 +0100229 _output_gate_input.allocator()->allocate();
230
231 // Long term memory
232 _memory_group.manage(&_cell_state_tmp1);
233 _cell_state_tmp1.allocator()->init(TensorInfo(_forget_gate_output.info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_4));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100234 _mul_forget_gate_cell_state.configure(compile_context, &_forget_gate_output, cell_state_in, &_cell_state_tmp1, 1, ConvertPolicy::SATURATE, RoundingPolicy::TO_ZERO);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100235 _forget_gate_output.allocator()->allocate();
236
237 _memory_group.manage(&_cell_state_tmp2);
238 _cell_state_tmp2.allocator()->init(TensorInfo(_input_gate_output.info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_4));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100239 _mul_input_gate_input_mod_gate.configure(compile_context, &_input_gate_output, &_input_modulation_gate_output, &_cell_state_tmp2, 1, ConvertPolicy::SATURATE, RoundingPolicy::TO_ZERO);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100240 _input_modulation_gate_output.allocator()->allocate();
241 _input_gate_output.allocator()->allocate();
242
Manuel Bottini2b84be52020-04-08 10:15:51 +0100243 _add_cell_state_tmps.configure(compile_context, &_cell_state_tmp1, &_cell_state_tmp2, cell_state_out, ConvertPolicy::SATURATE);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100244 _cell_state_tmp1.allocator()->allocate();
245 _cell_state_tmp2.allocator()->allocate();
246
247 // Short term memory
248 _memory_group.manage(&_output_state_tmp);
249 _output_state_tmp.allocator()->init(TensorInfo(cell_state_out->info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_0));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100250 _tanh_output_state.configure(compile_context, cell_state_out, &_output_state_tmp, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::TANH, 1.0f, 1.0f));
Manuel Bottini10c53f12019-07-17 16:11:53 +0100251
252 _memory_group.manage(&_output_state_out_symm);
253 _output_state_out_symm.allocator()->init(TensorInfo(_output_gate_output.info()->tensor_shape(), 1, DataType::QSYMM16, qsymm_0));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100254 _mul_output_state_tmp_output_gate.configure(compile_context, &_output_state_tmp, &_output_gate_output, &_output_state_out_symm, 1, ConvertPolicy::SATURATE, RoundingPolicy::TO_ZERO);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100255 _output_gate_output.allocator()->allocate();
256 _output_state_tmp.allocator()->allocate();
257
258 // Requantize the output state from QSYMM16 to QASYMM8
259 _memory_group.manage(&_output_state_out_f32);
260 _output_state_out_f32.allocator()->init(TensorInfo(_output_state_out_symm.info()->tensor_shape(), 1, DataType::F32));
Manuel Bottini2b84be52020-04-08 10:15:51 +0100261 _dequantize.configure(compile_context, &_output_state_out_symm, &_output_state_out_f32);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100262 _output_state_out_symm.allocator()->allocate();
263
Manuel Bottini2b84be52020-04-08 10:15:51 +0100264 _quantize.configure(compile_context, &_output_state_out_f32, output_state_out);
Manuel Bottini10c53f12019-07-17 16:11:53 +0100265 _output_state_out_f32.allocator()->allocate();
266}
267
268Status CLLSTMLayerQuantized::validate(const ITensorInfo *input,
269 const ITensorInfo *input_to_input_weights, const ITensorInfo *input_to_forget_weights, const ITensorInfo *input_to_cell_weights, const ITensorInfo *input_to_output_weights,
270 const ITensorInfo *recurrent_to_input_weights, const ITensorInfo *recurrent_to_forget_weights, const ITensorInfo *recurrent_to_cell_weights, const ITensorInfo *recurrent_to_output_weights,
271 const ITensorInfo *input_gate_bias, const ITensorInfo *forget_gate_bias, const ITensorInfo *cell_bias, const ITensorInfo *output_gate_bias,
272 const ITensorInfo *cell_state_in, const ITensorInfo *output_state_in,
273 const ITensorInfo *cell_state_out, const ITensorInfo *output_state_out)
274{
275 ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, input_to_input_weights, input_to_forget_weights, input_to_cell_weights, input_to_output_weights, recurrent_to_input_weights,
276 recurrent_to_forget_weights, recurrent_to_cell_weights, recurrent_to_output_weights, input_gate_bias, forget_gate_bias, cell_bias, output_gate_bias, cell_state_in,
277 output_state_in, cell_state_out, output_state_out);
278
279 const int input_size = input->dimension(0);
280 const int batch_size = input->dimension(1);
281 const int output_size = input_to_input_weights->dimension(1);
282
283 // Dimensionality checks
284 ARM_COMPUTE_RETURN_ERROR_ON(input->num_dimensions() > 2);
285 ARM_COMPUTE_RETURN_ERROR_ON(input_to_input_weights->num_dimensions() > 2);
286 ARM_COMPUTE_RETURN_ERROR_ON(input_gate_bias->num_dimensions() > 1);
287 ARM_COMPUTE_RETURN_ERROR_ON(output_state_in->num_dimensions() > 2);
288
289 TensorInfo input_weights_info(input_to_input_weights->clone()->set_tensor_shape(TensorShape(input_size, output_size)).set_data_type(DataType::QASYMM8));
290 TensorInfo recurrent_weights_info(input_to_input_weights->clone()->set_tensor_shape(TensorShape(output_size, output_size)).set_data_type(DataType::QASYMM8));
291 TensorInfo bias_info(input_gate_bias->clone()->set_tensor_shape(TensorShape(output_size)).set_data_type(DataType::S32));
292 TensorInfo output_state_info(cell_state_in->clone()->set_tensor_shape(TensorShape(output_size, batch_size)).set_data_type(DataType::QASYMM8).set_quantization_info(qasymm));
293 TensorInfo cell_state_info(cell_state_in->clone()->set_tensor_shape(TensorShape(output_size, batch_size)).set_data_type(DataType::QSYMM16).set_quantization_info(qsymm_4));
294
295 // Shape checks
296 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(&input_weights_info, input_to_input_weights, input_to_forget_weights, input_to_cell_weights, input_to_output_weights);
297 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(&recurrent_weights_info, recurrent_to_input_weights, recurrent_to_forget_weights, recurrent_to_cell_weights, recurrent_to_output_weights);
298 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(&bias_info, input_gate_bias, forget_gate_bias, cell_bias, output_gate_bias);
299 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(&cell_state_info, cell_state_in);
300 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(&output_state_info, output_state_in);
301
302 // Data type checks
303 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(&input_weights_info, input, input_to_input_weights, input_to_forget_weights, input_to_cell_weights, input_to_output_weights);
304 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(&recurrent_weights_info, recurrent_to_input_weights, recurrent_to_forget_weights, recurrent_to_cell_weights, recurrent_to_output_weights);
305 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(&bias_info, input_gate_bias, forget_gate_bias, cell_bias, output_gate_bias);
306 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(&cell_state_info, cell_state_in);
307 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(&output_state_info, output_state_in);
308
309 // Quantization checks
310 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(input_to_input_weights, input_to_forget_weights, input_to_cell_weights, input_to_output_weights);
311 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(recurrent_to_input_weights, recurrent_to_forget_weights, recurrent_to_cell_weights, recurrent_to_output_weights);
312 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(&cell_state_info, cell_state_in);
313 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(&output_state_info, output_state_in);
314
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100315 // Validate internal functions
316 // _concat_input_weights
317 std::vector<const ITensorInfo *> inputs_weights_vector;
318 inputs_weights_vector.emplace_back(input_to_input_weights);
319 inputs_weights_vector.emplace_back(input_to_forget_weights);
320 inputs_weights_vector.emplace_back(input_to_cell_weights);
321 inputs_weights_vector.emplace_back(input_to_output_weights);
322 const QuantizationInfo qweights = input_to_input_weights->quantization_info(); // Weights quantization
323 const TensorInfo input_weights(TensorShape(input_size, 4 * output_size), 1, DataType::QASYMM8, qweights);
324 ARM_COMPUTE_RETURN_ON_ERROR(CLConcatenateLayer::validate(inputs_weights_vector, &input_weights, Window::DimY));
325
326 // _concat_recurrent_weights
327 std::vector<const ITensorInfo *> recurrent_weights_vector;
328 recurrent_weights_vector.emplace_back(recurrent_to_input_weights);
329 recurrent_weights_vector.emplace_back(recurrent_to_forget_weights);
330 recurrent_weights_vector.emplace_back(recurrent_to_cell_weights);
331 recurrent_weights_vector.emplace_back(recurrent_to_output_weights);
332 const TensorInfo recurrent_weights(TensorShape(output_size, 4 * output_size), 1, DataType::QASYMM8, qweights);
333 ARM_COMPUTE_RETURN_ON_ERROR(CLConcatenateLayer::validate(recurrent_weights_vector, &recurrent_weights, Window::DimY));
334
335 // _concat_weights
336 std::vector<const ITensorInfo *> weights_vector;
337 weights_vector.emplace_back(&recurrent_weights);
338 weights_vector.emplace_back(&input_weights);
339 const TensorInfo weights(TensorShape(input_size + output_size, 4 * output_size), 1, DataType::QASYMM8, qweights);
340 ARM_COMPUTE_RETURN_ON_ERROR(CLConcatenateLayer::validate(weights_vector, &weights, Window::DimX));
341 // _transpose_weights
342 const TensorShape weights_transposed_shape(weights.tensor_shape()[1], weights.tensor_shape()[0]);
343 TensorInfo weights_transposed = weights.clone()->set_is_resizable(true).set_tensor_shape(weights_transposed_shape);
344 ARM_COMPUTE_RETURN_ON_ERROR(CLTranspose::validate(&weights, &weights_transposed));
345
346 // _concat_inputs
347 std::vector<const ITensorInfo *> input_vector;
348 input_vector.emplace_back(input);
349 input_vector.emplace_back(output_state_in);
350 TensorInfo input_concatenated(TensorShape(output_size + input_size, batch_size), 1, DataType::QASYMM8, qasymm);
351 ARM_COMPUTE_RETURN_ON_ERROR(CLConcatenateLayer::validate(input_vector, &input_concatenated, Window::DimX));
352
353 // _concat_bias
354 std::vector<const ITensorInfo *> bias_vector;
355 bias_vector.emplace_back(input_gate_bias);
356 bias_vector.emplace_back(forget_gate_bias);
357 bias_vector.emplace_back(cell_bias);
358 bias_vector.emplace_back(output_gate_bias);
359
360 const TensorInfo bias_concatenated(TensorShape(4 * output_size), 1, DataType::S32);
361 ARM_COMPUTE_RETURN_ON_ERROR(CLConcatenateLayer::validate(bias_vector, &bias_concatenated, Window::DimX));
362
363 // Invert the offset for gemmlowp
364 input_concatenated.set_quantization_info(QuantizationInfo(qasymm.uniform().scale, -qasymm.uniform().offset));
365 weights_transposed.set_quantization_info(QuantizationInfo(qweights.uniform().scale, -qweights.uniform().offset));
366
367 // _gemmlowp
368 const TensorInfo output_highp(TensorShape(4 * output_size, batch_size), 1, DataType::S32);
369 ARM_COMPUTE_RETURN_ON_ERROR(CLGEMMLowpMatrixMultiplyCore::validate(&input_concatenated, &weights_transposed, nullptr, &output_highp));
370
371 // Set the offset back
372 input_concatenated.set_quantization_info(QuantizationInfo(qasymm.uniform().scale, qasymm.uniform().offset));
373 weights_transposed.set_quantization_info(QuantizationInfo(qweights.uniform().scale, qweights.uniform().offset));
374
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100375 const TensorInfo output_lowp(output_highp.tensor_shape(), 1, DataType::QSYMM16, qsymm_3);
376
Manuel Bottini07263982019-10-17 18:37:26 +0100377 const float multiplier = 4096.f * qasymm.uniform().scale * qweights.uniform().scale;
378 int output_multiplier = 0;
379 int output_shift = 0;
380 ARM_COMPUTE_RETURN_ON_ERROR(quantization::calculate_quantized_multiplier(multiplier, &output_multiplier, &output_shift));
381
Michele Di Giorgio601ba3f2019-08-22 16:20:04 +0100382 // _output_stage
383 ARM_COMPUTE_RETURN_ON_ERROR(CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPoint::validate(&output_highp, &bias_concatenated, &output_lowp));
384
385 TensorInfo input_gate_input;
386 TensorInfo forget_gate_input;
387 TensorInfo input_modulation_gate_input;
388 TensorInfo output_gate_input;
389
390 if(batch_size > 1)
391 {
392 // _slice_input_tensor
393 input_gate_input = TensorInfo(TensorShape(output_size, batch_size), 1, DataType::QSYMM16, qsymm_3);
394 ARM_COMPUTE_RETURN_ON_ERROR(CLSlice::validate(&output_lowp, &input_gate_input, { 0, 0 }, { output_size, batch_size }));
395 // _slice_forget_tensor
396 forget_gate_input = TensorInfo(TensorShape(output_size, batch_size), 1, DataType::QSYMM16, qsymm_3);
397 ARM_COMPUTE_RETURN_ON_ERROR(CLSlice::validate(&output_lowp, &forget_gate_input, { output_size, 0 }, { 2 * output_size, batch_size }));
398 // _slice_cell_tensor
399 input_modulation_gate_input = TensorInfo(TensorShape(output_size, batch_size), 1, DataType::QSYMM16, qsymm_3);
400 ARM_COMPUTE_RETURN_ON_ERROR(CLSlice::validate(&output_lowp, &input_modulation_gate_input, { 2 * output_size, 0 }, { 3 * output_size, batch_size }));
401 // _slice_output_tensor
402 output_gate_input = TensorInfo(TensorShape(output_size, batch_size), 1, DataType::QSYMM16, qsymm_3);
403 ARM_COMPUTE_RETURN_ON_ERROR(CLSlice::validate(&output_lowp, &output_gate_input, { 3 * output_size, 0 }, { 4 * output_size, batch_size }));
404 }
405 else
406 {
407 // _slice_input_tensor
408 input_gate_input = TensorInfo(TensorShape(output_size), 1, DataType::QSYMM16, qsymm_3);
409 ARM_COMPUTE_RETURN_ON_ERROR(CLSlice::validate(&output_lowp, &input_gate_input, { 0 }, { output_size }));
410 // _slice_forget_tensor
411 forget_gate_input = TensorInfo(TensorShape(output_size), 1, DataType::QSYMM16, qsymm_3);
412 ARM_COMPUTE_RETURN_ON_ERROR(CLSlice::validate(&output_lowp, &forget_gate_input, { output_size }, { 2 * output_size }));
413 // _slice_cell_tensor
414 input_modulation_gate_input = TensorInfo(TensorShape(output_size), 1, DataType::QSYMM16, qsymm_3);
415 ARM_COMPUTE_RETURN_ON_ERROR(CLSlice::validate(&output_lowp, &input_modulation_gate_input, { 2 * output_size }, { 3 * output_size }));
416 // _slice_output_tensor
417 output_gate_input = TensorInfo(TensorShape(output_size), 1, DataType::QSYMM16, qsymm_3);
418 ARM_COMPUTE_RETURN_ON_ERROR(CLSlice::validate(&output_lowp, &output_gate_input, { 3 * output_size }, { 4 * output_size }));
419 }
420
421 // _sigmoid_forget_gate
422 const TensorInfo forget_gate_output(forget_gate_input.tensor_shape(), 1, DataType::QSYMM16, qsymm_0);
423 ARM_COMPUTE_RETURN_ON_ERROR(CLActivationLayer::validate(&forget_gate_input, &forget_gate_output, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::LOGISTIC)));
424 // _sigmoid_input_gate
425 const TensorInfo input_gate_output(input_gate_input.tensor_shape(), 1, DataType::QSYMM16, qsymm_0);
426 ARM_COMPUTE_RETURN_ON_ERROR(CLActivationLayer::validate(&input_gate_input, &input_gate_output, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::LOGISTIC)));
427 // _tanh_modulation_gate
428 const TensorInfo input_modulation_gate_output(input_modulation_gate_input.tensor_shape(), 1, DataType::QSYMM16, qsymm_0);
429 ARM_COMPUTE_RETURN_ON_ERROR(CLActivationLayer::validate(&input_modulation_gate_input, &input_modulation_gate_output, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::TANH, 1.0f, 1.0f)));
430 // _sigmoid_output_gate
431 const TensorInfo output_gate_output(output_gate_input.tensor_shape(), 1, DataType::QSYMM16, qsymm_0);
432 ARM_COMPUTE_RETURN_ON_ERROR(CLActivationLayer::validate(&output_gate_input, &output_gate_output, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::LOGISTIC)));
433
434 // _mul_forget_gate_cell_state
435 const TensorInfo cell_state_tmp1(forget_gate_output.tensor_shape(), 1, DataType::QSYMM16, qsymm_4);
436 ARM_COMPUTE_RETURN_ON_ERROR(CLPixelWiseMultiplication::validate(&forget_gate_output, cell_state_in, &cell_state_tmp1, 1, ConvertPolicy::SATURATE, RoundingPolicy::TO_ZERO));
437
438 // _mul_input_gate_input_mod_gate
439 const TensorInfo cell_state_tmp2(input_gate_output.tensor_shape(), 1, DataType::QSYMM16, qsymm_4);
440 ARM_COMPUTE_RETURN_ON_ERROR(CLPixelWiseMultiplication::validate(&input_gate_output, &input_modulation_gate_output, &cell_state_tmp2, 1, ConvertPolicy::SATURATE, RoundingPolicy::TO_ZERO));
441
442 // _add_cell_state_tmps
443 ARM_COMPUTE_RETURN_ON_ERROR(CLArithmeticAddition::validate(&cell_state_tmp1, &cell_state_tmp2, cell_state_out, ConvertPolicy::SATURATE));
444
445 // _tanh_modulation_gate
446 const TensorInfo output_state_tmp(cell_state_out->tensor_shape(), 1, DataType::QSYMM16, qsymm_0);
447 ARM_COMPUTE_RETURN_ON_ERROR(CLActivationLayer::validate(cell_state_out, &output_state_tmp, ActivationLayerInfo(ActivationLayerInfo::ActivationFunction::TANH, 1.0f, 1.0f)));
448
449 // _mul_output_state_tmp_output_gate
450 const TensorInfo output_state_out_symm(output_gate_output.tensor_shape(), 1, DataType::QSYMM16, qsymm_0);
451 ARM_COMPUTE_RETURN_ON_ERROR(CLPixelWiseMultiplication::validate(&output_state_tmp, &output_gate_output, &output_state_out_symm, 1, ConvertPolicy::SATURATE, RoundingPolicy::TO_ZERO));
452
453 // _dequantize
454 const TensorInfo output_state_out_f32(output_state_out_symm.tensor_shape(), 1, DataType::F32);
455 ARM_COMPUTE_RETURN_ON_ERROR(CLDequantizationLayer::validate(&output_state_out_symm, &output_state_out_f32));
456
457 // _quantize
458 ARM_COMPUTE_RETURN_ON_ERROR(CLQuantizationLayer::validate(&output_state_out_f32, output_state_out));
459
Manuel Bottini10c53f12019-07-17 16:11:53 +0100460 if(cell_state_out->total_size() != 0)
461 {
462 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(&cell_state_info, cell_state_out);
463 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(&cell_state_info, cell_state_out);
464 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(&cell_state_info, cell_state_out);
465 }
466
467 if(output_state_out->total_size() != 0)
468 {
469 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(&output_state_info, output_state_out);
470 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(&output_state_info, output_state_out);
471 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(&output_state_info, output_state_out);
472 }
473
474 return Status{};
475}
476
477void CLLSTMLayerQuantized::run()
478{
479 prepare();
480
481 // Acquire all the temporaries
482 MemoryGroupResourceScope scope_mg(_memory_group);
483
484 // Concat and transpose the input
485 _concat_inputs.run();
486
487 // Run gemmlowp
488 _gemmlowp.run();
489 _output_stage.run();
490
491 // Slice the results
492 _slice_input_tensor.run();
493 _slice_forget_tensor.run();
494 _slice_cell_tensor.run();
495 _slice_output_tensor.run();
496
497 // Gates
498 // Forget gate
499 _sigmoid_forget_gate.run();
500
501 // Input gate
502 _sigmoid_input_gate.run();
503
504 // Input modulation gate
505 _tanh_modulation_gate.run();
506
507 // Output gate
508 _sigmoid_output_gate.run();
509
510 // Cell state (long term memory)
511 _mul_forget_gate_cell_state.run();
512 _mul_input_gate_input_mod_gate.run();
513 _add_cell_state_tmps.run();
514
515 // Output state (short term memory)
516 _tanh_output_state.run();
517 _mul_output_state_tmp_output_gate.run();
518
Michele Di Giorgio35ea9a72019-08-23 12:02:06 +0100519 // Requantize output state from QSYMM16 to QASYMM8
Manuel Bottini10c53f12019-07-17 16:11:53 +0100520 _dequantize.run();
521 _quantize.run();
522}
523
524void CLLSTMLayerQuantized::prepare()
525{
526 if(!_is_prepared)
527 {
528 _input_weights.allocator()->allocate();
529 _concat_input_weights.run();
530
531 _input_to_input_weights->mark_as_unused();
532 _input_to_forget_weights->mark_as_unused();
533 _input_to_cell_weights->mark_as_unused();
534 _input_to_output_weights->mark_as_unused();
535
536 _recurrent_weights.allocator()->allocate();
537 _concat_recurrent_weights.run();
538 _recurrent_to_input_weights->mark_as_unused();
539 _recurrent_to_forget_weights->mark_as_unused();
540 _recurrent_to_cell_weights->mark_as_unused();
541 _recurrent_to_output_weights->mark_as_unused();
542
543 _weights.allocator()->allocate();
544 _concat_weights.run();
545
546 _input_weights.mark_as_unused();
547 _input_weights.allocator()->free();
548 _recurrent_weights.mark_as_unused();
549 _recurrent_weights.allocator()->free();
550
551 _weights_transposed.allocator()->allocate();
552 _transpose_weights.run();
553
554 _weights.mark_as_unused();
555 _weights.allocator()->free();
556
557 _bias.allocator()->allocate();
558 _concat_bias.run();
559 _input_gate_bias->mark_as_unused();
560 _forget_gate_bias->mark_as_unused();
561 _cell_bias->mark_as_unused();
562 _output_gate_bias->mark_as_unused();
563
564 _is_prepared = true;
565 }
566}
567
Michele Di Giorgio35ea9a72019-08-23 12:02:06 +0100568} // namespace arm_compute