Compute Library
 21.11
CLReorgLayerKernel Class Reference

OpenCL kernel to perform a reorg layer. More...

#include <CLReorgLayerKernel.h>

Collaboration diagram for CLReorgLayerKernel:
[legend]

Public Member Functions

 CLReorgLayerKernel ()
 Default constructor. More...
 
 CLReorgLayerKernel (const CLReorgLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers). More...
 
CLReorgLayerKerneloperator= (const CLReorgLayerKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers). More...
 
 CLReorgLayerKernel (CLReorgLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLReorgLayerKerneloperator= (CLReorgLayerKernel &&)=default
 Allow instances of this class to be moved. More...
 
void configure (const ICLTensor *input, ICLTensor *output, int32_t stride)
 Initialize the kernel's input, output. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, int32_t stride)
 Initialize the kernel's input, 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...
 
CLKernelType type () const
 Returns the CL kernel type. 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...
 
bool is_window_configured () const
 Function to check if the embedded window of this kernel has been configured. More...
 

Static Public Member Functions

static Status validate (const ITensorInfo *input, const ITensorInfo *output, int32_t stride)
 Static function to check if given info will lead to a valid configuration of CLReorgLayerKernel. 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 perform a reorg layer.

Definition at line 35 of file CLReorgLayerKernel.h.

Constructor & Destructor Documentation

◆ CLReorgLayerKernel() [1/3]

Default constructor.

Definition at line 68 of file CLReorgLayerKernel.cpp.

References arm_compute::ELEMENTWISE.

69  : _input(nullptr), _output(nullptr)
70 {
72 }
Elementeise CL kernel type.
Definition: CLTypes.h:84

◆ CLReorgLayerKernel() [2/3]

CLReorgLayerKernel ( const CLReorgLayerKernel )
delete

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

◆ CLReorgLayerKernel() [3/3]

Allow instances of this class to be moved.

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output,
int32_t  stride 
)

Initialize the kernel's input, output.

Parameters
[in]inputSource tensor. Data types supported: All.
[out]outputDestination tensor with tensor shape: [width_input / stride, height_input / stride, channels_input * stride * stride, batch_size]. This means the output has the same number of input elements. Data types supported: same as input.
[in]strideStride value to use for reorganizing the values in the output tensor. It defines the spatial distance between 2 consecutive pixels in the x and y direction

Definition at line 74 of file CLReorgLayerKernel.cpp.

References CLKernelLibrary::get().

75 {
76  configure(CLKernelLibrary::get().get_compile_context(), input, output, stride);
77 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLTensor *input, ICLTensor *output, int32_t stride)
Initialize the kernel&#39;s input, output.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output,
int32_t  stride 
)

Initialize the kernel's input, output.

Parameters
[in]compile_contextThe compile context to be used.
[in]inputSource tensor. Data types supported: All.
[out]outputDestination tensor with tensor shape: [width_input / stride, height_input / stride, channels_input * stride * stride, batch_size]. This means the output has the same number of input elements. Data types supported: same as input.
[in]strideStride value to use for reorganizing the values in the output tensor. It defines the spatial distance between 2 consecutive pixels in the x and y direction

Definition at line 79 of file CLReorgLayerKernel.cpp.

References CLBuildOptions::add_option(), ARM_COMPUTE_ERROR_ON, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::auto_init_if_empty(), arm_compute::calculate_max_window(), arm_compute::CHANNEL, ICloneable< T >::clone(), arm_compute::misc::shape_calculator::compute_reorg_output_shape(), arm_compute::create_kernel(), ITensorInfo::data_layout(), ITensorInfo::data_type(), ITensorInfo::dimension(), arm_compute::get_cl_type_from_data_type(), arm_compute::get_data_layout_dimension_index(), arm_compute::get_padding_info(), arm_compute::has_padding_changed(), ITensor::info(), arm_compute::test::validation::input, kernel_name, arm_compute::lower_string(), arm_compute::string_from_data_layout(), arm_compute::string_from_data_type(), and arm_compute::support::cpp11::to_string().

