Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 1 | /* |
Renato Arantes | 5713294 | 2023-04-24 07:19:59 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2023 Arm Limited. |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 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_IM2COL_KERNEL_H |
| 25 | #define ARM_COMPUTE_CPU_IM2COL_KERNEL_H |
| 26 | |
| 27 | #include "arm_compute/core/Size2D.h" |
| 28 | #include "src/core/common/Macros.h" |
Georgios Pinitas | 7891a73 | 2021-08-20 21:39:25 +0100 | [diff] [blame] | 29 | #include "src/cpu/ICpuKernel.h" |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 30 | |
| 31 | namespace arm_compute |
| 32 | { |
| 33 | class ITensor; |
| 34 | namespace cpu |
| 35 | { |
| 36 | namespace kernels |
| 37 | { |
| 38 | /** Interface for the im2col reshape kernel. |
| 39 | * |
| 40 | * Rearranges image blocks into columns. It is used to strip out each convolution block to a single column. |
| 41 | * It is used to transform a convolution to a plain matrix multiplication. |
| 42 | * |
| 43 | * For example taking into account the image below and assuming 3x3 image blocks with stride of 1 we have: |
| 44 | * |
| 45 | * @f[ |
| 46 | * \left( \begin{array}{cccc} |
| 47 | * a00 & a01 & a02 & a03 \\ |
| 48 | * a10 & a11 & a12 & a13 \\ |
| 49 | * a20 & a21 & a22 & a23 \\ |
| 50 | * a30 & a31 & a32 & a33 \\ |
| 51 | * \end{array} \right) |
| 52 | * \rightarrow |
| 53 | * \left( \begin{array}{ccccccccc} |
| 54 | * a00 & a01 & a02 & a10 & a11 & a12 & a20 & a21 & a22 \\ |
| 55 | * a01 & a02 & a03 & a11 & a12 & a13 & a21 & a22 & a23 \\ |
| 56 | * a10 & a11 & a12 & a20 & a21 & a22 & a30 & a31 & a32 \\ |
| 57 | * a11 & a12 & a13 & a21 & a22 & a23 & a31 & a32 & a33 \\ |
| 58 | * \end{array} \right) |
| 59 | * @f] |
| 60 | */ |
Yair Schwarzbaum | 46d44d2 | 2022-01-12 16:38:58 +0200 | [diff] [blame] | 61 | class CpuIm2ColKernel : public ICpuKernel<CpuIm2ColKernel> |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 62 | { |
| 63 | public: |
| 64 | /** Default constructor */ |
| 65 | CpuIm2ColKernel() = default; |
| 66 | ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuIm2ColKernel); |
| 67 | /** Set the input and output of the kernel. |
| 68 | * |
Renato Arantes | 5713294 | 2023-04-24 07:19:59 +0000 | [diff] [blame] | 69 | * @param[in] src The input tensor info to convert. 3 lower dimensions represent a single input [width, height, IFM], |
| 70 | * while every optional dimension from 4 and above represent a batch of inputs. |
| 71 | * Data types supported: QASYMM8/QASYMM8_SIGNED/BFLOAT16/F16/F32 |
| 72 | * Note: QASYMM8/QASYMM8_SIGNED works only for has_bias = false |
| 73 | * @param[out] dst The output tensor info. Data types supported: Same as @p input |
| 74 | * @param[in] kernel_dims The kernel dimensions (width and height). |
| 75 | * @param[in] conv_info Contains padding and stride information described in @ref PadStrideInfo. |
| 76 | * @param[in] has_bias In case biases are provided expands the matrix with 1. |
| 77 | * @param[in] dilation (Optional) Dilation, in elements, across x and y. Defaults to (1, 1). |
| 78 | * @param[in] num_groups (Optional) Number of groups when performing a grouped convolution. num_groups != 1 is not supported |
| 79 | * @param[in] input_pad_right (Optional) When fast-math is selected, per element padding for the im2col matrix may be necessary |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 80 | */ |
Manuel Bottini | 29599d0 | 2021-07-06 15:01:35 +0100 | [diff] [blame] | 81 | void configure(const ITensorInfo *src, ITensorInfo *dst, const Size2D &kernel_dims, const PadStrideInfo &conv_info, |
Renato Arantes | 5713294 | 2023-04-24 07:19:59 +0000 | [diff] [blame] | 82 | bool has_bias, const Size2D &dilation = Size2D(1U, 1U), unsigned int num_groups = 1, unsigned int input_pad_right = 0); |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 83 | /** Static function to check if given info will lead to a valid configuration |
| 84 | * |
| 85 | * Similar to CpuIm2ColKernel::configure() |
| 86 | * |
| 87 | * @return a status |
| 88 | */ |
| 89 | static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const Size2D &kernel_dims, const PadStrideInfo &conv_info, |
Renato Arantes | 5713294 | 2023-04-24 07:19:59 +0000 | [diff] [blame] | 90 | bool has_bias, const Size2D &dilation = Size2D(1U, 1U), unsigned int num_groups = 1, unsigned int input_pad_right = 0); |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 91 | |
| 92 | // Inherited methods overridden: |
Renato Arantes | 5713294 | 2023-04-24 07:19:59 +0000 | [diff] [blame] | 93 | void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override; |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 94 | const char *name() const override; |
Dana Zlotnik | 4cdd6b8 | 2021-10-07 15:31:54 +0300 | [diff] [blame] | 95 | /** Return minimum workload size of the relevant kernel |
| 96 | * |
| 97 | * @param[in] platform The CPU platform used to create the context. |
| 98 | * @param[in] thread_count Number of threads in the execution. |
| 99 | * |
| 100 | * @return[out] small_network_mws Minimum workload size for requsted configuration. |
| 101 | */ |
| 102 | size_t get_mws(const CPUInfo &platform, size_t thread_count) const override; |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 103 | |
| 104 | private: |
| 105 | /** Template function to run im2col |
| 106 | * |
| 107 | * @param[in] src The input tensor info |
| 108 | * @param[out] dst The output tensor info |
| 109 | * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()). |
| 110 | */ |
| 111 | template <typename T, bool has_pads, bool is_nchw> |
| 112 | void run_im2col(const ITensor *src, ITensor *dst, const Window &window); |
| 113 | |
| 114 | /** Common signature for all the specialised im2col functions |
| 115 | * |
| 116 | * @param[in] window Region on which to execute the kernel. |
| 117 | */ |
| 118 | using Im2ColFunctionPtr = void (CpuIm2ColKernel::*)(const ITensor *src, ITensor *dst, const Window &window); |
| 119 | |
Renato Arantes | 5713294 | 2023-04-24 07:19:59 +0000 | [diff] [blame] | 120 | Im2ColFunctionPtr _func{ nullptr }; |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 121 | std::pair<unsigned int, unsigned int> _convolved_dims{}; |
Renato Arantes | 5713294 | 2023-04-24 07:19:59 +0000 | [diff] [blame] | 122 | PadStrideInfo _conv_info{}; |
| 123 | unsigned int _kernel_width{ 0 }; |
| 124 | unsigned int _kernel_height{ 0 }; |
| 125 | unsigned int _input_pad_right{ 0 }; |
| 126 | bool _has_bias{ false }; |
| 127 | Size2D _dilation{ 1U, 1U }; |
| 128 | DataLayout _data_layout{ DataLayout::UNKNOWN }; |
Manuel Bottini | 9002899 | 2021-06-30 18:29:18 +0100 | [diff] [blame] | 129 | }; |
| 130 | } // namespace kernels |
| 131 | } // namespace cpu |
| 132 | } // namespace arm_compute |
| 133 | #endif /*ARM_COMPUTE_CPU_IM2COL_KERNEL_H */ |