Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 1 | /* |
Sheri Zhang | ac6499a | 2021-02-10 15:32:38 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2021 Arm Limited. |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 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 | */ |
Manuel Bottini | 1f332d4 | 2019-11-29 17:25:25 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_CLGEMMLOWPOUTPUTSTAGE_H |
| 25 | #define ARM_COMPUTE_CLGEMMLOWPOUTPUTSTAGE_H |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 26 | |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 27 | #include "arm_compute/core/Error.h" |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 28 | #include "arm_compute/runtime/CL/ICLSimpleFunction.h" |
| 29 | |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 30 | #include <limits> |
| 31 | |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 32 | /** This file contains all available output stages for GEMMLowp on OpenCL. |
| 33 | * |
| 34 | * In gemmlowp, the "output stage" is the process that takes a final int32 accumulator value (the output of @ref CLGEMMLowpMatrixMultiplyCore), |
Manuel Bottini | 1f332d4 | 2019-11-29 17:25:25 +0000 | [diff] [blame] | 35 | * and processes it to obtain the final QASYMM8/QASYMM8_SIGNED value. |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 36 | * |
| 37 | * More information about the GEMMLowp output stage can be found at https://github.com/google/gemmlowp/blob/master/doc/output.md |
| 38 | */ |
| 39 | |
| 40 | namespace arm_compute |
| 41 | { |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 42 | class CLCompileContext; |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 43 | class ITensor; |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 44 | class ICLTensor; |
| 45 | class ITensorInfo; |
| 46 | struct GEMMLowpOutputStageInfo; |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 47 | |
Sheri Zhang | 0cdbda5 | 2020-02-25 15:57:21 +0000 | [diff] [blame] | 48 | /** Basic function to execute GEMMLowpQuantizeDown kernels on CL. |
| 49 | * |
| 50 | * This function calls the following CL kernels: |
| 51 | * |
Georgios Pinitas | 4a578b9 | 2021-06-25 12:13:49 +0100 | [diff] [blame] | 52 | * -# @ref opencl::kernels::ClGemmLowpQuantizeDownInt32ScaleKernel |
| 53 | * -# @ref opencl::kernels::ClGemmLowpQuantizeDownInt32ScaleByFloatKernel |
| 54 | * -# @ref opencl::kernels::ClGemmLowpQuantizeDownInt32ScaleByFixedPointKernel |
Sheri Zhang | 0cdbda5 | 2020-02-25 15:57:21 +0000 | [diff] [blame] | 55 | */ |
Georgios Pinitas | 4a578b9 | 2021-06-25 12:13:49 +0100 | [diff] [blame] | 56 | class CLGEMMLowpOutputStage : public IFunction |
Sheri Zhang | 0cdbda5 | 2020-02-25 15:57:21 +0000 | [diff] [blame] | 57 | { |
| 58 | public: |
Georgios Pinitas | 4a578b9 | 2021-06-25 12:13:49 +0100 | [diff] [blame] | 59 | CLGEMMLowpOutputStage(); |
| 60 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 61 | CLGEMMLowpOutputStage(const CLGEMMLowpOutputStage &) = delete; |
| 62 | /** Default move constructor */ |
| 63 | CLGEMMLowpOutputStage(CLGEMMLowpOutputStage &&); |
| 64 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 65 | CLGEMMLowpOutputStage &operator=(const CLGEMMLowpOutputStage &) = delete; |
| 66 | /** Default move assignment operator */ |
| 67 | CLGEMMLowpOutputStage &operator=(CLGEMMLowpOutputStage &&); |
| 68 | /** Default destructor */ |
| 69 | ~CLGEMMLowpOutputStage(); |
Sheri Zhang | 0cdbda5 | 2020-02-25 15:57:21 +0000 | [diff] [blame] | 70 | /** Initialise the kernel's inputs, output |
| 71 | * |
Sheri Zhang | 6124ce6 | 2021-05-04 14:03:13 +0100 | [diff] [blame] | 72 | * Valid data layouts: |
| 73 | * - All |
| 74 | * |
| 75 | * Valid data type configurations: |
| 76 | * |src0 |src1 |dst | |
| 77 | * |:--------------|:-------------|:-------------| |
| 78 | * |S32 |S32 |QASYMM8 | |
| 79 | * |S32 |S32 |QASYMM8_SIGNED| |
| 80 | * |S32 |S32 |QSYMM16 | |
| 81 | * |
Sheri Zhang | 0cdbda5 | 2020-02-25 15:57:21 +0000 | [diff] [blame] | 82 | * @param[in] input Input tensor. Data type supported: S32 |
| 83 | * @param[in] bias Biases tensor. Only shared biases supported and it can be a nullptr if the biases addition is not required. |
| 84 | * Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input. |
Sheri Zhang | 6124ce6 | 2021-05-04 14:03:13 +0100 | [diff] [blame] | 85 | * @param[out] output Output tensor. Data type supported: QASYMM8/QASYMM8_SIGNED/QSYMM16 |
Sheri Zhang | 0cdbda5 | 2020-02-25 15:57:21 +0000 | [diff] [blame] | 86 | * @param[in] info GEMMLowp output stage metadata. |
| 87 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame^] | 88 | void |
| 89 | configure(const ICLTensor *input, const ICLTensor *bias, ICLTensor *output, const GEMMLowpOutputStageInfo &info); |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 90 | /** Initialise the kernel's inputs, output |
| 91 | * |
| 92 | * @param[in] compile_context The compile context to be used. |
| 93 | * @param[in] input Input tensor. Data type supported: S32 |
| 94 | * @param[in] bias Biases tensor. Only shared biases supported and it can be a nullptr if the biases addition is not required. |
| 95 | * Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input. |
| 96 | * @param[out] output Output tensor. Data type supported: QASYMM8/QASYMM8_SIGNED |
| 97 | * @param[in] info GEMMLowp output stage metadata. |
| 98 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame^] | 99 | void configure(const CLCompileContext &compile_context, |
| 100 | const ICLTensor *input, |
| 101 | const ICLTensor *bias, |
| 102 | ICLTensor *output, |
| 103 | const GEMMLowpOutputStageInfo &info); |
Georgios Pinitas | 4a578b9 | 2021-06-25 12:13:49 +0100 | [diff] [blame] | 104 | /** Static function to check if given info will lead to a valid configuration of @ref opencl::kernels::ClGemmLowpQuantizeDownInt32ScaleByFixedPointKernel |
Sheri Zhang | 0cdbda5 | 2020-02-25 15:57:21 +0000 | [diff] [blame] | 105 | * |
| 106 | * @param[in] input Input tensor. It is the output of @ref CLGEMMLowpMatrixMultiplyCore function. Data type supported: S32 |
| 107 | * @param[in] bias Biases tensor. Only shared biases supported and it can be a nullptr if the addition of biases is not required. |
| 108 | * Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input. |
| 109 | * @param[in] output Output tensor. Data type supported: QASYMM8/QASYMM8_SIGNED |
| 110 | * @param[in] info GEMMLowp output stage metadata. |
| 111 | * |
| 112 | * @return a status |
| 113 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame^] | 114 | static Status validate(const ITensorInfo *input, |
| 115 | const ITensorInfo *bias, |
| 116 | const ITensorInfo *output, |
| 117 | const GEMMLowpOutputStageInfo &info); |
Georgios Pinitas | 4a578b9 | 2021-06-25 12:13:49 +0100 | [diff] [blame] | 118 | |
| 119 | // Inherited methods overridden: |
| 120 | void run() override; |
| 121 | |
| 122 | private: |
Georgios Pinitas | 399f623 | 2021-06-29 15:31:58 +0100 | [diff] [blame] | 123 | struct Impl; |
| 124 | std::unique_ptr<Impl> _impl; |
Sheri Zhang | 0cdbda5 | 2020-02-25 15:57:21 +0000 | [diff] [blame] | 125 | }; |
Georgios Pinitas | 932491f | 2018-09-21 16:33:15 +0100 | [diff] [blame] | 126 | } // namespace arm_compute |
Sang-Hoon Park | a45abfd | 2020-08-17 13:50:15 +0100 | [diff] [blame] | 127 | #endif /*ARM_COMPUTE_CLGEMMLOWPOUTPUTSTAGE_H */ |