Compute Library
 19.08
CLGEMMReshapeRHSMatrixKernel Class Reference

OpenCL kernel to reshape the RHS matrix when performing the matrix multiplication In particular, this kernel splits the input matrix in blocks of size K0xN0 and stores each one in the output matrix unrolling the values. More...

#include <CLGEMMReshapeRHSMatrixKernel.h>

Collaboration diagram for CLGEMMReshapeRHSMatrixKernel:
[legend]

Public Member Functions

 CLGEMMReshapeRHSMatrixKernel ()
 Default constructor. More...
 
 CLGEMMReshapeRHSMatrixKernel (const CLGEMMReshapeRHSMatrixKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLGEMMReshapeRHSMatrixKerneloperator= (const CLGEMMReshapeRHSMatrixKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLGEMMReshapeRHSMatrixKernel (CLGEMMReshapeRHSMatrixKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLGEMMReshapeRHSMatrixKerneloperator= (CLGEMMReshapeRHSMatrixKernel &&)=default
 Allow instances of this class to be moved. More...
 
void configure (const ICLTensor *input, ICLTensor *output, const GEMMRHSMatrixInfo &rhs_info)
 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 *input, const ITensorInfo *output, const GEMMRHSMatrixInfo &rhs_info)
 Static function to check if given info will lead to a valid configuration of CLGEMMReshapeRHSMatrixKernel. 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 to reshape the RHS matrix when performing the matrix multiplication In particular, this kernel splits the input matrix in blocks of size K0xN0 and stores each one in the output matrix unrolling the values.

Definition at line 36 of file CLGEMMReshapeRHSMatrixKernel.h.

Constructor & Destructor Documentation

◆ CLGEMMReshapeRHSMatrixKernel() [1/3]

Default constructor.

Definition at line 98 of file CLGEMMReshapeRHSMatrixKernel.cpp.

99  : _input(nullptr), _output(nullptr)
100 {
101 }

◆ CLGEMMReshapeRHSMatrixKernel() [2/3]

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

◆ CLGEMMReshapeRHSMatrixKernel() [3/3]

Allow instances of this class to be moved.

Member Function Documentation

◆ configure()

void configure ( const ICLTensor input,
ICLTensor output,
const GEMMRHSMatrixInfo rhs_info 
)

Initialise the kernel's input and output.

Parameters
[in]inputInput tensor. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[out]outputOutput tensor. Data type supported: same as input
[in]rhs_infoRHS matrix information to be used for reshaping. This object contains all the necessary information to reshape the input tensor. Only the following values are supported: rhs_info.n0: 2,3,4,8,16 rhs_info.k0: 1,2,3,4,8,16 (k0 = 1 only if rhs_info.transpose = false) rhs_info.h0: greater than 0 rhs_info.transpose: true, false rhs_info.interleave: true, false

Definition at line 103 of file CLGEMMReshapeRHSMatrixKernel.cpp.

104 {
105  ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);
106 
107  // Perform validate step
108  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), rhs_info));
109 
110  _input = input;
111  _output = output;
112 
113  // Create build options
114  CLBuildOptions build_opts;
115  build_opts.add_option("-DN0=" + support::cpp11::to_string(rhs_info.n0));
116  build_opts.add_option("-DK0=" + support::cpp11::to_string(rhs_info.k0));
117  build_opts.add_option("-DH0=" + support::cpp11::to_string(rhs_info.h0));
118  build_opts.add_option_if(rhs_info.transpose, "-DTRANSPOSE");
119  build_opts.add_option_if(rhs_info.interleave, "-DINTERLEAVE");
120  build_opts.add_option("-DSRC_HEIGHT=" + support::cpp11::to_string(input->info()->dimension(1)));
121 
122  switch(input->info()->element_size())
123  {
124  case 1:
125  build_opts.add_option("-DDATA_TYPE=uchar");
126  break;
127  case 2:
128  build_opts.add_option("-DDATA_TYPE=ushort");
129  break;
130  case 4:
131  build_opts.add_option("-DDATA_TYPE=uint");
132  break;
133  default:
134  ARM_COMPUTE_ERROR("Data type not supported");
135  }
136 
137  std::string kernel_name("gemm_reshape_rhs_matrix_");
138  kernel_name += rhs_info.transpose ? "t" : "nt";
139 
140  // Create kernel
141  _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts.options()));
142 
143  // Configure kernel window
144  auto win_config = validate_and_configure_window(input->info(), output->info(), rhs_info);
145  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
146  ICLKernel::configure_internal(win_config.second);
147 }
#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.
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.
unsigned int h0
Number of horizontal blocks of size (k0xn0) stored on the same output row.
Definition: Types.h:1870
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:327
bool transpose
True if the (k0xn0) block has to be transposed before been stored.
Definition: Types.h:1871
void add_option(std::string option)
Adds option to the existing build option list.
unsigned int k0
Number of partial accumulations performed by the matrix multiplication.
Definition: Types.h:1869
unsigned int n0
Number of columns processed by the matrix multiplication.
Definition: Types.h:1868
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;.
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
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
bool interleave
True if the h0 (k0xn0) blocks have to be interleaved in the output row.
Definition: Types.h:1872

References CLBuildOptions::add_option(), CLBuildOptions::add_option_if(), ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::dimension(), ITensorInfo::element_size(), CLKernelLibrary::get(), GEMMRHSMatrixInfo::h0, ITensor::info(), GEMMRHSMatrixInfo::interleave, GEMMRHSMatrixInfo::k0, GEMMRHSMatrixInfo::n0, CLBuildOptions::options(), arm_compute::support::cpp11::to_string(), GEMMRHSMatrixInfo::transpose, and arm_compute::validate_and_configure_window().

Referenced by CLGEMMLowpMatrixMultiplyCore::configure(), and arm_compute::test::validation::DATA_TEST_CASE().

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

158 {
161 
163 
164  do
165  {
166  unsigned int idx = 0;
167  add_3D_tensor_argument(idx, _input, slice);
168  add_3D_tensor_argument(idx, _output, slice);
169  enqueue(queue, *this, slice);
170  }
172 }
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
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
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:319
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_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), Window::first_slice_window_3D(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const GEMMRHSMatrixInfo rhs_info 
)
static

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

Parameters
[in]inputInput tensor info. Data types supported: U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
[in]outputOutput tensor info which stores the interleaved matrix. Data type supported: same as input.
[in]rhs_infoRHS matrix information to be used for reshaping. This object contains all the necessary information to reshape the input tensor. Only the following values are supported: rhs_info.n0: 2,3,4,8,16 rhs_info.k0: 1,2,3,4,8,16 (k0 = 1 only if rhs_info.transpose = false) rhs_info.h0: greater than 0 rhs_info.transpose: true, false rhs_info.interleave: true, false
Returns
a status

Definition at line 149 of file CLGEMMReshapeRHSMatrixKernel.cpp.

150 {
151  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, rhs_info));
152  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), output->clone().get(), rhs_info).first);
153 
154  return Status{};
155 }
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 CLGEMMLowpMatrixMultiplyCore::validate().


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