Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2017 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_CLIM2COLKERNEL_H__ |
| 25 | #define __ARM_COMPUTE_CLIM2COLKERNEL_H__ |
| 26 | |
| 27 | #include "arm_compute/core/CL/ICLKernel.h" |
| 28 | |
| 29 | namespace arm_compute |
| 30 | { |
| 31 | class ICLTensor; |
Gian Marco Iodice | 13edbff | 2017-06-26 17:20:16 +0100 | [diff] [blame] | 32 | class Size2D; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 33 | |
| 34 | /** Interface for the im2col reshape kernel. |
| 35 | * |
| 36 | * Rearranges image blocks into columns. It is used to strip out each convolution block to a single column. |
| 37 | * It is used to transform a convolution to a plain matrix multiplication. |
| 38 | * |
| 39 | * For example taking into account the image below and assuming 3x3 image blocks with stride of 1 we have: |
| 40 | * @f[ |
| 41 | * \left( \begin{array}{cccc} |
| 42 | * a00 & a01 & a02 & a03 \\ |
| 43 | * a10 & a11 & a12 & a13 \\ |
| 44 | * a20 & a21 & a22 & a23 \\ |
| 45 | * a30 & a31 & a32 & a33 \\ |
| 46 | * \end{array} \right) |
| 47 | * = |
| 48 | * \left( \begin{array}{ccccccccc} |
| 49 | * a00 & a01 & a02 & a10 & a11 & a12 & a20 & a21 & a22 \\ |
| 50 | * a01 & a02 & a03 & a11 & a12 & a13 & a21 & a22 & a23 \\ |
| 51 | * a10 & a11 & a12 & a20 & a21 & a22 & a30 & a31 & a32 \\ |
| 52 | * a11 & a12 & a13 & a21 & a22 & a23 & a31 & a32 & a33 \\ |
| 53 | * \end{array} \right) |
| 54 | * @f] |
| 55 | */ |
| 56 | class CLIm2ColKernel : public ICLKernel |
| 57 | { |
| 58 | public: |
| 59 | /** Default constructor */ |
| 60 | CLIm2ColKernel(); |
| 61 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 62 | CLIm2ColKernel(const CLIm2ColKernel &) = delete; |
| 63 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 64 | CLIm2ColKernel &operator=(const CLIm2ColKernel &) = delete; |
| 65 | /** Allow instances of this class to be moved */ |
| 66 | CLIm2ColKernel(CLIm2ColKernel &&) = default; |
| 67 | /** Allow instances of this class to be moved */ |
| 68 | CLIm2ColKernel &operator=(CLIm2ColKernel &&) = default; |
| 69 | /** Set the input and output of the kernel. |
| 70 | * |
Gian Marco Iodice | 13edbff | 2017-06-26 17:20:16 +0100 | [diff] [blame] | 71 | * @param[in] input The input tensor to convert. 3 lower dimensions represent a single input [width, height, IFM], |
Georgios Pinitas | 358ca20 | 2017-12-07 16:47:52 +0000 | [diff] [blame^] | 72 | * while every optional dimension from 4 and above represent a batch of inputs. Data types supported: QS8/QASYMM8/QS16/F16/F32 |
Gian Marco Iodice | 13edbff | 2017-06-26 17:20:16 +0100 | [diff] [blame] | 73 | * @param[out] output The output tensor. First 2 lower dimensions represent a transform of each 3D input, |
| 74 | * while every dimension above represents a batch. Data types supported: Same as @p input |
| 75 | * @param[in] kernel_dims The kernel dimensions (width and height). |
| 76 | * @param[in] conv_info Contains padding and stride information described in @ref PadStrideInfo. |
| 77 | * @param[in] has_bias In case biases are provided expands the matrix with 1. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 78 | */ |
Gian Marco Iodice | 13edbff | 2017-06-26 17:20:16 +0100 | [diff] [blame] | 79 | void configure(const ICLTensor *input, ICLTensor *output, const Size2D &kernel_dims, const PadStrideInfo &conv_info, bool has_bias); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 80 | |
| 81 | // Inherited methods overridden: |
| 82 | void run(const Window &window, cl::CommandQueue &queue) override; |
Georgios Pinitas | 358ca20 | 2017-12-07 16:47:52 +0000 | [diff] [blame^] | 83 | /** Static function to check if given info will lead to a valid configuration of @ref CLIm2ColKernel |
| 84 | * |
| 85 | * @param[in] input The input tensor to convert. 3 lower dimensions represent a single input [width, height, IFM], |
| 86 | * while every optional dimension from 4 and above represent a batch of inputs. Data types supported: QS8/QASYMM8/QS16/F16/F32 |
| 87 | * @param[in] output The output tensor. First 2 lower dimensions represent a transform of each 3D input, |
| 88 | * while every dimension above represents a batch. Data types supported: Same as @p input |
| 89 | * @param[in] kernel_dims The kernel dimensions (width and height). |
| 90 | * @param[in] conv_info Contains padding and stride information described in @ref PadStrideInfo. |
| 91 | * @param[in] has_bias In case biases are provided expands the matrix with 1. |
| 92 | * |
| 93 | * @return a status |
| 94 | */ |
| 95 | static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Size2D &kernel_dims, const PadStrideInfo &conv_info, bool has_bias); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 96 | |
| 97 | private: |
| 98 | /** Run the reshape kernel optimised for the special case (stride is 1, padding is 0 and kernel's low 3 dimensions are same as input) |
| 99 | * |
| 100 | * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()). |
| 101 | * @param[in,out] queue Command queue on which to enqueue the kernel. |
| 102 | */ |
| 103 | void run_reduced(const Window &window, cl::CommandQueue &queue); |
| 104 | /** run the generic convolution layer input reshape kernel |
| 105 | * |
| 106 | * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()). |
| 107 | * @param[in,out] queue Command queue on which to enqueue the kernel. |
| 108 | */ |
| 109 | void run_generic(const Window &window, cl::CommandQueue &queue); |
| 110 | |
| 111 | /** Common signature for the kernel to run */ |
| 112 | using Im2ColFunction = void (CLIm2ColKernel::*)(const Window &, cl::CommandQueue &); |
| 113 | |
| 114 | private: |
| 115 | const ICLTensor *_input; |
| 116 | ICLTensor *_output; |
| 117 | std::pair<unsigned int, unsigned int> _convolved_dims; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 118 | unsigned int _num_elems_processed_per_iteration; |
| 119 | Im2ColFunction _run_func; |
| 120 | }; |
Gian Marco Iodice | f670a0a | 2017-09-18 12:20:45 +0100 | [diff] [blame] | 121 | } // namespace arm_compute |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 122 | #endif /*__ARM_COMPUTE_CLIM2COLKERNEL_H__ */ |