1 /* 2 * Copyright (c) 2023 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_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPUSOFTMAX 25 #define ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPUSOFTMAX 26 27 #include "arm_compute/core/ITensorInfo.h" 28 #include "arm_compute/dynamic_fusion/sketch/attributes/SoftmaxAttributes.h" 29 30 namespace arm_compute 31 { 32 namespace experimental 33 { 34 namespace dynamic_fusion 35 { 36 /** Forward declaration */ 37 class GpuWorkloadContext; 38 class GpuWorkloadSketch; 39 40 /** Operator interface. */ 41 class GpuSoftmax final 42 { 43 public: 44 /** Attributes are a set of backend-agnostic parameters that define what an operator does */ 45 using Attributes = SoftmaxAttributes; 46 47 /** Create an operator and fuse it into the workload sketch. 48 * @note If @ref validate_op() fails, the creation also fails and may throw an error. 49 * @note If @ref validate_op() fails, @p sketch remains unchanged and valid. 50 * 51 * Valid data type configurations: 52 * |src |dst | 53 * |:--------------|:--------------| 54 * |F16 |F16 | 55 * |F32 |F32 | 56 * 57 * Valid data layouts: 58 * - All 59 * 60 * @param[in,out] sketch Workload sketch into which the operator will be fused 61 * @param[in] src Source tensor info. 62 * @param[in] dst Destination tensor info. 63 * @param[in] attributes Operator attributes 64 */ 65 static void create_op(GpuWorkloadSketch &sketch, 66 ITensorInfo *src, 67 ITensorInfo *dst, 68 const Attributes &attributes); 69 /** Check if the operator configuration is supported, irrespective of fusion 70 * 71 * @param[in] context Workload context within which the operator is running 72 * @param[in] src Source tensor info. 73 * @param[in] dst Destination tensor info. 74 * @param[in] attributes Operator attributes 75 * 76 * @return Status 77 */ 78 static Status is_supported_op(const GpuWorkloadContext &context, 79 const ITensorInfo *src, 80 const ITensorInfo *dst, 81 const Attributes &attributes); 82 /** Validate the operator and check if the its configuration is supported and if it can be fused into the workload sketch. 83 * Similar to @ref GpuSoftmax::create_op() 84 * 85 * @return a status 86 */ 87 static Status validate_op(const GpuWorkloadSketch &sketch, 88 const ITensorInfo *src, 89 const ITensorInfo *dst, 90 const Attributes &attributes); 91 }; 92 } // namespace dynamic_fusion 93 } // namespace experimental 94 } // namespace arm_compute 95 #endif /* ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPUSOFTMAX */ 96