xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/dynamic_fusion/sketch/gpu/operators/GpuConv2d.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2022-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_GPUCONV2D
25 #define ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPUCONV2D
26 
27 #include "arm_compute/core/Error.h"
28 #include "arm_compute/dynamic_fusion/sketch/attributes/Conv2dAttributes.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 GpuConv2d final
42 {
43 public:
44     /** Attributes are a set of backend-agnostic parameters that define what an operator does */
45     using Attributes = Conv2dAttributes;
46     /** Create an operator and fuse it into the workload sketch.
47      *    @note If @ref validate_op() fails, the creation also fails and may throw an error.
48      *    @note If @ref validate_op() fails, @p sketch remains unchanged and valid.
49      *
50      * Valid data type configurations:
51      * |src            |wei            |bia            |dst            |
52      * |:--------------|:--------------|:--------------|:--------------|
53      * |F16            |F16            |F16            |F16            |
54      * |F32            |F32            |F32            |F32            |
55      *
56      * Valid data layouts:
57      * - NHWC
58      *
59      * @param[in,out] sketch     Workload sketch into which the operator will be fused
60      * @param[in]     src        Source tensor
61      * @param[in]     wei        Weight tensor
62      * @param[in]     bia        (Optional) Bias tensor
63      * @param[in]     attributes Operator attributes
64      *
65      * @return Pointer for the destination tensor info
66      */
67     static ITensorInfo *create_op(GpuWorkloadSketch &sketch,
68                                   ITensorInfo       *src,
69                                   ITensorInfo       *wei,
70                                   ITensorInfo       *bia,
71                                   const Attributes &attributes);
72     /** Check if the operator configuration is supported, irrespective of fusion
73      *
74      * @param[in] context    Workload context within which the operator is running
75      * @param[in] src        Source tensor
76      * @param[in] wei        Weight tensor
77      * @param[in] bia        (Optional) Bias tensor
78      * @param[in] attributes Operator attributes
79      *
80      * @return Status
81      */
82     static Status is_supported_op(const GpuWorkloadContext &context,
83                                   const ITensorInfo        *src,
84                                   const ITensorInfo        *wei,
85                                   const ITensorInfo        *bia,
86                                   const Attributes         &attributes);
87     /** Check if the operator configuration is supported and if it can be fused into the workload sketch.
88      *
89      * Parameters are similar to @ref GpuConv2d::create_op()
90      *
91      * @return Status
92      */
93     static Status validate_op(const GpuWorkloadSketch &sketch,
94                               const ITensorInfo       *src,
95                               const ITensorInfo       *wei,
96                               const ITensorInfo       *bia,
97                               const Attributes        &attributes);
98 };
99 } // namespace dynamic_fusion
100 } // namespace experimental
101 } // namespace arm_compute
102 #endif /* ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPUCONV2D */
103