Compute Library
 19.08
CLGEMMLowpMatrixAReductionKernel Class Reference

OpenCL kernel used to compute the row-vectors of sums of all the entries in each row of Matrix A. More...

#include <CLGEMMLowpReductionKernel.h>

Collaboration diagram for CLGEMMLowpMatrixAReductionKernel:
[legend]

Public Member Functions

void configure (const ICLTensor *mtx_a, ICLTensor *vector_sum_row) override
 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 ICLGEMMLowpReductionKernel
 ICLGEMMLowpReductionKernel ()
 Constructor. More...
 
 ICLGEMMLowpReductionKernel (const ICLGEMMLowpReductionKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICLGEMMLowpReductionKerneloperator= (const ICLGEMMLowpReductionKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICLGEMMLowpReductionKernel (ICLGEMMLowpReductionKernel &&)=default
 Allow instances of this class to be moved. More...
 
ICLGEMMLowpReductionKerneloperator= (ICLGEMMLowpReductionKernel &&)=default
 Allow instances of this class to be moved. 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 *mtx_a, const ITensorInfo *vector_sum_row)
 Static function to check if given info will lead to a valid configuration of CLGEMMLowpMatrixAReductionKernel. 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 compute the row-vectors of sums of all the entries in each row of Matrix A.

Note
This stage is needed to handle the offset of matrix product https://github.com/google/gemmlowp/blob/master/doc/low-precision.md

Definition at line 65 of file CLGEMMLowpReductionKernel.h.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor mtx_a,
ICLTensor vector_sum_row 
)
overridevirtual

Initialise the kernel's input and output.

Parameters
[in]mtx_aInput tensor. Data type supported: QASYMM8
[out]vector_sum_rowOutput row-vector of sums of all the entries in each row of mtx_a. Data type supported: S32

Implements ICLGEMMLowpReductionKernel.

Definition at line 103 of file CLGEMMLowpReductionKernel.cpp.

104 {
105  // Perform validate step
106  ARM_COMPUTE_ERROR_ON_NULLPTR(mtx_a, vector_sum_row);
107  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments_matrix_a_reduction(mtx_a->info(), vector_sum_row->info()));
108 
109  _input = mtx_a;
110  _output = vector_sum_row;
111 
112  // Set the arguments to pass at compile time
113  CLBuildOptions build_opts;
114  build_opts.add_option("-DCOLS_A=" + support::cpp11::to_string(mtx_a->info()->dimension(0)));
115 
116  const bool is_dot8_supported = dot8_supported(CLKernelLibrary::get().get_device());
117 
118  std::string kernel_name = "gemmlowp_matrix_a_reduction" + std::string(is_dot8_supported ? "_dot8" : "");
119 
120  // Create kernel
121  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
122 
123  // Configure kernel window
124  auto win_config = validate_and_configure_window_matrix_a_reduction(_input->info(), _output->info());
125  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
126  ICLKernel::configure_internal(win_config.second);
127 
128  _config_id = kernel_name;
129  _config_id += "_";
130  _config_id += support::cpp11::to_string(_input->info()->dimension(0));
131  _config_id += "_";
132  _config_id += support::cpp11::to_string(_input->info()->dimension(1));
133  _config_id += "_";
134  _config_id += support::cpp11::to_string(_input->info()->dimension(2));
135 }
bool dot8_supported(const cl::Device &device)
Helper function to check whether the cl_arm_integer_dot_product_int8 extension is supported.
Definition: CLHelpers.cpp:149
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::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

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::dimension(), arm_compute::dot8_supported(), CLKernelLibrary::get(), ITensor::info(), CLBuildOptions::options(), and arm_compute::support::cpp11::to_string().

Referenced by CLGEMMLowpMatrixMultiplyCore::configure().

◆ 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 145 of file CLGEMMLowpReductionKernel.cpp.

146 {
149 
151  Window slice_in = collapsed.first_slice_window_2D();
152  Window slice_out = collapsed.first_slice_window_2D();
153 
154  // Setup input slice. Its dimensions are increased in the cl kernel.
155  slice_in.set(Window::DimX, Window::Dimension(0, 0, 0));
156  slice_in.set(Window::DimY, Window::Dimension(0, 0, 0));
157  slice_in.set(Window::DimZ, Window::Dimension(0, 0, 0));
158 
159  do
160  {
161  unsigned int idx = 0;
162  add_3D_tensor_argument(idx, _input, slice_in);
163  add_2D_tensor_argument(idx, _output, slice_out);
164  enqueue(queue, *this, slice_out, lws_hint());
165  }
166  while(collapsed.slide_window_slice_2D(slice_out));
167 }
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:267
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
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
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
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.
Definition: ICLKernel.h:134
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:940

References ICLKernel::add_2D_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::DimY, Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_2D(), ICLKernel::lws_hint(), Window::set(), Window::slide_window_slice_2D(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo mtx_a,
const ITensorInfo vector_sum_row 
)
static

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

Parameters
[in]mtx_aInput tensor. Data type supported: QASYMM8
[in]vector_sum_rowOutput row-vector of sums of all the entries in each row of mtx_a. Data type supported: S32
Returns
a status

Definition at line 137 of file CLGEMMLowpReductionKernel.cpp.

138 {
139  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments_matrix_a_reduction(mtx_a, vector_sum_row));
140  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window_matrix_a_reduction(mtx_a->clone().get(), vector_sum_row->clone().get()).first);
141 
142  return Status{};
143 }
#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, and ICloneable< T >::clone().

Referenced by CLGEMMLowpMatrixMultiplyCore::validate().


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