80 {
82  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), stride));
83  auto padding_info = get_padding_info({ input, output });
84 
85  _input = input;
86  _output = output;
87 
88  std::string kernel_name = std::string("reorg_layer_") + lower_string(string_from_data_layout(input->info()->data_layout()));
89  const size_t idx_channel = get_data_layout_dimension_index(input->info()->data_layout(), DataLayoutDimension::CHANNEL);
90 
91  // Create kernel
92  CLBuildOptions build_opts;
93  build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(input->info()->data_type()));
94  build_opts.add_option("-DSRC_DEPTH=" + support::cpp11::to_string(input->info()->dimension(idx_channel)));
95  build_opts.add_option("-DSTRIDE=" + support::cpp11::to_string(stride));
96  _kernel = create_kernel(compile_context, kernel_name, build_opts.options());
97 
98  // Configure window
99  // auto inizialize the output tensor if not yet initialized
100  auto_init_if_empty(*output->info(), input->info()->clone()->set_tensor_shape(misc::shape_calculator::compute_reorg_output_shape(*input->info(), stride)));
101 
102  Window win = calculate_max_window(*output->info(), Steps());
103 
104  // The CLWeightsReshapeKernel doesn't need padding so update_window_and_padding() can be skipped
105  ICLKernel::configure_internal(win);
106 
107  _config_id = kernel_name;
108  _config_id += "_";
109  _config_id += string_from_data_type(input->info()->data_type());
110  _config_id += "_";
111  _config_id += support::cpp11::to_string(input->info()->dimension(0));
112  _config_id += "_";
113  _config_id += support::cpp11::to_string(input->info()->dimension(1));
114  _config_id += "_";
115  _config_id += support::cpp11::to_string(input->info()->dimension(2));
116  _config_id += "_";
117  _config_id += support::cpp11::to_string(stride);
119 }
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
std::string to_string(T &&value)
Convert integer and float values to string.
#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
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
TensorShape compute_reorg_output_shape(const ITensorInfo &input, int32_t stride)
Calculate the output shape of the reorg layer given a stride.
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:326
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:391
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:135
std::string get_cl_type_from_data_type(const DataType &dt)
Translates a tensor data type to the appropriate OpenCL type.
Definition: CLHelpers.cpp:39
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
bool has_padding_changed(const std::unordered_map< const ITensorInfo *, PaddingSize > &padding_map)
Check if the previously stored padding info has changed after configuring a kernel.
Definition: Utils.cpp:533
const std::string & string_from_data_layout(DataLayout dl)
Convert a data layout identity into a string.
Definition: Utils.cpp:123
size_t get_data_layout_dimension_index(const DataLayout &data_layout, const DataLayoutDimension &data_layout_dimension)
Get the index of the given dimension.
Definition: Helpers.inl:193
std::unordered_map< const ITensorInfo *, PaddingSize > get_padding_info(std::initializer_list< const ITensorInfo *> infos)
Stores padding information before configuring a kernel.
Definition: Utils.cpp:518
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:157
std::string kernel_name

◆ operator=() [1/2]

CLReorgLayerKernel& operator= ( const CLReorgLayerKernel )
delete

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

◆ operator=() [2/2]

CLReorgLayerKernel& operator= ( CLReorgLayerKernel &&  )
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 128 of file CLReorgLayerKernel.cpp.

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(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

129 {
132 
134 
135  do
136  {
137  unsigned int idx = 0;
138  add_3D_tensor_argument(idx, _input, slice);
139  add_3D_tensor_argument(idx, _output, slice);
140  enqueue(queue, *this, slice, lws_hint());
141  }
142  while(window.slide_window_slice_3D(slice));
143 }
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:32
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:318
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:214
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:335
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:915
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:291
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:201
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
int32_t  stride 
)
static

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

Parameters
[in]inputSource tensor. Data types supported: All.
[in]outputDestination tensor with tensor shape: [width_input / stride, height_input / stride, channels_input * stride * stride, batch_size]. This means the output has the same number of input elements. Data types supported: same as input. Data types supported: same as input.
[in]strideStride value to use for reorganizing the values in the output tensor It defines the spatial distance between 2 consecutive pixels in the x and y direction
Returns
a status

Definition at line 121 of file CLReorgLayerKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR.

Referenced by CLReorgLayer::validate().

122 {
123  ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, stride));
124 
125  return Status{};
126 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204

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