Compute Library
 21.11
CLDeconvolutionLayerUpsampleKernel.cpp
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  */
25 
31 #include "src/core/CL/CLValidate.h"
33 
34 namespace arm_compute
35 {
37  : _input(nullptr), _output(nullptr), _info(), _data_layout(DataLayout::UNKNOWN)
38 {
40 }
41 
43  const PadStrideInfo &info)
44 {
45  ARM_COMPUTE_UNUSED(info);
51 
52  const DataLayout data_layout = input->data_layout();
53 
54  const size_t idx_w = get_data_layout_dimension_index(data_layout, DataLayoutDimension::WIDTH);
55  const size_t idx_h = get_data_layout_dimension_index(data_layout, DataLayoutDimension::HEIGHT);
56  const size_t idx_c = get_data_layout_dimension_index(data_layout, DataLayoutDimension::CHANNEL);
57 
58  ARM_COMPUTE_RETURN_ERROR_ON(output->dimension(idx_w) == 0);
59  ARM_COMPUTE_RETURN_ERROR_ON(output->dimension(idx_h) == 0);
60 
61  ARM_COMPUTE_RETURN_ERROR_ON(input->dimension(idx_c) != output->dimension(idx_c));
62  for(size_t i = 3; i < Coordinates::num_max_dimensions; ++i)
63  {
64  ARM_COMPUTE_RETURN_ERROR_ON(input->dimension(i) != output->dimension(i));
65  }
66 
67  return Status{};
68 }
69 
71  const PadStrideInfo &info)
72 {
73  configure(CLKernelLibrary::get().get_compile_context(), input, output, info);
74 }
75 
77  const PadStrideInfo &info)
78 {
79  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
80 
81  // Perform validation step
83  auto padding_info = get_padding_info({ input, output });
84 
85  _input = input;
86  _output = output;
87  _info = info;
88  _data_layout = input->info()->data_layout();
89 
90  // Create kernel
91  CLBuildOptions build_opts;
92  build_opts.add_option(("-DDATA_TYPE=" + get_cl_unsigned_type_from_element_size(input->info()->element_size())));
93  _kernel = create_kernel(compile_context, "deconvolution_upsample", build_opts.options());
94 
95  constexpr unsigned int num_elems_processed_per_iteration = 1;
96 
97  // Configure kernel window
98  Window win = calculate_max_window(*output->info(), Steps(num_elems_processed_per_iteration));
100 
101  ICLKernel::configure_internal(win);
103 }
104 
105 void CLDeconvolutionLayerUpsampleKernel::run(const Window &window, cl::CommandQueue &queue)
106 {
109 
110  const size_t idx_w = get_data_layout_dimension_index(_data_layout, DataLayoutDimension::WIDTH);
111  const size_t idx_h = get_data_layout_dimension_index(_data_layout, DataLayoutDimension::HEIGHT);
112 
113  const int out_start_x = _info.pad_left();
114  const int out_end_x = _output->info()->dimension(idx_w) - _info.pad_right() + _info.stride().first - 1;
115  const int out_step_x = _info.stride().first;
116 
117  const int out_start_y = _info.pad_top();
118  const int out_end_y = _output->info()->dimension(idx_h) - _info.pad_bottom() + _info.stride().second - 1;
119  const int out_step_y = _info.stride().second;
120 
121  switch(_data_layout)
122  {
123  case DataLayout::NCHW:
124  {
126 
127  Window slice_out = collapsed.first_slice_window_3D();
128  slice_out.set(Window::DimX, Window::Dimension(out_start_x, out_end_x, out_step_x));
129  slice_out.set(Window::DimY, Window::Dimension(out_start_y, out_end_y, out_step_y));
130 
131  Window slice_in = collapsed.first_slice_window_3D();
132 
133  do
134  {
135  unsigned int idx = 0;
136  add_3D_tensor_argument(idx, _input, slice_in);
137  add_3D_tensor_argument(idx, _output, slice_out);
138  enqueue(queue, *this, slice_out, lws_hint());
139  }
140  while(collapsed.slide_window_slice_3D(slice_in) && collapsed.slide_window_slice_3D(slice_out));
141  break;
142  }
143  case DataLayout::NHWC:
144  {
145  // NOTE: not collapsing in NHWC
146  Window slice_out = window.first_slice_window_3D();
147  slice_out.set(Window::DimY, Window::Dimension(out_start_x, out_end_x, out_step_x));
148  slice_out.set(Window::DimZ, Window::Dimension(out_start_y, out_end_y, out_step_y));
149 
150  Window slice_in = window.first_slice_window_3D();
151 
152  do
153  {
154  unsigned int idx = 0;
155  add_3D_tensor_argument(idx, _input, slice_in);
156  add_3D_tensor_argument(idx, _output, slice_out);
157  enqueue(queue, *this, slice_out, lws_hint());
158  }
159  while(window.slide_window_slice_3D(slice_in) && window.slide_window_slice_3D(slice_out));
160  break;
161  }
162  default:
163  ARM_COMPUTE_ERROR("Unsupported data layout");
164  }
165 }
166 } // namespace arm_compute
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
#define ARM_COMPUTE_RETURN_ERROR_ON_F16_UNSUPPORTED(tensor)
Definition: CLValidate.h:35
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(...)
Definition: Validate.h:606
Unknown CL kernel type.
Definition: CLTypes.h:81
void enqueue(cl::CommandQueue &queue, ICLKernel &kernel, const Window &window, const cl::NDRange &lws_hint=CLKernelLibrary::get().default_ndrange(), bool use_dummy_work_items=false)
Add the kernel to the command queue with the given window.
Definition: ICLKernel.cpp:32
const StringSet & options() const
Gets the current options list set.
#define ARM_COMPUTE_ERROR(msg)
Print the given message then throw an std::runtime_error.
Definition: Error.h:352
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:318
virtual DataType data_type() const =0
Data type used for each element of the tensor.
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
Describe one of the image&#39;s dimensions with a start, end and step.
Definition: Window.h:77
Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context...
unsigned int pad_top() const
Get the top padding.
Definition: Types.h:740
Status class.
Definition: Error.h:52
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PadStrideInfo &info)
Static function to check if given info will lead to a valid configuration of CLDeconvolutionLayerUpsa...
#define ARM_COMPUTE_RETURN_ERROR_ON(cond)
If the condition is true, an error is returned.
Definition: Error.h:296
void add_3D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 3D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:214
Copyright (c) 2017-2021 Arm Limited.
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:159
void add_option(std::string option)
Adds option to the existing build option list.
cl::Kernel create_kernel(const CLCompileContext &ctx, const std::string &kernel_name, const std::set< std::string > &build_opts=std::set< std::string >())
Creates an opencl kernel using a compile context.
Definition: CLHelpers.cpp:391
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
Window collapse_if_possible(const Window &full_window, size_t first, size_t last, bool *has_collapsed=nullptr) const
Collapse the dimensions between first and last if possible.
Definition: Window.inl:68
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
std::pair< unsigned int, unsigned int > stride() const
Get the stride.
Definition: Types.h:704
unsigned int num_elems_processed_per_iteration
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
unsigned int pad_right() const
Get the right padding.
Definition: Types.h:735
Padding and stride information class.
Definition: Types.h:656
virtual size_t element_size() const =0
Element size in bytes calculated as data_size() * num_channels()
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:49
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
void configure(const ICLTensor *input, ICLTensor *output, const PadStrideInfo &info)
Initialise the kernel&#39;s input and output.
Elementeise CL kernel type.
Definition: CLTypes.h:84
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:335
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:915
bool has_padding_changed(const std::unordered_map< const ITensorInfo *, PaddingSize > &padding_map)
Check if the previously stored padding info has changed after configuring a kernel.
Definition: Utils.cpp:533
Num samples, channels, height, width.
CLCompileContext class.
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
size_t get_data_layout_dimension_index(const DataLayout &data_layout, const DataLayoutDimension &data_layout_dimension)
Get the index of the given dimension.
Definition: Helpers.inl:193
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:541
Num samples, height, width, channels.
std::string get_cl_unsigned_type_from_element_size(size_t element_size)
Translates the element size to an unsigned integer data type.
Definition: CLHelpers.cpp:105
std::unordered_map< const ITensorInfo *, PaddingSize > get_padding_info(std::initializer_list< const ITensorInfo *> infos)
Stores padding information before configuring a kernel.
Definition: Utils.cpp:518
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
unsigned int pad_bottom() const
Get the bottom padding.
Definition: Types.h:745
static constexpr size_t num_max_dimensions
Number of dimensions the tensor has.
Definition: Dimensions.h:46
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:291
unsigned int pad_left() const
Get the left padding.
Definition: Types.h:730
DataLayout
[DataLayout enum definition]
Definition: Types.h:113
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201
virtual DataLayout data_layout() const =0
Get the data layout of the tensor.