Compute Library
 21.02
CLDeconvolutionLayerUpsampleKernel Class Reference

Interface for the Deconvolution layer kernel on OpenCL. More...

#include <CLDeconvolutionLayerUpsampleKernel.h>

Collaboration diagram for CLDeconvolutionLayerUpsampleKernel:
[legend]

Public Member Functions

 CLDeconvolutionLayerUpsampleKernel ()
 Constructor. More...
 
 CLDeconvolutionLayerUpsampleKernel (const CLDeconvolutionLayerUpsampleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLDeconvolutionLayerUpsampleKerneloperator= (const CLDeconvolutionLayerUpsampleKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLDeconvolutionLayerUpsampleKernel (CLDeconvolutionLayerUpsampleKernel &&)=default
 Default Move Constructor. More...
 
CLDeconvolutionLayerUpsampleKerneloperator= (CLDeconvolutionLayerUpsampleKernel &&)=default
 Default move assignment operator. More...
 
 ~CLDeconvolutionLayerUpsampleKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, const PadStrideInfo &info)
 Initialise the kernel's input and output. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const PadStrideInfo &info)
 Initialise the kernel's input and output. More...
 
void run (const Window &window, cl::CommandQueue &queue) override
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
- Public Member Functions inherited from ICLKernel
 ICLKernel ()
 Constructor. More...
 
cl::Kernel & kernel ()
 Returns a reference to the OpenCL kernel of this object. More...
 
template<typename T >
void add_1D_array_argument (unsigned int &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed 1D array's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_2D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_2D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_3D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_4D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 4D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
virtual void run_op (ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
template<typename T >
void add_argument (unsigned int &idx, T value)
 Add the passed parameters to the object's kernel's arguments starting from the index idx. More...
 
void set_lws_hint (const cl::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
cl::NDRange lws_hint () const
 Return the Local-Workgroup-Size hint. More...
 
void set_wbsm_hint (const cl_int &wbsm_hint)
 Set the workgroup batch size modifier hint. More...
 
cl_int wbsm_hint () const
 Return the workgroup batch size modifier hint. More...
 
const std::string & config_id () const
 Get the configuration ID. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
void set_target (cl::Device &device)
 Set the targeted GPU architecture according to the CL device. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. More...
 
size_t get_max_workgroup_size ()
 Get the maximum workgroup size for the device the CLKernelLibrary uses. More...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
template<typename T , unsigned int dimension_size>
void add_array_argument (unsigned &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed array's parameters to the object's kernel's arguments starting from the index idx. More...
 
- Public Member Functions inherited from IKernel
 IKernel ()
 Constructor. More...
 
virtual ~IKernel ()=default
 Destructor. More...
 
virtual bool is_parallelisable () const
 Indicates whether or not the kernel is parallelisable. More...
 
virtual BorderSize border_size () const
 The size of the border for that kernel. More...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 

Static Public Member Functions

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 CLDeconvolutionLayerUpsample. More...
 
- Static Public Member Functions inherited from ICLKernel
static constexpr unsigned int num_arguments_per_1D_array ()
 Returns the number of arguments enqueued per 1D array object. More...
 
static constexpr unsigned int num_arguments_per_1D_tensor ()
 Returns the number of arguments enqueued per 1D tensor object. More...
 
static constexpr unsigned int num_arguments_per_2D_tensor ()
 Returns the number of arguments enqueued per 2D tensor object. More...
 
static constexpr unsigned int num_arguments_per_3D_tensor ()
 Returns the number of arguments enqueued per 3D tensor object. More...
 
static constexpr unsigned int num_arguments_per_4D_tensor ()
 Returns the number of arguments enqueued per 4D tensor object. More...
 
static cl::NDRange gws_from_window (const Window &window)
 Get the global work size given an execution window. More...
 

Detailed Description

Interface for the Deconvolution layer kernel on OpenCL.

Definition at line 35 of file CLDeconvolutionLayerUpsampleKernel.h.

Constructor & Destructor Documentation

◆ CLDeconvolutionLayerUpsampleKernel() [1/3]

Constructor.

Definition at line 36 of file CLDeconvolutionLayerUpsampleKernel.cpp.

37  : _input(nullptr), _output(nullptr), _info(), _data_layout(DataLayout::UNKNOWN)
38 {
39 }

◆ CLDeconvolutionLayerUpsampleKernel() [2/3]

Prevent instances of this class from being copied (As this class contains pointers)

◆ CLDeconvolutionLayerUpsampleKernel() [3/3]

Default Move Constructor.

◆ ~CLDeconvolutionLayerUpsampleKernel()

Default destructor.

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output,
const PadStrideInfo info 
)

Initialise the kernel's input and output.

Parameters
[in]inputSource tensor. Data types supported: All.
[out]outputDestination tensor. Data types supported: same as input. All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
[in]infoContains padding and stride information described in PadStrideInfo.

Definition at line 69 of file CLDeconvolutionLayerUpsampleKernel.cpp.

References CLKernelLibrary::get().

71 {
72  configure(CLKernelLibrary::get().get_compile_context(), input, output, info);
73 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLTensor *input, ICLTensor *output, const PadStrideInfo &info)
Initialise the kernel&#39;s input and output.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output,
const PadStrideInfo info 
)

Initialise the kernel's input and output.

Parameters
[in]compile_contextThe compile context to be used.
[in]inputSource tensor. Data types supported: All.
[out]outputDestination tensor. Data types supported: same as input. All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
[in]infoContains padding and stride information described in PadStrideInfo.

Definition at line 75 of file CLDeconvolutionLayerUpsampleKernel.cpp.

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::calculate_max_window(), arm_compute::create_kernel(), ITensorInfo::data_layout(), ITensorInfo::element_size(), arm_compute::get_cl_unsigned_type_from_element_size(), arm_compute::get_padding_info(), arm_compute::has_padding_changed(), ITensor::info(), arm_compute::test::validation::info, arm_compute::test::validation::input, num_elems_processed_per_iteration, CLBuildOptions::options(), AccessWindowRectangle::set_valid_region(), ITensorInfo::tensor_shape(), and CLDeconvolutionLayerUpsampleKernel::validate().

77 {
79 
80  // Perform validation step
82  auto padding_info = get_padding_info({ input, output });
83 
84  _input = input;
85  _output = output;
86  _info = info;
87  _data_layout = input->info()->data_layout();
88 
89  // Create kernel
90  CLBuildOptions build_opts;
91  build_opts.add_option(("-DDATA_TYPE=" + get_cl_unsigned_type_from_element_size(input->info()->element_size())));
92  _kernel = create_kernel(compile_context, "deconvolution_upsample", build_opts.options());
93 
94  constexpr unsigned int num_elems_processed_per_iteration = 1;
95 
96  // Configure kernel window
97  Window win = calculate_max_window(*output->info(), Steps(num_elems_processed_per_iteration));
98  AccessWindowHorizontal output_access(output->info(), 0, num_elems_processed_per_iteration);
99  output_access.set_valid_region(win, ValidRegion(Coordinates(), output->info()->tensor_shape()));
100 
101  ICLKernel::configure_internal(win);
103 }
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
#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
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
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...
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:403
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:528
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
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:103
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:513
unsigned int num_elems_processed_per_iteration
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

◆ operator=() [1/2]

Prevent instances of this class from being copied (As this class contains pointers)

◆ operator=() [2/2]

Default move assignment operator.

◆ run()

void run ( const Window window,
cl::CommandQueue &  queue 
)
overridevirtual

Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.

Note
The queue is not flushed by this method, and therefore the kernel will not have been executed by the time this method returns.
Parameters
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).
[in,out]queueCommand queue on which to enqueue the kernel.

Reimplemented from ICLKernel.

Definition at line 105 of file CLDeconvolutionLayerUpsampleKernel.cpp.

References ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::collapse_if_possible(), ITensorInfo::dimension(), Window::DimX, Window::DimY, Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_3D(), arm_compute::get_data_layout_dimension_index(), arm_compute::HEIGHT, ITensor::info(), ICLKernel::lws_hint(), arm_compute::NCHW, arm_compute::NHWC, PadStrideInfo::pad_bottom(), PadStrideInfo::pad_left(), PadStrideInfo::pad_right(), PadStrideInfo::pad_top(), Window::set(), Window::slide_window_slice_3D(), PadStrideInfo::stride(), arm_compute::WIDTH, and IKernel::window().

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 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void enqueue(IGCKernel &kernel, const Window &window, const gles::NDRange &lws=gles::NDRange(1U, 1U, 1U))
Add the kernel to the command queue with the given window.
Definition: IGCKernel.cpp:41
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
#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:276
unsigned int pad_top() const
Get the top padding.
Definition: Types.h:806
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:172
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
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
std::pair< unsigned int, unsigned int > stride() const
Get the stride.
Definition: Types.h:770
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:801
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:49
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:941
Num samples, channels, height, width.
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
Num samples, height, width, channels.
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
unsigned int pad_bottom() const
Get the bottom padding.
Definition: Types.h:811
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:796
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const PadStrideInfo info 
)
static

Static function to check if given info will lead to a valid configuration of CLDeconvolutionLayerUpsample.

Parameters
[in]inputSource tensor info. Data types supported: All.
[in]outputDestination tensor info. Data types supported: same as input. All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
[in]infoContains padding and stride information described in PadStrideInfo.
Returns
a status

Definition at line 41 of file CLDeconvolutionLayerUpsampleKernel.cpp.

References ARM_COMPUTE_RETURN_ERROR_ON, ARM_COMPUTE_RETURN_ERROR_ON_F16_UNSUPPORTED, ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES, ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO, ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR, ARM_COMPUTE_UNUSED, arm_compute::CHANNEL, arm_compute::test::validation::data_layout, ITensorInfo::data_layout(), ITensorInfo::data_type(), ITensorInfo::dimension(), arm_compute::get_data_layout_dimension_index(), arm_compute::HEIGHT, Dimensions< int >::num_max_dimensions, arm_compute::UNKNOWN, and arm_compute::WIDTH.

Referenced by CLDeconvolutionLayerUpsampleKernel::configure(), and CLDeconvolutionLayerUpsample::validate().

43 {
50 
51  const DataLayout data_layout = input->data_layout();
52 
53  const size_t idx_w = get_data_layout_dimension_index(data_layout, DataLayoutDimension::WIDTH);
54  const size_t idx_h = get_data_layout_dimension_index(data_layout, DataLayoutDimension::HEIGHT);
55  const size_t idx_c = get_data_layout_dimension_index(data_layout, DataLayoutDimension::CHANNEL);
56 
57  ARM_COMPUTE_RETURN_ERROR_ON(output->dimension(idx_w) == 0);
58  ARM_COMPUTE_RETURN_ERROR_ON(output->dimension(idx_h) == 0);
59 
60  ARM_COMPUTE_RETURN_ERROR_ON(input->dimension(idx_c) != output->dimension(idx_c));
61  for(size_t i = 3; i < Coordinates::num_max_dimensions; ++i)
62  {
63  ARM_COMPUTE_RETURN_ERROR_ON(input->dimension(i) != output->dimension(i));
64  }
65 
66  return Status{};
67 }
#define ARM_COMPUTE_RETURN_ERROR_ON_F16_UNSUPPORTED(tensor)
Definition: CLValidate.h:35
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(...)
Definition: Validate.h:610
const DataLayout data_layout
Definition: Im2Col.cpp:151
#define ARM_COMPUTE_RETURN_ERROR_ON(cond)
If the condition is true, an error is returned.
Definition: Error.h:296
#define ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(...)
Definition: Validate.h:163
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
#define ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:545
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
static constexpr size_t num_max_dimensions
Number of dimensions the tensor has.
Definition: Dimensions.h:46
DataLayout
[DataLayout enum definition]
Definition: Types.h:120

The documentation for this class was generated from the following files: