Compute Library
 19.11
CLDequantizationLayerKernel Class Reference

Interface for the dequantization layer kernel. More...

#include <CLDequantizationLayerKernel.h>

Collaboration diagram for CLDequantizationLayerKernel:
[legend]

Public Member Functions

 CLDequantizationLayerKernel ()
 Default constructor. More...
 
 CLDequantizationLayerKernel (const CLDequantizationLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLDequantizationLayerKerneloperator= (const CLDequantizationLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLDequantizationLayerKernel (CLDequantizationLayerKernel &&)=default
 Default Move Constructor. More...
 
CLDequantizationLayerKerneloperator= (CLDequantizationLayerKernel &&)=default
 Default move assignment operator. More...
 
 ~CLDequantizationLayerKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output)
 Set the input, output, min and max. 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...
 
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...
 
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<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...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
- 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)
 Static function to check if given info will lead to a valid configuration of CLDequantizationLayerKernel. 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 dequantization layer kernel.

Definition at line 34 of file CLDequantizationLayerKernel.h.

Constructor & Destructor Documentation

◆ CLDequantizationLayerKernel() [1/3]

Default constructor.

Definition at line 72 of file CLDequantizationLayerKernel.cpp.

73  : _input(nullptr), _output(nullptr)
74 {
75 }

◆ CLDequantizationLayerKernel() [2/3]

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

◆ CLDequantizationLayerKernel() [3/3]

Default Move Constructor.

◆ ~CLDequantizationLayerKernel()

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output 
)

Set the input, output, min and max.

Parameters
[in]inputSource tensor. Data types supported: QASYMM8/QSYMM8_PER_CHANNEL/QSYMM8/QSYMM16.
[out]outputDestination tensor. Data types supported: F16/F32.

Definition at line 77 of file CLDequantizationLayerKernel.cpp.

78 {
80  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info()));
81 
82  _input = input;
83  _output = output;
84 
85  const int vec_size_x = 16 / output->info()->element_size();
86  const int output_width_x = output->info()->tensor_shape().x();
87  const bool multi_access_x = (output_width_x / vec_size_x > 0);
88 
89  // Create and update the window (if needed)
90  Window win = calculate_max_window(*output->info());
91  if(multi_access_x)
92  {
93  win.set(Window::DimX,
94  Window::Dimension(win.x().start(), ceil_to_multiple(win.x().end(), vec_size_x), vec_size_x));
95  }
96  ICLKernel::configure_internal(win);
97 
98  const bool is_quantized_per_channel = is_data_type_quantized_per_channel(input->info()->data_type());
99  std::string kernel_name = "dequantization_layer";
100 
101  // Create kernel
102  CLBuildOptions build_opts;
103  if(!is_quantized_per_channel)
104  {
105  const UniformQuantizationInfo qinfo = input->info()->quantization_info().uniform();
106  const int qoffset = is_data_type_quantized_asymmetric(input->info()->data_type()) ? qinfo.offset : 0;
107  build_opts.add_option("-DSCALE=" + float_to_string_with_full_precision(qinfo.scale));
108  build_opts.add_option("-DOFFSET=" + support::cpp11::to_string(qoffset));
109  }
110  else
111  {
112  kernel_name += "_per_channel";
113  kernel_name += input->info()->data_layout() == DataLayout::NCHW ? "_nchw" : "_nhwc";
114  }
115 
116  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(vec_size_x));
117  build_opts.add_option("-DDATA_TYPE_SRC=" + get_cl_type_from_data_type(input->info()->data_type()));
118  build_opts.add_option("-DDATA_TYPE_DST=" + get_cl_type_from_data_type(output->info()->data_type()));
119  build_opts.add_option_if(multi_access_x, "-DLAST_ACCESSED_X=" + support::cpp11::to_string(std::max<int>(output_width_x - vec_size_x, 0)));
120 
121  // Create kernel name
122  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
123 }
const std::vector< int32_t > & offset() const
Offset vector accessor.
std::string to_string(T &&value)
Convert integer and float values to string.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps=Steps(), bool skip_border=false, BorderSize border_size=BorderSize())
Calculate the maximum window for a given tensor shape and border setting.
Definition: Helpers.cpp:28
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
bool is_data_type_quantized_per_channel(DataType dt)
Check if a given data type is of per channel type.
Definition: Utils.h:1082
std::string float_to_string_with_full_precision(float val)
Create a string with the float in full precision.
Definition: Utils.h:1099
auto ceil_to_multiple(S value, T divisor) -> decltype(((value+divisor - 1)/divisor) *divisor)
Computes the smallest number larger or equal to value that is a multiple of divisor.
Definition: Utils.h:66
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:37
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
const std::vector< float > & scale() const
Scale vector accessor.
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
std::unique_ptr< Kernel > create_kernel()
Helper function to create and return a unique_ptr pointed to a CL/GLES kernel object.
Definition: Helpers.h:86
Num samples, channels, height, width.
bool is_data_type_quantized_asymmetric(DataType dt)
Check if a given data type is of asymmetric quantized type.
Definition: Utils.h:1044
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
const QuantizationInfo qinfo
Definition: Im2Col.cpp:150

