arm_compute/runtime/NEON/functions/NEDeconvolutionLayer.h

   1 /*
   2  * Copyright (c) 2017-2018 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_NEDECONVOLUTIONLAYER_H__
  25 #define __ARM_COMPUTE_NEDECONVOLUTIONLAYER_H__
  26
  27 #include "arm_compute/runtime/CPP/functions/CPPUpsample.h"
  28 #include "arm_compute/runtime/NEON/functions/NEConvolutionLayer.h"
  29 #include "arm_compute/runtime/NEON/functions/NEDirectConvolutionLayer.h"
  30
  31 #include "arm_compute/core/Types.h"
  32 #include "arm_compute/runtime/IFunction.h"
  33 #include "arm_compute/runtime/IMemoryManager.h"
  34 #include "arm_compute/runtime/MemoryGroup.h"
  35 #include "arm_compute/runtime/Tensor.h"
  36
  37 #include <memory>
  38
  39 namespace arm_compute
  40 {
  41 /** Function to run the deconvolution layer.
  42  *
  43  * Deconvolution Layer is the backward pass of Convolution Layer. First we transform the input depending on the stride and pad info and then perfrom a 1x1
  44  * convolution pass. Input stride defines how many zeroes we should put between each element of the input, pad is the amount of padding and finaly a is a user
  45  * specified value where a < stride - 1 that increases the padding top and right of the input image.
  46  *
  47  *  The relation between input to output is as follows:
  48  *       width_output = round((width_input − 1) ∗ (stride_x - 1) − 2 ∗ padding_x + kernel_x + inner_border_right )
  49  *       height_output = round((height_input − 1) ∗ (stride_y - 1) − 2 ∗ padding_y + kernel_y + inner_border_top )
  50  *
  51  *  where
  52  *      width is the size of the first input dimension.
  53  *      height is the size of the second input dimension.
  54  *      width_output is the size of the first output dimension.
  55  *      height_output is the size of the second output dimension.
  56  *      kernel_x and kernel_y are the convolution sizes in x and y.
  57  *      inner_border_right and inner_border_top the number of zeros added to the top and right edges of the input.
  58  *      stride_x and stride_y is the input stride of the first and second dimension.
  59  *
  60  *  This function calls the following NEON kernels:
  61  *
  62  * -# @ref NEDirectConvolutionLayer
  63  *
  64  */
  65 class NEDeconvolutionLayer : public IFunction
  66 {
  67 public:
  68     /** Default constructor */
  69     NEDeconvolutionLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
  70
  71     /** Prevent instances of this class from being copied (As this class contains pointers) */
  72     NEDeconvolutionLayer(const NEDeconvolutionLayer &) = delete;
  73     /** Prevent instances of this class from being copied (As this class contains pointers) */
  74     NEDeconvolutionLayer &operator=(const NEDeconvolutionLayer &) = delete;
  75     /** Allow instances of this class to be moved */
  76     NEDeconvolutionLayer(NEDeconvolutionLayer &&) = default;
  77     /** Allow instances of this class to be moved */
  78     NEDeconvolutionLayer &operator=(NEDeconvolutionLayer &&) = default;
  79     /** Default destructor */
  80     virtual ~NEDeconvolutionLayer() = default;
  81     /** Set the input, weights, biases and output tensors.
  82      *
  83      * @param[in,out] input              Input tensor. 3 lower dimensions represent a single input, and an optional 4th dimension for batch of inputs. Data types supported: F32.
  84      * @param[in]     weights            The 4d weights with dimensions [width, height, IFM, OFM]. Data type supported: Same as @p input.
  85      * @param[in]     bias               Optional, ignored if NULL. The biases have one dimension. Data type supported: Same as @p input.
  86      * @param[out]    output             Output tensor. The output has the same number of dimensions as the @p input.
  87      * @param[in]     info               Contains padding and policies to be used in the deconvolution, this is decribed in @ref PadStrideInfo.
  88      * @param[in]     inner_border_right The number of zeros added to right edge of the input.
  89      * @param[in]     inner_border_top   The number of zeros added to top edge of the input.
  90      *
  91      */
  92     void configure(ITensor *input, const ITensor *weights, const ITensor *bias, ITensor *output, const PadStrideInfo &info,
  93                    unsigned int inner_border_right, unsigned int inner_border_top);
  94     /** Static function to check if given info will lead to a valid configuration of @ref NEDeconvolutionLayer
  95      *
  96      * @param[in] input              Input tensor info. 3 lower dimensions represent a single input, and an optional 4th dimension for batch of inputs. Data types supported: F32.
  97      * @param[in] weights            The 4d weights info with dimensions [width, height, IFM, OFM]. Data type supported: Same as @p input.
  98      * @param[in] bias               (Optional) The biases have one dimension. Data type supported: Same as @p input.
  99      * @param[in] output             Output tensor info. The output has the same number of dimensions as the @p input.
 100      * @param[in] info               Contains padding and policies to be used in the deconvolution, this is decribed in @ref PadStrideInfo.
 101      * @param[in] inner_border_right The number of zeros added to right edge of the input.
 102      * @param[in] inner_border_top   The number of zeros added to top edge of the input.
 103      *
 104      * @return a status
 105      */
 106     static Status validate(const ITensorInfo *input, const ITensorInfo *weights, const ITensorInfo *bias, const ITensorInfo *output, const PadStrideInfo &info,
 107                            unsigned int inner_border_right, unsigned int inner_border_top);
 108
 109     // Inherited methods overridden:
 110     void run() override;
 111
 112 private:
 113     MemoryGroup        _memory_group;
 114     NEConvolutionLayer _conv_f;
 115     CPPUpsample        _upsample_f;
 116     Tensor             _scaled_output;
 117     ITensor           *_input;
 118     PadStrideInfo      _info;
 119     std::pair<unsigned int, unsigned int> _inner_border;
 120 };
 121 } // arm_compute
 122 #endif /* __ARM_COMPUTE_NEDECONVOLUTIONLAYER_H__ */