aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/core/NEON/kernels/convolution/depthwise/depthwise.hpp
blob: 80b061401553f9ff59651e1402d40e3bcafb62bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
 * Copyright (c) 2018 ARM Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#pragma once

namespace depthwise
{

class IDepthwiseConvolution
{
public:
    virtual ~IDepthwiseConvolution() = default;
    virtual int output_size(const int dim_size, const bool padding_same) const = 0;
    virtual unsigned int get_window(void) const = 0;
    virtual void run(const unsigned int start, const unsigned int stop) = 0;
};

template <
  int OutputTileRows,
  int OutputTileCols,
  int KernelRows,
  int KernelCols,
  int StrideRows,
  int StrideCols,
  typename TIn,
  typename TOut
>
class DepthwiseConvolution : public IDepthwiseConvolution
{
  public:
    typedef TIn InputType;
    typedef TOut OutputType;

    // Information about the specific convolution instance
    static constexpr int output_tile_rows = OutputTileRows;
    static constexpr int output_tile_cols = OutputTileCols;
    static constexpr int kernel_rows = KernelRows;
    static constexpr int kernel_cols = KernelCols;
    static constexpr int stride_rows = StrideRows;
    static constexpr int stride_cols = StrideCols;
    static constexpr int inner_tile_rows = stride_rows * output_tile_rows + kernel_rows - 1;
    static constexpr int inner_tile_cols = stride_cols * output_tile_cols + kernel_cols - 1;

    /** Create a new depthwise convolution engine.
     *
     * @param[in] n_batches Number of batches tensors.
     * @param[in] n_input_rows Number of rows in input tensor.
     * @param[in] n_input_cols Number of columns in input tensor.
     * @param[in] n_channels Number of channels in input and output tensors.
     * @param[in] padding_same True if padding is SAME, else VALID.
     * @param[in] weights Pointer to Height x Width x Channel ordered weights.
     * @param[in] input Pointer to NHWC ordered input tensor.
     * @param[output] output Pointer to NHWC ordered output tensor.
     */
    DepthwiseConvolution(
      const int n_batches, const int n_input_rows, const int n_input_cols,
      const int n_channels, const bool padding_same,
      const TIn* const weights,
      const TIn* const input,
      TOut* const output
    );

    // Cannot copy or move a DepthwiseConvolution.
    DepthwiseConvolution(DepthwiseConvolution&) = delete;
    DepthwiseConvolution operator=(DepthwiseConvolution&) = delete;

    /** Get the number of output rows/columns.
     *
     * @param[in] dim_size Number of elements in the dimension (rows/columns)
     * @param[in] same_padding True if the padding is SAME, otherwise false.
     */
    static int get_output_size(const int dim_size, const bool padding_same);

    /** Get the number of output rows/columns.
     *
     * @param[in] dim_size Number of elements in the dimension (rows/columns)
     * @param[in] same_padding True if the padding is SAME, otherwise false.
     */
    int output_size(const int dim_size, const bool padding_same) const override
    {
        return DepthwiseConvolution<OutputTileRows,
                                    OutputTileCols,
                                    KernelRows,
                                    KernelCols,
                                    StrideRows,
                                    StrideCols,
                                    TIn,
                                    TOut>::get_output_size(dim_size, padding_same);
    }

    /** Get the window of work to be performed by an instance of the operator.
     */
    unsigned int get_window(void) const override;

    /** Perform a portion of the work associated with the operator.
     *
     * Will perform the window of work described by $[start, stop)$.
     *
     * @param[in] start Start of the window of work to perform.
     * @param[in] stop End of the work to perform.
     */
    void run(const unsigned int start, const unsigned int stop) override;

  protected:
    /** Process a tile-row of the tensors.
     */
    static void process_tile_row(
      const int n_channels,
      const TIn* const weights,
      const TIn* const inptr,
      const int in_row_stride,
      const int in_col_stride,
      TOut* const outptr,
      const int out_row_stride,
      const int out_col_stride,
      const int row_pad_in_top,
      const int row_pad_in_left,
      const int row_pad_in_bottom,
      const int row_pad_out_bottom,
      const int n_tiles,
      const int n_input_cols,
      const int n_output_cols
    );

    /** Process a single tile of the tensors.
     *
     * @param[in] n_channels Number of channels.
     * @param[in] weights Pointer to Height x Width x Channels ordered weights.
     * @param[in] inptr Pointer to the top-left unpadded value of the tile.
     * @param[in] in_row_stride Stride between rows of the input tensor.
     * @param[in] in_col_stride Stride between columns of the input tensor.
     * @param[out] outptr Pointer to the top-left output value for the tile.
     * @param[in] out_row_stride Stride between rows of the output tensor.
     * @param[in] out_col_stride Stride between columns of the output tensor.
     */
    template <
      int in_pad_top, int in_pad_left, int in_pad_bottom, int in_pad_right,
      int out_pad_bottom, int out_pad_right
    >
    static void process_tile(
      const int n_channels,
      const TIn* const weights,
      const TIn* const inptr,
      const int in_row_stride,
      const int in_col_stride,
      TOut* const outptr,
      const int out_row_stride,
      const int out_col_stride
    );

    // Type of a pointer to a `process_tile` instance
    typedef void (*TileFn)(
      const int,
      const TIn* const,
      const TIn* const, const int, const int,
      TOut* const, const int, const int
    );

    // Determine the maximum padding values which can be applied to tiles of
    // the tensors involved in this class of convolution.
    static constexpr int max_in_pad_top = 2;
    static constexpr int max_in_pad_left = 2;
    static constexpr int max_in_pad_bottom = inner_tile_rows - 1;
    static constexpr int max_in_pad_right = inner_tile_cols - 1;
    static constexpr int max_out_pad_bottom = output_tile_rows;
    static constexpr int max_out_pad_right = output_tile_cols;

    /** Array of methods to process tensor tiles.
     *
     * Allows dynamic dispatch to specialized implementations based on
     * different padding configurations.
     */
    static const TileFn tile_fns[
      max_in_pad_top][max_in_pad_left][max_in_pad_bottom][max_in_pad_right][
      max_out_pad_bottom][max_out_pad_right
    ];

  private:
    // Member variables of instances of a convolution engine.
    const TIn* const _weights;
    const TIn* const _input;
    TOut* const _output;
    const int _n_batches, _n_input_rows, _n_input_cols, _n_channels,
              _n_output_rows, _n_output_cols, _n_tile_rows, _n_tile_cols;
    const bool _padding_same;
};

}  // namespace depthwise