Compute Library
 21.02
CLCol2ImKernel Class Reference

Interface for the col2im reshaping kernel. More...

#include <CLCol2ImKernel.h>

Collaboration diagram for CLCol2ImKernel:
[legend]

Public Member Functions

 CLCol2ImKernel ()
 Default constructor. More...
 
 CLCol2ImKernel (const CLCol2ImKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLCol2ImKerneloperator= (const CLCol2ImKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLCol2ImKernel (CLCol2ImKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLCol2ImKerneloperator= (CLCol2ImKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLCol2ImKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, const Size2D &convolved_dims, unsigned int num_groups=1)
 Set the input and output of the kernel. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const Size2D &convolved_dims, unsigned int num_groups=1)
 Set the input and output of the kernel. 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...
 
virtual void run_op (ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. 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...
 
void set_wbsm_hint (const cl_int &wbsm_hint)
 Set the workgroup batch size modifier hint. More...
 
cl_int wbsm_hint () const
 Return the workgroup batch size modifier 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<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
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...
 
- 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 Size2D &convolved_dims, unsigned int num_groups=1)
 Static function to check if given info will lead to a valid configuration of CLCol2ImKernel. 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...
 

Data Fields

const ICLTensor_input
 
ICLTensor_output
 
Size2D _convolved_dims
 

Detailed Description

Interface for the col2im reshaping kernel.

Rearranges each matrix column into image blocks. It's the inverse operation of CLIm2ColKernel.

For example, a vector of 9 elements can be reshaped to a block(image) of 3x3:

\[ \left( \begin{array}{ccccccccc} a0 & a1 & a2 & a3 & a4 & a5 & a6 & a7 & a8 \\ \end{array} \right) \rightarrow \left( \begin{array}{ccc} a0 & a1 & a2 \\ a3 & a4 & a5 \\ a6 & a7 & a8 \\ \end{array} \right) \]

Definition at line 51 of file CLCol2ImKernel.h.

Constructor & Destructor Documentation

◆ CLCol2ImKernel() [1/3]

Default constructor.

Definition at line 87 of file CLCol2ImKernel.cpp.

88  : _input(nullptr), _output(nullptr), _convolved_dims()
89 {
90 }

◆ CLCol2ImKernel() [2/3]

CLCol2ImKernel ( const CLCol2ImKernel )
delete

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

◆ CLCol2ImKernel() [3/3]

CLCol2ImKernel ( CLCol2ImKernel &&  )
default

Allow instances of this class to be moved.

◆ ~CLCol2ImKernel()

~CLCol2ImKernel ( )
default

Default destructor.

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output,
const Size2D convolved_dims,
unsigned int  num_groups = 1 
)

Set the input and output of the kernel.

Parameters
[in]inputThe input tensor to convert. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32
[out]outputThe output tensor. 3 lower dimensions represent a single output [width, height, OFM], while the rest represent batch of outputs. Data types supported: Same as input. Data layout: NCHW
[in]convolved_dimsOutput convolved dimensions.
[in]num_groups(Optional) Number of groups when performing a grouped convolution

Definition at line 92 of file CLCol2ImKernel.cpp.

References CLKernelLibrary::get().

93 {
94  configure(CLKernelLibrary::get().get_compile_context(), input, output, convolved_dims, num_groups);
95 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
const unsigned int num_groups
Definition: Im2Col.cpp:153
void configure(const ICLTensor *input, ICLTensor *output, const Size2D &convolved_dims, unsigned int num_groups=1)
Set the input and output of the kernel.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output,
const Size2D convolved_dims,
unsigned int  num_groups = 1 
)

Set the input and output of the kernel.

Parameters
[in]compile_contextThe compile context to be used.
[in]inputThe input tensor to convert. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32
[out]outputThe output tensor. 3 lower dimensions represent a single output [width, height, OFM], while the rest represent batch of outputs. Data types supported: Same as input. Data layout: NCHW
[in]convolved_dimsOutput convolved dimensions.
[in]num_groups(Optional) Number of groups when performing a grouped convolution

Definition at line 97 of file CLCol2ImKernel.cpp.

References CLCol2ImKernel::_convolved_dims, CLCol2ImKernel::_input, CLCol2ImKernel::_output, CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), arm_compute::test::validation::data_type, ITensorInfo::data_type(), ITensorInfo::dimension(), ITensorInfo::element_size(), arm_compute::get_cl_type_from_data_type(), ITensor::info(), arm_compute::test::validation::input, arm_compute::lower_string(), arm_compute::test::validation::num_groups, CLBuildOptions::options(), arm_compute::string_from_data_type(), arm_compute::support::cpp11::to_string(), arm_compute::validate_arguments(), and Size2D::width.

