xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/kernels/CpuConvertFullyConnectedWeightsKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2022 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_CPU_CONVERT_FULLYCONNECTED_WEIGHTS_KERNEL_H
25 #define ARM_COMPUTE_CPU_CONVERT_FULLYCONNECTED_WEIGHTS_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
28 #include "src/cpu/ICpuKernel.h"
29 
30 namespace arm_compute
31 {
32 namespace cpu
33 {
34 namespace kernels
35 {
36 /** Interface to convert the 2D Fully Connected weights from NCHW to NHWC or vice versa.
37  *
38  * @note This function can be applied to the 2D weights used by a Fully Connected layer if:
39  *       - It follows a Convolution layer
40  *       - The data layout used by the network does not match the one the model has been trained in.
41  *
42  * @note This function assumes the weights are already reshaped (transposed)
43  */
44 class CpuConvertFullyConnectedWeightsKernel : public ICpuKernel<CpuConvertFullyConnectedWeightsKernel>
45 {
46 public:
47     CpuConvertFullyConnectedWeightsKernel() = default;
48     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuConvertFullyConnectedWeightsKernel);
49     /** Set the src and dst tensor.
50      *
51      * @param[in] src                  Source weights tensor info to convert. Must be 2 dimensional. Data types supported: All.
52      * @param[in] dst                  The converted weights tensor info. Shape and Data Type: Same as @p src.
53      * @param[in] original_input_shape Shape of the original src tensor (the one entering fully connected layer).
54      * @param[in] data_layout          The data layout the weights have been trained in.
55      */
56     void configure(const ITensorInfo *src, ITensorInfo *dst, const TensorShape &original_input_shape, DataLayout data_layout);
57     /** Static function to check if given info will lead to a valid configuration
58      *
59      * Similar to @ref CpuConvertFullyConnectedWeightsKernel::configure()
60      *
61      * @return a status
62      */
63     static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const TensorShape &original_input_shape, DataLayout data_layout);
64 
65     // Inherited methods overridden:
66     void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
67     const char *name() const override;
68 
69 private:
70     unsigned int _factor1{ 0 }; /* equals to the number of elements per original src plane if @p data_layout == NCHW; its number of channels otherwise */
71     unsigned int _factor2{ 0 }; /* equals to the number of elements per original src plane if @p data_layout == NHWC; its number of channels otherwise */
72 };
73 } // namespace kernels
74 } // namespace cpu
75 } // namespace arm_compute
76 #endif /* ARM_COMPUTE_CPU_CONVERT_FULLYCONNECTED_WEIGHTS_KERNEL_H */