References CLBuildOptions::add_option(), CLBuildOptions::add_option_if(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::calculate_max_window(), arm_compute::ceil_to_multiple(), arm_compute::create_kernel(), ITensorInfo::data_type(), Window::DimX, ITensorInfo::element_size(), Window::Dimension::end(), arm_compute::float_to_string_with_full_precision(), CLKernelLibrary::get(), arm_compute::get_cl_type_from_data_type(), ITensor::info(), arm_compute::test::validation::input, arm_compute::is_data_type_quantized_asymmetric(), arm_compute::is_data_type_quantized_per_channel(), arm_compute::NCHW, QuantizationInfo::offset(), CLBuildOptions::options(), arm_compute::test::validation::qinfo, QuantizationInfo::scale(), Window::set(), Window::Dimension::start(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), Dimensions< T >::x(), and Window::x().

Referenced by CLGenerateProposalsLayer::configure().

◆ 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.

Implements ICLKernel.

Definition at line 132 of file CLDequantizationLayerKernel.cpp.

133 {
136 
137  const bool is_quantized_per_channel = is_data_type_quantized_per_channel(_input->info()->data_type());
138 
139  // Collapse windo
140  Window new_window = is_quantized_per_channel ? window.collapse_if_possible(ICLKernel::window(), 4) : window.collapse_if_possible(ICLKernel::window(), 3);
141  Window slice = new_window.first_slice_window_3D();
142 
143  if(is_quantized_per_channel)
144  {
145  unsigned int idx = num_arguments_per_3D_tensor() * 2; //Skip the input and output parameters
146  _kernel.setArg(idx++, _input->quantization().scale->cl_buffer());
147  }
148 
149  do
150  {
151  unsigned int idx = 0;
152  add_3D_tensor_argument(idx, _input, slice);
153  add_3D_tensor_argument(idx, _output, slice);
154  enqueue(queue, *this, slice, lws_hint());
155  }
156  while(new_window.slide_window_slice_3D(slice));
157 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
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:39
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:247
virtual DataType data_type() const =0
Data type used for each element of the tensor.
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.
Definition: ICLKernel.h:158
static constexpr unsigned int num_arguments_per_3D_tensor()
Returns the number of arguments enqueued per 3D tensor object.
Definition: ICLKernel.h:200
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
bool is_data_type_quantized_per_channel(DataType dt)
Check if a given data type is of per channel type.
Definition: Utils.h:1082
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
const ICLFloatArray * scale
Quantization scale array.
Definition: CLTypes.h:70
virtual CLQuantization quantization() const =0
Interface to be implemented by the child class to return the wrapped quantization info data.
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
virtual const cl::Buffer & cl_buffer() const =0
Interface to be implemented by the child class to return a reference to the OpenCL buffer containing ...
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ICLArray< T >::cl_buffer(), Window::collapse_if_possible(), ITensorInfo::data_type(), arm_compute::enqueue(), ITensor::info(), arm_compute::is_data_type_quantized_per_channel(), ICLKernel::lws_hint(), ICLKernel::num_arguments_per_3D_tensor(), ICLTensor::quantization(), CLQuantization::scale, arm_compute::test::validation::reference::slice(), and IKernel::window().

◆ validate()

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

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

Parameters
[in]inputInput tensor info. Data types supported: QASYMM8/QSYMM8_PER_CHANNEL/QSYMM8/QSYMM16.
[in]outputOutput tensor info. Data types supported: F16/F32.
Returns
a status

Definition at line 125 of file CLDequantizationLayerKernel.cpp.

126 {
127  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output));
128  ARM_COMPUTE_RETURN_ON_ERROR(std::get<0>(validate_and_configure_window(input->clone().get(), output->clone().get())));
129  return Status{};
130 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204

References ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), and arm_compute::test::validation::input.

Referenced by CLDequantizationLayer::validate(), and CLGenerateProposalsLayer::validate().


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