1 /* 2 * Copyright (c) 2017-2020 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_CLDIRECTCONVOLUTIONLAYER_H 25 #define ARM_COMPUTE_CLDIRECTCONVOLUTIONLAYER_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/CL/functions/CLActivationLayer.h" 29 #include "arm_compute/runtime/IFunction.h" 30 31 #include <memory> 32 33 namespace arm_compute 34 { 35 class CLCompileContext; 36 class CLDirectConvolutionLayerKernel; 37 class CLFillBorderKernel; 38 class ICLTensor; 39 class ITensorInfo; 40 41 /** Basic function to execute direct convolution function: 42 */ 43 class CLDirectConvolutionLayer : public IFunction 44 { 45 public: 46 /** Default constructor */ 47 CLDirectConvolutionLayer(); 48 /** Prevent instances of this class from being copied */ 49 CLDirectConvolutionLayer(const CLDirectConvolutionLayer &) = delete; 50 /** Prevent instances of this class from being copied */ 51 CLDirectConvolutionLayer &operator=(const CLDirectConvolutionLayer &) = delete; 52 /** Default destructor */ 53 ~CLDirectConvolutionLayer(); 54 /** Set the input and output tensors. 55 * 56 * @param[in] input Source tensor. 3 lower dimensions represent a single input [width, height, IFM], 57 * while every optional dimension from 4 and above represent a batch of inputs. 58 * Data types supported: QASYMM8_SIGNED/QASYMM8/F16/F32. 59 * @param[in] weights Weights tensor. Weights are 4D tensor with dimensions [kernel_x, kernel_y, IFM, OFM]. Data type supported:Same as @p input. 60 * @param[in] biases Biases tensor. Shared biases supported. Biases are 1D tensor with dimensions [OFM]. 61 * Data type supported: Should match @p input data type, except for input of QASYMM8 and QASYMM8_SIGNED type where biases should be of S32 type. 62 * @param[out] output Destination tensor. 3 lower dimensions represent a single output [width, height, OFM], while the rest represent batch of outputs. 63 * Data types supported: Same as @p input. 64 * @param[in] conv_info Contains padding and stride information described in @ref PadStrideInfo. 65 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. 66 */ 67 void configure(ICLTensor *input, const ICLTensor *weights, const ICLTensor *biases, ICLTensor *output, const PadStrideInfo &conv_info, const ActivationLayerInfo &act_info = ActivationLayerInfo()); 68 /** Set the input and output tensors. 69 * 70 * @param[in] compile_context The compile context to be used. 71 * @param[in] input Source tensor. 3 lower dimensions represent a single input [width, height, IFM], 72 * while every optional dimension from 4 and above represent a batch of inputs. 73 * Data types supported: QASYMM8_SIGNED/QASYMM8/F16/F32. 74 * @param[in] weights Weights tensor. Weights are 4D tensor with dimensions [kernel_x, kernel_y, IFM, OFM]. Data type supported:Same as @p input. 75 * @param[in] biases Biases tensor. Shared biases supported. Biases are 1D tensor with dimensions [OFM]. 76 * Data type supported: Should match @p input data type, except for input of QASYMM8 and QASYMM8_SIGNED type where biases should be of S32 type. 77 * @param[out] output Destination tensor. 3 lower dimensions represent a single output [width, height, OFM], while the rest represent batch of outputs. 78 * Data types supported: Same as @p input. 79 * @param[in] conv_info Contains padding and stride information described in @ref PadStrideInfo. 80 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. 81 */ 82 void configure(const CLCompileContext &compile_context, ICLTensor *input, const ICLTensor *weights, const ICLTensor *biases, ICLTensor *output, const PadStrideInfo &conv_info, 83 const ActivationLayerInfo &act_info = ActivationLayerInfo()); 84 /** Static function to check if given info will lead to a valid configuration of @ref CLDirectConvolutionLayer 85 * 86 * @param[in] input Source tensor. 3 lower dimensions represent a single input [width, height, IFM], 87 * while every optional dimension from 4 and above represent a batch of inputs. 88 * Data types supported: QASYMM8_SIGNED/QASYMM8/F16/F32. 89 * @param[in] weights Weights tensor. Weights are 4D tensor with dimensions [kernel_x, kernel_y, IFM, OFM]. Data type supported:Same as @p input. 90 * @param[in] biases Biases tensor. Shared biases supported. Biases are 1D tensor with dimensions [OFM]. 91 * Data type supported: Should match @p input data type, except for input of QASYMM8 and QASYMM8_SIGNED type where biases should be of S32 type. 92 * @param[in] output Destination tensor. 3 lower dimensions represent a single output [width, height, OFM], while the rest represent batch of outputs. 93 * Data types supported: Same as @p input. 94 * @param[in] conv_info Contains padding and stride information described in @ref PadStrideInfo. 95 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. 96 * 97 * @return a status 98 */ 99 static Status validate(const ITensorInfo *input, const ITensorInfo *weights, const ITensorInfo *biases, const ITensorInfo *output, const PadStrideInfo &conv_info, 100 const ActivationLayerInfo &act_info = ActivationLayerInfo()); 101 102 // Inherited methods overridden: 103 void run() override; 104 105 private: 106 std::unique_ptr<CLDirectConvolutionLayerKernel> _direct_conv_kernel; 107 std::unique_ptr<CLFillBorderKernel> _input_border_handler; 108 CLActivationLayer _activationlayer_function; 109 110 bool _is_activationlayer_enabled; 111 }; 112 } 113 #endif /* ARM_COMPUTE_CLDIRECTCONVOLUTIONLAYER_H */ 114