Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2021 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_CL_SOFTMAX_H |
| 25 | #define ARM_COMPUTE_CL_SOFTMAX_H |
| 26 | |
| 27 | #include "arm_compute/runtime/CL/CLTensor.h" |
Georgios Pinitas | 7891a73 | 2021-08-20 21:39:25 +0100 | [diff] [blame] | 28 | #include "src/gpu/cl/ClCompileContext.h" |
| 29 | #include "src/gpu/cl/IClOperator.h" |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 30 | |
| 31 | namespace arm_compute |
| 32 | { |
| 33 | struct SoftmaxKernelInfo; |
| 34 | |
| 35 | namespace opencl |
| 36 | { |
| 37 | class ClPermute; |
| 38 | namespace kernels |
| 39 | { |
| 40 | class ClLogits1DMaxShiftExpSumKernel; |
| 41 | class ClLogits1DNormKernel; |
| 42 | } // namespace kernels |
| 43 | class ClSoftmax : public IClOperator |
| 44 | { |
| 45 | public: |
| 46 | /** Constructor */ |
| 47 | ClSoftmax(); |
| 48 | /** Configure the operator |
| 49 | * |
| 50 | * @param[in] compile_context The compile context to be used. |
| 51 | * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32 for Softmax and F16/F32 for Log Softmax |
| 52 | * @param[out] dst Destination tensor info. Data types supported: same as @p src |
| 53 | * @param[in] info Contains information consumed by kernels for softmax described in @ref SoftmaxKernelInfo. |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 54 | */ |
| 55 | void configure(const CLCompileContext &compile_context, const ITensorInfo &src, ITensorInfo &dst, const SoftmaxKernelInfo &info); |
Georgios Pinitas | 2eb5d16 | 2021-07-02 09:01:49 +0100 | [diff] [blame] | 56 | /** Static function to check if given info will lead to a valid configuration |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 57 | * |
Georgios Pinitas | 2eb5d16 | 2021-07-02 09:01:49 +0100 | [diff] [blame] | 58 | * Similar to ClSoftmax::configure() |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 59 | * |
Georgios Pinitas | 2eb5d16 | 2021-07-02 09:01:49 +0100 | [diff] [blame] | 60 | * @return a status |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 61 | */ |
| 62 | static Status validate(const ITensorInfo &src, const ITensorInfo &dst, const SoftmaxKernelInfo &info); |
| 63 | // Inherited methods overridden: |
| 64 | void run(ITensorPack &tensors) override; |
| 65 | experimental::MemoryRequirements workspace() const override; |
| 66 | |
| 67 | private: |
Manuel Bottini | 94f799e | 2021-06-09 16:37:32 +0100 | [diff] [blame] | 68 | enum InternalTensorIdx |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 69 | { |
| 70 | MAX = 0, |
| 71 | SUM, |
| 72 | TMP, |
| 73 | PERMUTED_SRC, |
| 74 | PERMUTED_DST, |
| 75 | COUNT |
| 76 | }; |
| 77 | |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 78 | std::unique_ptr<ClPermute> _permute_input; |
| 79 | std::unique_ptr<ClPermute> _permute_output; |
| 80 | std::unique_ptr<kernels::ClLogits1DMaxShiftExpSumKernel> _max_shift_exp_sum_kernel; |
| 81 | std::unique_ptr<kernels::ClLogits1DNormKernel> _norm_kernel; |
| 82 | bool _needs_permute{ false }; |
| 83 | |
Manuel Bottini | 94f799e | 2021-06-09 16:37:32 +0100 | [diff] [blame] | 84 | TensorInfo _max_info; |
| 85 | TensorInfo _sum_info; |
| 86 | TensorInfo _tmp_info; |
| 87 | TensorInfo _permuted_src_info; |
| 88 | TensorInfo _permuted_dst_info; |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 89 | |
Manuel Bottini | 94f799e | 2021-06-09 16:37:32 +0100 | [diff] [blame] | 90 | experimental::MemoryRequirements _aux_mem{}; |
Sang-Hoon Park | 201e0fe | 2021-01-27 13:14:56 +0000 | [diff] [blame] | 91 | }; |
| 92 | |
| 93 | } // opencl |
| 94 | } // arm_compute |
| 95 | #endif /* ARM_COMPUTE_CL_SOFTMAX_H */ |