Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [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_GCSOFTMAXLAYER_H__ |
| 25 | #define __ARM_COMPUTE_GCSOFTMAXLAYER_H__ |
| 26 | |
| 27 | #include "arm_compute/core/GLES_COMPUTE/kernels/GCSoftmaxLayerKernel.h" |
| 28 | #include "arm_compute/runtime/GLES_COMPUTE/GCTensor.h" |
| 29 | #include "arm_compute/runtime/IFunction.h" |
| 30 | |
| 31 | namespace arm_compute |
| 32 | { |
| 33 | class IGCTensor; |
| 34 | |
| 35 | /** Basic function to compute a SoftmaxLayer. |
| 36 | * |
| 37 | * Softmax is calculated by : |
| 38 | * @f[ out = exp(x - max(x)) / sum(exp(x - max(x))) @f] |
| 39 | * |
| 40 | * This function runs the following kernels: |
| 41 | * -# @ref GCLogits1DMaxKernel |
| 42 | * -# @ref GCLogits1DShiftExpSumKernel |
| 43 | * -# @ref GCLogits1DNormKernel |
| 44 | */ |
| 45 | class GCSoftmaxLayer : public IFunction |
| 46 | { |
| 47 | public: |
| 48 | /** Constructor */ |
| 49 | GCSoftmaxLayer(); |
| 50 | /** Set the input and output tensors. |
| 51 | * |
| 52 | * @param[in] input Source tensor. Data types supported: F16/F32 |
| 53 | * @param[out] output Destination tensor. Data types supported: same as @p input |
Pablo Palmier | a2b89ca | 2017-10-05 15:01:34 +0100 | [diff] [blame^] | 54 | * @param[in] beta (Optional) A scaling factor for the exponent. Only beta = 1 is supported. |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 55 | */ |
Pablo Palmier | a2b89ca | 2017-10-05 15:01:34 +0100 | [diff] [blame^] | 56 | void configure(const IGCTensor *input, IGCTensor *output, float beta = 1.0f); |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 57 | |
| 58 | // Inherited methods overridden: |
| 59 | void run() override; |
| 60 | |
| 61 | private: |
| 62 | GCLogits1DMaxKernel _max_kernel; |
| 63 | GCLogits1DShiftExpSumKernel _shift_exp_sum_kernel; |
| 64 | GCLogits1DNormKernel _norm_kernel; |
| 65 | GCTensor _max; |
| 66 | GCTensor _sum; |
| 67 | GCTensor _tmp; |
| 68 | }; |
| 69 | } |
| 70 | #endif /* __ARM_COMPUTE_GCSOFTMAXLAYER_H__ */ |