Compute Library
 19.08
CLNormalizePlanarYUVLayerKernel Class Reference

Interface for the NormalizePlanarYUV layer kernel. More...

#include <CLNormalizePlanarYUVLayerKernel.h>

Collaboration diagram for CLNormalizePlanarYUVLayerKernel:
[legend]

Public Member Functions

 CLNormalizePlanarYUVLayerKernel ()
 Constructor. More...
 
 CLNormalizePlanarYUVLayerKernel (const CLNormalizePlanarYUVLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLNormalizePlanarYUVLayerKerneloperator= (const CLNormalizePlanarYUVLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLNormalizePlanarYUVLayerKernel (CLNormalizePlanarYUVLayerKernel &&)=default
 Default Move Constructor. More...
 
CLNormalizePlanarYUVLayerKerneloperator= (CLNormalizePlanarYUVLayerKernel &&)=default
 Default move assignment operator. More...
 
 ~CLNormalizePlanarYUVLayerKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *std)
 Set the input and output tensors. 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, const ITensorInfo *mean, const ITensorInfo *std)
 Static function to check if given info will lead to a valid configuration of CLNormalizePlanarYUVLayerKernel. 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 NormalizePlanarYUV layer kernel.

Definition at line 34 of file CLNormalizePlanarYUVLayerKernel.h.

Constructor & Destructor Documentation

◆ CLNormalizePlanarYUVLayerKernel() [1/3]

Constructor.

Definition at line 93 of file CLNormalizePlanarYUVLayerKernel.cpp.

94  : _input(nullptr), _output(nullptr), _mean(nullptr), _std(nullptr)
95 {
96 }

◆ CLNormalizePlanarYUVLayerKernel() [2/3]

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

◆ CLNormalizePlanarYUVLayerKernel() [3/3]

Default Move Constructor.

◆ ~CLNormalizePlanarYUVLayerKernel()

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output,
const ICLTensor mean,
const ICLTensor std 
)

Set the input and output tensors.

Parameters
[in]inputSource tensor. 3 lower dimensions represent a single input with dimensions [width, height, channels]. Data types supported: QASYMM8/F16/F32.
[out]outputDestination tensor. Data type supported: same as input
[in]meanMean values tensor. 1 dimension with size equal to the number of input channels. Data types supported: same as input
[in]stdStandard deviation values tensor. 1 dimension with size equal to the number of input channels. Data types supported: same as input

Definition at line 98 of file CLNormalizePlanarYUVLayerKernel.cpp.

99 {
100  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output, mean, std);
101 
102  // Output tensor auto initialization if not yet initialized
103  auto_init_if_empty(*output->info(), *input->info()->clone());
104 
105  // Perform validation step
106  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), mean->info(), std->info()));
107 
108  _input = input;
109  _output = output;
110  _mean = mean;
111  _std = std;
112 
113  const unsigned int num_elems_processed_per_iteration = 16 / input->info()->element_size();
114  const unsigned int channel_idx = get_data_layout_dimension_index(input->info()->data_layout(), DataLayoutDimension::CHANNEL);
115  const DataType dt = input->info()->data_type();
116 
117  // Set build options
118  CLBuildOptions build_opts;
119  build_opts.add_option(("-DDATA_TYPE=" + get_cl_type_from_data_type(dt)));
120  build_opts.add_option(("-DVEC_SIZE=" + support::cpp11::to_string(num_elems_processed_per_iteration)));
121  build_opts.add_option(("-DNUM_CHANNELS=" + support::cpp11::to_string(input->info()->dimension(channel_idx))));
122 
123  std::string kernel_name = "normalize_planar_yuv_layer_";
124  if(is_data_type_quantized(dt))
125  {
127  build_opts.add_option(("-DOFFSET=" + support::cpp11::to_string(qinfo.offset)));
128  build_opts.add_option(("-DSCALE=" + support::cpp11::to_string(qinfo.scale)));
129  kernel_name += "q8_";
130  }
131 
132  // Create kernel
133  kernel_name += lower_string(string_from_data_layout(input->info()->data_layout()));
134  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
135 
136  // Configure kernel window
137  auto win_config = validate_and_configure_window(input->info(), output->info(), mean->info(), std->info());
138  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
139  ICLKernel::configure_internal(win_config.second);
140 
141  // Set config_id for enabling LWS tuning
142  _config_id = "normalize_planar_yuv_layer_";
143  _config_id += lower_string(string_from_data_layout(input->info()->data_layout()));
144  _config_id += "_";
145  _config_id += lower_string(string_from_data_type(dt));
146  _config_id += "_";
147  _config_id += support::cpp11::to_string(input->info()->dimension(0));
148  _config_id += "_";
149  _config_id += support::cpp11::to_string(input->info()->dimension(1));
150  _config_id += "_";
151  _config_id += support::cpp11::to_string(input->info()->dimension(2));
152 }
bool is_data_type_quantized(DataType dt)
Check if a given data type is of quantized type.
Definition: Utils.h:1010
const std::vector< int32_t > & offset() const
Offset vector accessor.
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
const StringSet & options() const
Gets the current options list set.
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *input, ITensorInfo *weights, ITensorInfo *biases, ITensorInfo *output, const PadStrideInfo &conv_info, unsigned int depth_multiplier, const Size2D &dilation)
std::string to_string(T &&value)
Convert integer and float values to string.
virtual DataType data_type() const =0
Data type used for each element of the tensor.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
Quantization info when assuming per layer quantization.
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:327
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
Definition: Helpers.inl:201
void add_option(std::string option)
Adds option to the existing build option list.
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:144
UniformQuantizationInfo uniform() const
Return per layer quantization info.
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:35
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.
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()
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
virtual QuantizationInfo quantization_info() const =0
Get the quantization settings (scale and offset) of the tensor.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
const std::string & string_from_data_layout(DataLayout dl)
Convert a data layout identity into a string.
Definition: Utils.cpp:132
const QuantizationInfo qinfo
Definition: Im2Col.cpp:150
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:326
DataType
Available data types.
Definition: Types.h:74
virtual DataLayout data_layout() const =0
Get the data layout of the tensor.

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), arm_compute::CHANNEL, ICloneable< T >::clone(), arm_compute::create_kernel(), ITensorInfo::data_layout(), ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::element_size(), CLKernelLibrary::get(), arm_compute::get_cl_type_from_data_type(), arm_compute::get_data_layout_dimension_index(), ITensor::info(), arm_compute::is_data_type_quantized(), arm_compute::lower_string(), QuantizationInfo::offset(), CLBuildOptions::options(), arm_compute::test::validation::qinfo, ITensorInfo::quantization_info(), QuantizationInfo::scale(), arm_compute::string_from_data_layout(), arm_compute::string_from_data_type(), arm_compute::support::cpp11::to_string(), QuantizationInfo::uniform(), and arm_compute::validate_and_configure_window().

