Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2017 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 | #ifndef __ARM_COMPUTE_CLGEMMLOWPOUTPUTSTAGE_H__ |
| 25 | #define __ARM_COMPUTE_CLGEMMLOWPOUTPUTSTAGE_H__ |
| 26 | |
| 27 | #include "arm_compute/runtime/CL/ICLSimpleFunction.h" |
| 28 | |
| 29 | /** This file contains all available output stages for GEMMLowp on OpenCL. |
| 30 | * |
| 31 | * In gemmlowp, the "output stage" is the process that takes a final int32 accumulator value (the output of @ref CLGEMMLowpMatrixMultiplyCore), |
| 32 | * and processes it to obtain the final ASYMM8 value. |
| 33 | * |
| 34 | * More information about the GEMMLowp output stage can be found at https://github.com/google/gemmlowp/blob/master/doc/output.md |
| 35 | */ |
| 36 | |
| 37 | namespace arm_compute |
| 38 | { |
| 39 | class ITensor; |
| 40 | |
| 41 | /** Basic function to execute CLGEMMLowpQuantizeDownInt32ToUint8Scale on OpenCL. |
| 42 | * |
| 43 | * CLGEMMLowpQuantizeDownInt32ToUint8Scale depends on 3 parameters: result_offset, result_mult_int, result_shift |
| 44 | * The final result is: |
| 45 | * |
| 46 | * ((input[i][k] + result_offset) * result_mult_int) >> result_shift |
| 47 | * |
| 48 | * In case the bias tensor is provided, the final result is: |
| 49 | * |
Gian Marco | 58c5794 | 2017-11-28 09:10:03 +0000 | [diff] [blame] | 50 | * ((input[i][k] + bias[k] + result_offset) * result_mult_int) >> result_shift |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 51 | * |
| 52 | * This function calls the following OpenCL kernels: |
| 53 | * |
| 54 | * -# @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleKernel |
| 55 | * |
| 56 | * @note The function accepts also 2 optional input arguments (min and max) which can be used to implement "rectified linear unit" activation functions |
Gian Marco | 58c5794 | 2017-11-28 09:10:03 +0000 | [diff] [blame] | 57 | * after the result is shifted right by result_shift |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 58 | */ |
| 59 | class CLGEMMLowpQuantizeDownInt32ToUint8Scale : public ICLSimpleFunction |
| 60 | { |
| 61 | public: |
| 62 | /** Initialise the kernel's inputs, output |
| 63 | * |
| 64 | * @param[in] input Input tensor. It is the output of @ref CLGEMMLowpMatrixMultiplyCore function. Data type supported: S32 |
| 65 | * @param[in] bias Biases tensor. Only shared biases supported and it can be a nullptr if the addition of biases is not required. |
| 66 | * Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input. |
| 67 | * @param[out] output Output tensor. Data type supported: Data type supported: QASYMM8 |
| 68 | * @param[in] result_offset Offset to be added to each element of the input matrix |
| 69 | * @param[in] result_mult_int Value to be multiplied to each element of the input matrix when once the result_offset has been add |
| 70 | * @param[in] result_shift Number of bits to shift right the result before converting back to QASYMM8 |
| 71 | * @param[in] min (Optional) Min value used to saturate down the output result before converting back to QASYMM8 |
| 72 | * @param[in] max (Optional) Max value used to saturate up the output result before converting back to QASYMM8, |
| 73 | * Along with @p min, this value can be used to implement "rectified linear unit" activation functions |
| 74 | */ |
| 75 | void configure(const ICLTensor *input, const ICLTensor *bias, ICLTensor *output, int result_offset, int result_mult_int, int result_shift, int min = 0, int max = 0); |
Gian Marco | 58c5794 | 2017-11-28 09:10:03 +0000 | [diff] [blame] | 76 | /** Static function to check if given info will lead to a valid configuration of @ref CLGEMMLowpQuantizeDownInt32ToUint8Scale |
| 77 | * |
| 78 | * @param[in] input Input tensor. It is the output of @ref CLGEMMLowpMatrixMultiplyCore function. Data type supported: S32 |
| 79 | * @param[in] bias Biases tensor. Only shared biases supported and it can be a nullptr if the addition of biases is not required. |
| 80 | * Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input. |
| 81 | * @param[in] output Output tensor. Data type supported: Data type supported: QASYMM8 |
| 82 | * @param[in] min (Optional) Min value used to saturate down the output result before converting back to QASYMM8 |
| 83 | * @param[in] max (Optional) Max value used to saturate up the output result before converting back to QASYMM8, |
| 84 | * Along with @p min, this value can be used to implement "rectified linear unit" activation functions |
| 85 | * |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 86 | * @return a status |
Gian Marco | 58c5794 | 2017-11-28 09:10:03 +0000 | [diff] [blame] | 87 | */ |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 88 | static Status validate(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, int min = 0, int max = 0); |
Gian Marco | 58c5794 | 2017-11-28 09:10:03 +0000 | [diff] [blame] | 89 | }; |
| 90 | |
| 91 | /** Basic function to execute CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint on OpenCL. |
| 92 | * |
| 93 | * CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint depends on 3 parameters: |
| 94 | * |
| 95 | * result_fixedpoint_multiplier, result_shift, result_offset_after_shift |
| 96 | * |
| 97 | * The final result is: |
| 98 | * |
| 99 | * (FixedPointMul(input[i][k], result_fixedpoint_multiplier) >> result_shift) + result_offset_after_shift |
| 100 | * |
| 101 | * where FixedPointMul(x, y) is the nearest integer to the following |
| 102 | * mathematical expression, evaluated without overflow or intermediate rounding: |
| 103 | * |
| 104 | * (x * y) / 2^31 |
| 105 | * |
| 106 | * For more information: https://github.com/google/gemmlowp/blob/master/public/output_stages.h#L68 |
| 107 | * |
| 108 | * In case the bias tensor is provided, the final result is: |
| 109 | * |
| 110 | * ((FixedPointMul(input[i][k] + bias[k], result_fixedpoint_multiplier)) >> result_shift) + result_offset_after_shift |
| 111 | * |
| 112 | * This function calls the following OpenCL kernels: |
| 113 | * |
| 114 | * -# @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel |
| 115 | * |
| 116 | * @note The function accepts also 2 optional input arguments (min and max) which can be used to implement "rectified linear unit" activation functions |
| 117 | * after the result is shifted right by result_shift |
| 118 | */ |
| 119 | class CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint : public ICLSimpleFunction |
| 120 | { |
| 121 | public: |
| 122 | /** Initialise the kernel's inputs, output |
| 123 | * |
| 124 | * @param[in] input Input tensor. Data type supported: S32 |
| 125 | * @param[in] bias Biases tensor. Only shared biases supported and it can be a nullptr if the biases addition is not required. |
| 126 | * Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input. |
| 127 | * @param[out] output Output tensor. Data type supported: Data type supported: QASYMM8 |
| 128 | * @param[in] result_fixedpoint_multiplier Fixed point value to be multiplied to each element of the input matrix when once the result_offset has been add |
| 129 | * @param[in] result_shift Number of bits to shift right the result after the fixed point multiplication |
| 130 | * @param[in] result_offset_after_shift Offset to be applied to result before converting it back to QASYMM8 |
| 131 | * @param[in] min (Optional) Min value used to saturate down the output result before converting back to QASYMM8 |
| 132 | * @param[in] max (Optional) Max value used to saturate up the output result before converting back to QASYMM8, |
| 133 | * Along with @p min, this value can be used to implement "rectified linear unit" activation functions |
| 134 | */ |
| 135 | void configure(const ICLTensor *input, const ICLTensor *bias, ICLTensor *output, int result_fixedpoint_multiplier, int result_shift, int result_offset_after_shift, int min = 0, int max = 0); |
| 136 | /** Static function to check if given info will lead to a valid configuration of @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint |
| 137 | * |
| 138 | * @param[in] input Input tensor. It is the output of @ref CLGEMMLowpMatrixMultiplyCore function. Data type supported: S32 |
| 139 | * @param[in] bias Biases tensor. Only shared biases supported and it can be a nullptr if the addition of biases is not required. |
| 140 | * Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input. |
| 141 | * @param[in] output Output tensor. Data type supported: Data type supported: QASYMM8 |
| 142 | * @param[in] min (Optional) Min value used to saturate down the output result before converting back to QASYMM8 |
| 143 | * @param[in] max (Optional) Max value used to saturate up the output result before converting back to QASYMM8, |
| 144 | * Along with @p min, this value can be used to implement "rectified linear unit" activation functions |
| 145 | * |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 146 | * @return a status |
Gian Marco | 58c5794 | 2017-11-28 09:10:03 +0000 | [diff] [blame] | 147 | */ |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 148 | static Status validate(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, int min = 0, int max = 0); |
Gian Marco | 05288a2 | 2017-11-21 10:57:50 +0000 | [diff] [blame] | 149 | }; |
| 150 | } |
| 151 | #endif /*__ARM_COMPUTE_CLGEMMLOWPOUTPUTSTAGE_H__ */ |