Compute Library
 19.08
CLHeightConcatenateLayerKernel Class Reference

Interface for the height concatenate kernel. More...

#include <CLHeightConcatenateLayerKernel.h>

Collaboration diagram for CLHeightConcatenateLayerKernel:
[legend]

Public Member Functions

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

The input tensor will be concatenated into the output tensor.

Definition at line 38 of file CLHeightConcatenateLayerKernel.h.

Constructor & Destructor Documentation

◆ CLHeightConcatenateLayerKernel() [1/3]

Default constructor.

Definition at line 79 of file CLHeightConcatenateLayerKernel.cpp.

80  : _input(nullptr), _output(nullptr), _height_offset(0), _num_elems_processed_per_iteration()
81 {
82 }

◆ CLHeightConcatenateLayerKernel() [2/3]

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

◆ CLHeightConcatenateLayerKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLHeightConcatenateLayerKernel()

Default destructor.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
unsigned int  height_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]height_offsetThe starting offset on the Y axis for the output tensor.
[out]outputOutput tensor. Data types supported: Same as input.

Definition at line 92 of file CLHeightConcatenateLayerKernel.cpp.

93 {
94  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
95  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), height_offset, output->info()));
96 
97  _input = input;
98  _output = output;
99  _height_offset = height_offset;
100 
101  auto win_config = validate_and_configure_window(input->info(), height_offset, output->info(), _num_elems_processed_per_iteration);
102 
103  // Add build options
104  CLBuildOptions build_opts;
105 
106  switch(input->info()->element_size())
107  {
108  case 1:
109  {
110  build_opts.add_option("-DDATA_TYPE=uchar");
111  break;
112  }
113  case 2:
114  {
115  build_opts.add_option("-DDATA_TYPE=short");
116  break;
117  }
118  case 4:
119  {
120  build_opts.add_option("-DDATA_TYPE=int");
121  break;
122  }
123  default:
124  {
125  ARM_COMPUTE_ERROR("Unsupported input data type.");
126  break;
127  }
128  }
129 
130  build_opts.add_option("-DVEC_SIZE=" + support::cpp11::to_string(_num_elems_processed_per_iteration));
131  build_opts.add_option("-DHEIGHT_OFFSET=" + support::cpp11::to_string(_height_offset));
132  build_opts.add_option("-DDEPTH=" + support::cpp11::to_string(input->info()->dimension(2)));
133 
134  if(is_data_type_quantized_asymmetric(input->info()->data_type()) && input->info()->quantization_info() != output->info()->quantization_info())
135  {
136  const UniformQuantizationInfo iq_info = input->info()->quantization_info().uniform();
137  const UniformQuantizationInfo oq_info = output->info()->quantization_info().uniform();
138 
139  build_opts.add_option("-DOFFSET_IN1=" + float_to_string_with_full_precision(iq_info.offset));
140  build_opts.add_option("-DOFFSET_OUT=" + float_to_string_with_full_precision(oq_info.offset));
141  build_opts.add_option("-DSCALE_IN1=" + float_to_string_with_full_precision(iq_info.scale));
142  build_opts.add_option("-DSCALE_OUT=" + float_to_string_with_full_precision(oq_info.scale));
143  }
144 
145  // Create kernel
146  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel("concatenate_height", build_opts.options()));
147  // Configure kernel window
148 
149  ARM_COMPUTE_ERROR_THROW_ON(std::get<0>(win_config));
150 
151  ICLKernel::configure_internal(std::get<1>(win_config));
152 
153  // Set output valid region
154  output->info()->set_valid_region(ValidRegion(Coordinates(), output->info()->tensor_shape()));
155 }
#define ARM_COMPUTE_ERROR(...)
Print the given message then throw an std::runtime_error.
Definition: Error.h:261
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
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.
virtual void set_valid_region(const ValidRegion &valid_region)=0
Set the valid region of the tensor.
void add_option(std::string option)
Adds option to the existing build option list.
std::string float_to_string_with_full_precision(float val)
Create a string with the float in full precision.
Definition: Utils.h:1066
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
Coordinates of an item.
Definition: Coordinates.h:37
UniformQuantizationInfo uniform() const
Return per layer quantization info.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
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.
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
Container for valid region of a window.
Definition: Types.h:174

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::element_size(), arm_compute::float_to_string_with_full_precision(), CLKernelLibrary::get(), ITensor::info(), arm_compute::is_data_type_quantized_asymmetric(), UniformQuantizationInfo::offset, 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 157 of file CLHeightConcatenateLayerKernel.cpp.

158 {
161 
162  unsigned int idx = 0;
163  add_4D_tensor_argument(idx, _input, window);
164  add_4D_tensor_argument(idx, _output, window);
165  enqueue(queue, *this, window);
166 }
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  height_offset,
const ITensorInfo output 
)
static

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

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

Definition at line 84 of file CLHeightConcatenateLayerKernel.cpp.

85 {
86  unsigned int num_elems_processed_per_iteration;
87  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, height_offset, output));
88  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), height_offset, output->clone().get(), num_elems_processed_per_iteration).first);
89  return Status{};
90 }
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().


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