1 /*
2 * Copyright (c) 2017-2020, 2022 Arm Limited.
3 *
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 #include "arm_compute/core/Types.h"
25 #include "arm_compute/runtime/NEON/functions/NESoftmaxLayer.h"
26 #include "arm_compute/runtime/Tensor.h"
27 #include "arm_compute/runtime/TensorAllocator.h"
28 #include "src/common/cpuinfo/CpuIsaInfo.h"
29 #include "src/cpu/kernels/CpuSoftmaxKernel.h"
30 #include "tests/NEON/Accessor.h"
31 #include "tests/PaddingCalculator.h"
32 #include "tests/datasets/ShapeDatasets.h"
33 #include "tests/framework/Asserts.h"
34 #include "tests/framework/Macros.h"
35 #include "tests/framework/datasets/Datasets.h"
36 #include "tests/validation/Validation.h"
37 #include "tests/validation/fixtures/SoftmaxLayerFixture.h"
38 namespace arm_compute
39 {
40 namespace test
41 {
42 namespace validation
43 {
44 namespace
45 {
46 /** Tolerance for float operations */
47 constexpr AbsoluteTolerance<float> tolerance_f32(0.000001f);
48 RelativeTolerance<half> tolerance_f16(half(0.2));
49
50 /** Tolerance for quantized operations */
51 constexpr AbsoluteTolerance<uint8_t> tolerance_qasymm8(1);
52 constexpr AbsoluteTolerance<int8_t> tolerance_qasymm8_signed(1);
53
54 /** CNN data types */
55 const auto CNNDataTypes = framework::dataset::make("DataType",
56 {
57 #ifdef __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
58 DataType::F16,
59 #endif /* __ARM_FEATURE_FP16_VECTOR_ARITHMETIC */
60 DataType::F32,
61 });
62 } // namespace
63
64 TEST_SUITE(NEON)
TEST_SUITE(SoftmaxLayer)65 TEST_SUITE(SoftmaxLayer)
66 // *INDENT-OFF*
67 // clang-format off
68 DATA_TEST_CASE(Validate, framework::DatasetMode::ALL, zip(zip(zip(zip(
69 framework::dataset::make("InputInfo", { TensorInfo(TensorShape(27U, 13U), 1, DataType::F32), // Mismatching data types
70 TensorInfo(TensorShape(27U, 13U), 1, DataType::F32), // Mismatching shapes
71 TensorInfo(TensorShape(27U, 13U), 1, DataType::QASYMM8, // Invalid output quantization info
72 QuantizationInfo(1.f/256, 12)),
73 TensorInfo(TensorShape(32U, 13U), 1, DataType::F32),
74 TensorInfo(TensorShape(32U, 13U), 1, DataType::QASYMM8,
75 QuantizationInfo(1.f/256, 12)),
76 TensorInfo(TensorShape(32U, 13U), 1, DataType::F32),
77 TensorInfo(TensorShape(32U, 13U), 1, DataType::QASYMM8, //Invalid axis high
78 QuantizationInfo(1.f/256, 12)),
79 TensorInfo(TensorShape(32U, 13U), 1, DataType::QASYMM8, //Invalid axis low
80 QuantizationInfo(1.f/256, 12)),
81 }),
82 framework::dataset::make("OutputInfo",{ TensorInfo(TensorShape(27U, 13U), 1, DataType::F16),
83 TensorInfo(TensorShape(27U, 11U), 1, DataType::F32),
84 TensorInfo(TensorShape(27U, 13U), 1, DataType::QASYMM8,
85 QuantizationInfo(1.f/256, 12)),
86 TensorInfo(TensorShape(32U, 13U), 1, DataType::F32),
87 TensorInfo(TensorShape(32U, 13U), 1, DataType::QASYMM8,
88 QuantizationInfo(1.f/256, 0)),
89 TensorInfo(TensorShape(32U, 13U), 1, DataType::F32),
90 TensorInfo(TensorShape(32U, 13U), 1, DataType::QASYMM8,
91 QuantizationInfo(1.f/256, 0)),
92 TensorInfo(TensorShape(32U, 13U), 1, DataType::QASYMM8,
93 QuantizationInfo(1.f/256, 0)),
94 })),
95 framework::dataset::make("beta", { 1.0,
96 2.0,
97 1.0,
98 2.0,
99 1.0,
100 1.0,
101 2.0,
102 1.0,
103 })),
104 framework::dataset::make("axis", { 0,
105 0,
106 0,
107 1,
108 0,
109 -1,
110 2,
111 -3,
112 })),
113 framework::dataset::make("Expected", { false, false, false, true, true, true, false, false })),
114 input_info, output_info, beta, axis, expected)
115 {
116 ARM_COMPUTE_EXPECT(bool(NESoftmaxLayer::validate(&input_info.clone()->set_is_resizable(false), &output_info.clone()->set_is_resizable(false), beta, axis)) == expected, framework::LogLevel::ERRORS);
117 }
118 // clang-format on
119 // *INDENT-ON*
120
121 template <typename T>
122 using NESoftmaxLayerFixture = SoftmaxValidationFixture<Tensor, Accessor, NESoftmaxLayer, T>;
123
124 DATA_TEST_CASE(KernelSelection_max_logits, framework::DatasetMode::ALL, concat(
125 combine(framework::dataset::make("CpuExt", std::string("NEON")),
126 framework::dataset::make("DataType", { DataType::F32,
127 DataType::F16,
128 DataType::QASYMM8,
129 DataType::QASYMM8_SIGNED
130 })),
131 combine(framework::dataset::make("CpuExt", std::string("SVE")),
132 framework::dataset::make("DataType", { DataType::F32,
133 DataType::F16,
134 DataType::QASYMM8,
135 DataType::QASYMM8_SIGNED
136 }))),
137 cpu_ext, data_type)
138 {
139 using namespace cpu::kernels;
140
141 cpuinfo::CpuIsaInfo cpu_isa{};
142 cpu_isa.neon = (cpu_ext == "NEON");
143 cpu_isa.sve = (cpu_ext == "SVE");
144 cpu_isa.fp16 = (data_type == DataType::F16);
145
146 const auto *selected_impl = CpuLogits1DMaxKernel::get_implementation(DataTypeISASelectorData{ data_type, cpu_isa }, cpu::KernelSelectionType::Preferred);
147
148 ARM_COMPUTE_ERROR_ON_NULLPTR(selected_impl);
149
150 std::string expected = lower_string(cpu_ext) + "_" + cpu_impl_dt(data_type) + "_logits_1d_max";
151 std::string actual = selected_impl->name;
152
153 ARM_COMPUTE_EXPECT_EQUAL(expected, actual, framework::LogLevel::ERRORS);
154 }
155
156 DATA_TEST_CASE(KernelSelection_logits, framework::DatasetMode::ALL, concat(concat(
157 combine(framework::dataset::make("CpuExt", std::string("NEON")),
158 framework::dataset::make("DataType", { DataType::F32,
159 DataType::F16,
160 DataType::QASYMM8,
161 DataType::QASYMM8_SIGNED
162 })),
163 combine(framework::dataset::make("CpuExt", std::string("SVE")),
164 framework::dataset::make("DataType", { DataType::F32,
165 DataType::F16
166 }))),
167 combine(framework::dataset::make("CpuExt", std::string("SVE2")),
168 framework::dataset::make("DataType", { DataType::QASYMM8,
169 DataType::QASYMM8_SIGNED
170 }))),
171 cpu_ext, data_type)
172 {
173 using namespace cpu::kernels;
174
175 cpuinfo::CpuIsaInfo cpu_isa{};
176 cpu_isa.neon = (cpu_ext == "NEON");
177 cpu_isa.sve = (cpu_ext == "SVE");
178 cpu_isa.sve2 = (cpu_ext == "SVE2");
179 cpu_isa.fp16 = (data_type == DataType::F16);
180
181 const auto *selected_impl = CpuLogits1DSoftmaxKernel<false>::get_implementation(DataTypeISASelectorData{ data_type, cpu_isa }, cpu::KernelSelectionType::Preferred);
182
183 ARM_COMPUTE_ERROR_ON_NULLPTR(selected_impl);
184
185 std::string expected = lower_string(cpu_ext) + "_" + cpu_impl_dt(data_type) + "_softmax_logits_1d";
186 std::string actual = selected_impl->name;
187
188 ARM_COMPUTE_EXPECT_EQUAL(expected, actual, framework::LogLevel::ERRORS);
189 }
190
191 TEST_SUITE(Float)
192 #ifdef __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
TEST_SUITE(FP16)193 TEST_SUITE(FP16)
194 FIXTURE_DATA_TEST_CASE(RunSmall, NESoftmaxLayerFixture<half>, framework::DatasetMode::PRECOMMIT, combine(combine(combine(datasets::Small4DShapes(),
195 framework::dataset::make("DataType", DataType::F16)),
196 framework::dataset::make("Beta", { 1.0f, 2.0f })),
197 framework::dataset::make("Axis", { 0, 1 })))
198 {
199 // Validate output
200 validate(Accessor(_target), _reference, tolerance_f16);
201 }
202 FIXTURE_DATA_TEST_CASE(RunSmall4D, NESoftmaxLayerFixture<half>, framework::DatasetMode::PRECOMMIT, combine(combine(combine(datasets::Small4DShapes(),
203 framework::dataset::make("DataType", DataType::F16)),
204 framework::dataset::make("Beta", { 1.0f, 2.0f })),
205 framework::dataset::make("Axis", { 0, 2, -1 })))
206 {
207 // Validate output
208 validate(Accessor(_target), _reference, tolerance_f16);
209 }
210 FIXTURE_DATA_TEST_CASE(RunLarge, NESoftmaxLayerFixture<half>, framework::DatasetMode::NIGHTLY, combine(combine(combine(datasets::SoftmaxLayerLargeShapes(),
211 framework::dataset::make("DataType", DataType::F16)),
212 framework::dataset::make("Beta", { 1.0f, 2.0f })),
213 framework::dataset::make("Axis", { 0 })))
214 {
215 // Validate output
216 validate(Accessor(_target), _reference, tolerance_f16);
217 }
218 TEST_SUITE_END() //FP16
219 #endif /* __ARM_FEATURE_FP16_VECTOR_ARITHMETIC */
220
TEST_SUITE(FP32)221 TEST_SUITE(FP32)
222 FIXTURE_DATA_TEST_CASE(RunSmall2D, NESoftmaxLayerFixture<float>, framework::DatasetMode::PRECOMMIT, combine(combine(combine(datasets::SoftmaxLayerSmallShapes(),
223 framework::dataset::make("DataType", DataType::F32)),
224 framework::dataset::make("Beta", { 1.0f, 2.0f })),
225 framework::dataset::make("Axis", { 0, -1 })))
226 {
227 // Validate output
228 validate(Accessor(_target), _reference, tolerance_f32);
229 }
230 FIXTURE_DATA_TEST_CASE(RunSmall4D, NESoftmaxLayerFixture<float>, framework::DatasetMode::PRECOMMIT, combine(combine(combine(datasets::Small4DShapes(),
231 framework::dataset::make("DataType", DataType::F32)),
232 framework::dataset::make("Beta", { 1.0f, 2.0f })),
233 framework::dataset::make("Axis", { 0, -2, 3 })))
234 {
235 // Validate output
236 validate(Accessor(_target), _reference, tolerance_f32);
237 }
238 FIXTURE_DATA_TEST_CASE(RunLarge, NESoftmaxLayerFixture<float>, framework::DatasetMode::NIGHTLY, combine(combine(combine(datasets::SoftmaxLayerLargeShapes(),
239 framework::dataset::make("DataType", DataType::F32)),
240 framework::dataset::make("Beta", { 1.0f, 2.0f })),
241 framework::dataset::make("Axis", { 0 })))
242 {
243 // Validate output
244 validate(Accessor(_target), _reference, tolerance_f32);
245 }
246 TEST_SUITE_END() //FP32
247 TEST_SUITE_END() //Float
248
249 template <typename T>
250 using NESoftmaxLayerQuantizedFixture = SoftmaxValidationQuantizedFixture<Tensor, Accessor, NESoftmaxLayer, T>;
251
252 TEST_SUITE(Quantized)
TEST_SUITE(QASYMM8)253 TEST_SUITE(QASYMM8)
254 FIXTURE_DATA_TEST_CASE(RunSmall2D, NESoftmaxLayerQuantizedFixture<uint8_t>, framework::DatasetMode::ALL, combine(combine(combine(datasets::SoftmaxLayerSmallShapes(),
255 framework::dataset::make("DataType", DataType::QASYMM8)),
256 combine(framework::dataset::make("QuantizationInfo", { QuantizationInfo(0.5f, -10) }),
257 framework::dataset::make("Beta", { 1.0f, 2.f }))),
258 framework::dataset::make("Axis", { 0, -1 })))
259 {
260 // Validate output
261 validate(Accessor(_target), _reference, tolerance_qasymm8);
262 }
263 FIXTURE_DATA_TEST_CASE(RunSmall4D, NESoftmaxLayerQuantizedFixture<uint8_t>, framework::DatasetMode::ALL, combine(combine(combine(datasets::Small4DShapes(),
264 framework::dataset::make("DataType", DataType::QASYMM8)),
265 combine(framework::dataset::make("QuantizationInfo", { QuantizationInfo(0.5f, -10) }),
266 framework::dataset::make("Beta", { 1.0f, 2.f }))),
267 framework::dataset::make("Axis", { 0, 1, -2 })))
268 {
269 // Validate output
270 validate(Accessor(_target), _reference, tolerance_qasymm8);
271 }
272 FIXTURE_DATA_TEST_CASE(RunLarge, NESoftmaxLayerQuantizedFixture<uint8_t>, framework::DatasetMode::NIGHTLY, combine(combine(combine(datasets::SoftmaxLayerLargeShapes(),
273 framework::dataset::make("DataType", DataType::QASYMM8)),
274 combine(framework::dataset::make("QuantizationInfo", { QuantizationInfo(0.5f, -10) }),
275 framework::dataset::make("Beta", { 1.0f, 2.0f }))),
276 framework::dataset::make("Axis", { 0 })))
277 {
278 // Validate output
279 validate(Accessor(_target), _reference, tolerance_qasymm8);
280 }
281 TEST_SUITE_END() //QASYMM8
282
TEST_SUITE(QASYMM8_SIGNED)283 TEST_SUITE(QASYMM8_SIGNED)
284 FIXTURE_DATA_TEST_CASE(RunSmall2D, NESoftmaxLayerQuantizedFixture<int8_t>, framework::DatasetMode::ALL, combine(combine(combine(datasets::SoftmaxLayerSmallShapes(),
285 framework::dataset::make("DataType", DataType::QASYMM8_SIGNED)),
286 combine(framework::dataset::make("QuantizationInfo", { QuantizationInfo(0.5f, -10) }),
287 framework::dataset::make("Beta", { 1.0f, 2.f }))),
288 framework::dataset::make("Axis", { 0, -1 })))
289 {
290 // Validate output
291 validate(Accessor(_target), _reference, tolerance_qasymm8_signed);
292 }
293 FIXTURE_DATA_TEST_CASE(RunSmall4D, NESoftmaxLayerQuantizedFixture<int8_t>, framework::DatasetMode::ALL, combine(combine(combine(datasets::Small4DShapes(),
294 framework::dataset::make("DataType", DataType::QASYMM8_SIGNED)),
295 combine(framework::dataset::make("QuantizationInfo", { QuantizationInfo(0.5f, -10) }),
296 framework::dataset::make("Beta", { 1.0f, 2.f }))),
297 framework::dataset::make("Axis", { 0, 1, -1 })))
298 {
299 // Validate output
300 validate(Accessor(_target), _reference, tolerance_qasymm8_signed);
301 }
302 TEST_SUITE_END() //QASYMM8_SIGNED
303
304 TEST_SUITE_END() //Quantized
305
306 TEST_SUITE_END() //SoftmaxLayer
307 TEST_SUITE_END() //NEON
308 } // namespace validation
309 } // namespace test
310 } // namespace arm_compute
311