Compute Library
 19.08
CLGEMMLowpOffsetContributionKernel Class Reference

OpenCL kernel used to add the offset contribution after CLGEMMLowpMatrixMultiplyKernel. More...

#include <CLGEMMLowpOffsetContributionKernel.h>

Collaboration diagram for CLGEMMLowpOffsetContributionKernel:
[legend]

Public Member Functions

 CLGEMMLowpOffsetContributionKernel ()
 Constructor. More...
 
 CLGEMMLowpOffsetContributionKernel (const CLGEMMLowpOffsetContributionKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLGEMMLowpOffsetContributionKerneloperator= (const CLGEMMLowpOffsetContributionKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLGEMMLowpOffsetContributionKernel (CLGEMMLowpOffsetContributionKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLGEMMLowpOffsetContributionKerneloperator= (CLGEMMLowpOffsetContributionKernel &&)=default
 Allow instances of this class to be moved. More...
 
void configure (ICLTensor *mm_result, const ICLTensor *vector_sum_col, const ICLTensor *vector_sum_row, const ICLTensor *bias, int32_t k, int32_t a_offset, int32_t b_offset)
 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...
 
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 *mm_result, const ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, const ITensorInfo *bias, int32_t a_offset, int32_t b_offset)
 Static function to check if given info will lead to a valid configuration of CLGEMMLowpOffsetContributionKernel. 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

OpenCL kernel used to add the offset contribution after CLGEMMLowpMatrixMultiplyKernel.

The computation is performed in-place

This kernel takes a final int32 accumulator value (the output of CLGEMMLowpMatrixMultiplyKernel), and adds to it the offset contribution of matrix A and matrix B in-place.

The final result is:

mm_result[i][k] = mm_result[i][k] + (vector_sum_col[k] * a_offset) + (vector_sum_row[i] * b_offset) + (a_offset * b_offset * k)

Definition at line 46 of file CLGEMMLowpOffsetContributionKernel.h.

Constructor & Destructor Documentation

◆ CLGEMMLowpOffsetContributionKernel() [1/3]

Constructor.

Definition at line 140 of file CLGEMMLowpOffsetContributionKernel.cpp.

141  : _vector_sum_col(nullptr), _vector_sum_row(nullptr), _mm_result(nullptr), _bias(nullptr)
142 {
143 }

◆ CLGEMMLowpOffsetContributionKernel() [2/3]

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

◆ CLGEMMLowpOffsetContributionKernel() [3/3]

Allow instances of this class to be moved.

Member Function Documentation

◆ configure()

void configure ( ICLTensor mm_result,
const ICLTensor vector_sum_col,
const ICLTensor vector_sum_row,
const ICLTensor bias,
int32_t  k,
int32_t  a_offset,
int32_t  b_offset 
)

Initialise the kernel's input and output.

Parameters
[in,out]mm_resultInput tensor containing the result of CLGEMMLowpMatrixMultiplyKernel. Data type supported: S32
[in]vector_sum_colInput row-vector of sums of all the entries in each column of matrix B. Note: vector_sum_col can be a nullptr in case a_offset = 0. Data type supported: same as mm_result
[in]vector_sum_rowInput row-vector of sums of all the entries in each row of matrix A. Note: vector_sum_row can be a nullptr in case b_offset = 0. Data type supported: same as mm_result
[in]biasBiases tensor. Only shared biases supported and it can be a nullptr if the addition of biases is not required. Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as input.
[in]kNumber of matrix A columns or Matrix B rows
[in]a_offsetOffset to be added to each element of the matrix A.
[in]b_offsetOffset to be added to each element of the matrix B.

Definition at line 145 of file CLGEMMLowpOffsetContributionKernel.cpp.

147 {
148  // Perform validate step
149  ARM_COMPUTE_ERROR_ON_NULLPTR(mm_result);
150  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(mm_result->info(),
151  vector_sum_col != nullptr ? vector_sum_col->info() : nullptr,
152  vector_sum_row != nullptr ? vector_sum_row->info() : nullptr,
153  bias != nullptr ? bias->info() : nullptr,
154  a_offset, b_offset)); // NOLINT
155 
156  _vector_sum_col = vector_sum_col;
157  _vector_sum_row = vector_sum_row;
158  _mm_result = mm_result;
159  _bias = bias;
160 
161  // Check if input is a 3D reinterpretation
162  const bool reinterpret_as_3d = vector_sum_row != nullptr
163  && mm_result->info()->num_dimensions() > 1
164  && mm_result->info()->tensor_shape().y() != vector_sum_row->info()->tensor_shape().x();
165 
166  // Set the arguments to pass at compile time
167  CLBuildOptions build_opts;
168 
169  // If a_offset == 0, vector_sum_col can be a nullptr
170  if(a_offset != 0)
171  {
172  build_opts.add_option("-DA_OFFSET=" + support::cpp11::to_string(a_offset));
173  build_opts.add_option_if(vector_sum_col->info()->tensor_shape().num_dimensions() > 1, "-DSUM_COL_HAS_BATCHES");
174  }
175  // If b_offset == 0, vector_sum_row can be a nullptr
176  build_opts.add_option_if(b_offset != 0, "-DB_OFFSET=" + support::cpp11::to_string(b_offset));
177  build_opts.add_option("-DK_OFFSET=" + support::cpp11::to_string(a_offset * b_offset * k));
178  build_opts.add_option_if(reinterpret_as_3d, "-DHEIGHT_INPUT3D=" + support::cpp11::to_string(mm_result->info()->dimension(1)));
179  build_opts.add_option_if(reinterpret_as_3d, "-DDEPTH_INPUT3D=" + support::cpp11::to_string(mm_result->info()->dimension(2)));
180  build_opts.add_option_if(bias != nullptr, "-DADD_BIAS");
181 
182  std::string kernel_name("gemmlowp_offset_contribution");
183 
184  // Create kernel
185  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
186 
187  // Configure kernel window
188  auto win_config = validate_and_configure_window(mm_result->info(),
189  vector_sum_col != nullptr ? vector_sum_col->info() : nullptr,
190  vector_sum_row != nullptr ? vector_sum_row->info() : nullptr,
191  bias != nullptr ? bias->info() : nullptr,
192  a_offset, b_offset); // NOLINT
193  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
194  ICLKernel::configure_internal(win_config.second);
195 
196  // Set config_id for enabling LWS tuning
197  _config_id = kernel_name + "_";
198  _config_id += support::cpp11::to_string(mm_result->info()->dimension(0));
199  _config_id += "_";
200  _config_id += support::cpp11::to_string(mm_result->info()->dimension(1));
201  _config_id += "_";
202  _config_id += support::cpp11::to_string(mm_result->info()->dimension(2));
203 }
virtual size_t num_dimensions() const =0
The number of dimensions of the tensor (rank)
TensorInfo * info() const override
Interface to be implemented by the child class to return the tensor's metadata.
Definition: CLTensor.cpp:35
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.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
void add_option(std::string option)
Adds option to the existing build option list.
T x() const
Alias to access the size of the first dimension.
Definition: Dimensions.h:81
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor's metadata.
void add_option_if(bool cond, std::string option)
Adds option if a given condition is true;.
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
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
unsigned int num_dimensions() const
Returns the effective dimensionality of the tensor.
Definition: Dimensions.h:122
T y() const
Alias to access the size of the second dimension.
Definition: Dimensions.h:86

References CLBuildOptions::add_option(), CLBuildOptions::add_option_if(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::test::validation::bias, arm_compute::create_kernel(), ITensorInfo::dimension(), CLKernelLibrary::get(), ITensor::info(), CLTensor::info(), Dimensions< T >::num_dimensions(), ITensorInfo::num_dimensions(), CLBuildOptions::options(), ITensorInfo::tensor_shape(), arm_compute::support::cpp11::to_string(), arm_compute::validate_and_configure_window(), Dimensions< T >::x(), and Dimensions< T >::y().

Referenced by CLGEMMLowpMatrixMultiplyCore::configure().

◆ 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 219 of file CLGEMMLowpOffsetContributionKernel.cpp.

220 {
223 
225  Window slice = collapsed.first_slice_window_3D();
226 
227  // Set window for vector_sum_col
228  Window win_vector_sum_col = slice;
229  win_vector_sum_col.set(Window::DimY, Window::Dimension(0, 0, 0));
230  win_vector_sum_col.set(Window::DimZ, Window::Dimension(0, 0, 0));
231 
232  // Set window for vector_sum_row
233  Window win_vector_sum_row = slice;
234  win_vector_sum_row.set(Window::DimX, Window::Dimension(0, 0, 0));
235  win_vector_sum_row.set(Window::DimY, Window::Dimension(0, 0, 0));
236  win_vector_sum_col.set(Window::DimZ, Window::Dimension(0, 0, 0));
237 
238  Window biases_slice = slice;
239  biases_slice.set(Window::DimY, Window::Dimension(0, 1, 1));
240  biases_slice.set(Window::DimZ, Window::Dimension(0, 1, 1));
241 
242  do
243  {
244  unsigned int idx = 0;
245  add_3D_tensor_argument(idx, _mm_result, slice);
246  add_2D_tensor_argument_if((_vector_sum_col != nullptr), idx, _vector_sum_col, win_vector_sum_col);
247  add_2D_tensor_argument_if((_vector_sum_row != nullptr), idx, _vector_sum_row, win_vector_sum_row);
248  add_1D_tensor_argument_if((_bias != nullptr), idx, _bias, biases_slice);
249 
250  enqueue(queue, *this, slice, lws_hint());
251  }
252  while(collapsed.slide_window_slice_3D(slice));
253 }
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 ...
Definition: ICLKernel.h:121
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
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 ...
Definition: ICLKernel.h:145
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
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 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
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
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

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

◆ validate()

Status validate ( const ITensorInfo mm_result,
const ITensorInfo vector_sum_col,
const ITensorInfo vector_sum_row,
const ITensorInfo bias,
int32_t  a_offset,
int32_t  b_offset 
)
static

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

Parameters
[in]mm_resultInput tensor containing the result of CLGEMMLowpOffsetContributionKernel. Data type supported: S32
[in]vector_sum_colInput row-vector of sums of all the entries in each column of matrix B. Note: vector_sum_col can be a nullptr in case a_offset = 0. Data type supported: same as mm_result
[in]vector_sum_rowInput row-vector of sums of all the entries in each row of matrix A. Note: vector_sum_row can be a nullptr in case b_offset = 0. Data type supported: same as mm_result
[in]biasBiases tensor. Only shared biases supported and it can be a nullptr if the addition of biases is not required. Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as input.
[in]a_offsetOffset to be added to each element of the matrix A.
[in]b_offsetOffset to be added to each element of the matrix B.
Returns
a status

Definition at line 205 of file CLGEMMLowpOffsetContributionKernel.cpp.

207 {
208  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(mm_result, vector_sum_col, vector_sum_row, bias, a_offset, b_offset));
210  vector_sum_col != nullptr ? vector_sum_col->clone().get() : nullptr,
211  vector_sum_row != nullptr ? vector_sum_row->clone().get() : nullptr,
212  bias != nullptr ? bias->clone().get() : nullptr,
213  a_offset, b_offset)
214  .first); // NOLINT
215 
216  return Status{};
217 }
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, arm_compute::test::validation::bias, ICloneable< T >::clone(), and arm_compute::validate_and_configure_window().

Referenced by CLGEMMLowpMatrixMultiplyCore::validate().


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