Referenced by CLNormalizePlanarYUVLayer::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 162 of file CLNormalizePlanarYUVLayerKernel.cpp.

163 {
166 
168  Window slice = collapsed.first_slice_window_3D();
169 
170  Window slice_in = collapsed.first_slice_window_1D();
171  slice_in.set(Window::DimX, Window::Dimension(0, 0, 0));
172 
173  unsigned int idx = 2 * num_arguments_per_3D_tensor();
174  add_1D_tensor_argument(idx, _mean, slice_in);
175  add_1D_tensor_argument(idx, _std, slice_in);
176 
177  do
178  {
179  idx = 0;
180  add_3D_tensor_argument(idx, _input, slice);
181  add_3D_tensor_argument(idx, _output, slice);
182  enqueue(queue, *this, slice, lws_hint());
183  }
184  while(collapsed.slide_window_slice_3D(slice));
185 }
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
Describe one of the image's dimensions with a start, end and step.
Definition: Window.h:75
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 size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
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:54
void set(size_t dimension, const Dimension &dim)
Set the values of a given dimension.
Definition: Window.inl:48
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:319
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
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.
Definition: ICLKernel.h:110
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:275
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940
Window first_slice_window_1D() const
First 1D slice of the window.
Definition: Window.h:259
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

References ICLKernel::add_1D_tensor_argument(), ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::collapse_if_possible(), Window::DimX, Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_1D(), Window::first_slice_window_3D(), ICLKernel::lws_hint(), ICLKernel::num_arguments_per_3D_tensor(), Window::set(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

◆ validate()

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

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

Parameters
[in]inputSource tensor info. 3 lower dimensions represent a single input with dimensions [width, height, channels]. Data types supported: QASYMM8/F16/F32.
[out]outputDestination tensor info. Data type supported: same as input
[in]meanMean values tensor info. 1 dimension with size equal to the number of input channels. Data types supported: same as input
[in]stdStandard deviation values tensor info. 1 dimension with size equal to the number of input channels. Data types supported: same as input
Returns
a status

Definition at line 154 of file CLNormalizePlanarYUVLayerKernel.cpp.

155 {
156  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, mean, std));
157  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), output->clone().get(), mean->clone().get(), std->clone().get()).first);
158 
159  return Status{};
160 }
std::pair< Status, Window > validate_and_configure_window(ITensorInfo *input, ITensorInfo *weights, ITensorInfo *biases, ITensorInfo *output, const PadStrideInfo &conv_info, unsigned int depth_multiplier, const Size2D &dilation)
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:193
Status class.
Definition: Error.h:52
virtual std::unique_ptr< T > clone() const =0
Provide a clone of the current object of class T.

References ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), and arm_compute::validate_and_configure_window().

Referenced by CLNormalizePlanarYUVLayer::validate().


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