Compute Library
 19.08
CLWidthConcatenateLayerKernel Class Reference

Interface for the width concatenate kernel. More...

#include <CLWidthConcatenateLayerKernel.h>

Collaboration diagram for CLWidthConcatenateLayerKernel:
[legend]

Public Member Functions

 CLWidthConcatenateLayerKernel ()
 Default constructor. More...
 
 CLWidthConcatenateLayerKernel (const CLWidthConcatenateLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLWidthConcatenateLayerKerneloperator= (const CLWidthConcatenateLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLWidthConcatenateLayerKernel (CLWidthConcatenateLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLWidthConcatenateLayerKerneloperator= (CLWidthConcatenateLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLWidthConcatenateLayerKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, unsigned int width_offset, ICLTensor *output)
 Initialise the kernel's inputs 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...
 
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, unsigned int width_offset, const ITensorInfo *output)
 Static function to check if given info will lead to a valid configuration of CLWidthConcatenateLayerKernel. 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 width concatenate kernel.

The input tensor will be concatenated into the output tensor.

Definition at line 38 of file CLWidthConcatenateLayerKernel.h.

Constructor & Destructor Documentation

◆ CLWidthConcatenateLayerKernel() [1/3]

Default constructor.

Definition at line 81 of file CLWidthConcatenateLayerKernel.cpp.

82  : _input(nullptr), _output(nullptr), _width_offset(0)
83 {
84 }

◆ CLWidthConcatenateLayerKernel() [2/3]

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

◆ CLWidthConcatenateLayerKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLWidthConcatenateLayerKernel()

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
unsigned int  width_offset,
ICLTensor output 
)

Initialise the kernel's inputs and output.

Parameters
[in]inputInput tensor. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[in]width_offsetThe offset on the X axis.
[in,out]outputOutput tensor. Data types supported: Same as input.

Definition at line 93 of file CLWidthConcatenateLayerKernel.cpp.

94 {
95  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
96  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), width_offset, output->info()));
97 
98  _input = input;
99  _output = output;
100  _width_offset = width_offset;
101 
102  // Add build options
103  CLBuildOptions build_opts;
104  build_opts.add_option("-DDATA_TYPE=" + get_underlying_cl_type_from_data_type(input->info()->data_type()));
105  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(num_elems_processed_per_iteration));
106  build_opts.add_option("-DWIDTH_OFFSET=" + support::cpp11::to_string(_width_offset));
107  build_opts.add_option("-DDEPTH=" + support::cpp11::to_string(input->info()->dimension(2)));
108 
109  if(is_data_type_quantized_asymmetric(input->info()->data_type()) && input->info()->quantization_info() != output->info()->quantization_info())
110  {
111  const UniformQuantizationInfo iqinfo = input->info()->quantization_info().uniform();
112  const UniformQuantizationInfo oqinfo = output->info()->quantization_info().uniform();
113 
114  build_opts.add_option("-DOFFSET_IN1=" + float_to_string_with_full_precision(iqinfo.offset));
115  build_opts.add_option("-DOFFSET_OUT=" + float_to_string_with_full_precision(oqinfo.offset));
116  build_opts.add_option("-DSCALE_IN1=" + float_to_string_with_full_precision(iqinfo.scale));
117  build_opts.add_option("-DSCALE_OUT=" + float_to_string_with_full_precision(oqinfo.scale));
118  }
119 
120  // Create kernel
121  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel("concatenate_width", build_opts.options()));
122  // Configure kernel window
123  auto win_config = validate_and_configure_window(input->info(), width_offset, output->info());
124  ARM_COMPUTE_ERROR_THROW_ON(std::get<0>(win_config));
125 
126  ICLKernel::configure_internal(std::get<1>(win_config));
127 
128  // Set output valid region
129  output->info()->set_valid_region(ValidRegion(Coordinates(), output->info()->tensor_shape()));
130 }
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.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
std::string float_to_string_with_full_precision(float val)
Create a string with the float in full precision.
Definition: Utils.h:1066
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
std::string get_underlying_cl_type_from_data_type(const DataType &dt)
Translates fixed point tensor data type to the underlying OpenCL type.
Definition: CLHelpers.cpp:126
bool is_data_type_quantized_asymmetric(DataType dt)
Check if a given data type is of asymmetric quantized type.
Definition: Utils.h:1030
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), arm_compute::float_to_string_with_full_precision(), CLKernelLibrary::get(), arm_compute::get_underlying_cl_type_from_data_type(), ITensor::info(), arm_compute::is_data_type_quantized_asymmetric(), UniformQuantizationInfo::offset, CLBuildOptions::options(), ITensorInfo::quantization_info(), UniformQuantizationInfo::scale, ITensorInfo::set_valid_region(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), QuantizationInfo::uniform(), and arm_compute::validate_and_configure_window().

◆ operator=() [1/2]

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

◆ operator=() [2/2]

Allow instances of this class to be moved.

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

133 {
136 
137  unsigned int idx = 0;
138  add_4D_tensor_argument(idx, _input, window);
139  add_4D_tensor_argument(idx, _output, window);
140  enqueue(queue, *this, window);
141 }
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
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
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.
Definition: ICLKernel.h:168
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940

References ICLKernel::add_4D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
unsigned int  width_offset,
const ITensorInfo output 
)
static

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

Parameters
[in]inputInput tensor info. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[in]width_offsetThe offset on the X axis.
[in]outputOutput tensor info. Data types supported: Same as input.
Returns
a status

Definition at line 86 of file CLWidthConcatenateLayerKernel.cpp.

87 {
88  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, width_offset, output));
89  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), width_offset, output->clone().get()).first);
90  return Status{};
91 }
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

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


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