xref: /aosp_15_r20/external/XNNPACK/test/vlrelu-microkernel-tester.h (revision 4bdc94577ba0e567308109d787f7fec7b531ce36)
1*4bdc9457SAndroid Build Coastguard Worker // Copyright 2022 Google LLC
2*4bdc9457SAndroid Build Coastguard Worker //
3*4bdc9457SAndroid Build Coastguard Worker // This source code is licensed under the BSD-style license found in the
4*4bdc9457SAndroid Build Coastguard Worker // LICENSE file in the root directory of this source tree.
5*4bdc9457SAndroid Build Coastguard Worker 
6*4bdc9457SAndroid Build Coastguard Worker #pragma once
7*4bdc9457SAndroid Build Coastguard Worker 
8*4bdc9457SAndroid Build Coastguard Worker #include <gtest/gtest.h>
9*4bdc9457SAndroid Build Coastguard Worker 
10*4bdc9457SAndroid Build Coastguard Worker #include <algorithm>
11*4bdc9457SAndroid Build Coastguard Worker #include <cassert>
12*4bdc9457SAndroid Build Coastguard Worker #include <cmath>
13*4bdc9457SAndroid Build Coastguard Worker #include <cstddef>
14*4bdc9457SAndroid Build Coastguard Worker #include <cstdlib>
15*4bdc9457SAndroid Build Coastguard Worker #include <functional>
16*4bdc9457SAndroid Build Coastguard Worker #include <limits>
17*4bdc9457SAndroid Build Coastguard Worker #include <random>
18*4bdc9457SAndroid Build Coastguard Worker #include <vector>
19*4bdc9457SAndroid Build Coastguard Worker 
20*4bdc9457SAndroid Build Coastguard Worker #include <xnnpack.h>
21*4bdc9457SAndroid Build Coastguard Worker #include <xnnpack/math.h>
22*4bdc9457SAndroid Build Coastguard Worker #include <xnnpack/microfnptr.h>
23*4bdc9457SAndroid Build Coastguard Worker #include <xnnpack/microparams-init.h>
24*4bdc9457SAndroid Build Coastguard Worker 
25*4bdc9457SAndroid Build Coastguard Worker 
26*4bdc9457SAndroid Build Coastguard Worker class VLReLUMicrokernelTester {
27*4bdc9457SAndroid Build Coastguard Worker  public:
batch_size(size_t batch_size)28*4bdc9457SAndroid Build Coastguard Worker   inline VLReLUMicrokernelTester& batch_size(size_t batch_size) {
29*4bdc9457SAndroid Build Coastguard Worker     assert(batch_size != 0);
30*4bdc9457SAndroid Build Coastguard Worker     this->batch_size_ = batch_size;
31*4bdc9457SAndroid Build Coastguard Worker     return *this;
32*4bdc9457SAndroid Build Coastguard Worker   }
33*4bdc9457SAndroid Build Coastguard Worker 
batch_size()34*4bdc9457SAndroid Build Coastguard Worker   inline size_t batch_size() const {
35*4bdc9457SAndroid Build Coastguard Worker     return this->batch_size_;
36*4bdc9457SAndroid Build Coastguard Worker   }
37*4bdc9457SAndroid Build Coastguard Worker 
positive_scale(float positive_scale)38*4bdc9457SAndroid Build Coastguard Worker   inline VLReLUMicrokernelTester& positive_scale(float positive_scale) {
39*4bdc9457SAndroid Build Coastguard Worker     assert(positive_scale > 0.0f);
40*4bdc9457SAndroid Build Coastguard Worker     assert(std::isnormal(positive_scale));
41*4bdc9457SAndroid Build Coastguard Worker     this->positive_scale_ = positive_scale;
42*4bdc9457SAndroid Build Coastguard Worker     return *this;
43*4bdc9457SAndroid Build Coastguard Worker   }
44*4bdc9457SAndroid Build Coastguard Worker 
positive_scale()45*4bdc9457SAndroid Build Coastguard Worker   inline float positive_scale() const {
46*4bdc9457SAndroid Build Coastguard Worker     return this->positive_scale_;
47*4bdc9457SAndroid Build Coastguard Worker   }
48*4bdc9457SAndroid Build Coastguard Worker 
negative_scale(float negative_scale)49*4bdc9457SAndroid Build Coastguard Worker   inline VLReLUMicrokernelTester& negative_scale(float negative_scale) {
50*4bdc9457SAndroid Build Coastguard Worker     assert(std::isnormal(negative_scale));
51*4bdc9457SAndroid Build Coastguard Worker     this->negative_scale_ = negative_scale;
52*4bdc9457SAndroid Build Coastguard Worker     return *this;
53*4bdc9457SAndroid Build Coastguard Worker   }
54*4bdc9457SAndroid Build Coastguard Worker 
negative_scale()55*4bdc9457SAndroid Build Coastguard Worker   inline float negative_scale() const {
56*4bdc9457SAndroid Build Coastguard Worker     return this->negative_scale_;
57*4bdc9457SAndroid Build Coastguard Worker   }
58*4bdc9457SAndroid Build Coastguard Worker 
input_zero_point(int16_t input_zero_point)59*4bdc9457SAndroid Build Coastguard Worker   inline VLReLUMicrokernelTester& input_zero_point(int16_t input_zero_point) {
60*4bdc9457SAndroid Build Coastguard Worker     this->input_zero_point_ = input_zero_point;
61*4bdc9457SAndroid Build Coastguard Worker     return *this;
62*4bdc9457SAndroid Build Coastguard Worker   }
63*4bdc9457SAndroid Build Coastguard Worker 
input_zero_point()64*4bdc9457SAndroid Build Coastguard Worker   inline int16_t input_zero_point() const {
65*4bdc9457SAndroid Build Coastguard Worker     return this->input_zero_point_;
66*4bdc9457SAndroid Build Coastguard Worker   }
67*4bdc9457SAndroid Build Coastguard Worker 
output_zero_point(int16_t output_zero_point)68*4bdc9457SAndroid Build Coastguard Worker   inline VLReLUMicrokernelTester& output_zero_point(int16_t output_zero_point) {
69*4bdc9457SAndroid Build Coastguard Worker     this->output_zero_point_ = output_zero_point;
70*4bdc9457SAndroid Build Coastguard Worker     return *this;
71*4bdc9457SAndroid Build Coastguard Worker   }
72*4bdc9457SAndroid Build Coastguard Worker 
output_zero_point()73*4bdc9457SAndroid Build Coastguard Worker   inline int16_t output_zero_point() const {
74*4bdc9457SAndroid Build Coastguard Worker     return this->output_zero_point_;
75*4bdc9457SAndroid Build Coastguard Worker   }
76*4bdc9457SAndroid Build Coastguard Worker 
iterations(size_t iterations)77*4bdc9457SAndroid Build Coastguard Worker   inline VLReLUMicrokernelTester& iterations(size_t iterations) {
78*4bdc9457SAndroid Build Coastguard Worker     this->iterations_ = iterations;
79*4bdc9457SAndroid Build Coastguard Worker     return *this;
80*4bdc9457SAndroid Build Coastguard Worker   }
81*4bdc9457SAndroid Build Coastguard Worker 
iterations()82*4bdc9457SAndroid Build Coastguard Worker   inline size_t iterations() const {
83*4bdc9457SAndroid Build Coastguard Worker     return this->iterations_;
84*4bdc9457SAndroid Build Coastguard Worker   }
85*4bdc9457SAndroid Build Coastguard Worker 
Test(xnn_qs8_vlrelu_ukernel_function vlrelu,xnn_init_qs8_lrelu_params_fn init_params)86*4bdc9457SAndroid Build Coastguard Worker   void Test(xnn_qs8_vlrelu_ukernel_function vlrelu, xnn_init_qs8_lrelu_params_fn init_params) const {
87*4bdc9457SAndroid Build Coastguard Worker     ASSERT_GE(input_zero_point(), std::numeric_limits<int8_t>::min());
88*4bdc9457SAndroid Build Coastguard Worker     ASSERT_LE(input_zero_point(), std::numeric_limits<int8_t>::max());
89*4bdc9457SAndroid Build Coastguard Worker     ASSERT_GE(output_zero_point(), std::numeric_limits<int8_t>::min());
90*4bdc9457SAndroid Build Coastguard Worker     ASSERT_LE(output_zero_point(), std::numeric_limits<int8_t>::max());
91*4bdc9457SAndroid Build Coastguard Worker 
92*4bdc9457SAndroid Build Coastguard Worker     std::random_device random_device;
93*4bdc9457SAndroid Build Coastguard Worker     auto rng = std::mt19937(random_device());
94*4bdc9457SAndroid Build Coastguard Worker     std::uniform_int_distribution<int32_t> i8dist(
95*4bdc9457SAndroid Build Coastguard Worker       std::numeric_limits<int8_t>::min(), std::numeric_limits<int8_t>::max());
96*4bdc9457SAndroid Build Coastguard Worker 
97*4bdc9457SAndroid Build Coastguard Worker     std::vector<int8_t> input(batch_size() + XNN_EXTRA_BYTES / sizeof(int8_t));
98*4bdc9457SAndroid Build Coastguard Worker     std::vector<int8_t> output(batch_size());
99*4bdc9457SAndroid Build Coastguard Worker     std::vector<int8_t> output_ref(batch_size());
100*4bdc9457SAndroid Build Coastguard Worker     for (size_t iteration = 0; iteration < iterations(); iteration++) {
101*4bdc9457SAndroid Build Coastguard Worker       std::generate(input.begin(), input.end(), [&]() { return i8dist(rng); });
102*4bdc9457SAndroid Build Coastguard Worker       std::fill(output.begin(), output.end(), INT8_C(0xA5));
103*4bdc9457SAndroid Build Coastguard Worker 
104*4bdc9457SAndroid Build Coastguard Worker       union xnn_qs8_lrelu_params params;
105*4bdc9457SAndroid Build Coastguard Worker       init_params(&params, positive_scale(), negative_scale(), input_zero_point(), output_zero_point());
106*4bdc9457SAndroid Build Coastguard Worker 
107*4bdc9457SAndroid Build Coastguard Worker       // Call optimized micro-kernel.
108*4bdc9457SAndroid Build Coastguard Worker       vlrelu(batch_size() * sizeof(int8_t), input.data(), output.data(), &params);
109*4bdc9457SAndroid Build Coastguard Worker 
110*4bdc9457SAndroid Build Coastguard Worker       // Compute reference results
111*4bdc9457SAndroid Build Coastguard Worker       const int32_t positive_multiplier = (int32_t) lrintf(-256.0f * positive_scale());
112*4bdc9457SAndroid Build Coastguard Worker       const int32_t negative_multiplier = (int32_t) lrintf(-256.0f * negative_scale());
113*4bdc9457SAndroid Build Coastguard Worker       for (size_t i = 0; i < batch_size(); i++) {
114*4bdc9457SAndroid Build Coastguard Worker         const int32_t input_value = (input_zero_point() - input[i]) << 7;
115*4bdc9457SAndroid Build Coastguard Worker         const int32_t multiplier = input_value <= 0 ? positive_multiplier : negative_multiplier;
116*4bdc9457SAndroid Build Coastguard Worker         int32_t output_value = math_asr_s32(input_value * multiplier + INT32_C(0x4000), 15) + output_zero_point();
117*4bdc9457SAndroid Build Coastguard Worker         output_value = std::min<int32_t>(output_value, std::numeric_limits<int8_t>::max());
118*4bdc9457SAndroid Build Coastguard Worker         output_value = std::max<int32_t>(output_value, std::numeric_limits<int8_t>::min());
119*4bdc9457SAndroid Build Coastguard Worker         output_ref[i] = static_cast<int8_t>(output_value);
120*4bdc9457SAndroid Build Coastguard Worker       }
121*4bdc9457SAndroid Build Coastguard Worker 
122*4bdc9457SAndroid Build Coastguard Worker       // Verify results.
123*4bdc9457SAndroid Build Coastguard Worker       for (size_t i = 0; i < batch_size(); i++) {
124*4bdc9457SAndroid Build Coastguard Worker         ASSERT_EQ(int32_t(output[i]), int32_t(output_ref[i]))
125*4bdc9457SAndroid Build Coastguard Worker           << "at " << i << " / " << batch_size()
126*4bdc9457SAndroid Build Coastguard Worker           << ", x[" << i << "] = " << int32_t(input[i]);
127*4bdc9457SAndroid Build Coastguard Worker       }
128*4bdc9457SAndroid Build Coastguard Worker     }
129*4bdc9457SAndroid Build Coastguard Worker   }
130*4bdc9457SAndroid Build Coastguard Worker 
Test(xnn_qu8_vlrelu_ukernel_function vlrelu,xnn_init_qu8_lrelu_params_fn init_params)131*4bdc9457SAndroid Build Coastguard Worker   void Test(xnn_qu8_vlrelu_ukernel_function vlrelu, xnn_init_qu8_lrelu_params_fn init_params) const {
132*4bdc9457SAndroid Build Coastguard Worker     ASSERT_GE(input_zero_point(), std::numeric_limits<uint8_t>::min());
133*4bdc9457SAndroid Build Coastguard Worker     ASSERT_LE(input_zero_point(), std::numeric_limits<uint8_t>::max());
134*4bdc9457SAndroid Build Coastguard Worker     ASSERT_GE(output_zero_point(), std::numeric_limits<uint8_t>::min());
135*4bdc9457SAndroid Build Coastguard Worker     ASSERT_LE(output_zero_point(), std::numeric_limits<uint8_t>::max());
136*4bdc9457SAndroid Build Coastguard Worker 
137*4bdc9457SAndroid Build Coastguard Worker     std::random_device random_device;
138*4bdc9457SAndroid Build Coastguard Worker     auto rng = std::mt19937(random_device());
139*4bdc9457SAndroid Build Coastguard Worker     std::uniform_int_distribution<int32_t> u8dist(
140*4bdc9457SAndroid Build Coastguard Worker       std::numeric_limits<uint8_t>::min(), std::numeric_limits<uint8_t>::max());
141*4bdc9457SAndroid Build Coastguard Worker 
142*4bdc9457SAndroid Build Coastguard Worker     std::vector<uint8_t> input(batch_size() + XNN_EXTRA_BYTES / sizeof(uint8_t));
143*4bdc9457SAndroid Build Coastguard Worker     std::vector<uint8_t> output(batch_size());
144*4bdc9457SAndroid Build Coastguard Worker     std::vector<uint8_t> output_ref(batch_size());
145*4bdc9457SAndroid Build Coastguard Worker     for (size_t iteration = 0; iteration < iterations(); iteration++) {
146*4bdc9457SAndroid Build Coastguard Worker       std::generate(input.begin(), input.end(), [&]() { return u8dist(rng); });
147*4bdc9457SAndroid Build Coastguard Worker       std::fill(output.begin(), output.end(), UINT8_C(0xA5));
148*4bdc9457SAndroid Build Coastguard Worker 
149*4bdc9457SAndroid Build Coastguard Worker       union xnn_qu8_lrelu_params params;
150*4bdc9457SAndroid Build Coastguard Worker       init_params(&params, positive_scale(), negative_scale(), input_zero_point(), output_zero_point());
151*4bdc9457SAndroid Build Coastguard Worker 
152*4bdc9457SAndroid Build Coastguard Worker       // Call optimized micro-kernel.
153*4bdc9457SAndroid Build Coastguard Worker       vlrelu(batch_size() * sizeof(uint8_t), input.data(), output.data(), &params);
154*4bdc9457SAndroid Build Coastguard Worker 
155*4bdc9457SAndroid Build Coastguard Worker       // Compute reference results
156*4bdc9457SAndroid Build Coastguard Worker       const int32_t positive_multiplier = (int32_t) lrintf(-256.0f * positive_scale());
157*4bdc9457SAndroid Build Coastguard Worker       const int32_t negative_multiplier = (int32_t) lrintf(-256.0f * negative_scale());
158*4bdc9457SAndroid Build Coastguard Worker       for (size_t i = 0; i < batch_size(); i++) {
159*4bdc9457SAndroid Build Coastguard Worker         const int32_t input_value = (input_zero_point() - input[i]) << 7;
160*4bdc9457SAndroid Build Coastguard Worker         const int32_t multiplier = input_value <= 0 ? positive_multiplier : negative_multiplier;
161*4bdc9457SAndroid Build Coastguard Worker         int32_t output_value = math_asr_s32(input_value * multiplier + INT32_C(0x4000), 15) + output_zero_point();
162*4bdc9457SAndroid Build Coastguard Worker         output_value = std::min<int32_t>(output_value, std::numeric_limits<uint8_t>::max());
163*4bdc9457SAndroid Build Coastguard Worker         output_value = std::max<int32_t>(output_value, std::numeric_limits<uint8_t>::min());
164*4bdc9457SAndroid Build Coastguard Worker         output_ref[i] = static_cast<uint8_t>(output_value);
165*4bdc9457SAndroid Build Coastguard Worker       }
166*4bdc9457SAndroid Build Coastguard Worker 
167*4bdc9457SAndroid Build Coastguard Worker       // Verify results.
168*4bdc9457SAndroid Build Coastguard Worker       for (size_t i = 0; i < batch_size(); i++) {
169*4bdc9457SAndroid Build Coastguard Worker         ASSERT_EQ(int32_t(output[i]), int32_t(output_ref[i]))
170*4bdc9457SAndroid Build Coastguard Worker           << "at " << i << " / " << batch_size()
171*4bdc9457SAndroid Build Coastguard Worker           << ", x[" << i << "] = " << int32_t(input[i]);
172*4bdc9457SAndroid Build Coastguard Worker       }
173*4bdc9457SAndroid Build Coastguard Worker     }
174*4bdc9457SAndroid Build Coastguard Worker   }
175*4bdc9457SAndroid Build Coastguard Worker 
176*4bdc9457SAndroid Build Coastguard Worker  private:
177*4bdc9457SAndroid Build Coastguard Worker   float positive_scale_ = 1.75f;
178*4bdc9457SAndroid Build Coastguard Worker   float negative_scale_ = 0.75f;
179*4bdc9457SAndroid Build Coastguard Worker   int16_t input_zero_point_ = 1;
180*4bdc9457SAndroid Build Coastguard Worker   int16_t output_zero_point_ = 5;
181*4bdc9457SAndroid Build Coastguard Worker   size_t batch_size_ = 1;
182*4bdc9457SAndroid Build Coastguard Worker   size_t iterations_ = 15;
183*4bdc9457SAndroid Build Coastguard Worker };
184