Compute Library
 23.11
deconvolution_layer.cl
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2021 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 #include "helpers.h"
25 
26 /** This function applies upsample on an input image.
27  *
28  * @param[in] src_ptr Pointer to the source image. Supported data types: All.
29  * @param[in] src_stride_x Stride of the source image in X dimension (in bytes)
30  * @param[in] src_step_x src_stride_x * number of elements along X processed per workitem(in bytes)
31  * @param[in] src_stride_y Stride of the source image in Y dimension (in bytes)
32  * @param[in] src_step_y src_stride_y * number of elements along Y processed per workitem(in bytes)
33  * @param[in] src_stride_z Stride of the source tensor in Z dimension (in bytes)
34  * @param[in] src_step_z src_stride_z * number of elements along Z processed per workitem(in bytes)
35  * @param[in] src_offset_first_element_in_bytes The offset of the first element in the source image
36  * @param[out] dst_ptr Pointer to the destination image. Supported data types: same as @p src_ptr
37  * @param[in] dst_stride_x Stride of the destination image in X dimension (in bytes)
38  * @param[in] dst_step_x dst_stride_x * number of elements along X processed per workitem(in bytes)
39  * @param[in] dst_stride_y Stride of the destination image in Y dimension (in bytes)
40  * @param[in] dst_step_y dst_stride_y * number of elements along Y processed per workitem(in bytes)
41  * @param[in] dst_stride_z Stride of the source tensor in Z dimension (in bytes)
42  * @param[in] dst_step_z dst_stride_z * number of elements along Z processed per workitem(in bytes)
43  * @param[in] dst_offset_first_element_in_bytes The offset of the first element in the destination image
44  */
45 __kernel void deconvolution_upsample(
46  TENSOR3D_DECLARATION(src),
47  TENSOR3D_DECLARATION(dst))
48 {
49  Tensor3D src = CONVERT_TO_TENSOR3D_STRUCT(src);
50  Tensor3D dst = CONVERT_TO_TENSOR3D_STRUCT(dst);
51 
52  // Store result
53  *((__global DATA_TYPE *)dst.ptr) = *((__global DATA_TYPE *)src.ptr);
54 }
55 
56 #if defined(FILTER_WIDTH) && defined(FILTER_HEIGHT) && defined(SRC_WIDTH) && defined(SRC_HEIGHT) && defined(DATA_TYPE)
57 /** This kernel reshapes the deconvolution output tensor before returning the result of the Deconvolution. The decovnolution output tensor
58  * is the result of a @ref CLGEMM operation between the deconvolution input and the deconvolution filter
59  *
60  * @note Data type should be given as a preprocessor argument using -DDATA_TYPE=type, e.g., -DDATA_TYPE=F32
61  * @note The width of the filter should be given as a preprocessor argument using -DFILTER_WIDTH=width, e.g., -DFILTER_WIDTH=2
62  * @note The height of the filter should be given as a preprocessor argument using -DFILTER_HEIGHT=height, e.g., -DFILTER_HEIGHT=2
63  * @note The width of the input should be given as a preprocessor argument using -DSRC_WIDTH=width, e.g., -DSRC_WIDTH=10
64  * @note The height of the input should be given as a preprocessor argument using -DSRC_HEIGHT=width, e.g., -DSRC_HEIGHT=10
65  * @note The output data layout is NHWC if the preprocessor argument NUM_FILTERS is defined, NCHW if NUM_FILTERS is not defined
66  *
67  * @param[in] src_ptr Pointer to the source image. Supported data types: QASYMM8/QASYMM8_SIGNED/F16/F32
68  * @param[in] src_stride_x Stride of the source image in X dimension (in bytes)
69  * @param[in] src_step_x src_stride_x * number of elements along X processed per workitem(in bytes)
70  * @param[in] src_stride_y Stride of the source image in Y dimension (in bytes)
71  * @param[in] src_step_y src_stride_y * number of elements along Y processed per workitem(in bytes)
72  * @param[in] src_stride_z Stride of the source tensor in Z dimension (in bytes)
73  * @param[in] src_step_z src_stride_z * number of elements along Z processed per workitem(in bytes)
74  * @param[in] src_offset_first_element_in_bytes The offset of the first element in the source image
75  * @param[out] dst_ptr Pointer to the destination image. Supported data types: same as @p src_ptr
76  * @param[in] dst_stride_x Stride of the destination image in X dimension (in bytes)
77  * @param[in] dst_step_x dst_stride_x * number of elements along X processed per workitem(in bytes)
78  * @param[in] dst_stride_y Stride of the destination image in Y dimension (in bytes)
79  * @param[in] dst_step_y dst_stride_y * number of elements along Y processed per workitem(in bytes)
80  * @param[in] dst_stride_z Stride of the source tensor in Z dimension (in bytes)
81  * @param[in] dst_step_z dst_stride_z * number of elements along Z processed per workitem(in bytes)
82  * @param[in] dst_offset_first_element_in_bytes The offset of the first element in the destination image
83  * @param[in] bias_ptr (Optional) Pointer to the biases vector. Supported data types: F16/F32/S32
84  * @param[in] bias_stride_x (Optional) Stride of the biases vector in X dimension (in bytes)
85  * @param[in] bias_step_x (Optional) biases_stride_x * number of elements along X processed per workitem(in bytes)
86  * @param[in] bias_offset_first_element_in_bytes (Optional) The offset of the first element in the biases vector
87  */
88 __kernel void deconvolution_reshape(
89  TENSOR3D_DECLARATION(src),
90  TENSOR3D_DECLARATION(dst)
91 #if defined(ADD_BIAS)
92  ,
93  VECTOR_DECLARATION(bias)
94 #endif // defined(ADD_BIAS)
95 )
96 {
97 #define FILTER_AREA ((FILTER_WIDTH) * (FILTER_HEIGHT))
98 
99  Tensor3D src = CONVERT_TO_TENSOR3D_STRUCT(src);
100  Tensor3D dst = CONVERT_TO_TENSOR3D_STRUCT_NO_STEP(dst);
101  const DATA_TYPE data = *(__global DATA_TYPE *)src.ptr;
102 
103  // Store result
104  const int x_in = get_global_id(0);
105  const int y_in = get_global_id(1);
106  const int z_in = get_global_id(2);
107 
108 #if defined(NUM_FILTERS)
109  const int bias_index = x_in / (FILTER_AREA);
110  const int z_out = bias_index + (NUM_FILTERS) * (z_in / (SRC_HEIGHT));
111  const int x_out = x_in % (FILTER_WIDTH) + y_in * (FILTER_WIDTH);
112  const int y_out = (FILTER_HEIGHT) * (z_in % (SRC_HEIGHT)) + ((x_in % (FILTER_AREA)) / (FILTER_WIDTH));
113 #else // defined(NUM_FILTERS)
114  const int x_out = x_in / (FILTER_AREA);
115  const int y_out = x_in % (FILTER_WIDTH) + y_in * (FILTER_WIDTH);
116  const int z_out = (FILTER_HEIGHT) * z_in + ((x_in % (FILTER_AREA)) / (FILTER_WIDTH));
117  const int bias_index = x_out;
118 #endif // defined(NUM_FILTERS)
119 
120 #if defined(ADD_BIAS)
121  Vector bias = CONVERT_TO_VECTOR_STRUCT_NO_STEP(bias);
122  const DATA_TYPE bias_val = *(__global DATA_TYPE *)vector_offset(&bias, bias_index);
123  *((__global DATA_TYPE *)tensor3D_offset(&dst, x_out, y_out, z_out)) = data + bias_val;
124 #else // defined(ADD_BIAS)
125  *((__global DATA_TYPE *)tensor3D_offset(&dst, x_out, y_out, z_out)) = data;
126 #endif // defined(ADD_BIAS)
127 
128 #undef FILTER_AREA
129 }
130 #endif // defined(FILTER_WIDTH) && defined(FILTER_HEIGHT) && defined(SRC_WIDTH) && defined(SRC_HEIGHT) && defined(DATA_TYPE)
Vector
Structure to hold Vector information.
Definition: helpers.h:915
arm_compute::test::validation::src
SimpleTensor< float > src
Definition: DFT.cpp:155
arm_compute::test::validation::dst
auto dst
Definition: DFT.cpp:170
CONVERT_TO_TENSOR3D_STRUCT
#define CONVERT_TO_TENSOR3D_STRUCT(name)
Definition: helpers.h:893
Tensor3D
Structure to hold 3D tensor information.
Definition: helpers.h:932
CONVERT_TO_VECTOR_STRUCT_NO_STEP
#define CONVERT_TO_VECTOR_STRUCT_NO_STEP(name)
Definition: helpers.h:869
deconvolution_upsample
__kernel void deconvolution_upsample(__global uchar *src_ptr, uint src_stride_x, uint src_step_x, uint src_stride_y, uint src_step_y, uint src_stride_z, uint src_step_z, uint src_offset_first_element_in_bytes, __global uchar *dst_ptr, uint dst_stride_x, uint dst_step_x, uint dst_stride_y, uint dst_step_y, uint dst_stride_z, uint dst_step_z, uint dst_offset_first_element_in_bytes)
This function applies upsample on an input image.
Definition: deconvolution_layer.cl:45
TENSOR3D_DECLARATION
#define TENSOR3D_DECLARATION(name)
Definition: helpers.h:852
VECTOR_DECLARATION
#define VECTOR_DECLARATION(name)
Definition: helpers.h:845
bias
const int32_t * bias
Definition: working_space.hpp:322
vector_offset
const __global uchar * vector_offset(const Vector *vec, int x)
Get the pointer position of a Vector.
Definition: helpers.h:1117
CONVERT_TO_TENSOR3D_STRUCT_NO_STEP
#define CONVERT_TO_TENSOR3D_STRUCT_NO_STEP(name)
Definition: helpers.h:897
tensor3D_offset
const __global uchar * tensor3D_offset(const Tensor3D *tensor, int x, int y, int z)
Get the pointer position of a Tensor3D.
Definition: helpers.h:1140
helpers.h