98 {
100 
101  // Perform validation step
102  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), convolved_dims, num_groups));
103 
104  _input = input;
105  _output = output;
106  _convolved_dims = convolved_dims;
107 
108  const DataType data_type = input->info()->data_type();
109 
110  // Create kernel
111  CLBuildOptions build_opts;
112  build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(data_type));
113  build_opts.add_option("-DELEMENT_SIZE=" + support::cpp11::to_string(input->info()->element_size()));
114  build_opts.add_option("-DWIDTH_INPUT=" + support::cpp11::to_string(input->info()->dimension(0)));
115  build_opts.add_option("-DWIDTH_OUTPUT=" + support::cpp11::to_string(_convolved_dims.width));
116  build_opts.add_option("-DNUM_GROUPS=" + support::cpp11::to_string(num_groups));
117 
118  _kernel = create_kernel(compile_context, "col2im", build_opts.options());
119 
120  // Configure kernel window
121  auto win_config = validate_and_configure_window(input->info(), output->info(), _convolved_dims, num_groups);
122  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
123  ICLKernel::configure_internal(win_config.second);
124 
125  // Set config_id for enabling LWS tuning
126  _config_id = "col2im_";
127  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
128  _config_id += "_";
129  _config_id += support::cpp11::to_string(num_groups);
130  _config_id += "_";
131  _config_id += support::cpp11::to_string(input->info()->dimension(0));
132  _config_id += "_";
133  _config_id += support::cpp11::to_string(input->info()->dimension(1));
134  _config_id += "_";
135  _config_id += support::cpp11::to_string(output->info()->dimension(0));
136  _config_id += "_";
137  _config_id += support::cpp11::to_string(output->info()->dimension(1));
138 }
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:350
const DataType data_type
Definition: Im2Col.cpp:150
cl::Kernel create_kernel(const CLCompileContext &ctx, const std::string &kernel_name, const std::set< std::string > &build_opts=std::set< std::string >())
Creates an opencl kernel using a compile context.
Definition: CLHelpers.cpp:403
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:135
const unsigned int num_groups
Definition: Im2Col.cpp:153
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:37
size_t width
Width of the image region or rectangle.
Definition: Size2D.h:89
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
DataType
Available data types.
Definition: Types.h:77

◆ operator=() [1/2]

CLCol2ImKernel& operator= ( const CLCol2ImKernel )
delete

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

◆ operator=() [2/2]

CLCol2ImKernel& operator= ( CLCol2ImKernel &&  )
default

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.

Reimplemented from ICLKernel.

Definition at line 148 of file CLCol2ImKernel.cpp.

References CLCol2ImKernel::_input, CLCol2ImKernel::_output, ICLKernel::add_3D_tensor_argument(), ICLKernel::add_4D_tensor_argument(), ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_MISMATCHING_WINDOWS, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, Window::collapse_if_possible(), Window::DimZ, arm_compute::enqueue(), Window::first_slice_window_3D(), Window::first_slice_window_4D(), ITensor::info(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), Window::slide_window_slice_4D(), ITensorInfo::tensor_shape(), Window::use_tensor_dimensions(), and IKernel::window().

149 {
152 
153  bool is_collapsed = false;
154  bool is_collapsed_out = false;
155 
156  Window out_window;
157  out_window.use_tensor_dimensions(_output->info()->tensor_shape());
158 
159  Window collapsed = window.collapse_if_possible(ICLKernel::window(), Window::DimZ, &is_collapsed);
160  Window collapsed_out = out_window.collapse_if_possible(out_window, 3, &is_collapsed_out);
161 
162  ARM_COMPUTE_ERROR_ON(is_collapsed != is_collapsed_out);
163 
164  Window slice = collapsed.first_slice_window_3D();
165  Window slice_out = collapsed_out.first_slice_window_4D();
166  do
167  {
168  // Set inputs
169  unsigned int idx = 0;
170  add_3D_tensor_argument(idx, _input, slice);
171  add_4D_tensor_argument(idx, _output, slice_out);
172  enqueue(queue, *this, slice, lws_hint());
173  }
174  while(collapsed.slide_window_slice_3D(slice) && collapsed_out.slide_window_slice_4D(slice_out));
175 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void enqueue(IGCKernel &kernel, const Window &window, const gles::NDRange &lws=gles::NDRange(1U, 1U, 1U))
Add the kernel to the command queue with the given window.
Definition: IGCKernel.cpp:41
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:276
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
void add_3D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 3D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:172
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_WINDOWS(f, w)
Definition: Validate.h:183
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:68
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&#39;s metadata.
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
static constexpr size_t DimZ
Alias for dimension 2 also known as Z dimension.
Definition: Window.h:47
void add_4D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 4D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:182
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const Size2D convolved_dims,
unsigned int  num_groups = 1 
)
static

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

Parameters
[in]inputThe input tensor to convert. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32
[in]outputThe output tensor. 3 lower dimensions represent a single output [width, height, OFM], while the rest represent batch of outputs. Data types supported: Same as input. Data layout: NCHW
[in]convolved_dimsOutput convolved dimensions.
[in]num_groups(Optional) Number of groups when performing a grouped convolution
Returns
a status

Definition at line 140 of file CLCol2ImKernel.cpp.

References ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), arm_compute::test::validation::num_groups, and arm_compute::validate_arguments().

Referenced by arm_compute::test::validation::TEST_CASE(), and CLGEMMConvolutionLayer::validate().

141 {
144  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), output->clone().get(), convolved_dims, num_groups).first);
145  return Status{};
146 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
const unsigned int num_groups
Definition: Im2Col.cpp:153
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

Field Documentation

◆ _convolved_dims

Size2D _convolved_dims

Definition at line 103 of file CLCol2ImKernel.h.

Referenced by CLCol2ImKernel::configure().

◆ _input

const ICLTensor* _input

Definition at line 101 of file CLCol2ImKernel.h.

Referenced by CLCol2ImKernel::configure(), and CLCol2ImKernel::run().

◆ _output

ICLTensor* _output

Definition at line 102 of file CLCol2ImKernel.h.

Referenced by CLCol2ImKernel::configure(), and CLCol2ImKernel::run().


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